Make PhpDocINfo::removeByType() return bool to inform about changed n…

…ode (#4979)

packages/BetterPhpDocParser/PhpDocInfo/PhpDocInfo.php

@@ -254,11 +254,14 @@ public function findOneByAnnotationClass(string $desiredClass): ?DoctrineAnnotat
      * @template T of \PHPStan\PhpDocParser\Ast\Node
      * @param class-string<T> $typeToRemove
      */
-    public function removeByType(string $typeToRemove): void
+    public function removeByType(string $typeToRemove): bool
     {
+        $hasChanged = false;
+
         $phpDocNodeTraverser = new PhpDocNodeTraverser();
         $phpDocNodeTraverser->traverseWithCallable($this->phpDocNode, '', function (Node $node) use (
-            $typeToRemove
+            $typeToRemove,
+            &$hasChanged,
         ): ?int {
             if ($node instanceof PhpDocTagNode && $node->value instanceof $typeToRemove) {
                 // keep special annotation for tools
@@ -271,6 +274,7 @@ public function removeByType(string $typeToRemove): void
                 }
 
                 $this->markAsChanged();
+                $hasChanged = true;
                 return PhpDocNodeTraverser::NODE_REMOVE;
             }
 
@@ -279,8 +283,11 @@ public function removeByType(string $typeToRemove): void
             }
 
             $this->markAsChanged();
+            $hasChanged = true;
             return PhpDocNodeTraverser::NODE_REMOVE;
         });
+
+        return $hasChanged;
     }
 
     public function addTagValueNode(PhpDocTagValueNode $phpDocTagValueNode): void

packages/BetterPhpDocParser/PhpDocManipulator/PhpDocTagRemover.php

@@ -12,8 +12,10 @@
 
 final class PhpDocTagRemover
 {
-    public function removeByName(PhpDocInfo $phpDocInfo, string $name): void
+    public function removeByName(PhpDocInfo $phpDocInfo, string $name): bool
     {
+        $hasChanged = false;
+
         $phpDocNode = $phpDocInfo->getPhpDocNode();
 
         foreach ($phpDocNode->children as $key => $phpDocChildNode) {
@@ -23,16 +25,20 @@ public function removeByName(PhpDocInfo $phpDocInfo, string $name): void
 
             if ($this->areAnnotationNamesEqual($name, $phpDocChildNode->name)) {
                 unset($phpDocNode->children[$key]);
+                $hasChanged = true;
                 $phpDocInfo->markAsChanged();
             }
 
             if ($phpDocChildNode->value instanceof DoctrineAnnotationTagValueNode && $phpDocChildNode->value->hasClassName(
                 $name
             )) {
                 unset($phpDocNode->children[$key]);
+                $hasChanged = true;
                 $phpDocInfo->markAsChanged();
             }
         }
+
+        return $hasChanged;
     }
 
     public function removeTagValueFromNode(PhpDocInfo $phpDocInfo, Node $desiredNode): void

rules/DeadCode/Rector/ClassLike/RemoveAnnotationRector.php

@@ -10,6 +10,7 @@
 use PhpParser\Node\Stmt\ClassLike;
 use PhpParser\Node\Stmt\Property;
 use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagValueNode;
+use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
 use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTagRemover;
 use Rector\Core\Contract\Rector\ConfigurableRectorInterface;
 use Rector\Core\Rector\AbstractRector;
@@ -69,22 +70,32 @@ public function getNodeTypes(): array
      */
     public function refactor(Node $node): ?Node
     {
-        if ($this->annotationsToRemove === []) {
+        Assert::notEmpty($this->annotationsToRemove);
+
+        $phpDocInfo = $this->phpDocInfoFactory->createFromNode($node);
+        if (! $phpDocInfo instanceof PhpDocInfo) {
             return null;
         }
 
-        $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
+        $hasChanged = false;
 
         foreach ($this->annotationsToRemove as $annotationToRemove) {
-            $this->phpDocTagRemover->removeByName($phpDocInfo, $annotationToRemove);
+            $namedHasChanged = $this->phpDocTagRemover->removeByName($phpDocInfo, $annotationToRemove);
+            if ($namedHasChanged) {
+                $hasChanged = true;
+            }
+
             if (! is_a($annotationToRemove, PhpDocTagValueNode::class, true)) {
                 continue;
             }
 
-            $phpDocInfo->removeByType($annotationToRemove);
+            $typedHasChanged = $phpDocInfo->removeByType($annotationToRemove);
+            if ($typedHasChanged) {
+                $hasChanged = true;
+            }
         }
 
-        if ($phpDocInfo->hasChanged()) {
+        if ($hasChanged) {
             return $node;
         }