[TypeDeclaration] Add AddReturnArrayDocblockBasedOnArrayMapRector (#6235

)

* [TypeDeclaration] Add AddReturnArrayDocblockBasedOnArrayMapRector

* skip first class callable

* skip if else case

* add if/else with valid return

* add fixture

* add fixture for use class

* add arrow function support

rules-tests/TypeDeclaration/Rector/ClassMethod/AddReturnArrayDocblockBasedOnArrayMapRector/AddReturnArrayDocblockBasedOnArrayMapRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class AddReturnArrayDocblockBasedOnArrayMapRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/AddReturnArrayDocblockBasedOnArrayMapRector/Fixture/function_array_map_return.php.inc

@@ -0,0 +1,34 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector\Fixture;
+
+final class FunctionArrayMapReturn
+{
+    public function process(array $items)
+    {
+        return array_map(function ($item): int {
+            return $item;
+        }, $items);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector\Fixture;
+
+final class FunctionArrayMapReturn
+{
+    /**
+     * @return int[]
+     */
+    public function process(array $items)
+    {
+        return array_map(function ($item): int {
+            return $item;
+        }, $items);
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/AddReturnArrayDocblockBasedOnArrayMapRector/Fixture/improve_simple_array.php.inc

@@ -0,0 +1,37 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector\Fixture;
+
+final class ImproveSimpleArray
+{
+    /**
+     * @return array
+     */
+    public function process(array $items)
+    {
+        return array_map(function ($item): int {
+            return $item;
+        }, $items);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector\Fixture;
+
+final class ImproveSimpleArray
+{
+    /**
+     * @return int[]
+     */
+    public function process(array $items)
+    {
+        return array_map(function ($item): int {
+            return $item;
+        }, $items);
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/AddReturnArrayDocblockBasedOnArrayMapRector/Fixture/include_arrow_function.php.inc

@@ -0,0 +1,30 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector\Fixture;
+
+final class IncludeArrowFunction
+{
+    public function run(array $items)
+    {
+        return array_map(fn ($item): int => 1000, $items);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector\Fixture;
+
+final class IncludeArrowFunction
+{
+    /**
+     * @return int[]
+     */
+    public function run(array $items)
+    {
+        return array_map(fn ($item): int => 1000, $items);
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/AddReturnArrayDocblockBasedOnArrayMapRector/Fixture/multiple_filters.php.inc

@@ -0,0 +1,46 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector\Fixture;
+
+final class MultipleFilters
+{
+    public function run(array $items)
+    {
+        if (mt_rand(0, 1)) {
+            return array_map(function ($item): int {
+                return $item;
+            }, $items);
+        }
+
+        return array_map(function ($item): int {
+            return 1000;
+        }, $items);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector\Fixture;
+
+final class MultipleFilters
+{
+    /**
+     * @return int[]
+     */
+    public function run(array $items)
+    {
+        if (mt_rand(0, 1)) {
+            return array_map(function ($item): int {
+                return $item;
+            }, $items);
+        }
+
+        return array_map(function ($item): int {
+            return 1000;
+        }, $items);
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/AddReturnArrayDocblockBasedOnArrayMapRector/Fixture/multiple_types.php.inc

@@ -0,0 +1,46 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector\Fixture;
+
+final class MultipleTypes
+{
+    public function run(array $items)
+    {
+        if (mt_rand(0, 1)) {
+            return array_map(function ($item): int {
+                return $item;
+            }, $items);
+        }
+
+        return array_map(function ($item): string {
+            return '1000';
+        }, $items);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector\Fixture;
+
+final class MultipleTypes
+{
+    /**
+     * @return int[]|string[]
+     */
+    public function run(array $items)
+    {
+        if (mt_rand(0, 1)) {
+            return array_map(function ($item): int {
+                return $item;
+            }, $items);
+        }
+
+        return array_map(function ($item): string {
+            return '1000';
+        }, $items);
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/AddReturnArrayDocblockBasedOnArrayMapRector/Fixture/skip_already_class.php.inc

@@ -0,0 +1,18 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector\Fixture;
+
+use stdClass;
+
+final class SkipAlreadyClass
+{
+    /**
+     * @return stdClass[]
+     */
+    public function process(array $items)
+    {
+        return array_map(function ($item): stdClass {
+            return $item;
+        }, $items);
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/AddReturnArrayDocblockBasedOnArrayMapRector/Fixture/skip_first_class_callable.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector\Fixture;
+
+final class SkipFirstClassCallable
+{
+    public function run(array $items)
+    {
+        return array_map(...);
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/AddReturnArrayDocblockBasedOnArrayMapRector/Fixture/skip_if_else.php.inc

@@ -0,0 +1,17 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector\Fixture;
+
+final class SkipIfElse
+{
+    public function go(array $items)
+    {
+        if (rand(0, 1)) {
+            return array_map(function ($item): int {
+                return $item;
+            }, $items);
+        }
+
+        return [];
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/AddReturnArrayDocblockBasedOnArrayMapRector/config/configured_rule.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector;
+
+return RectorConfig::configure()
+    ->withRules([AddReturnArrayDocblockBasedOnArrayMapRector::class]);