[NodeRemover] Use return null after $this->removeNode() (#3558)

* [NodeRemover] Use return null after $this->removeNode() * return node if it try to change next node before remove * update warning message
rectorphp · Apr 3, 2023 · 5e5681d · 5e5681d
1 parent 3cbf710
commit 5e5681d
Show file tree

Hide file tree

Showing 9 changed files with 11 additions and 10 deletions.
diff --git a/rules/DeadCode/Rector/Assign/RemoveUnusedVariableAssignRector.php b/rules/DeadCode/Rector/Assign/RemoveUnusedVariableAssignRector.php
@@ -109,7 +109,7 @@ public function refactor(Node $node): ?Node
         }
 
         $this->removeNode($node);
-        return $node;
+        return null;
     }
 
     private function cleanCastedExpr(Expr $expr): Expr

diff --git a/rules/DeadCode/Rector/ClassMethod/RemoveEmptyClassMethodRector.php b/rules/DeadCode/Rector/ClassMethod/RemoveEmptyClassMethodRector.php
@@ -93,7 +93,7 @@ public function refactor(Node $node): ?Node
 
         $this->removeNode($node);
 
-        return $node;
+        return null;
     }
 
     private function shouldSkipNonFinalNonPrivateClassMethod(Class_ $class, ClassMethod $classMethod): bool

diff --git a/rules/DeadCode/Rector/ClassMethod/RemoveUnusedPrivateMethodRector.php b/rules/DeadCode/Rector/ClassMethod/RemoveUnusedPrivateMethodRector.php
@@ -87,7 +87,7 @@ public function refactor(Node $node): ?Node
 
         $this->removeNode($node);
 
-        return $node;
+        return null;
     }
 
     private function shouldSkip(ClassMethod $classMethod): bool

diff --git a/rules/DeadCode/Rector/For_/RemoveDeadLoopRector.php b/rules/DeadCode/Rector/For_/RemoveDeadLoopRector.php
@@ -66,6 +66,6 @@ public function refactor(Node $node): ?Node
         }
 
         $this->removeNode($node);
-        return $node;
+        return null;
     }
 }
diff --git a/rules/DeadCode/Rector/MethodCall/RemoveEmptyMethodCallRector.php b/rules/DeadCode/Rector/MethodCall/RemoveEmptyMethodCallRector.php
@@ -127,7 +127,7 @@ public function refactor(Node $node): ?Node
 
         $this->removeNode($node);
 
-        return $node;
+        return null;
     }
 
     private function resolveClassLike(MethodCall $methodCall): ?ClassLike

diff --git a/rules/DeadCode/Rector/TryCatch/RemoveDeadTryCatchRector.php b/rules/DeadCode/Rector/TryCatch/RemoveDeadTryCatchRector.php
@@ -73,7 +73,7 @@ public function refactor(Node $node): array|null|TryCatch
 
         if ($this->isEmpty($node->stmts)) {
             $this->removeNode($node);
-            return $node;
+            return null;
         }
 
         if (count($node->catches) !== 1) {

diff --git a/rules/Php70/Rector/Break_/BreakNotInLoopOrSwitchToReturnRector.php b/rules/Php70/Rector/Break_/BreakNotInLoopOrSwitchToReturnRector.php
@@ -97,6 +97,6 @@ public function refactor(Node $node): ?Node
 
         $this->removeNode($node);
 
-        return $node;
+        return null;
     }
 }
diff --git a/rules/Php73/Rector/FuncCall/ArrayKeyFirstLastRector.php b/rules/Php73/Rector/FuncCall/ArrayKeyFirstLastRector.php
@@ -130,6 +130,7 @@ public function refactor(Node $node): ?Node
 
         $this->removeNode($node);
 
+        // change next node before remove, so it needs to return the Node
         return $node;
     }
 

diff --git a/src/Rector/AbstractRector.php b/src/Rector/AbstractRector.php
@@ -52,14 +52,14 @@ abstract class AbstractRector extends NodeVisitorAbstract implements PhpRectorIn
     private const EMPTY_NODE_ARRAY_MESSAGE = <<<CODE_SAMPLE
 Array of nodes cannot be empty. Ensure "%s->refactor()" returns non-empty array for Nodes.
 
-A) Return null for no change:
+A) Direct return null for no change:
 
     return null;
 
 B) Remove the Node:
 
     \$this->removeNode(\$node);
-    return \$node;
+    return null;
 CODE_SAMPLE;
 
     protected NodeNameResolver $nodeNameResolver;
@@ -210,7 +210,7 @@ final public function enterNode(Node $node)
 
         $refactoredNode = $this->refactor($node);
 
-        // nothing to change → continue
+        // nothing to change or just removed via removeNode() → continue
         if ($refactoredNode === null) {
             return null;
         }