[code-quality] Add AttributeNamedArgsRector

config/set/named-args.php

@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use Rector\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector;
 use Rector\CodeQuality\Rector\Attribute\SortAttributeNamedArgsRector;
 use Rector\CodeQuality\Rector\CallLike\AddNameToBooleanArgumentRector;
 use Rector\CodeQuality\Rector\CallLike\AddNameToNullArgumentRector;
@@ -17,6 +18,7 @@
         RemoveNullNamedArgOnNullDefaultParamRector::class,
         SortCallLikeNamedArgsRector::class,
         SortAttributeNamedArgsRector::class,
+        ExplicitAttributeNamedArgsRector::class,
         UtilsJsonStaticCallNamedArgRector::class,
     ]);
 };

rules-tests/CodeQuality/Rector/Attribute/ExplicitAttributeNamedArgsRector/ExplicitAttributeNamedArgsRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class ExplicitAttributeNamedArgsRectorTest 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';
+    }
+}

rules-tests/CodeQuality/Rector/Attribute/ExplicitAttributeNamedArgsRector/Fixture/other_attribute.php.inc

@@ -0,0 +1,25 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Fixture;
+
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\OtherAttribute;
+
+#[OtherAttribute('a', 'b')]
+class OtherAttributeFixture
+{
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Fixture;
+
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\OtherAttribute;
+
+#[OtherAttribute(a: 'a', b: 'b')]
+class OtherAttributeFixture
+{
+}
+
+?>

rules-tests/CodeQuality/Rector/Attribute/ExplicitAttributeNamedArgsRector/Fixture/positional_except.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Fixture;
+
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\Middleware;
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\RequireToken;
+
+#[Middleware(RequireToken::class, null, ['home'])]
+class PositionalExcept
+{
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Fixture;
+
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\Middleware;
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\RequireToken;
+
+#[Middleware(middleware: RequireToken::class, only: null, except: ['home'])]
+class PositionalExcept
+{
+}
+
+?>

rules-tests/CodeQuality/Rector/Attribute/ExplicitAttributeNamedArgsRector/Fixture/positional_middleware.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Fixture;
+
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\Middleware;
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\RequireToken;
+
+#[Middleware(RequireToken::class, except: ['home'])]
+class PositionalMiddleware
+{
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Fixture;
+
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\Middleware;
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\RequireToken;
+
+#[Middleware(middleware: RequireToken::class, except: ['home'])]
+class PositionalMiddleware
+{
+}
+
+?>

rules-tests/CodeQuality/Rector/Attribute/ExplicitAttributeNamedArgsRector/Fixture/positional_only.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Fixture;
+
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\Middleware;
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\RequireToken;
+
+#[Middleware(RequireToken::class, ['export'])]
+class PositionalOnly
+{
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Fixture;
+
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\Middleware;
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\RequireToken;
+
+#[Middleware(middleware: RequireToken::class, only: ['export'])]
+class PositionalOnly
+{
+}
+
+?>

rules-tests/CodeQuality/Rector/Attribute/ExplicitAttributeNamedArgsRector/Fixture/skip_already_named.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Fixture;
+
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\Middleware;
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\RequireToken;
+
+#[Middleware(middleware: RequireToken::class, only: ['export'])]
+class SkipAlreadyNamed
+{
+}

rules-tests/CodeQuality/Rector/Attribute/ExplicitAttributeNamedArgsRector/Fixture/skip_variadic.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Fixture;
+
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\MiddlewareWithVariadic;
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\RequireToken;
+
+#[MiddlewareWithVariadic(RequireToken::class, 'a', 'b')]
+class SkipVariadic
+{
+}

rules-tests/CodeQuality/Rector/Attribute/ExplicitAttributeNamedArgsRector/Fixture/variadic_named_prefix.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Fixture;
+
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\MiddlewareWithVariadic;
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\RequireToken;
+
+#[MiddlewareWithVariadic(RequireToken::class)]
+class VariadicNamedPrefix
+{
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Fixture;
+
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\MiddlewareWithVariadic;
+use Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source\RequireToken;
+
+#[MiddlewareWithVariadic(middleware: RequireToken::class)]
+class VariadicNamedPrefix
+{
+}
+
+?>

rules-tests/CodeQuality/Rector/Attribute/ExplicitAttributeNamedArgsRector/Source/Middleware.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source;
+
+#[\Attribute]
+class Middleware
+{
+    public function __construct($middleware = null, $only = null, $except = null)
+    {
+    }
+}

rules-tests/CodeQuality/Rector/Attribute/ExplicitAttributeNamedArgsRector/Source/MiddlewareWithVariadic.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source;
+
+#[\Attribute]
+class MiddlewareWithVariadic
+{
+    public function __construct($middleware = null, ...$groups)
+    {
+    }
+}

rules-tests/CodeQuality/Rector/Attribute/ExplicitAttributeNamedArgsRector/Source/OtherAttribute.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source;
+
+#[\Attribute]
+class OtherAttribute
+{
+    public function __construct($a = null, $b = null)
+    {
+    }
+}

rules-tests/CodeQuality/Rector/Attribute/ExplicitAttributeNamedArgsRector/Source/RequireToken.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\Source;
+
+class RequireToken
+{
+}

rules-tests/CodeQuality/Rector/Attribute/ExplicitAttributeNamedArgsRector/config/configured_rule.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector;
+use Rector\Config\RectorConfig;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(ExplicitAttributeNamedArgsRector::class);
+};

rules/CodeQuality/Rector/Attribute/ExplicitAttributeNamedArgsRector.php

@@ -0,0 +1,131 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\CodeQuality\Rector\Attribute;
+
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Attribute;
+use PhpParser\Node\Identifier;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\ParameterReflection;
+use PHPStan\Reflection\ParametersAcceptorSelector;
+use Rector\Rector\AbstractRector;
+use Rector\Reflection\ReflectionResolver;
+use Rector\ValueObject\PhpVersionFeature;
+use Rector\VersionBonding\Contract\MinPhpVersionInterface;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Tests\CodeQuality\Rector\Attribute\ExplicitAttributeNamedArgsRector\ExplicitAttributeNamedArgsRectorTest
+ */
+final class ExplicitAttributeNamedArgsRector extends AbstractRector implements MinPhpVersionInterface
+{
+    public function __construct(
+        private readonly ReflectionResolver $reflectionResolver
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Convert positional arguments on attributes into named arguments, using the attribute constructor parameter names',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+#[SomeAttribute(SomeClass::class, null, ['home'])]
+class SomeClass
+{
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+#[SomeAttribute(value: SomeClass::class, only: null, except: ['home'])]
+class SomeClass
+{
+}
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Attribute::class];
+    }
+
+    /**
+     * @param Attribute $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        $methodReflection = $this->reflectionResolver->resolveConstructorReflectionFromAttribute($node);
+        if (! $methodReflection instanceof MethodReflection) {
+            return null;
+        }
+
+        $extendedParametersAcceptor = ParametersAcceptorSelector::combineAcceptors($methodReflection->getVariants());
+        $parameters = $extendedParametersAcceptor->getParameters();
+
+        $namesToApply = $this->resolveArgNamesToApply($node->args, $parameters);
+        if ($namesToApply === []) {
+            return null;
+        }
+
+        foreach ($namesToApply as $position => $name) {
+            $node->args[$position]->name = new Identifier($name);
+        }
+
+        return $node;
+    }
+
+    public function provideMinPhpVersion(): int
+    {
+        return PhpVersionFeature::NAMED_ARGUMENTS;
+    }
+
+    /**
+     * Resolve the positional arguments to name, as a position => parameter-name map, or [] when
+     * nothing should change. Naming an argument forces every later positional argument to be named
+     * too (PHP forbids a positional argument after a named one). So if any argument maps to a
+     * variadic parameter, or to no parameter at all (overflow past a variadic), the whole attribute
+     * is left untouched rather than producing invalid PHP.
+     *
+     * @param Arg[]                 $args
+     * @param ParameterReflection[] $parameters
+     * @return array<int, string>
+     */
+    private function resolveArgNamesToApply(array $args, array $parameters): array
+    {
+        $namesToApply = [];
+
+        foreach ($args as $position => $arg) {
+            // already named
+            if ($arg->name instanceof Identifier) {
+                continue;
+            }
+
+            $parameter = $parameters[$position] ?? null;
+
+            // no matching parameter, e.g. overflow past a variadic
+            if ($parameter === null) {
+                return [];
+            }
+
+            // naming a variadic would rebind it or strand later positional arguments
+            if ($parameter->isVariadic()) {
+                return [];
+            }
+
+            $namesToApply[$position] = $parameter->getName();
+        }
+
+        return $namesToApply;
+    }
+}