change existing dummy array

Author: TomasVotruba

rules/TypeDeclarationDocblocks/Rector/ClassMethod/DocblockReturnArrayFromDirectArrayInstanceRector.php

@@ -12,9 +12,11 @@
 use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
 use PHPStan\Type\Constant\ConstantArrayType;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
+use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger;
 use Rector\Comments\NodeDocBlock\DocBlockUpdater;
 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;
@@ -29,6 +31,8 @@ public function __construct(
         private readonly DocBlockUpdater $docBlockUpdater,
         private readonly ConstantArrayTypeGeneralizer $constantArrayTypeGeneralizer,
         private readonly ReturnNodeFinder $returnNodeFinder,
+        private readonly UsefulArrayTagNodeAnalyzer $usefulArrayTagNodeAnalyzer,
+        private readonly PhpDocTypeChanger $phpDocTypeChanger
     ) {
     }
 
@@ -82,11 +86,17 @@ public function refactor(Node $node): ?Node
     {
         $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
 
-        // return tag is already given
-        if ($phpDocInfo->getReturnTagValue() instanceof ReturnTagValueNode) {
+        if ($this->usefulArrayTagNodeAnalyzer->isUsefulArrayTag($phpDocInfo->getReturnTagValue())) {
             return null;
         }
 
+        //        if ($phpDocInfo->getReturnTagValue() instanceof ReturnTagValueNode) {
+        //            if ($phpDocInfo->getReturnTagValue()->type);
+        //            die;
+        //
+        //            return null;
+        //        }
+
         if ($node->stmts === null) {
             return null;
         }
@@ -108,8 +118,13 @@ public function refactor(Node $node): ?Node
 
         $genericTypeNode = $this->constantArrayTypeGeneralizer->generalize($returnedType);
 
-        $returnTagValueNode = new ReturnTagValueNode($genericTypeNode, '');
-        $phpDocInfo->addTagValueNode($returnTagValueNode);
+        $existingReturnTagValueNode = $phpDocInfo->getReturnTagValue();
+        if ($existingReturnTagValueNode instanceof ReturnTagValueNode) {
+            $existingReturnTagValueNode->type = $genericTypeNode;
+        } else {
+            $returnTagValueNode = new ReturnTagValueNode($genericTypeNode, '');
+            $phpDocInfo->addTagValueNode($returnTagValueNode);
+        }
 
         $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($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 === null) {
+            return false;
+        }
+
+        $type = $returnTagValueNode->type;
+        if (! $type instanceof IdentifierTypeNode) {
+            return true;
+        }
+
+        return $type->name !== 'array';
+    }
+}