refactor: fix and micro-optimize code in Format

system/Format/Exceptions/FormatException.php

@@ -37,7 +37,7 @@ public static function forInvalidFormatter(string $class)
      * Thrown in JSONFormatter when the json_encode produces
      * an error code other than JSON_ERROR_NONE and JSON_ERROR_RECURSION.
      *
-     * @param string $error The error message
+     * @param string|null $error The error message
      *
      * @return static
      */

system/Format/Format.php

@@ -23,19 +23,8 @@
  */
 class Format
 {
-    /**
-     * Configuration instance
-     *
-     * @var FormatConfig
-     */
-    protected $config;
-
-    /**
-     * Constructor.
-     */
-    public function __construct(FormatConfig $config)
+    public function __construct(protected FormatConfig $config)
     {
-        $this->config = $config;
     }
 
     /**

system/Format/FormatterInterface.php

@@ -21,9 +21,9 @@ interface FormatterInterface
     /**
      * Takes the given data and formats it.
      *
-     * @param array|object|string $data
+     * @param array<array-key, mixed>|object|string $data
      *
-     * @return false|string
+     * @return false|non-empty-string
      */
     public function format($data);
 }

system/Format/JSONFormatter.php

@@ -26,9 +26,9 @@ class JSONFormatter implements FormatterInterface
     /**
      * Takes the given data and formats it.
      *
-     * @param array|bool|float|int|object|string|null $data
+     * @param array<array-key, mixed>|object|string $data
      *
-     * @return false|string (JSON string | false)
+     * @return false|non-empty-string
      */
     public function format($data)
     {
@@ -37,7 +37,9 @@ public function format($data)
         $options = $config->formatterOptions['application/json'] ?? JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES;
         $options |= JSON_PARTIAL_OUTPUT_ON_ERROR;
 
-        $options = ENVIRONMENT === 'production' ? $options : $options | JSON_PRETTY_PRINT;
+        if (ENVIRONMENT !== 'production') {
+            $options |= JSON_PRETTY_PRINT;
+        }
 
         $result = json_encode($data, $options, 512);
 

system/Format/XMLFormatter.php

@@ -27,9 +27,9 @@ class XMLFormatter implements FormatterInterface
     /**
      * Takes the given data and formats it.
      *
-     * @param array|bool|float|int|object|string|null $data
+     * @param array<array-key, mixed>|object|string $data
      *
-     * @return false|string (XML string | false)
+     * @return false|non-empty-string
      */
     public function format($data)
     {
@@ -56,7 +56,8 @@ public function format($data)
      *
      * @see http://www.codexworld.com/convert-array-to-xml-in-php/
      *
-     * @param SimpleXMLElement $output
+     * @param array<array-key, mixed> $data
+     * @param SimpleXMLElement        $output
      *
      * @return void
      */

tests/system/Format/JSONFormatterTest.php

@@ -13,8 +13,9 @@
 
 namespace CodeIgniter\Format;
 
-use CodeIgniter\Exceptions\RuntimeException;
+use CodeIgniter\Format\Exceptions\FormatException;
 use CodeIgniter\Test\CIUnitTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Group;
 
 /**
@@ -31,51 +32,34 @@ protected function setUp(): void
         $this->jsonFormatter = new JSONFormatter();
     }
 
-    public function testBasicJSON(): void
+    /**
+     * @param array<string, string> $data
+     */
+    #[DataProvider('provideFormattingToJson')]
+    public function testFormattingToJson(array $data, string $expected): void
     {
-        $data = [
-            'foo' => 'bar',
-        ];
-
-        $expected = '{
-    "foo": "bar"
-}';
-
         $this->assertSame($expected, $this->jsonFormatter->format($data));
     }
 
-    public function testUnicodeOutput(): void
+    /**
+     * @return iterable<string, array{0: array<string, string>, 1: string}>
+     */
+    public static function provideFormattingToJson(): iterable
     {
-        $data = [
-            'foo' => 'База данни грешка',
-        ];
+        yield 'empty array' => [[], '[]'];
 
-        $expected = '{
-    "foo": "База данни грешка"
-}';
+        yield 'simple array' => [['foo' => 'bar'], "{\n    \"foo\": \"bar\"\n}"];
 
-        $this->assertSame($expected, $this->jsonFormatter->format($data));
-    }
+        yield 'unicode array' => [['foo' => 'База данни грешка'], "{\n    \"foo\": \"База данни грешка\"\n}"];
 
