[type-declaration-docblocks] Add AddParamArrayDocblockFromDimFetchAccessRector

Author: TomasVotruba

config/set/php85.php

@@ -42,7 +42,7 @@
             ChrArgModuloRector::class,
             SleepToSerializeRector::class,
             OrdSingleByteRector::class,
-            WakeupToUnserializeRector::class
+            WakeupToUnserializeRector::class,
         ]
     );
 

config/set/type-declaration-docblocks.php

@@ -6,6 +6,7 @@
 use Rector\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\AddReturnDocblockForScalarArrayFromAssignsRector;
 use Rector\TypeDeclarationDocblocks\Rector\Class_\DocblockVarFromParamDocblockInConstructorRector;
+use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDimFetchAccessRector;
 use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForCommonObjectDenominatorRector;
 use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\DocblockGetterReturnArrayFromPropertyDocblockVarRector;
 
@@ -20,5 +21,6 @@
         DocblockVarFromParamDocblockInConstructorRector::class,
         DocblockGetterReturnArrayFromPropertyDocblockVarRector::class,
         AddReturnDocblockForCommonObjectDenominatorRector::class,
+        AddParamArrayDocblockFromDimFetchAccessRector::class,
     ]);
 };

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddParamArrayDocblockFromDimFetchAccessRector/AddParamArrayDocblockFromDimFetchAccessRectorTest.php

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

@@ -0,0 +1,34 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDimFetchAccessRector\Fixture;
+
+final class IntKeys
+{
+    public function process(array $data): void
+    {
+        $item = $data[55];
+
+        $anotherItem = $data[132];
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDimFetchAccessRector\Fixture;
+
+final class IntKeys
+{
+    /**
+     * @param array<int, mixed> $data
+     */
+    public function process(array $data): void
+    {
+        $item = $data[55];
+
+        $anotherItem = $data[132];
+    }
+}
+
+?>

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddParamArrayDocblockFromDimFetchAccessRector/Fixture/param_array.php.inc

@@ -0,0 +1,34 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDimFetchAccessRector\Fixture;
+
+final class ParamArray
+{
+    public function process(array $data): void
+    {
+        $item = $data['key'];
+
+        $anotherItem = $data['another_key'];
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDimFetchAccessRector\Fixture;
+
+final class ParamArray
+{
+    /**
+     * @param array<string, mixed> $data
+     */
+    public function process(array $data): void
+    {
+        $item = $data['key'];
+
+        $anotherItem = $data['another_key'];
+    }
+}
+
+?>

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddParamArrayDocblockFromDimFetchAccessRector/Fixture/skip_mixed.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDimFetchAccessRector\Fixture;
+
+final class SkipMixed
+{
+    public function process(array $data, int|string $key): void
+    {
+        $item = $data[$key];
+    }
+}

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddParamArrayDocblockFromDimFetchAccessRector/Fixture/skip_no_access.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDimFetchAccessRector\Fixture;
+
+final class SkipNoAccess
+{
+    public function process(array $data): void
+    {
+        $data[] = '111';
+    }
+}

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddParamArrayDocblockFromDimFetchAccessRector/config/configured_rule.php

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

rules/Php85/Rector/Class_/WakeupToUnserializeRector.php

@@ -5,6 +5,7 @@
 namespace Rector\Php85\Rector\Class_;
 
 use PhpParser\Node;
+use PhpParser\Node\Arg;
 use PhpParser\Node\Expr\Assign;
 use PhpParser\Node\Expr\FuncCall;
 use PhpParser\Node\Expr\PropertyFetch;
@@ -86,46 +87,43 @@ public function refactor(Node $node): ?Node
         if (! $classMethod instanceof ClassMethod) {
             return null;
         }
-         
+
         $classMethod->name = new Identifier('__unserialize');
         $classMethod->returnType = new Identifier('void');
-          $param = new Param(
-            var: new Variable('data'),
-            type: new Identifier('array')
-        );
+
+        $param = new Param(var: new Variable('data'), type: new Identifier('array'));
 
         $classMethod->params[] = $param;
 
         $classMethod->stmts = [$this->assignProperties()];
-        
+
         return $node;
     }
 
-    protected function  assignProperties(): Foreach_{
+    private function assignProperties(): Foreach_
+    {
         $assign = new Assign(
             new PropertyFetch(new Variable('this'), new Variable('property')),
             new Variable('value')
         );
 
         $if = new If_(
             new FuncCall(new Name('property_exists'), [
-                new Node\Arg(new Variable('this')),
-                new Node\Arg(new Variable('property')),
+                new Arg(new Variable('this')),
+                new Arg(new Variable('property')),
             ]),
             [
                 'stmts' => [new Expression($assign)],
             ]
         );
 
-        $foreach = new Foreach_(
+        return new Foreach_(
             new Variable('data'),
             new Variable('value'),
             [
                 'keyVar' => new Variable('property'),
-                'stmts'  => [$if],
+                'stmts' => [$if],
             ]
         );
-
-        return $foreach;
     }
 }

rules/TypeDeclarationDocblocks/NodeFinder/DimFetchFinder.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\TypeDeclarationDocblocks\NodeFinder;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\ArrayDimFetch;
+use PhpParser\Node\Expr\Variable;
+use Rector\NodeNameResolver\NodeNameResolver;
+use Rector\PhpParser\Node\BetterNodeFinder;
+
+final readonly class DimFetchFinder
+{
+    public function __construct(
+        private BetterNodeFinder $betterNodeFinder,
+        private NodeNameResolver $nodeNameResolver
+    ) {
+    }
+
+    /**
+     * @return ArrayDimFetch[]
+     */
+    public function findByVariableName(Node $node, string $variableName): array
+    {
+        $dimFetches = $this->betterNodeFinder->findInstancesOfScoped([$node], ArrayDimFetch::class);
+
+        return array_filter($dimFetches, function (ArrayDimFetch $arrayDimFetch) use ($variableName): bool {
+            if (! $arrayDimFetch->var instanceof Variable) {
+                return false;
+            }
+
+            return $this->nodeNameResolver->isName($arrayDimFetch->var, $variableName);
+        });
+    }
+}