fix: SimplifiedNullReturnFixer - support array return typehint (PHP-C…

…S-Fixer#7728)

phpstan.dist.neon

@@ -21,7 +21,7 @@ parameters:
         -
             message: '#^Method PhpCsFixer\\Tests\\.+::provide.+Cases\(\) return type has no value type specified in iterable type iterable\.$#'
             path: tests
-            count: 1034
+            count: 1025
 
         -
             message: '#Call to static method .+ with .+ will always evaluate to true.$#'

src/Fixer/ReturnNotation/SimplifiedNullReturnFixer.php

@@ -125,7 +125,8 @@ private function isStrictOrNullableReturnTypeFunction(Tokens $tokens, int $retur
         } while ($closingCurlyBraceIndex < $returnIndex);
 
         $possibleVoidIndex = $tokens->getPrevMeaningfulToken($openingCurlyBraceIndex);
-        $isStrictReturnType = $tokens[$possibleVoidIndex]->isGivenKind(T_STRING) && 'void' !== $tokens[$possibleVoidIndex]->getContent();
+        $isStrictReturnType = $tokens[$possibleVoidIndex]->isGivenKind([T_STRING, CT::T_ARRAY_TYPEHINT])
+            && 'void' !== $tokens[$possibleVoidIndex]->getContent();
 
         $nullableTypeIndex = $tokens->getNextTokenOfKind($functionIndex, [[CT::T_NULLABLE_TYPE]]);
         $isNullableReturnType = null !== $nullableTypeIndex && $nullableTypeIndex < $openingCurlyBraceIndex;

tests/Fixer/ReturnNotation/NoUselessReturnFixerTest.php

@@ -31,6 +31,9 @@ public function testFix(string $expected, ?string $input = null): void
         $this->doTest($expected, $input);
     }
 
+    /**
+     * @return iterable<array{0: non-empty-string, 1?: non-empty-string}>
+     */
     public static function provideFixCases(): iterable
     {
         yield [

tests/Fixer/ReturnNotation/ReturnAssignmentFixerTest.php

@@ -31,6 +31,9 @@ public function testFixNestedFunctions(string $expected, string $input): void
         $this->doTest($expected, $input);
     }
 
+    /**
+     * @return iterable<array{0: non-empty-string, 1?: non-empty-string}>
+     */
     public static function provideFixNestedFunctionsCases(): iterable
     {
         yield [
@@ -189,6 +192,9 @@ public function testFix(string $expected, string $input): void
         $this->doTest($expected, $input);
     }
 
+    /**
+     * @return iterable<array{0: non-empty-string, 1?: non-empty-string}>
+     */
     public static function provideFixCases(): iterable
     {
         yield [
@@ -819,6 +825,9 @@ public function testDoNotFix(string $expected): void
         $this->doTest($expected);
     }
 
+    /**
+     * @return iterable<array{0: non-empty-string, 1?: non-empty-string}>
+     */
     public static function provideDoNotFixCases(): iterable
     {
         yield 'invalid reference stays invalid' => [
@@ -1261,6 +1270,9 @@ public function testDoNotFix80(string $expected): void
         $this->doTest($expected);
     }
 
+    /**
+     * @return iterable<array{0: non-empty-string, 1?: non-empty-string}>
+     */
     public static function provideDoNotFix80Cases(): iterable
     {
         yield 'try with non-capturing catch block' => [
@@ -1291,6 +1303,9 @@ public function testRepetitiveFix(string $expected, ?string $input = null): void
         $this->doTest($expected, $input);
     }
 
+    /**
+     * @return iterable<array{0: non-empty-string, 1?: non-empty-string}>
+     */
     public static function provideRepetitiveFixCases(): iterable
     {
         yield [
@@ -1344,6 +1359,9 @@ public function testFix80(string $expected, ?string $input = null): void
         $this->doTest($expected, $input);
     }
 
+    /**
+     * @return iterable<array{0: non-empty-string, 1?: non-empty-string}>
+     */
     public static function provideFix80Cases(): iterable
     {
         yield 'match' => [
@@ -1394,6 +1412,9 @@ public function testFixPhp83(string $expected, ?string $input = null): void
         $this->doTest($expected, $input);
     }
 
+    /**
+     * @return iterable<array{0: non-empty-string, 1?: non-empty-string}>
+     */
     public static function provideFixPhp83Cases(): iterable
     {
         yield 'anonymous readonly class' => [

tests/Fixer/ReturnNotation/SimplifiedNullReturnFixerTest.php

@@ -33,6 +33,9 @@ public function testFix(string $expected, ?string $input = null): void
         $this->doTest($expected, $input);
     }
 
+    /**
+     * @return iterable<array{0: non-empty-string, 1?: non-empty-string}>
+     */
     public static function provideFixCases(): iterable
     {
         // check correct statements aren't changed
@@ -90,4 +93,47 @@ public static function provideFixCases(): iterable
             '<?php function foo(): void { return; }',
         ];
     }
+
+    /**
+     * @requires PHP 8.0
+     *
+     * @dataProvider provideFix80Cases
+     */
+    public function testFix80(string $expected, ?string $input = null): void
+    {
+        $this->doTest($expected, $input);
+    }
+
+    /**
+     * @return iterable<array{0: non-empty-string, 1?: non-empty-string}>
+     */
+    public static function provideFix80Cases(): iterable
+    {
+        yield [
+            '<?php
+            function test(): null|int
+            {
+                if (true) { return null; }
+                return 42;
+            }',
+        ];
+
+        yield [
+            '<?php
+            function test(): null|array
+            {
+                if (true) { return null; }
+                return [];
+            }',
+        ];
+
+        yield [
+            '<?php
+            function test(): array|null
+            {
+                if (true) { return null; }
+                return [];
+            }',
+        ];
+    }
 }