[cleanup] Make FirstClassCallableRector use attributes over node traverser hacks (#7696)

* [cleanup] Make FirstClassCallableRector use attributes over node traverser hacks

* handle nested arrays as well

Author: TomasVotruba

rules-tests/Php81/Rector/Array_/FirstClassCallableRector/Fixture/skip_on_class_const.php.inc

@@ -6,6 +6,10 @@ final class SkipOnClassConst
 {
     private const CLASS_CONST = [SkipOnClassConst::class, 'size'];
 
+    private const CLASS_CONST_NESTED = [
+        'hey' => [SkipOnClassConst::class, 'size']
+    ];
+
     public function size()
     {
     }

rules-tests/Php81/Rector/Array_/FirstClassCallableRector/Fixture/skip_on_property.php.inc

@@ -6,6 +6,10 @@ final class SkipOnProperty
 {
     private $prop = [SkipOnProperty::class, 'size'];
 
+    private $nestedProperty = [
+        'some_callback' => [SkipOnProperty::class, 'size']
+    ];
+
     public function size()
     {
     }

rules/Php81/Rector/Array_/FirstClassCallableRector.php

@@ -12,15 +12,14 @@
 use PhpParser\Node\Expr\PropertyFetch;
 use PhpParser\Node\Expr\StaticCall;
 use PhpParser\Node\Expr\Variable;
-use PhpParser\Node\Stmt\ClassConst;
-use PhpParser\Node\Stmt\Property;
 use PhpParser\Node\VariadicPlaceholder;
 use PhpParser\NodeVisitor;
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\ReflectionProvider;
 use Rector\NodeCollector\NodeAnalyzer\ArrayCallableMethodMatcher;
 use Rector\NodeCollector\ValueObject\ArrayCallable;
+use Rector\NodeTypeResolver\Node\AttributeKey;
 use Rector\PHPStan\ScopeFetcher;
 use Rector\Rector\AbstractRector;
 use Rector\Reflection\ReflectionResolver;
@@ -32,6 +31,7 @@
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
+ * @see RFC https://wiki.php.net/rfc/first_class_callable_syntax
  * @see \Rector\Tests\Php81\Rector\Array_\FirstClassCallableRector\FirstClassCallableRectorTest
  */
 final class FirstClassCallableRector extends AbstractRector implements MinPhpVersionInterface
@@ -46,7 +46,6 @@ public function __construct(
 
     public function getRuleDefinition(): RuleDefinition
     {
-        // see RFC https://wiki.php.net/rfc/first_class_callable_syntax
         return new RuleDefinition('Upgrade array callable to first class callable', [
             new CodeSample(
                 <<<'CODE_SAMPLE'
@@ -86,14 +85,14 @@ public function name()
      */
     public function getNodeTypes(): array
     {
-        return [Property::class, ClassConst::class, Array_::class, Closure::class];
+        return [Array_::class, Closure::class];
     }
 
     /**
-     * @param Property|ClassConst|Array_|Closure $node
+     * @param Array_|Closure $node
      * @return StaticCall|MethodCall|null|NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN
      */
-    public function refactor(Node $node): int|null|StaticCall|MethodCall
+    public function refactor(Node $node): StaticCall|MethodCall|null|int
     {
         if ($node instanceof Closure) {
             if ($this->symfonyPhpClosureDetector->detect($node)) {
@@ -103,10 +102,6 @@ public function refactor(Node $node): int|null|StaticCall|MethodCall
             return null;
         }
 
-        if ($node instanceof Property || $node instanceof ClassConst) {
-            return NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN;
-        }
-
         $scope = ScopeFetcher::fetch($node);
 
         $arrayCallable = $this->arrayCallableMethodMatcher->match($node, $scope);
@@ -119,6 +114,14 @@ public function refactor(Node $node): int|null|StaticCall|MethodCall
             return null;
         }
 
+        if ($node->getAttribute(AttributeKey::IS_CLASS_CONST_VALUE)) {
+            return null;
+        }
+
+        if ($node->getAttribute(AttributeKey::IS_DEFAULT_PROPERTY_VALUE)) {
+            return null;
+        }
+
         $args = [new VariadicPlaceholder()];
         if ($callerExpr instanceof ClassConstFetch) {
             $type = $this->getType($callerExpr->class);

src/DependencyInjection/LazyContainerFactory.php

@@ -102,6 +102,7 @@
 use Rector\NodeTypeResolver\PHPStan\Scope\NodeVisitor\ContextNodeVisitor;
 use Rector\NodeTypeResolver\PHPStan\Scope\NodeVisitor\GlobalVariableNodeVisitor;
 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\PHPStanNodeScopeResolver;
 use Rector\NodeTypeResolver\Reflection\BetterReflection\SourceLocatorProvider\DynamicSourceLocatorProvider;
@@ -243,6 +244,7 @@ final class LazyContainerFactory
         GlobalVariableNodeVisitor::class,
         NameNodeVisitor::class,
         StaticVariableNodeVisitor::class,
+        PropertyOrClassConstDefaultNodeVisitor::class,
     ];
 
     /**

src/NodeTypeResolver/Node/AttributeKey.php

@@ -286,4 +286,8 @@ final class AttributeKey
      * @var string
      */
     public const HAS_MERGED_COMMENTS = 'has_merged_comments';
+
+    public const IS_DEFAULT_PROPERTY_VALUE = 'is_default_property_value';
+
+    public const IS_CLASS_CONST_VALUE = 'is_default_class_const_value';
 }

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

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\NodeTypeResolver\PHPStan\Scope\NodeVisitor;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr;
+use PhpParser\Node\Stmt\ClassConst;
+use PhpParser\Node\Stmt\Property;
+use PhpParser\NodeVisitorAbstract;
+use Rector\Contract\PhpParser\DecoratingNodeVisitorInterface;
+use Rector\NodeTypeResolver\Node\AttributeKey;
+use Rector\PhpParser\NodeTraverser\SimpleTraverser;
+
+final class PropertyOrClassConstDefaultNodeVisitor extends NodeVisitorAbstract implements DecoratingNodeVisitorInterface
+{
+    public function enterNode(Node $node): ?Node
+    {
+        if ($node instanceof Property) {
+            foreach ($node->props as $propertyItem) {
+                $default = $propertyItem->default;
+                if (! $default instanceof Expr) {
+                    continue;
+                }
+
+                SimpleTraverser::decorateWithTrueAttribute($default, AttributeKey::IS_DEFAULT_PROPERTY_VALUE);
+            }
+        }
+
+        if ($node instanceof ClassConst) {
+            foreach ($node->consts as $const) {
+                SimpleTraverser::decorateWithTrueAttribute($const->value, AttributeKey::IS_CLASS_CONST_VALUE);
+            }
+        }
+
+        return null;
+    }
+}

src/PhpParser/NodeTraverser/SimpleTraverser.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PhpParser\NodeTraverser;
+
+use PhpParser\Node;
+use PhpParser\NodeTraverser;
+use PhpParser\NodeVisitorAbstract;
+use Rector\NodeTypeResolver\Node\AttributeKey;
+
+final class SimpleTraverser
+{
+    /**
+     * @param Node[]|Node $nodesOrNode
+     * @param AttributeKey::* $attributeKey
+     */
+    public static function decorateWithTrueAttribute(array|Node $nodesOrNode, string $attributeKey): void
+    {
+        $callableNodeVisitor = new class($attributeKey) extends NodeVisitorAbstract {
+            public function __construct(
+                private readonly string $attributeKey
+            ) {
+            }
+
+            public function enterNode(Node $node)
+            {
+                $node->setAttribute($this->attributeKey, true);
+                return null;
+            }
+        };
+
+        $nodeTraverser = new NodeTraverser($callableNodeVisitor);
+
+        $nodes = $nodesOrNode instanceof Node ? [$nodesOrNode] : $nodesOrNode;
+        $nodeTraverser->traverse($nodes);
+    }
+}