change existing dummy array

Author: TomasVotruba

rules/TypeDeclarationDocblocks/Rector/ClassMethod/DocblockReturnArrayFromDirectArrayInstanceRector.php

@@ -9,12 +9,12 @@
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Function_;
 use PhpParser\Node\Stmt\Return_;
-use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
 use PHPStan\Type\Constant\ConstantArrayType;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
-use Rector\Comments\NodeDocBlock\DocBlockUpdater;
+use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger;
 use Rector\Rector\AbstractRector;
 use Rector\TypeDeclarationDocblocks\NodeFinder\ReturnNodeFinder;
+use Rector\TypeDeclarationDocblocks\TagNodeAnalyzer\UsefulArrayTagNodeAnalyzer;
 use Rector\TypeDeclarationDocblocks\TypeResolver\ConstantArrayTypeGeneralizer;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
@@ -26,9 +26,10 @@ final class DocblockReturnArrayFromDirectArrayInstanceRector extends AbstractRec
 {
     public function __construct(
         private readonly PhpDocInfoFactory $phpDocInfoFactory,
-        private readonly DocBlockUpdater $docBlockUpdater,
+        private readonly PhpDocTypeChanger $phpDocTypeChanger,
         private readonly ConstantArrayTypeGeneralizer $constantArrayTypeGeneralizer,
         private readonly ReturnNodeFinder $returnNodeFinder,
+        private readonly UsefulArrayTagNodeAnalyzer $usefulArrayTagNodeAnalyzer
     ) {
     }
 
@@ -80,14 +81,13 @@ public function getItems(): array
      */
     public function refactor(Node $node): ?Node
     {
-        $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
-
-        // return tag is already given
-        if ($phpDocInfo->getReturnTagValue() instanceof ReturnTagValueNode) {
+        if ($node->stmts === null) {
             return null;
         }
 
-        if ($node->stmts === null) {
+        $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
+
+        if ($this->usefulArrayTagNodeAnalyzer->isUsefulArrayTag($phpDocInfo->getReturnTagValue())) {
             return null;
         }
 
@@ -107,11 +107,7 @@ public function refactor(Node $node): ?Node
         }
 
         $genericTypeNode = $this->constantArrayTypeGeneralizer->generalize($returnedType);
-
-        $returnTagValueNode = new ReturnTagValueNode($genericTypeNode, '');
-        $phpDocInfo->addTagValueNode($returnTagValueNode);
-
-        $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
+        $this->phpDocTypeChanger->changeReturnTypeNode($node, $phpDocInfo, $genericTypeNode);
 
         return $node;
     }

rules/TypeDeclarationDocblocks/TagNodeAnalyzer/UsefulArrayTagNodeAnalyzer.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\TypeDeclarationDocblocks\TagNodeAnalyzer;
+
+use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
+use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
+
+final class UsefulArrayTagNodeAnalyzer
+{
+    public function isUsefulArrayTag(?ReturnTagValueNode $returnTagValueNode): bool
+    {
+        if (! $returnTagValueNode instanceof ReturnTagValueNode) {
+            return false;
+        }
+
+        $type = $returnTagValueNode->type;
+        if (! $type instanceof IdentifierTypeNode) {
+            return true;
+        }
+
+        return $type->name !== 'array';
+    }
+}

src/BetterPhpDocParser/PhpDocManipulator/PhpDocTypeChanger.php

@@ -97,6 +97,22 @@ public function changeVarType(Stmt $stmt, PhpDocInfo $phpDocInfo, Type $newType)
         return true;
     }
 
+    public function changeReturnTypeNode(
+        FunctionLike $functionLike,
+        PhpDocInfo $phpDocInfo,
+        TypeNode $newTypeNode
+    ): void {
+        $existingReturnTagValueNode = $phpDocInfo->getReturnTagValue();
+        if ($existingReturnTagValueNode instanceof ReturnTagValueNode) {
+            $existingReturnTagValueNode->type = $newTypeNode;
+        } else {
+            $returnTagValueNode = new ReturnTagValueNode($newTypeNode, '');
+            $phpDocInfo->addTagValueNode($returnTagValueNode);
+        }
+
+        $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($functionLike);
+    }
+
     public function changeReturnType(FunctionLike $functionLike, PhpDocInfo $phpDocInfo, Type $newType): bool
     {
         // better not touch this, can crash