[tdd] Add AddVarArrayDocblockFromDimFetchAssignRector

rules-tests/TypeDeclarationDocblocks/Rector/Class_/AddVarArrayDocblockFromDimFetchAssignRector/AddVarArrayDocblockFromDimFetchAssignRectorTest.php

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

@@ -0,0 +1,44 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\AddVarArrayDocblockFromDimFetchAssignRector\Fixture;
+
+final class MultipleAssigns
+{
+    private array $items = [];
+
+    public function go()
+    {
+        $this->items[] = 'item1';
+    }
+
+    public function run()
+    {
+        $this->items[] = 'item2';
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\AddVarArrayDocblockFromDimFetchAssignRector\Fixture;
+
+final class MultipleAssigns
+{
+    /**
+     * @var string[]
+     */
+    private array $items = [];
+
+    public function go()
+    {
+        $this->items[] = 'item1';
+    }
+
+    public function run()
+    {
+        $this->items[] = 'item2';
+    }
+}
+
+?>

rules-tests/TypeDeclarationDocblocks/Rector/Class_/AddVarArrayDocblockFromDimFetchAssignRector/Fixture/skp_already_known.php.inc

@@ -0,0 +1,16 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\AddVarArrayDocblockFromDimFetchAssignRector\Fixture;
+
+final class SkipAlreadyKnown
+{
+    /**
+     * @var list<string>
+     */
+    private array $items = [];
+
+    public function go()
+    {
+        $this->items[] = 'item1';
+    }
+}

rules-tests/TypeDeclarationDocblocks/Rector/Class_/AddVarArrayDocblockFromDimFetchAssignRector/Fixture/some_class.php.inc

@@ -0,0 +1,34 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\AddVarArrayDocblockFromDimFetchAssignRector\Fixture;
+
+final class SomeClass
+{
+    private array $items = [];
+
+    public function go()
+    {
+        $this->items[] = 'item1';
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\AddVarArrayDocblockFromDimFetchAssignRector\Fixture;
+
+final class SomeClass
+{
+    /**
+     * @var string[]
+     */
+    private array $items = [];
+
+    public function go()
+    {
+        $this->items[] = 'item1';
+    }
+}
+
+?>

rules-tests/TypeDeclarationDocblocks/Rector/Class_/AddVarArrayDocblockFromDimFetchAssignRector/config/configured_rule.php

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

rules/TypeDeclarationDocblocks/NodeFinder/ArrayDimFetchFinder.php

@@ -8,7 +8,9 @@
 use PhpParser\Node\Expr;
 use PhpParser\Node\Expr\ArrayDimFetch;
 use PhpParser\Node\Expr\Assign;
+use PhpParser\Node\Expr\PropertyFetch;
 use PhpParser\Node\Expr\Variable;
+use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassMethod;
 use Rector\NodeNameResolver\NodeNameResolver;
 use Rector\PhpParser\Node\BetterNodeFinder;
@@ -49,6 +51,45 @@ public function findDimFetchAssignToVariableName(ClassMethod $classMethod, strin
         return $exprs;
     }
 
+    /**
+     * Look for bare assigns, $this->someProperty[] = ...
+     * @return Expr[]
+     */
+    public function findDimFetchAssignToPropertyName(Class_ $class, string $variableName): array
+    {
+        $assigns = $this->betterNodeFinder->findInstancesOfScoped($class->getMethods(), Assign::class);
+
+        $exprs = [];
+        foreach ($assigns as $assign) {
+            if (! $assign->var instanceof ArrayDimFetch) {
+                continue;
+            }
+
+            $arrayDimFetch = $assign->var;
+            if ($arrayDimFetch->dim instanceof Expr) {
+                continue;
+            }
+
+            if (! $arrayDimFetch->var instanceof PropertyFetch) {
+                continue;
+            }
+
+            $propertyFetch = $arrayDimFetch->var;
+
+            if (! $this->nodeNameResolver->isName($propertyFetch->var, 'this')) {
+                continue;
+            }
+
+            if (! $this->nodeNameResolver->isName($propertyFetch->name, $variableName)) {
+                continue;
+            }
+
+            $exprs[] = $assign->expr;
+        }
+
+        return $exprs;
+    }
+
     /**
      * @return ArrayDimFetch[]
      */

rules/TypeDeclarationDocblocks/Rector/Class_/AddVarArrayDocblockFromDimFetchAssignRector.php

@@ -0,0 +1,154 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\TypeDeclarationDocblocks\Rector\Class_;
+
+use PhpParser\Node;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\Property;
+use PHPStan\Type\ArrayType;
+use PHPStan\Type\MixedType;
+use PHPStan\Type\UnionType;
+use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
+use Rector\NodeTypeResolver\PHPStan\Type\TypeFactory;
+use Rector\Rector\AbstractRector;
+use Rector\TypeDeclarationDocblocks\NodeDocblockTypeDecorator;
+use Rector\TypeDeclarationDocblocks\NodeFinder\ArrayDimFetchFinder;
+use Rector\TypeDeclarationDocblocks\TagNodeAnalyzer\UsefulArrayTagNodeAnalyzer;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\AddVarArrayDocblockFromDimFetchAssignRector\AddVarArrayDocblockFromDimFetchAssignRectorTest
+ */
+final class AddVarArrayDocblockFromDimFetchAssignRector extends AbstractRector
+{
+    public function __construct(
+        private readonly TypeFactory $typeFactory,
+        private readonly PhpDocInfoFactory $phpDocInfoFactory,
+        private readonly UsefulArrayTagNodeAnalyzer $usefulArrayTagNodeAnalyzer,
+        private readonly NodeDocblockTypeDecorator $nodeDocblockTypeDecorator,
+        private readonly ArrayDimFetchFinder $arrayDimFetchFinder,
+    ) {
+
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Add @param array docblock if array_map is used on the parameter', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+final class SomeClass
+{
+    private array $items = [];
+
+    public function run()
+    {
+        $this->items[] = [
+            'name' => 'John',
+        ];
+    }
+}
+CODE_SAMPLE
+                ,
+                <<<'CODE_SAMPLE'
+final class SomeClass
+{
+    /**
+     * @var array<array<string, string>>
+     */
+    private array $items = [];
+
+    public function run()
+    {
+        $this->items[] = [
+            'name' => 'John',
+        ];
+    }
+}
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Class_::class];
+    }
+
+    /**
+     * @param Class_ $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        $hasChanged = false;
+
+        foreach ($node->getProperties() as $property) {
+            if (! $this->isPropertyTypeArray($property)) {
+                continue;
+            }
+
+            $propertyPhpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($property);
+
+            if ($this->usefulArrayTagNodeAnalyzer->isUsefulArrayTag($propertyPhpDocInfo->getVarTagValueNode())) {
+                continue;
+            }
+
+            $propertyName = $this->getName($property);
+
+            $assignedExprs = $this->arrayDimFetchFinder->findDimFetchAssignToPropertyName($node, $propertyName);
+
+            $assignedExprTypes = [];
+            foreach ($assignedExprs as $assignedExpr) {
+                $assignedExprTypes[] = $this->getType($assignedExpr);
+            }
+
+            // nothing to add
+            if ($assignedExprTypes === []) {
+                continue;
+            }
+
+            $uniqueGeneralizedUnionTypes = $this->typeFactory->uniquateTypes($assignedExprTypes);
+
+            if (count($uniqueGeneralizedUnionTypes) > 1) {
+                $generalizedUnionedTypes = new UnionType($uniqueGeneralizedUnionTypes);
+            } else {
+                $generalizedUnionedTypes = $uniqueGeneralizedUnionTypes[0];
+            }
+
+            $arrayReturnType = new ArrayType(new MixedType(), $generalizedUnionedTypes);
+
+            $hasPropertyChanged = $this->nodeDocblockTypeDecorator->decorateGenericIterableVarType(
+                $arrayReturnType,
+                $propertyPhpDocInfo,
+                $property
+            );
+
+            if ($hasPropertyChanged === false) {
+                continue;
+            }
+
+            $hasChanged = true;
+        }
+
+        if (! $hasChanged) {
+            return null;
+        }
+
+        return $node;
+    }
+
+    private function isPropertyTypeArray(Property $property): bool
+    {
+        if (! $property->type instanceof Identifier) {
+            return false;
+        }
+
+        return $this->isName($property->type, 'array');
+    }
+}

src/Config/Level/TypeDeclarationDocblocksLevel.php

@@ -9,6 +9,7 @@
 use Rector\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\AddReturnDocblockForScalarArrayFromAssignsRector;
 use Rector\TypeDeclarationDocblocks\Rector\Class_\AddReturnDocblockDataProviderRector;
+use Rector\TypeDeclarationDocblocks\Rector\Class_\AddVarArrayDocblockFromDimFetchAssignRector;
 use Rector\TypeDeclarationDocblocks\Rector\Class_\ClassMethodArrayDocblockParamFromLocalCallsRector;
 use Rector\TypeDeclarationDocblocks\Rector\Class_\DocblockVarArrayFromGetterReturnRector;
 use Rector\TypeDeclarationDocblocks\Rector\Class_\DocblockVarArrayFromPropertyDefaultsRector;
@@ -57,6 +58,7 @@ final class TypeDeclarationDocblocksLevel
         // property var
         DocblockVarFromParamDocblockInConstructorRector::class,
         DocblockVarArrayFromGetterReturnRector::class,
+        AddVarArrayDocblockFromDimFetchAssignRector::class,
 
         // return
         DocblockGetterReturnArrayFromPropertyDocblockVarRector::class,

src/PhpParser/Node/BetterNodeFinder.php

@@ -4,6 +4,7 @@
 
 namespace Rector\PhpParser\Node;
 
+use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node;
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Expr\Yield_;
@@ -239,7 +240,7 @@ public function findInstancesOfScoped(array $nodes, string|array $types): array
         $this->simpleCallableNodeTraverser->traverseNodesWithCallable(
             $nodes,
             static function (Node $subNode) use ($types, &$foundNodes): ?int {
-                if ($subNode instanceof Class_ || $subNode instanceof FunctionLike) {
+                if ($subNode instanceof Class_ || ($subNode instanceof FunctionLike && ! $subNode instanceof ClassMethod)) {
                     return NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN;
                 }