[code-quality] Extract standalone SortAttributeNamedArgsRector from SortNamedParamRector, to slightly different areas

TomasVotruba · TomasVotruba · commit 953c0439c6f6 · 2025-12-10T19:35:13.000+01:00
diff --git a/rules-tests/CodeQuality/Rector/Attribute/SortAttributeNamedArgsRector/Fixture/attribute.php.inc b/rules-tests/CodeQuality/Rector/Attribute/SortAttributeNamedArgsRector/Fixture/attribute.php.inc
@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\SortAttributeNamedArgsRector\Fixture;
+
+use Rector\Tests\CodeQuality\Rector\Attribute\SortAttributeNamedArgsRector\Source\MyAttribute;
+
+#[MyAttribute(bar: 1, foo: 2)]
+#[MyAttribute(1, baz: 2, bar: 3)]
+final class HandleAttribute
+{
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\SortAttributeNamedArgsRector\Fixture;
+
+use Rector\Tests\CodeQuality\Rector\Attribute\SortAttributeNamedArgsRector\Source\MyAttribute;
+
+#[MyAttribute(foo: 2, bar: 1)]
+#[MyAttribute(1, bar: 3, baz: 2)]
+final class HandleAttribute
+{
+}
+
+?>
diff --git a/rules-tests/CodeQuality/Rector/Attribute/SortAttributeNamedArgsRector/SortAttributeNamedArgsRectorTest.php b/rules-tests/CodeQuality/Rector/Attribute/SortAttributeNamedArgsRector/SortAttributeNamedArgsRectorTest.php
@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\SortAttributeNamedArgsRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class SortAttributeNamedArgsRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}
diff --git a/rules-tests/CodeQuality/Rector/Attribute/SortAttributeNamedArgsRector/Source/MyAttribute.php b/rules-tests/CodeQuality/Rector/Attribute/SortAttributeNamedArgsRector/Source/MyAttribute.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\SortAttributeNamedArgsRector\Source;
+
+#[\Attribute]
+class MyAttribute
+{
+    public function __construct($foo = null, $bar = null, $baz = null)
+    {
+    }
+}
diff --git a/rules-tests/CodeQuality/Rector/Attribute/SortAttributeNamedArgsRector/config/configured_rule.php b/rules-tests/CodeQuality/Rector/Attribute/SortAttributeNamedArgsRector/config/configured_rule.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\CodeQuality\Rector\Attribute\SortAttributeNamedArgsRector;
+use Rector\Config\RectorConfig;
+
+return RectorConfig::configure()
+    ->withRules([SortAttributeNamedArgsRector::class]);
diff --git a/rules-tests/CodeQuality/Rector/FuncCall/SortNamedParamRector/Fixture/attribute.php.inc b/rules-tests/CodeQuality/Rector/FuncCall/SortNamedParamRector/Fixture/attribute.php.inc
diff --git a/rules-tests/CodeQuality/Rector/FuncCall/SortNamedParamRector/Fixture/skip_attribute.php.inc b/rules-tests/CodeQuality/Rector/FuncCall/SortNamedParamRector/Fixture/skip_attribute.php.inc
@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\FuncCall\SortNamedParamRector\Fixture;
+
+use Rector\Tests\CodeQuality\Rector\FuncCall\SortNamedParamRector\Source\MyAttribute;
+
+#[MyAttribute(bar: 1, foo: 2)]
+#[MyAttribute(1, baz: 2, bar: 3)]
+class SkipAttribute
+{
+}
diff --git a/rules/CodeQuality/NodeManipulator/NamedArgsSorter.php b/rules/CodeQuality/NodeManipulator/NamedArgsSorter.php
@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\CodeQuality\NodeManipulator;
+
+use PhpParser\Node\Arg;
+use PhpParser\Node\Identifier;
+use PHPStan\Reflection\FunctionReflection;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\ParametersAcceptorSelector;
+
+final class NamedArgsSorter
+{
+    /**
+     * @param Arg[] $currentArgs
+     * @return list<Arg>
+     */
+    public function sortArgsToMatchReflectionParameters(
+        array $currentArgs,
+        FunctionReflection | MethodReflection $functionLikeReflection,
+    ): array {
+        $extendedParametersAcceptor = ParametersAcceptorSelector::combineAcceptors(
+            $functionLikeReflection->getVariants()
+        );
+
+        $parameters = $extendedParametersAcceptor->getParameters();
+
+        $order = [];
+        foreach ($parameters as $key => $parameter) {
+            $order[$parameter->getName()] = $key;
+        }
+
+        $sortedArgs = [];
+        $toSortArgs = [];
+        foreach ($currentArgs as $currentArg) {
+            if (! $currentArg->name instanceof Identifier) {
+                $sortedArgs[] = $currentArg;
+                continue;
+            }
+
+            $toSortArgs[] = $currentArg;
+        }
+
+        usort(
+            $toSortArgs,
+            static function (Arg $arg1, Arg $arg2) use ($order): int {
+                /** @var Identifier $argName1 */
+                $argName1 = $arg1->name;
+                /** @var Identifier $argName2 */
+                $argName2 = $arg2->name;
+
+                $order1 = $order[$argName1->name] ?? PHP_INT_MAX;
+                $order2 = $order[$argName2->name] ?? PHP_INT_MAX;
+
+                return $order1 <=> $order2;
+            }
+        );
+
+        return [...$sortedArgs, ...$toSortArgs];
+    }
+}
diff --git a/rules/CodeQuality/Rector/Attribute/SortAttributeNamedArgsRector.php b/rules/CodeQuality/Rector/Attribute/SortAttributeNamedArgsRector.php
@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\CodeQuality\Rector\Attribute;
+
+use PhpParser\Node;
+use PhpParser\Node\Attribute;
+use PHPStan\Reflection\MethodReflection;
+use Rector\CodeQuality\NodeManipulator\NamedArgsSorter;
+use Rector\NodeAnalyzer\ArgsAnalyzer;
+use Rector\Rector\AbstractRector;
+use Rector\Reflection\ReflectionResolver;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Tests\CodeQuality\Rector\Attribute\SortAttributeNamedArgsRector\SortAttributeNamedArgsRectorTest
+ */
+final class SortAttributeNamedArgsRector extends AbstractRector
+{
+    public function __construct(
+        private readonly ArgsAnalyzer $argsAnalyzer,
+        private readonly ReflectionResolver $reflectionResolver,
+        private readonly NamedArgsSorter $namedArgsSorter
+    ) {
+
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Sort named arguments in PHP 8 attributes to match their declaration order', []);
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [Attribute::class];
+    }
+
+    /**
+     * @param Node\Attribute $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        $args = $node->args;
+        if (count($args) <= 1) {
+            return null;
+        }
+
+        if (! $this->argsAnalyzer->hasNamedArg($args)) {
+            return null;
+        }
+
+        $functionLikeReflection = $this->reflectionResolver->resolveConstructorReflectionFromAttribute($node);
+        if (! $functionLikeReflection instanceof MethodReflection) {
+            return null;
+        }
+
+        $args = $this->namedArgsSorter->sortArgsToMatchReflectionParameters($args, $functionLikeReflection);
+        if ($node->args === $args) {
+            return null;
+        }
+
+        $node->args = $args;
+
+        return $node;
+
+    }
+}
diff --git a/rules/CodeQuality/Rector/FuncCall/SortNamedParamRector.php b/rules/CodeQuality/Rector/FuncCall/SortNamedParamRector.php
@@ -5,17 +5,13 @@
 namespace Rector\CodeQuality\Rector\FuncCall;
 
 use PhpParser\Node;
-use PhpParser\Node\Arg;
-use PhpParser\Node\Attribute;
-use PhpParser\Node\Expr\CallLike;
 use PhpParser\Node\Expr\FuncCall;
 use PhpParser\Node\Expr\MethodCall;
 use PhpParser\Node\Expr\New_;
 use PhpParser\Node\Expr\StaticCall;
-use PhpParser\Node\Identifier;
 use PHPStan\Reflection\FunctionReflection;
 use PHPStan\Reflection\MethodReflection;
-use PHPStan\Reflection\ParametersAcceptorSelector;
+use Rector\CodeQuality\NodeManipulator\NamedArgsSorter;
 use Rector\NodeAnalyzer\ArgsAnalyzer;
 use Rector\Rector\AbstractRector;
 use Rector\Reflection\ReflectionResolver;
@@ -29,30 +25,27 @@ final class SortNamedParamRector extends AbstractRector
 {
     public function __construct(
         private readonly ReflectionResolver $reflectionResolver,
-        private readonly ArgsAnalyzer $argsAnalyzer
+        private readonly ArgsAnalyzer $argsAnalyzer,
+        private readonly NamedArgsSorter $namedArgsSorter,
     ) {
     }
 
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Sort named parameters usage in a function or method call',
+            'Sort named arguments to match their order in a function or method call or class constructors',
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
 function run($foo = null, $bar = null, $baz = null) {}
 
 run(bar: $bar, foo: $foo);
-
-run($foo, baz: $baz, bar: $bar);
 CODE_SAMPLE
                     ,
                     <<<'CODE_SAMPLE'
 function run($foo = null, $bar = null, $baz = null) {}
 
 run(foo: $foo, bar: $bar);
-
-run($foo, bar: $bar, baz: $baz);
 CODE_SAMPLE
                 ),
             ]
@@ -64,20 +57,19 @@ function run($foo = null, $bar = null, $baz = null) {}
      */
     public function getNodeTypes(): array
     {
-        return [MethodCall::class, StaticCall::class, New_::class, FuncCall::class, Attribute::class];
+        return [MethodCall::class, StaticCall::class, New_::class, FuncCall::class];
     }
 
     /**
-     * @param MethodCall|StaticCall|New_|FuncCall|Attribute $node
+     * @param MethodCall|StaticCall|New_|FuncCall $node
      */
     public function refactor(Node $node): ?Node
     {
-        if ($node instanceof CallLike && $node->isFirstClassCallable()) {
+        if ($node->isFirstClassCallable()) {
             return null;
         }
 
-        $args = $node instanceof Attribute ? $node->args : $node->getArgs();
-
+        $args = $node->getArgs();
         if (count($args) <= 1) {
             return null;
         }
@@ -88,8 +80,6 @@ public function refactor(Node $node): ?Node
 
         if ($node instanceof New_) {
             $functionLikeReflection = $this->reflectionResolver->resolveMethodReflectionFromNew($node);
-        } elseif ($node instanceof Attribute) {
-            $functionLikeReflection = $this->reflectionResolver->resolveMethodReflectionFromAttribute($node);
         } else {
             $functionLikeReflection = $this->reflectionResolver->resolveFunctionLikeReflectionFromCall($node);
         }
@@ -98,7 +88,7 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
-        $args = $this->sortNamedArguments($functionLikeReflection, $args);
+        $args = $this->namedArgsSorter->sortArgsToMatchReflectionParameters($args, $functionLikeReflection);
         if ($node->args === $args) {
             return null;
         }
@@ -107,52 +97,4 @@ public function refactor(Node $node): ?Node
 
         return $node;
     }
-
-    /**
-     * @param Arg[] $currentArgs
-     * @return Arg[]
-     */
-    public function sortNamedArguments(
-        FunctionReflection | MethodReflection $functionLikeReflection,
-        array $currentArgs
-    ): array {
-        $extendedParametersAcceptor = ParametersAcceptorSelector::combineAcceptors(
-            $functionLikeReflection->getVariants()
-        );
-
-        $parameters = $extendedParametersAcceptor->getParameters();
-
-        $order = [];
-        foreach ($parameters as $key => $parameter) {
-            $order[$parameter->getName()] = $key;
-        }
-
-        $sortedArgs = [];
-        $toSortArgs = [];
-        foreach ($currentArgs as $currentArg) {
-            if (! $currentArg->name instanceof Identifier) {
-                $sortedArgs[] = $currentArg;
-                continue;
-            }
-
-            $toSortArgs[] = $currentArg;
-        }
-
-        usort(
-            $toSortArgs,
-            static function (Arg $arg1, Arg $arg2) use ($order): int {
-                /** @var Identifier $argName1 */
-                $argName1 = $arg1->name;
-                /** @var Identifier $argName2 */
-                $argName2 = $arg2->name;
-
-                $order1 = $order[$argName1->name] ?? PHP_INT_MAX;
-                $order2 = $order[$argName2->name] ?? PHP_INT_MAX;
-
-                return $order1 <=> $order2;
-            }
-        );
-
-        return [...$sortedArgs, ...$toSortArgs];
-    }
 }
diff --git a/rules/CodingStyle/Guard/ArrowFunctionAndClosureFirstClassCallableGuard.php b/rules/CodingStyle/Guard/ArrowFunctionAndClosureFirstClassCallableGuard.php
diff --git a/src/PhpParser/NodeVisitor/ParamDefaultNodeVisitor.php b/src/PhpParser/NodeVisitor/ParamDefaultNodeVisitor.php
diff --git a/src/Reflection/ReflectionResolver.php b/src/Reflection/ReflectionResolver.php