-    public function testKeepsURLs(): void
-    {
-        $data = [
-            'foo' => 'https://www.example.com/foo/bar',
-        ];
-
-        $expected = '{
-    "foo": "https://www.example.com/foo/bar"
-}';
-
-        $this->assertSame($expected, $this->jsonFormatter->format($data));
+        yield 'url array' => [['foo' => 'https://www.example.com/foo/bar'], "{\n    \"foo\": \"https://www.example.com/foo/bar\"\n}"];
     }
 
-    public function testJSONError(): void
+    public function testJSONFormatterThrowsError(): void
     {
-        $this->expectException(RuntimeException::class);
+        $this->expectException(FormatException::class);
+        $this->expectExceptionMessage('Malformed UTF-8 characters, possibly incorrectly encoded');
 
-        $data     = ["\xB1\x31"];
-        $expected = 'Boom';
-        $this->assertSame($expected, $this->jsonFormatter->format($data));
+        $this->assertSame('Boom', $this->jsonFormatter->format(["\xB1\x31"]));
     }
 }

tests/system/Format/XMLFormatterTest.php

@@ -104,6 +104,9 @@ public function testValidatingXmlTags(): void
         $this->assertSame($expected, $this->xmlFormatter->format($data));
     }
 
+    /**
+     * @param array<string, string> $input
+     */
     #[DataProvider('provideValidatingInvalidTags')]
     public function testValidatingInvalidTags(string $expected, array $input): void
     {
@@ -116,6 +119,9 @@ public function testValidatingInvalidTags(string $expected, array $input): void
         $this->assertSame($expectedXML, $this->xmlFormatter->format($input));
     }
 
+    /**
+     * @return iterable<int, array{0: string, 1: array<string, string>}>
+     */
     public static function provideValidatingInvalidTags(): iterable
     {
         return [

utils/phpstan-baseline/loader.neon

@@ -1,4 +1,4 @@
-# total 3262 errors
+# total 3256 errors
 includes:
     - argument.type.neon
     - assign.propertyType.neon

utils/phpstan-baseline/missingType.iterableValue.neon

@@ -1,4 +1,4 @@
-# total 1571 errors
+# total 1565 errors
 
 parameters:
     ignoreErrors:
@@ -3052,26 +3052,6 @@ parameters:
             count: 1
             path: ../../system/Filters/PerformanceMetrics.php
 
-        -
-            message: '#^Method CodeIgniter\\Format\\FormatterInterface\:\:format\(\) has parameter \$data with no value type specified in iterable type array\.$#'
-            count: 1
-            path: ../../system/Format/FormatterInterface.php
-
-        -
-            message: '#^Method CodeIgniter\\Format\\JSONFormatter\:\:format\(\) has parameter \$data with no value type specified in iterable type array\.$#'
-            count: 1
-            path: ../../system/Format/JSONFormatter.php
-
-        -
-            message: '#^Method CodeIgniter\\Format\\XMLFormatter\:\:arrayToXML\(\) has parameter \$data with no value type specified in iterable type array\.$#'
-            count: 1
-            path: ../../system/Format/XMLFormatter.php
-
-        -
-            message: '#^Method CodeIgniter\\Format\\XMLFormatter\:\:format\(\) has parameter \$data with no value type specified in iterable type array\.$#'
-            count: 1
-            path: ../../system/Format/XMLFormatter.php
-
         -
             message: '#^Method CodeIgniter\\HTTP\\CLIRequest\:\:getArgs\(\) return type has no value type specified in iterable type array\.$#'
             count: 1
@@ -6517,16 +6497,6 @@ parameters:
             count: 1
             path: ../../tests/system/Filters/InvalidCharsTest.php
 
-        -
-            message: '#^Method CodeIgniter\\Format\\XMLFormatterTest\:\:provideValidatingInvalidTags\(\) return type has no value type specified in iterable type iterable\.$#'
-            count: 1
-            path: ../../tests/system/Format/XMLFormatterTest.php
-
-        -
-            message: '#^Method CodeIgniter\\Format\\XMLFormatterTest\:\:testValidatingInvalidTags\(\) has parameter \$input with no value type specified in iterable type array\.$#'
-            count: 1
-            path: ../../tests/system/Format/XMLFormatterTest.php
-
         -
             message: '#^Method CodeIgniter\\HTTP\\IncomingRequestTest\:\:provideCanGrabGetRawInputVar\(\) return type has no value type specified in iterable type iterable\.$#'
             count: 1