[Core] Handle Scope not available on DowngradeArrayIsListRector+Downg…

…radePregUnmatchedAsNullConstantRector (#2556) * [Core] Handle Scope not avaiable on DowngradeArrayIsListRector+DowngradePregUnmatchedAsNullConstantRector * Fixed 🎉 * final touch: clean up set scope on addNodesBeforeNode as already in addNodeBeforeNode, also avoid repetitive call getNode node on loop on addNodesAfterNode * really final touch: clean up addNodesAfterNode like in addNodesBeforeNode * final touch: use else for not pass SmartFileInfo * really final touch: make consistent to always use ChangedNodeScopeRefresher * final touch: remove unnecessary pass SmartFileInfo * really final touch: make consistent for getAttributes() check * [ci-review] Rector Rectify * [ci-review] Rector Rectify * final touch: restructure parameter on refresh so make smartFileInfo optional to be pulled from CurrentFileProvider when null Co-authored-by: GitHub Action <action@github.com>
rectorphp · Jun 25, 2022 · dcad222 · dcad222
1 parent 237f603
commit dcad222
Show file tree

Hide file tree

Showing 25 changed files with 119 additions and 71 deletions.
diff --git a/packages/PostRector/Collector/NodesToAddCollector.php b/packages/PostRector/Collector/NodesToAddCollector.php
@@ -16,7 +16,6 @@
 use Rector\Core\PhpParser\Node\BetterNodeFinder;
 use Rector\NodeTypeResolver\Node\AttributeKey;
 use Rector\PostRector\Contract\Collector\NodeCollectorInterface;
-use Symplify\SmartFileSystem\SmartFileInfo;
 
 final class NodesToAddCollector implements NodeCollectorInterface
 {
@@ -46,19 +45,14 @@ public function isActive(): bool
     /**
      * @deprecated Return created nodes right in refactor() method to keep context instead.
      */
-    public function addNodeBeforeNode(Node $addedNode, Node $positionNode, ?SmartFileInfo $smartFileInfo = null): void
+    public function addNodeBeforeNode(Node $addedNode, Node $positionNode): void
     {
         if ($positionNode->getAttributes() === []) {
             $message = sprintf('Switch arguments in "%s()" method', __METHOD__);
             throw new ShouldNotHappenException($message);
         }
 
-        // @todo the node must be returned here, so traverser can refresh it
-        // this is nasty hack to verify it works
-        if ($smartFileInfo instanceof SmartFileInfo) {
-            $currentScope = $positionNode->getAttribute(AttributeKey::SCOPE);
-            $this->changedNodeScopeRefresher->refresh($addedNode, $smartFileInfo, $currentScope);
-        }
+        $this->changedNodeScopeRefresher->refresh($addedNode, $positionNode->getAttribute(AttributeKey::SCOPE));
 
         $position = $this->resolveNearestStmtPosition($positionNode);
         $this->nodesToAddBefore[$position][] = $this->wrapToExpression($addedNode);
@@ -72,11 +66,10 @@ public function addNodeBeforeNode(Node $addedNode, Node $positionNode, ?SmartFil
      */
     public function addNodesAfterNode(array $addedNodes, Node $positionNode): void
     {
-        $position = $this->resolveNearestStmtPosition($positionNode);
         foreach ($addedNodes as $addedNode) {
             // prevent fluent method weird indent
             $addedNode->setAttribute(AttributeKey::ORIGINAL_NODE, null);
-            $this->nodesToAddAfter[$position][] = $this->wrapToExpression($addedNode);
+            $this->addNodeAfterNode($addedNode, $positionNode);
         }
 
         $this->rectorChangeCollector->notifyNodeFileInfo($positionNode);
@@ -88,6 +81,13 @@ public function addNodesAfterNode(array $addedNodes, Node $positionNode): void
      */
     public function addNodeAfterNode(Node $addedNode, Node $positionNode): void
     {
+        if ($positionNode->getAttributes() === []) {
+            $message = sprintf('Switch arguments in "%s()" method', __METHOD__);
+            throw new ShouldNotHappenException($message);
+        }
+
+        $this->changedNodeScopeRefresher->refresh($addedNode, $positionNode->getAttribute(AttributeKey::SCOPE));
+
         $position = $this->resolveNearestStmtPosition($positionNode);
         $this->nodesToAddAfter[$position][] = $this->wrapToExpression($addedNode);
 
@@ -131,7 +131,7 @@ public function clearNodesToAddBefore(Node $node): void
     public function addNodesBeforeNode(array $newNodes, Node $positionNode): void
     {
         foreach ($newNodes as $newNode) {
-            $this->addNodeBeforeNode($newNode, $positionNode, null);
+            $this->addNodeBeforeNode($newNode, $positionNode);
         }
 
         $this->rectorChangeCollector->notifyNodeFileInfo($positionNode);

diff --git a/rules/CodeQuality/Rector/FuncCall/CompactToVariablesRector.php b/rules/CodeQuality/Rector/FuncCall/CompactToVariablesRector.php
@@ -154,7 +154,7 @@ private function refactorAssignedArray(Assign $assign, FuncCall $funcCall, Expr
         $assignVariable = $firstArg->value;
         $preAssign = new Assign($assignVariable, $array);
 
-        $this->nodesToAddCollector->addNodeBeforeNode($preAssign, $currentStmt, $this->file->getSmartFileInfo());
+        $this->nodesToAddCollector->addNodeBeforeNode($preAssign, $currentStmt);
 
         return $expr;
     }

diff --git a/rules/DowngradePhp54/Rector/Closure/DowngradeThisInClosureRector.php b/rules/DowngradePhp54/Rector/Closure/DowngradeThisInClosureRector.php
@@ -104,7 +104,7 @@ public function refactor(Node $node): ?Node
 
         $expression = new Expression(new Assign($selfVariable, new Variable('this')));
 
-        $this->nodesToAddCollector->addNodeBeforeNode($expression, $node, $this->file->getSmartFileInfo());
+        $this->nodesToAddCollector->addNodeBeforeNode($expression, $node);
 
         $this->traverseNodesWithCallable($node, static function (Node $subNode) use ($selfVariable): ?Closure {
             if (! $subNode instanceof Closure) {

diff --git a/rules/DowngradePhp54/Rector/MethodCall/DowngradeInstanceMethodCallRector.php b/rules/DowngradePhp54/Rector/MethodCall/DowngradeInstanceMethodCallRector.php
@@ -66,7 +66,7 @@ public function refactor(Node $node): ?Node
         $variable = $this->namedVariableFactory->createVariable($node, 'object');
         $expression = new Expression(new Assign($variable, $node->var));
 
-        $this->nodesToAddCollector->addNodeBeforeNode($expression, $node, $this->file->getSmartFileInfo());
+        $this->nodesToAddCollector->addNodeBeforeNode($expression, $node);
         $node->var = $variable;
         // necessary to remove useless parentheses
         $node->setAttribute(AttributeKey::ORIGINAL_NODE, null);

diff --git a/rules/DowngradePhp56/Rector/FuncCall/DowngradeArrayFilterUseConstantRector.php b/rules/DowngradePhp56/Rector/FuncCall/DowngradeArrayFilterUseConstantRector.php
@@ -111,8 +111,7 @@ private function processClosure(FuncCall $funcCall, array $args): ?Variable
 
         $this->nodesToAddCollector->addNodeBeforeNode(
             new Expression(new Assign($variable, new Array_([]))),
-            $funcCall,
-            $this->file->getSmartFileInfo()
+            $funcCall
         );
 
         /** @var ConstFetch $constant */
@@ -121,7 +120,7 @@ private function processClosure(FuncCall $funcCall, array $args): ?Variable
             ? $this->applyArrayFilterUseKey($args, $closure, $variable)
             : $this->applyArrayFilterUseBoth($args, $closure, $variable);
 
-        $this->nodesToAddCollector->addNodeBeforeNode($foreach, $funcCall, $this->file->getSmartFileInfo());
+        $this->nodesToAddCollector->addNodeBeforeNode($foreach, $funcCall);
 
         return $variable;
     }

diff --git a/rules/DowngradePhp70/Rector/FuncCall/DowngradeDirnameLevelsRector.php b/rules/DowngradePhp70/Rector/FuncCall/DowngradeDirnameLevelsRector.php
@@ -131,7 +131,7 @@ private function refactorForVariableLevels(FuncCall $funcCall): FuncCall
         $closure = $this->createClosure();
         $exprAssignClosure = $this->createExprAssign($funcVariable, $closure);
 
-        $this->nodesToAddCollector->addNodeBeforeNode($exprAssignClosure, $funcCall, $this->file->getSmartFileInfo());
+        $this->nodesToAddCollector->addNodeBeforeNode($exprAssignClosure, $funcCall);
 
         $funcCall->name = $funcVariable;
 

diff --git a/rules/DowngradePhp70/Rector/FuncCall/DowngradeSessionStartArrayOptionsRector.php b/rules/DowngradePhp70/Rector/FuncCall/DowngradeSessionStartArrayOptionsRector.php
@@ -87,11 +87,7 @@ public function refactor(Node $node): ?Node
             $funcName = new Name('ini_set');
             $iniSet = new FuncCall($funcName, [new Arg($sessionKey), new Arg($option->value)]);
 
-            $this->nodesToAddCollector->addNodeBeforeNode(
-                new Expression($iniSet),
-                $node,
-                $this->file->getSmartFileInfo()
-            );
+            $this->nodesToAddCollector->addNodeBeforeNode(new Expression($iniSet), $node);
         }
 
         unset($node->args[0]);

diff --git a/rules/DowngradePhp70/Rector/MethodCall/DowngradeMethodCallOnCloneRector.php b/rules/DowngradePhp70/Rector/MethodCall/DowngradeMethodCallOnCloneRector.php
@@ -88,7 +88,7 @@ public function refactor(Node $node): ?MethodCall
             $assign = new Assign($variable, $node->var);
         }
 
-        $this->nodesToAddCollector->addNodeBeforeNode(new Expression($assign), $node, $this->file->getSmartFileInfo());
+        $this->nodesToAddCollector->addNodeBeforeNode(new Expression($assign), $node);
         $node->var = $variable;
         $node->setAttribute(AttributeKey::ORIGINAL_NODE, null);
 

diff --git a/rules/DowngradePhp70/Rector/Spaceship/DowngradeSpaceshipRector.php b/rules/DowngradePhp70/Rector/Spaceship/DowngradeSpaceshipRector.php
@@ -95,7 +95,7 @@ public function refactor(Node $node): FuncCall
         $assignVariable = $this->namedVariableFactory->createVariable($node, 'battleShipcompare');
 
         $assignExpression = $this->getAssignExpression($anonymousFunction, $assignVariable);
-        $this->nodesToAddCollector->addNodeBeforeNode($assignExpression, $node, $this->file->getSmartFileInfo());
+        $this->nodesToAddCollector->addNodeBeforeNode($assignExpression, $node);
 
         return new FuncCall($assignVariable, [new Arg($node->left), new Arg($node->right)]);
     }

diff --git a/rules/DowngradePhp71/Rector/StaticCall/DowngradeClosureFromCallableRector.php b/rules/DowngradePhp71/Rector/StaticCall/DowngradeClosureFromCallableRector.php
@@ -79,7 +79,7 @@ public function refactor(Node $node): ?Node
         $tempVariable = $this->namedVariableFactory->createVariable($node, 'callable');
         $expression = new Expression(new Assign($tempVariable, $node->args[0]->value));
 
-        $this->nodesToAddCollector->addNodeBeforeNode($expression, $node, $this->file->getSmartFileInfo());
+        $this->nodesToAddCollector->addNodeBeforeNode($expression, $node);
 
         $closure = new Closure();
         $closure->uses[] = new ClosureUse($tempVariable);

diff --git a/rules/DowngradePhp72/Rector/FuncCall/DowngradePregUnmatchedAsNullConstantRector.php b/rules/DowngradePhp72/Rector/FuncCall/DowngradePregUnmatchedAsNullConstantRector.php
@@ -248,7 +248,7 @@ private function handleNotInIdenticalAndBooleanNot(If_ $if, FuncCall $funcCall):
     {
         if ($if->stmts !== []) {
             $firstStmt = $if->stmts[0];
-            $this->nodesToAddCollector->addNodeBeforeNode($funcCall, $firstStmt, $this->file->getSmartFileInfo());
+            $this->nodesToAddCollector->addNodeBeforeNode($funcCall, $firstStmt);
 
             return;
         }

diff --git a/rules/DowngradePhp72/Rector/FuncCall/DowngradeStreamIsattyRector.php b/rules/DowngradePhp72/Rector/FuncCall/DowngradeStreamIsattyRector.php
@@ -108,7 +108,7 @@ public function refactorWithScope(Node $node, Scope $scope): ?Node
         $variable = new Variable($this->variableNaming->createCountedValueName('streamIsatty', $scope));
         $assign = new Assign($variable, $function);
 
-        $this->nodesToAddCollector->addNodeBeforeNode($assign, $node, $this->file->getSmartFileInfo());
+        $this->nodesToAddCollector->addNodeBeforeNode($assign, $node);
 
         return new FuncCall($variable, $node->args);
     }

diff --git a/rules/DowngradePhp73/Rector/FuncCall/DowngradeArrayKeyFirstLastRector.php b/rules/DowngradePhp73/Rector/FuncCall/DowngradeArrayKeyFirstLastRector.php
@@ -102,7 +102,7 @@ private function refactorArrayKeyFirst(FuncCall $funcCall): ?FuncCall
         }
 
         $resetFuncCall = $this->nodeFactory->createFuncCall('reset', [$array]);
-        $this->nodesToAddCollector->addNodeBeforeNode($resetFuncCall, $funcCall, $this->file->getSmartFileInfo());
+        $this->nodesToAddCollector->addNodeBeforeNode($resetFuncCall, $funcCall);
 
         $funcCall->name = new Name('key');
         if ($originalArray !== $array) {
@@ -130,7 +130,7 @@ private function refactorArrayKeyLast(FuncCall $funcCall): ?FuncCall
         }
 
         $resetFuncCall = $this->nodeFactory->createFuncCall('end', [$array]);
-        $this->nodesToAddCollector->addNodeBeforeNode($resetFuncCall, $funcCall, $this->file->getSmartFileInfo());
+        $this->nodesToAddCollector->addNodeBeforeNode($resetFuncCall, $funcCall);
 
         $funcCall->name = new Name('key');
         if ($originalArray !== $array) {
@@ -142,11 +142,7 @@ private function refactorArrayKeyLast(FuncCall $funcCall): ?FuncCall
 
     private function addAssignNewVariable(FuncCall $funcCall, Expr $expr, Expr|Variable $variable): void
     {
-        $this->nodesToAddCollector->addNodeBeforeNode(
-            new Expression(new Assign($variable, $expr)),
-            $funcCall,
-            $this->file->getSmartFileInfo()
-        );
+        $this->nodesToAddCollector->addNodeBeforeNode(new Expression(new Assign($variable, $expr)), $funcCall);
     }
 
     private function resolveCastedArray(Expr $expr): Expr|Variable

diff --git a/rules/DowngradePhp74/Rector/FuncCall/DowngradeStripTagsCallWithArrayRector.php b/rules/DowngradePhp74/Rector/FuncCall/DowngradeStripTagsCallWithArrayRector.php
@@ -121,11 +121,7 @@ public function refactor(Node $node): ?Node
             );
             // Assign the value to the variable
             $newVariable = new Variable($variableName);
-            $this->nodesToAddCollector->addNodeBeforeNode(
-                new Assign($newVariable, $allowableTagsParam),
-                $node,
-                $this->file->getSmartFileInfo()
-            );
+            $this->nodesToAddCollector->addNodeBeforeNode(new Assign($newVariable, $allowableTagsParam), $node);
 
             // Apply refactor on the variable
             $newExpr = $this->createIsArrayTernaryFromExpression($newVariable);

diff --git a/rules/DowngradePhp80/Rector/MethodCall/DowngradeReflectionClassGetConstantsFilterRector.php b/rules/DowngradePhp80/Rector/MethodCall/DowngradeReflectionClassGetConstantsFilterRector.php
@@ -135,20 +135,12 @@ private function processClassConstFetches(MethodCall $methodCall, array $classCo
             $variableReflectionClassConstants,
             new MethodCall($methodCall->var, 'getReflectionConstants')
         );
-        $this->nodesToAddCollector->addNodeBeforeNode(
-            new Expression($assign),
-            $methodCall,
-            $this->file->getSmartFileInfo()
-        );
+        $this->nodesToAddCollector->addNodeBeforeNode(new Expression($assign), $methodCall);
 
         $result = $this->variableNaming->createCountedValueName('result', $scope);
         $variableResult = new Variable($result);
         $assignVariableResult = new Assign($variableResult, new Array_());
-        $this->nodesToAddCollector->addNodeBeforeNode(
-            new Expression($assignVariableResult),
-            $methodCall,
-            $this->file->getSmartFileInfo()
-        );
+        $this->nodesToAddCollector->addNodeBeforeNode(new Expression($assignVariableResult), $methodCall);
 
         $ifs = [];
         $valueVariable = new Variable('value');
@@ -176,11 +168,7 @@ private function processClassConstFetches(MethodCall $methodCall, array $classCo
             'array_walk',
             [$variableReflectionClassConstants, $closure]
         );
-        $this->nodesToAddCollector->addNodeBeforeNode(
-            new Expression($funcCall),
-            $methodCall,
-            $this->file->getSmartFileInfo()
-        );
+        $this->nodesToAddCollector->addNodeBeforeNode(new Expression($funcCall), $methodCall);
 
         return $variableResult;
     }

diff --git a/rules/DowngradePhp80/Rector/New_/DowngradeArbitraryExpressionsSupportRector.php b/rules/DowngradePhp80/Rector/New_/DowngradeArbitraryExpressionsSupportRector.php
@@ -96,7 +96,7 @@ public function refactor(Node $node): ?Node
             $assign = new Assign($variable, $node->class);
         }
 
-        $this->nodesToAddCollector->addNodeBeforeNode($assign, $node, $this->file->getSmartFileInfo());
+        $this->nodesToAddCollector->addNodeBeforeNode($assign, $node);
         $node->class = $variable;
         return $node;
     }

diff --git a/rules/DowngradePhp81/NodeFactory/ArrayMergeFromArraySpreadFactory.php b/rules/DowngradePhp81/NodeFactory/ArrayMergeFromArraySpreadFactory.php
@@ -172,7 +172,7 @@ private function createVariableFromNonVariable(
         $newVariable = new Variable($variableName);
 
         $newVariableAssign = new Assign($newVariable, $arrayItem->value);
-        $this->nodesToAddCollector->addNodeBeforeNode($newVariableAssign, $array, $file->getSmartFileInfo());
+        $this->nodesToAddCollector->addNodeBeforeNode($newVariableAssign, $array);
 
         return $newVariable;
     }

diff --git a/rules/DowngradePhp81/Rector/FuncCall/DowngradeArrayIsListRector.php b/rules/DowngradePhp81/Rector/FuncCall/DowngradeArrayIsListRector.php
@@ -88,7 +88,7 @@ public function refactorWithScope(Node $node, Scope $scope): ?FuncCall
         $function = $this->createClosure();
         $expression = new Expression(new Assign($variable, $function));
 
-        $this->nodesToAddCollector->addNodeBeforeNode($expression, $node, $this->file->getSmartFileInfo());
+        $this->nodesToAddCollector->addNodeBeforeNode($expression, $node);
 
         return new FuncCall($variable, $node->args);
     }

diff --git a/rules/EarlyReturn/Rector/Foreach_/ReturnAfterToEarlyOnBreakRector.php b/rules/EarlyReturn/Rector/Foreach_/ReturnAfterToEarlyOnBreakRector.php
@@ -141,11 +141,7 @@ private function processEarlyReturn(
         Foreach_ $foreach
     ): Foreach_ {
         $this->removeNode($expression);
-        $this->nodesToAddCollector->addNodeBeforeNode(
-            new Return_($assign->expr),
-            $breaks[0],
-            $this->file->getSmartFileInfo()
-        );
+        $this->nodesToAddCollector->addNodeBeforeNode(new Return_($assign->expr), $breaks[0]);
         $this->removeNode($breaks[0]);
 
         $return->expr = $assignPreviousVariable->expr;

diff --git a/rules/Php70/Rector/FuncCall/NonVariableToVariableOnFunctionCallRector.php b/rules/Php70/Rector/FuncCall/NonVariableToVariableOnFunctionCallRector.php
@@ -107,11 +107,7 @@ public function refactor(Node $node): ?Node
                 continue;
             }
 
-            $this->nodesToAddCollector->addNodeBeforeNode(
-                $replacements->getAssign(),
-                $currentStmt,
-                $this->file->getSmartFileInfo()
-            );
+            $this->nodesToAddCollector->addNodeBeforeNode($replacements->getAssign(), $currentStmt);
 
             $node->args[$key]->value = $replacements->getVariable();
 

diff --git a/src/Application/ChangedNodeScopeRefresher.php b/src/Application/ChangedNodeScopeRefresher.php
@@ -32,6 +32,8 @@
 use Rector\Core\NodeAnalyzer\UnreachableStmtAnalyzer;
 use Rector\Core\PhpParser\Node\BetterNodeFinder;
 use Rector\Core\PhpParser\Node\CustomNode\FileWithoutNamespace;
+use Rector\Core\Provider\CurrentFileProvider;
+use Rector\Core\ValueObject\Application\File;
 use Rector\NodeTypeResolver\Node\AttributeKey;
 use Rector\NodeTypeResolver\PHPStan\Scope\PHPStanNodeScopeResolver;
 use Symplify\SmartFileSystem\SmartFileInfo;
@@ -45,11 +47,12 @@ public function __construct(
         private readonly PHPStanNodeScopeResolver $phpStanNodeScopeResolver,
         private readonly ScopeAnalyzer $scopeAnalyzer,
         private readonly UnreachableStmtAnalyzer $unreachableStmtAnalyzer,
-        private readonly BetterNodeFinder $betterNodeFinder
+        private readonly BetterNodeFinder $betterNodeFinder,
+        private readonly CurrentFileProvider $currentFileProvider
     ) {
     }
 
-    public function refresh(Node $node, SmartFileInfo $smartFileInfo, ?MutatingScope $mutatingScope): void
+    public function refresh(Node $node, ?MutatingScope $mutatingScope, ?SmartFileInfo $smartFileInfo = null): void
     {
         // nothing to refresh
         if (! $this->scopeAnalyzer->hasScope($node)) {
@@ -76,6 +79,12 @@ public function refresh(Node $node, SmartFileInfo $smartFileInfo, ?MutatingScope
             }
         }
 
+        if (! $smartFileInfo instanceof SmartFileInfo) {
+            /** @var File $file */
+            $file = $this->currentFileProvider->getFile();
+            $smartFileInfo = $file->getSmartFileInfo();
+        }
+
         // note from flight: when we traverse ClassMethod, the scope must be already in Class_, otherwise it crashes
         // so we need to somehow get a parent scope that is already in the same place the $node is
 

diff --git a/src/Rector/AbstractRector.php b/src/Rector/AbstractRector.php
@@ -251,7 +251,7 @@ final public function enterNode(Node $node)
         $this->mirrorAttributes($originalAttributes, $node);
 
         $currentScope = $originalNode->getAttribute(AttributeKey::SCOPE);
-        $this->changedNodeScopeRefresher->refresh($node, $this->file->getSmartFileInfo(), $currentScope);
+        $this->changedNodeScopeRefresher->refresh($node, $currentScope, $this->file->getSmartFileInfo());
 
         $this->connectParentNodes($node);
 

diff --git a/tests/Issues/ScopeNotAvailable/FixtureDowngradePregUnmatched/preg_unmatched.php.inc b/tests/Issues/ScopeNotAvailable/FixtureDowngradePregUnmatched/preg_unmatched.php.inc
@@ -0,0 +1,28 @@
+<?php
+
+namespace Rector\Core\Tests\Issues\ScopeNotAvailable\Fixture;
+
+function test()
+{
+        $match = ((\PREG_PATTERN_ORDER | \PREG_SET_ORDER) & $flags) ? 'preg_match_all' : 'preg_match';
+        $match($regexp.'u', $this->string, $matches, $flags | \PREG_UNMATCHED_AS_NULL, $offset);
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Core\Tests\Issues\ScopeNotAvailable\Fixture;
+
+function test()
+{
+        $match = ((\PREG_PATTERN_ORDER | \PREG_SET_ORDER) & $flags) ? 'preg_match_all' : 'preg_match';
+        $match($regexp.'u', $this->string, $matches, $flags, $offset);
+        array_walk_recursive($matches, function (&$value) {
+            if ($value === '') {
+                $value = null;
+            }
+        });
+}
+
+?>