fix: PhpdocTypesFixer - handle more complex types (#7791)

PHP-CS-Fixer · Feb 1, 2024 · d12282c · d12282c
1 parent 21f5b42
commit d12282c
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 40 deletions.
diff --git a/src/AbstractPhpdocTypesFixer.php b/src/AbstractPhpdocTypesFixer.php
@@ -16,6 +16,7 @@
 
 use PhpCsFixer\DocBlock\Annotation;
 use PhpCsFixer\DocBlock\DocBlock;
+use PhpCsFixer\DocBlock\TypeExpression;
 use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
 
@@ -100,18 +101,23 @@ private function fixTypes(Annotation $annotation): void
     private function normalizeTypes(array $types): array
     {
         return array_map(
-            fn (string $type): string => $this->normalizeType($type),
+            function (string $type): string {
+                $typeExpression = new TypeExpression($type, null, []);
+
+                $typeExpression->walkTypes(function (TypeExpression $type): void {
+                    if (!$type->isUnionType()) {
+                        $value = $this->normalize($type->toString());
+
+                        // TODO TypeExpression should be immutable and walkTypes method should be changed to mapTypes method
+                        \Closure::bind(static function () use ($type, $value): void {
+                            $type->value = $value;
+                        }, null, TypeExpression::class)();
+                    }
+                });
+
+                return $typeExpression->toString();
+            },
             $types
         );
     }
-
-    /**
-     * Prepare the type and normalize it.
-     */
-    private function normalizeType(string $type): string
-    {
-        return str_ends_with($type, '[]')
-            ? $this->normalizeType(substr($type, 0, -2)).'[]'
-            : $this->normalize($type);
-    }
 }
diff --git a/src/Fixer/Phpdoc/PhpdocScalarFixer.php b/src/Fixer/Phpdoc/PhpdocScalarFixer.php
@@ -113,10 +113,16 @@ protected function createConfigurationDefinition(): FixerConfigurationResolverIn
 
     protected function normalize(string $type): string
     {
+        $suffix = '';
+        while (str_ends_with($type, '[]')) {
+            $type = substr($type, 0, -2);
+            $suffix .= '[]';
+        }
+
         if (\in_array($type, $this->configuration['types'], true)) {
-            return self::$types[$type];
+            $type = self::$types[$type];
         }
 
-        return $type;
+        return $type.$suffix;
     }
 }
diff --git a/src/Fixer/Phpdoc/PhpdocTypesFixer.php b/src/Fixer/Phpdoc/PhpdocTypesFixer.php
@@ -15,7 +15,6 @@
 namespace PhpCsFixer\Fixer\Phpdoc;
 
 use PhpCsFixer\AbstractPhpdocTypesFixer;
-use PhpCsFixer\DocBlock\TypeExpression;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
 use PhpCsFixer\FixerConfiguration\AllowedValueSubset;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
@@ -129,32 +128,18 @@ public function getPriority(): int
 
     protected function normalize(string $type): string
     {
-        $typeExpression = new TypeExpression($type, null, []);
-
-        $typeExpression->walkTypes(function (TypeExpression $type): void {
-            if (!$type->isUnionType()) {
-                $value = $type->toString();
-                $valueLower = strtolower($value);
-                if (isset($this->typesSetToFix[$valueLower])) {
-                    $value = $valueLower;
-                }
-
-                // normalize shape/callable/generic identifiers too
-                // TODO parse them as inner types and this will be not needed then
-                $value = Preg::replaceCallback(
-                    '/^(\??\s*)([^()[\]{}<>\'"]+)(?<!\s)(\s*[\s()[\]{}<>])/',
-                    fn ($matches) => $matches[1].$this->normalize($matches[2]).$matches[3],
-                    $value
-                );
-
-                // TODO TypeExpression should be immutable and walkTypes method should be changed to mapTypes method
-                \Closure::bind(static function () use ($type, $value): void {
-                    $type->value = $value;
-                }, null, TypeExpression::class)();
-            }
-        });
-
-        return $typeExpression->toString();
+        $typeLower = strtolower($type);
+        if (isset($this->typesSetToFix[$typeLower])) {
+            $type = $typeLower;
+        }
+
+        // normalize shape/callable/generic identifiers too
+        // TODO parse them as inner types and this will be not needed then
+        return Preg::replaceCallback(
+            '/^(\??\s*)([^()[\]{}<>\'"]+)(?<!\s)(\s*[\s()[\]{}<>])/',
+            fn ($matches) => $matches[1].$this->normalize($matches[2]).$matches[3],
+            $type
+        );
     }
 
     protected function createConfigurationDefinition(): FixerConfigurationResolverInterface

diff --git a/tests/Fixer/Phpdoc/PhpdocScalarFixerTest.php b/tests/Fixer/Phpdoc/PhpdocScalarFixerTest.php
@@ -269,5 +269,25 @@ public static function provideFixCases(): iterable
              */
              '),
         ];
+
+        yield [
+            '<?php /** @var array<int, bool> */',
+            '<?php /** @var array<integer, boolean> */',
+        ];
+
+        yield [
+            '<?php /** @var array{bool, int, string} */',
+            '<?php /** @var array{boolean, integer, str} */',
+        ];
+
+        yield [
+            '<?php /** @var array{int, array{string, bool}} */',
+            '<?php /** @var array{integer, array{str, boolean}} */',
+        ];
+
+        yield [
+            '<?php /** @var array{index: int, isRequired: bool} */',
+            '<?php /** @var array{index: integer, isRequired: boolean} */',
+        ];
     }
 }