[DeadCode] Handle only remove 1 @var on multi vars on RemoveUselessVarTagRector (#7884)

* [DeadCode] Handle only remove 1 @var on multi vars on RemoveUselessVarTagRector

* Fix

Author: samsonasik

rules-tests/DeadCode/Rector/Property/RemoveUselessVarTagRector/Fixture/on_multi_var_remove_one_var.php.inc

@@ -0,0 +1,40 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\Property\RemoveUselessVarTagRector\Fixture;
+
+class MyClxProductNet_Translate {
+    /**
+     * @phpstan-pure
+     */
+    public static function create(): self
+    {
+        return new self();
+    }
+}
+
+/** @var MyActionController $this */
+/** @var MyClxProductNet_Translate $translator */
+$translator = MyClxProductNet_Translate::create();
+$url = $this->bulkConsumerRegistration ?? "abc";
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\Property\RemoveUselessVarTagRector\Fixture;
+
+class MyClxProductNet_Translate {
+    /**
+     * @phpstan-pure
+     */
+    public static function create(): self
+    {
+        return new self();
+    }
+}
+
+/** @var MyActionController $this */
+$translator = MyClxProductNet_Translate::create();
+$url = $this->bulkConsumerRegistration ?? "abc";
+
+?>

rules/DeadCode/PhpDoc/TagRemover/VarTagRemover.php

@@ -32,14 +32,14 @@ public function __construct(
     ) {
     }
 
-    public function removeVarTagIfUseless(PhpDocInfo $phpDocInfo, Property|ClassConst|Expression $property): bool
+    public function removeVarTagIfUseless(PhpDocInfo $phpDocInfo, Property|ClassConst|Expression $node): bool
     {
         $varTagValueNode = $phpDocInfo->getVarTagValueNode();
         if (! $varTagValueNode instanceof VarTagValueNode) {
             return false;
         }
 
-        $isVarTagValueDead = $this->deadVarTagValueNodeAnalyzer->isDead($varTagValueNode, $property);
+        $isVarTagValueDead = $this->deadVarTagValueNodeAnalyzer->isDead($varTagValueNode, $node);
         if (! $isVarTagValueDead) {
             return false;
         }
@@ -48,8 +48,8 @@ public function removeVarTagIfUseless(PhpDocInfo $phpDocInfo, Property|ClassCons
             return false;
         }
 
-        $phpDocInfo->removeByType(VarTagValueNode::class);
-        $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($property);
+        $phpDocInfo->removeByType(VarTagValueNode::class, $varTagValueNode->variableName);
+        $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
 
         return true;
     }

src/BetterPhpDocParser/PhpDocInfo/PhpDocInfo.php

@@ -254,6 +254,10 @@ public function removeByType(string $typeToRemove, ?string $name = null): bool
     {
         $hasChanged = false;
 
+        if ($name === '') {
+            $name = null;
+        }
+
         $phpDocNodeTraverser = new PhpDocNodeTraverser();
         $phpDocNodeTraverser->traverseWithCallable($this->phpDocNode, '', static function (Node $node) use (
             $typeToRemove,

src/Comments/NodeDocBlock/DocBlockUpdater.php

@@ -43,7 +43,26 @@ public function updateRefactoredNodeWithPhpDocInfo(Node $node): void
 
     private function setCommentsAttribute(Node $node): void
     {
-        $comments = array_filter($node->getComments(), static fn (Comment $comment): bool => ! $comment instanceof Doc);
+        $docComment = $node->getDocComment();
+        $docCommentText = $docComment instanceof Doc ? $docComment->getText() : null;
+
+        $comments = array_filter(
+            $node->getComments(),
+            static function (Comment $comment) use ($docCommentText): bool {
+                if (! $comment instanceof Doc) {
+                    return true;
+                }
+
+                // remove only the docblock that belongs to the node itself;
+                // keep other preceding docblocks (possible with multiple @var docblocks before a statement)
+                if ($docCommentText !== null && $comment->getText() === $docCommentText) {
+                    return false;
+                }
+
+                return true;
+            }
+        );
+
         $node->setAttribute(AttributeKey::COMMENTS, array_values($comments));
     }