[TypeDeclarationDocblocks] Allow override dummy array return on AddReturnDocblockDataProviderRector (#7378)

* [TypeDeclarationDocblocks] Allow override dummy array return on AddReturnDocblockDataProviderRector

* Fix

Author: samsonasik

rules-tests/TypeDeclarationDocblocks/Rector/Class_/AddReturnDocblockDataProviderRector/Fixture/override_dummy_array_return.php.inc

@@ -0,0 +1,55 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\AddReturnDocblockDataProviderRector\Fixture;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+
+final class OverrideDummyArrayReturn extends TestCase
+{
+    #[DataProvider('provideData')]
+    public function testSomething()
+    {
+    }
+
+    /**
+     * @return array
+     */
+    public static function provideData()
+    {
+        return [
+            [125, 35],
+            [1252]
+        ];
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\AddReturnDocblockDataProviderRector\Fixture;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+
+final class OverrideDummyArrayReturn extends TestCase
+{
+    #[DataProvider('provideData')]
+    public function testSomething()
+    {
+    }
+
+    /**
+     * @return int[][]
+     */
+    public static function provideData()
+    {
+        return [
+            [125, 35],
+            [1252]
+        ];
+    }
+}
+
+?>

rules/TypeDeclarationDocblocks/NodeDocblockTypeDecorator.php

@@ -46,15 +46,14 @@ public function decorateGenericIterableParamType(
             return false;
         }
 
-        $normalizedType = $this->typeNormalizer->generalizeConstantTypes($type);
-        $typeNode = $this->createTypeNode($normalizedType);
+        $typeNode = $this->createTypeNode($type);
 
         // no value iterable type
         if ($typeNode instanceof IdentifierTypeNode) {
             return false;
         }
 
-        $this->phpDocTypeChanger->changeParamType($classMethod, $phpDocInfo, $normalizedType, $param, $parameterName);
+        $this->phpDocTypeChanger->changeParamTypeNode($classMethod, $phpDocInfo, $param, $parameterName, $typeNode);
 
         return true;
     }
@@ -76,9 +75,7 @@ public function decorateGenericIterableReturnType(
             return false;
         }
 
-        $returnTagValueNode = new ReturnTagValueNode($typeNode, '');
-
-        $this->addTagValueNodeAndUpdatePhpDocInfo($classMethodPhpDocInfo, $returnTagValueNode, $classMethod);
+        $this->phpDocTypeChanger->changeReturnTypeNode($classMethod, $classMethodPhpDocInfo, $typeNode);
 
         return true;
     }

rules/TypeDeclarationDocblocks/Rector/ClassMethod/AddParamArrayDocblockFromAssignsParamToParamReferenceRector.php

@@ -102,9 +102,7 @@ public function refactor(Node $node): ?Node
             $paramTagValueNode = $phpDocInfo->getParamTagValueByName($paramName);
 
             // already defined, lets skip it
-            if ($this->usefulArrayTagNodeAnalyzer->isUsefulArrayTag(
-                $paramTagValueNode
-            )) {
+            if ($this->usefulArrayTagNodeAnalyzer->isUsefulArrayTag($paramTagValueNode)) {
                 continue;
             }
 

rules/TypeDeclarationDocblocks/Rector/Class_/AddReturnDocblockDataProviderRector.php

@@ -8,7 +8,6 @@
 use PhpParser\Node\Expr;
 use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\Return_;
-use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
 use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
 use Rector\Rector\AbstractRector;
@@ -17,6 +16,7 @@
 use Rector\TypeDeclarationDocblocks\NodeFinder\DataProviderMethodsFinder;
 use Rector\TypeDeclarationDocblocks\NodeFinder\ReturnNodeFinder;
 use Rector\TypeDeclarationDocblocks\NodeFinder\YieldNodeFinder;
+use Rector\TypeDeclarationDocblocks\TagNodeAnalyzer\UsefulArrayTagNodeAnalyzer;
 use Rector\TypeDeclarationDocblocks\TypeResolver\YieldTypeResolver;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
@@ -33,6 +33,7 @@ public function __construct(
         private readonly ReturnNodeFinder $returnNodeFinder,
         private readonly YieldTypeResolver $yieldTypeResolver,
         private readonly YieldNodeFinder $yieldNodeFinder,
+        private readonly UsefulArrayTagNodeAnalyzer $usefulArrayTagNodeAnalyzer,
         private readonly NodeDocblockTypeDecorator $nodeDocblockTypeDecorator,
     ) {
     }
@@ -118,7 +119,7 @@ public function refactor(Node $node): ?Node
             $returnTagValueNode = $classMethodPhpDocInfo->getReturnTagValue();
 
             // already set
-            if ($returnTagValueNode instanceof ReturnTagValueNode) {
+            if ($this->usefulArrayTagNodeAnalyzer->isUsefulArrayTag($returnTagValueNode)) {
                 continue;
             }
 

src/BetterPhpDocParser/PhpDocManipulator/PhpDocTypeChanger.php

@@ -7,6 +7,7 @@
 use PhpParser\Node\FunctionLike;
 use PhpParser\Node\Param;
 use PhpParser\Node\Stmt;
+use PhpParser\Node\Stmt\ClassMethod;
 use PHPStan\PhpDocParser\Ast\ConstExpr\ConstFetchNode;
 use PHPStan\PhpDocParser\Ast\Node;
 use PHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode;
@@ -113,6 +114,24 @@ public function changeReturnTypeNode(
         $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($functionLike);
     }
 
+    public function changeParamTypeNode(
+        ClassMethod $functionLike,
+        PhpDocInfo $phpDocInfo,
+        Param $param,
+        string $paramName,
+        TypeNode $newTypeNode
+    ): void {
+        $existingParamTagValueNode = $phpDocInfo->getParamTagValueByName($paramName);
+        if ($existingParamTagValueNode instanceof ParamTagValueNode) {
+            $existingParamTagValueNode->type = $newTypeNode;
+        } else {
+            $paramTagValueNode = $this->paramPhpDocNodeFactory->create($newTypeNode, $param);
+            $phpDocInfo->addTagValueNode($paramTagValueNode);
+        }
+
+        $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($functionLike);
+    }
+
     public function changeReturnType(FunctionLike $functionLike, PhpDocInfo $phpDocInfo, Type $newType): bool
     {
         // better not touch this, can crash