Remove direct NodeTravser::* where possible, use node visitor attribute key instead (#7697)

* bump phpstan rules

* make use of is assign attribute

* add SymfonyClosureNodeVisitor

Author: TomasVotruba

composer.json

@@ -56,7 +56,7 @@
         "rector/type-perfect": "^2.1",
         "shipmonk/composer-dependency-analyser": "^1.8",
         "symplify/phpstan-extensions": "^12.0.2",
-        "symplify/phpstan-rules": "^14.9.1",
+        "symplify/phpstan-rules": "dev-main",
         "symplify/vendor-patches": "^11.5",
         "tomasvotruba/class-leak": "^2.1",
         "tracy/tracy": "^2.11"

phpstan.neon

@@ -387,3 +387,12 @@ parameters:
         -
             path: rules/TypeDeclaration/Rector/StmtsAwareInterface/IncreaseDeclareStrictTypesRector.php
             identifier: rector.noOnlyNullReturnInRefactor
+
+        # handle next
+        -
+            identifier: rector.noIntegerRefactorReturn
+            paths:
+                - rules/CodeQuality/Rector/FuncCall/SetTypeToCastRector.php
+                - rules/Php55/Rector/String_/StringClassNameToClassConstantRector.php
+                - rules/Php80/Rector/Switch_/ChangeSwitchToMatchRector.php
+                - tests/Issues/InfiniteLoop/Rector/MethodCall/InfinityLoopRector.php

rules-tests/Transform/Rector/ArrayDimFetch/ArrayDimFetchToMethodCallRector/Fixture/skip_assign_ops.php.inc

@@ -6,15 +6,3 @@ namespace Rector\Tests\Transform\Rector\ArrayDimFetch\ArrayDimFetchToMethodCallR
 $object['key'] += 42;
 $object['key'] -= 42;
 $object['key'] *= 42;
-$object['key'] /= 42;
-$object['key'] %= 42;
-$object['key'] **= 42;
-$object['key'] .= 'value';
-$object['key'] &= 42;
-$object['key'] |= 42;
-$object['key'] ^= 42;
-$object['key'] <<= 42;
-$object['key'] >>= 42;
-$object['key'] ??= 'value';
-
-?>

rules/Php81/Rector/Array_/FirstClassCallableRector.php

@@ -7,13 +7,11 @@
 use PhpParser\Node;
 use PhpParser\Node\Expr\Array_;
 use PhpParser\Node\Expr\ClassConstFetch;
-use PhpParser\Node\Expr\Closure;
 use PhpParser\Node\Expr\MethodCall;
 use PhpParser\Node\Expr\PropertyFetch;
 use PhpParser\Node\Expr\StaticCall;
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\VariadicPlaceholder;
-use PhpParser\NodeVisitor;
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\ReflectionProvider;
@@ -24,7 +22,6 @@
 use Rector\Rector\AbstractRector;
 use Rector\Reflection\ReflectionResolver;
 use Rector\StaticTypeMapper\ValueObject\Type\FullyQualifiedObjectType;
-use Rector\Symfony\NodeAnalyzer\SymfonyPhpClosureDetector;
 use Rector\ValueObject\PhpVersion;
 use Rector\VersionBonding\Contract\MinPhpVersionInterface;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
@@ -40,7 +37,6 @@ public function __construct(
         private readonly ArrayCallableMethodMatcher $arrayCallableMethodMatcher,
         private readonly ReflectionProvider $reflectionProvider,
         private readonly ReflectionResolver $reflectionResolver,
-        private readonly SymfonyPhpClosureDetector $symfonyPhpClosureDetector
     ) {
     }
 
@@ -85,20 +81,15 @@ public function name()
      */
     public function getNodeTypes(): array
     {
-        return [Array_::class, Closure::class];
+        return [Array_::class];
     }
 
     /**
-     * @param Array_|Closure $node
-     * @return StaticCall|MethodCall|null|NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN
+     * @param Array_ $node
      */
-    public function refactor(Node $node): StaticCall|MethodCall|null|int
+    public function refactor(Node $node): StaticCall|MethodCall|null
     {
-        if ($node instanceof Closure) {
-            if ($this->symfonyPhpClosureDetector->detect($node)) {
-                return NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN;
-            }
-
+        if ($node->getAttribute(AttributeKey::IS_INSIDE_SYMFONY_PHP_CLOSURE)) {
             return null;
         }
 

rules/Transform/Rector/ArrayDimFetch/ArrayDimFetchToMethodCallRector.php

@@ -9,7 +9,6 @@
 use PhpParser\Node\Expr;
 use PhpParser\Node\Expr\ArrayDimFetch;
 use PhpParser\Node\Expr\Assign;
-use PhpParser\Node\Expr\AssignOp;
 use PhpParser\Node\Expr\BinaryOp\BooleanAnd;
 use PhpParser\Node\Expr\Isset_;
 use PhpParser\Node\Expr\MethodCall;
@@ -61,20 +60,15 @@ public function getRuleDefinition(): RuleDefinition
 
     public function getNodeTypes(): array
     {
-        return [AssignOp::class, Assign::class, Isset_::class, Unset_::class, ArrayDimFetch::class];
+        return [Assign::class, Isset_::class, Unset_::class, ArrayDimFetch::class];
     }
 
     /**
-     * @template TNode of ArrayDimFetch|Assign|Isset_|Unset_
-     * @param TNode $node
+     * @param ArrayDimFetch|Assign|Isset_|Unset_ $node
      * @return ($node is Unset_ ? Stmt[]|int : ($node is Isset_ ? Expr|int : MethodCall|int|null))
      */
     public function refactor(Node $node): array|Expr|null|int
     {
-        if ($node instanceof AssignOp) {
-            return NodeVisitor::DONT_TRAVERSE_CHILDREN;
-        }
-
         if ($node instanceof Unset_) {
             return $this->handleUnset($node);
         }
@@ -96,6 +90,10 @@ public function refactor(Node $node): array|Expr|null|int
             return null;
         }
 
+        if ($node->getAttribute(AttributeKey::IS_ASSIGN_OP_VAR)) {
+            return null;
+        }
+
         return $this->createExplicitMethodCall($node, 'get');
     }
 

src/DependencyInjection/LazyContainerFactory.php

@@ -104,6 +104,7 @@
 use Rector\NodeTypeResolver\PHPStan\Scope\NodeVisitor\NameNodeVisitor;
 use Rector\NodeTypeResolver\PHPStan\Scope\NodeVisitor\PropertyOrClassConstDefaultNodeVisitor;
 use Rector\NodeTypeResolver\PHPStan\Scope\NodeVisitor\StaticVariableNodeVisitor;
+use Rector\NodeTypeResolver\PHPStan\Scope\NodeVisitor\SymfonyClosureNodeVisitor;
 use Rector\NodeTypeResolver\PHPStan\Scope\PHPStanNodeScopeResolver;
 use Rector\NodeTypeResolver\Reflection\BetterReflection\SourceLocatorProvider\DynamicSourceLocatorProvider;
 use Rector\Php80\AttributeDecorator\DoctrineConverterAttributeDecorator;
@@ -238,6 +239,7 @@ final class LazyContainerFactory
     private const DECORATING_NODE_VISITOR_CLASSES = [
         ArgNodeVisitor::class,
         AssignedToNodeVisitor::class,
+        SymfonyClosureNodeVisitor::class,
         ByRefReturnNodeVisitor::class,
         ByRefVariableNodeVisitor::class,
         ContextNodeVisitor::class,

src/NodeTypeResolver/Node/AttributeKey.php

@@ -290,4 +290,6 @@ final class AttributeKey
     public const IS_DEFAULT_PROPERTY_VALUE = 'is_default_property_value';
 
     public const IS_CLASS_CONST_VALUE = 'is_default_class_const_value';
+
+    public const IS_INSIDE_SYMFONY_PHP_CLOSURE = 'is_inside_symfony_php_closure';
 }

src/NodeTypeResolver/PHPStan/Scope/NodeVisitor/SymfonyClosureNodeVisitor.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\NodeTypeResolver\PHPStan\Scope\NodeVisitor;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\Closure;
+use PhpParser\NodeVisitorAbstract;
+use Rector\Contract\PhpParser\DecoratingNodeVisitorInterface;
+use Rector\NodeTypeResolver\Node\AttributeKey;
+use Rector\PhpParser\NodeTraverser\SimpleTraverser;
+use Rector\Symfony\NodeAnalyzer\SymfonyPhpClosureDetector;
+
+final class SymfonyClosureNodeVisitor extends NodeVisitorAbstract implements DecoratingNodeVisitorInterface
+{
+    public function __construct(
+        private readonly SymfonyPhpClosureDetector $symfonyPhpClosureDetector
+    ) {
+    }
+
+    public function enterNode(Node $node): ?Node
+    {
+        if (! $node instanceof Closure) {
+            return null;
+        }
+
+        if (! $this->symfonyPhpClosureDetector->detect($node)) {
+            return null;
+        }
+
+        SimpleTraverser::decorateWithTrueAttribute($node, AttributeKey::IS_INSIDE_SYMFONY_PHP_CLOSURE);
+
+        return null;
+    }
+}