make RectorNodeTraverser immutable

Author: TomasVotruba

phpstan.neon

@@ -5,7 +5,7 @@ includes:
 parameters:
     level: 8
 
-    # reportUnmatchedIgnoredErrors: false
+    reportUnmatchedIgnoredErrors: false
 
     errorFormat: symplify
 
@@ -373,25 +373,11 @@ parameters:
         - '#Method Rector\\Utils\\Rector\\RemoveRefactorDuplicatedNodeInstanceCheckRector\:\:getInstanceofNodeClass\(\) should return class\-string<PhpParser\\Node>\|null but returns class\-string#'
 
         # copied from /vendor, to keep as original as possible
-        -
-            identifier: missingType.iterableValue
-            path: src/PhpParser/NodeTraverser/RectorNodeTraverser.php
         -
             identifier: symplify.noDynamicName
             path: src/PhpParser/NodeTraverser/RectorNodeTraverser.php
         -
             identifier: offsetAccess.nonArray
-<<<<<<< HEAD
-            path: src/PhpParser/NodeTraverser/AbstractImmutableNodeTraverser.php
-
-=======
-            path: src/PhpParser/NodeTraverser/RectorNodeTraverser.php
-        -
-            message: '#Property PhpParser\\Node\\Stmt\\ClassMethod\:\:\$stmts \(array<PhpParser\\Node\\Stmt>\|null\) does not accept array<PhpParser\\Node>#'
-            path: scripts/create-immutable-node-visitor.php
->>>>>>> bb4e608ca7 ([int] merge AbstractImmutableNodeTraverser and RectorNodeTraverser as sole child and tight design)
-        -
-            message: '#Property Rector\\PhpParser\\NodeTraverser\\AbstractImmutableNodeTraverser\:\:\$visitors \(list<PhpParser\\NodeVisitor>\) does not accept array<int\|string, PhpParser\\NodeVisitor>#'
             path: src/PhpParser/NodeTraverser/RectorNodeTraverser.php
 
         # false positive

src/PhpParser/NodeTraverser/AbstractImmutableNodeTraverser.php

@@ -25,6 +25,7 @@
  * - no leaveNode(), as we do all in enterNode() that calls refactor() method
  * - cached visitors per node class for performance, e.g. when we find rules for Class_ node, they're cached for next time
  * - immutability features, register Rector rules once, then use; no changes on the fly
+ * @see \Rector\Tests\PhpParser\NodeTraverser\RectorNodeTraverserTest
  */
 final class RectorNodeTraverser implements NodeTraverserInterface
 {
@@ -55,17 +56,6 @@ public function __construct(
     ) {
     }
 
-    //    /**
-    //     * @param Stmt[] $rectors
-    //     * @return Stmt[]
-    //     */
-    //    public function traverse(array $nodes): array
-    //    {
-    //        $this->prepareNodeVisitors();
-    //
-    //        return parent::traverse($nodes);
-    //    }
-
     /**
      * @param RectorInterface[] $rectors
      * @api used in tests to update the active rules
@@ -93,20 +83,23 @@ public function getVisitorsForNode(Node $node): array
     {
         $nodeClass = $node::class;
 
+        if (! $this->areNodeVisitorsPrepared) {
+            $this->prepareNodeVisitors();
+        }
+
         if (! isset($this->visitorsPerNodeClass[$nodeClass])) {
             $this->visitorsPerNodeClass[$nodeClass] = [];
 
-            /** @var RectorInterface $visitor */
-            foreach ($this->visitors as $visitor) {
-                foreach ($visitor->getNodeTypes() as $nodeType) {
+            foreach ($this->rectors as $rector) {
+                foreach ($rector->getNodeTypes() as $nodeType) {
                     // BC layer matching
                     if ($nodeType === FileWithoutNamespace::class && $nodeClass === FileNode::class) {
-                        $this->visitorsPerNodeClass[$nodeClass][] = $visitor;
+                        $this->visitorsPerNodeClass[$nodeClass][] = $rector;
                         continue;
                     }
 
                     if (is_a($nodeClass, $nodeType, true)) {
-                        $this->visitorsPerNodeClass[$nodeClass][] = $visitor;
+                        $this->visitorsPerNodeClass[$nodeClass][] = $rector;
                         continue 2;
                     }
                 }
@@ -116,24 +109,9 @@ public function getVisitorsForNode(Node $node): array
         return $this->visitorsPerNodeClass[$nodeClass];
     }
 
-    /**
-//     * Create a traverser with the given visitors.
-//     *
-//     * @param NodeVisitor ...$visitor Node visitors
-//     */
-    //    public function __construct(NodeVisitor ...$visitors)
-    //    {
-    //        $this->visitors = $visitors;
-    //    }
-
-    /**
-     * Adds a visitor.
-     *
-     * @deprecated @todo remove completely, even in tests to avoid mutable state
-     */
     public function addVisitor(NodeVisitor $visitor): void
     {
-        $this->visitors[] = $visitor;
+        throw new ShouldNotHappenException('The immutable node traverser does not support adding visitors.');
     }
 
     public function removeVisitor(NodeVisitor $visitor): void
@@ -253,7 +231,7 @@ private function traverseNode(Node $node): void
 
     /**
      * @param Node[] $nodes
-     * @return \PhpParser\Node[] Result of traversal (may be original array or changed one)
+     * @return Node[] Result of traversal (may be original array or changed one)
      */
     private function traverseArray(array $nodes): array
     {

src/PhpParser/NodeTraverser/RectorNodeTraverser.php

@@ -58,6 +58,7 @@ public function testGetVisitorsForNodeWhenNoVisitorsMatch(): void
     public function testGetVisitorsForNodeWhenSomeVisitorsMatch(): void
     {
         $class = new Class_('test');
+
         $this->rectorNodeTraverser->refreshPhpRectors([
             $this->ruleUsingFunctionRector,
             $this->ruleUsingClassRector,