[type-declarations] Add AddClassMethodParamArrayWhereDimFetchRector

Author: TomasVotruba

rules-tests/TypeDeclaration/Rector/ClassMethod/AddClassMethodParamArrayWhereDimFetchRector/AddClassMethodParamArrayWhereDimFetchRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddClassMethodParamArrayWhereDimFetchRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class AddClassMethodParamArrayWhereDimFetchRectorTest 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/AddClassMethodParamArrayWhereDimFetchRector/Fixture/fixture.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddClassMethodParamArrayWhereDimFetchRector\Fixture;
+
+final class Fixture
+{
+    public function process($items)
+    {
+        return $items[0];
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddClassMethodParamArrayWhereDimFetchRector\Fixture;
+
+final class Fixture
+{
+    public function process(array $items)
+    {
+        return $items[0];
+    }
+}
+
+?>

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

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\TypeDeclaration\Rector\ClassMethod\AddClassMethodParamArrayWhereDimFetchRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(AddClassMethodParamArrayWhereDimFetchRector::class);
+};

rules/TypeDeclaration/Rector/ClassMethod/AddClassMethodParamArrayWhereDimFetchRector.php

@@ -0,0 +1,101 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\TypeDeclaration\Rector\ClassMethod;
+
+use PhpParser\Node;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\Rector\AbstractRector;
+use Rector\TypeDeclarationDocblocks\NodeFinder\ArrayDimFetchFinder;
+use Rector\ValueObject\PhpVersionFeature;
+use Rector\VersionBonding\Contract\MinPhpVersionInterface;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddClassMethodParamArrayWhereDimFetchRector\AddClassMethodParamArrayWhereDimFetchRectorTest
+ */
+final class AddClassMethodParamArrayWhereDimFetchRector extends AbstractRector implements MinPhpVersionInterface
+{
+    public function __construct(
+        private readonly ArrayDimFetchFinder $arrayDimFetchFinder,
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Add method array type, if dim fetch is inside', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+final class SomeClass
+{
+    public function run($data)
+    {
+        return $data['key'];
+    }
+}
+CODE_SAMPLE
+
+                ,
+                <<<'CODE_SAMPLE'
+final class SomeClass
+{
+    public function run(array $data)
+    {
+        return $data['key'];
+    }
+}
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [ClassMethod::class];
+    }
+
+    /**
+     * @param ClassMethod $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        $hasChanged = false;
+
+        foreach ($node->getParams() as $param) {
+            if ($param->type instanceof Node) {
+                continue;
+            }
+
+            $paramName = $this->getName($param->var);
+
+            // find dim fetches in there
+            $arrayDimFetches = $this->arrayDimFetchFinder->findByVariableName($node, $paramName);
+
+            // no dim fetches found
+            if ($arrayDimFetches === []) {
+                continue;
+            }
+
+            // param type is array
+            $param->type = new Identifier('array');
+            $hasChanged = true;
+        }
+
+        if ($hasChanged === false) {
+            return null;
+        }
+
+        return $node;
+    }
+
+    public function provideMinPhpVersion(): int
+    {
+        return PhpVersionFeature::SCALAR_TYPES;
+    }
+}

rules/TypeDeclaration/Rector/FuncCall/AddArrowFunctionParamArrayWhereDimFetchRector.php

@@ -33,7 +33,7 @@ public function __construct(
 
     public function getRuleDefinition(): RuleDefinition
     {
-        return new RuleDefinition('Add function/closure param array type, if dim fetch is inside', [
+        return new RuleDefinition('Add closure and arrow function param array type, if dim fetch is used inside', [
             new CodeSample(
                 <<<'CODE_SAMPLE'
 $array = [['name' => 'John']];

src/Config/Level/TypeDeclarationLevel.php

@@ -15,6 +15,7 @@
 use Rector\TypeDeclaration\Rector\Class_\TypedPropertyFromCreateMockAssignRector;
 use Rector\TypeDeclaration\Rector\Class_\TypedPropertyFromDocblockSetUpDefinedRector;
 use Rector\TypeDeclaration\Rector\Class_\TypedPropertyFromJMSSerializerAttributeTypeRector;
+use Rector\TypeDeclaration\Rector\ClassMethod\AddClassMethodParamArrayWhereDimFetchRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\AddMethodCallBasedStrictParamTypeRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\AddParamTypeFromPropertyTypeRector;
@@ -141,8 +142,12 @@ final class TypeDeclarationLevel
         StrictStringParamConcatRector::class,
         TypedPropertyFromJMSSerializerAttributeTypeRector::class,
 
+        // array parameter from dim fetch assign inside
+        AddClassMethodParamArrayWhereDimFetchRector::class,
+
         // possibly based on docblocks, but also helpful, intentionally last
         AddArrayFunctionClosureParamTypeRector::class,
         TypedPropertyFromDocblockSetUpDefinedRector::class,
+
     ];
 }