[Symfony 6.3] Add ParamAndEnvAttributeRector

config/sets/symfony/symfony63.php

@@ -4,6 +4,7 @@
 
 use Rector\Config\RectorConfig;
 use Rector\Renaming\Rector\Name\RenameClassRector;
+use Rector\Symfony\Symfony63\Rector\Class_\ParamAndEnvAttributeRector;
 use Rector\Symfony\Symfony63\Rector\Class_\SignalableCommandInterfaceReturnTypeRector;
 
 // @see https://github.com/symfony/symfony/blob/6.3/UPGRADE-6.3.md
@@ -24,6 +25,10 @@
         ],
     );
 
-    // @see https://github.com/symfony/symfony/commit/1650e3861b5fcd931e5d3eb1dd84bad764020d8e
-    $rectorConfig->rule(SignalableCommandInterfaceReturnTypeRector::class);
+    $rectorConfig->rules([
+        // @see https://github.com/symfony/symfony/commit/1650e3861b5fcd931e5d3eb1dd84bad764020d8e
+        SignalableCommandInterfaceReturnTypeRector::class,
+        // @see https://symfony.com/blog/new-in-symfony-6-3-dependency-injection-improvements#new-options-for-autowire-attribute
+        ParamAndEnvAttributeRector::class,
+    ]);
 };

docs/rector_rules_overview.md

@@ -1,4 +1,4 @@
-# 83 Rules Overview
+# 84 Rules Overview
 
 ## ActionSuffixRemoverRector
 
@@ -1069,6 +1069,34 @@ Turns old option names to new ones in FormTypes in Form in Symfony
 
 <br>
 
+## ParamAndEnvAttributeRector
+
+Make param/env use in #[Attribute] more precise
+
+- class: [`Rector\Symfony\Symfony63\Rector\Class_\ParamAndEnvAttributeRector`](../rules/Symfony63/Rector/Class_/ParamAndEnvAttributeRector.php)
+
+```diff
+ namespace App\Service;
+
+ use Symfony\Component\DependencyInjection\Attribute\Autowire;
+
+ class MessageGenerator
+ {
+     public function __construct(
+-        #[Autowire('%kernel.debug%')]
++        #[Autowire(param: 'kernel.debug')]
+         bool $debugMode,
+
+-        #[Autowire('%env(SOME_ENV_VAR)%')]
++        #[Autowire(env: 'SOME_ENV_VAR')]
+         string $senderName,
+     ) {
+     }
+ }
+```
+
+<br>
+
 ## ParamConverterAttributeToMapEntityAttributeRector
 
 Replace ParamConverter attribute with mappings with the MapEntity attribute

rules-tests/Symfony63/Rector/Class_/ParamAndEnvAttributeRector/Fixture/simple-convert.php.inc

@@ -0,0 +1,39 @@
+<?php
+
+namespace Rector\Symfony\Tests\Symfony63\Rector\Class_\ParamAndEnvAttributeRector\Fixture;
+
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
+
+final class SimpleConvert
+{
+    public function __construct(
+        #[Autowire('%kernel.debug%')]
+        bool $debugMode,
+
+        #[Autowire('%env(SOME_ENV_VAR)%')]
+        string $senderName,
+    ) {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Symfony\Tests\Symfony63\Rector\Class_\ParamAndEnvAttributeRector\Fixture;
+
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
+
+final class SimpleConvert
+{
+    public function __construct(
+        #[Autowire(param: 'kernel.debug')]
+        bool $debugMode,
+
+        #[Autowire(env: 'SOME_ENV_VAR')]
+        string $senderName,
+    ) {
+    }
+}
+
+?>

rules-tests/Symfony63/Rector/Class_/ParamAndEnvAttributeRector/Fixture/skip-already-converted.php.inc

@@ -0,0 +1,14 @@
+<?php
+
+namespace Rector\Symfony\Tests\Symfony63\Rector\Class_\ParamAndEnvAttributeRector\Fixture;
+
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
+
+final class SkipAlreadyConverted
+{
+    public function __construct(
+        #[Autowire(param: '%kernel.debug%')]
+        bool $debugMode,
+    ) {
+    }
+}

rules-tests/Symfony63/Rector/Class_/ParamAndEnvAttributeRector/Fixture/skip-format-miss-match.php.inc

@@ -0,0 +1,14 @@
+<?php
+
+namespace Rector\Symfony\Tests\Symfony63\Rector\Class_\ParamAndEnvAttributeRector\Fixture;
+
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
+
+final class SkipFormatMissMatch
+{
+    public function __construct(
+        #[Autowire('%kernel_ebug')]
+        bool $debugMode,
+    ) {
+    }
+}

rules-tests/Symfony63/Rector/Class_/ParamAndEnvAttributeRector/ParamAndEnvAttributeRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Symfony\Tests\Symfony63\Rector\Class_\ParamAndEnvAttributeRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class ParamAndEnvAttributeRectorTest 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/Symfony63/Rector/Class_/ParamAndEnvAttributeRector/config/configured_rule.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Symfony\Symfony63\Rector\Class_\ParamAndEnvAttributeRector;
+
+return RectorConfig::configure()
+    ->withRules([ParamAndEnvAttributeRector::class]);

rules/Configs/NodeVisitor/CollectServiceArgumentsNodeVisitor.php

@@ -4,16 +4,16 @@
 
 namespace Rector\Symfony\Configs\NodeVisitor;
 
-use PhpParser\Node\Scalar\LNumber;
-use PhpParser\Node\Expr\Array_;
 use Nette\Utils\Strings;
 use PhpParser\Node;
 use PhpParser\Node\Arg;
 use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\Array_;
 use PhpParser\Node\Expr\ArrayItem;
 use PhpParser\Node\Expr\BinaryOp\Concat;
 use PhpParser\Node\Expr\MethodCall;
 use PhpParser\Node\Identifier;
+use PhpParser\Node\Scalar\LNumber;
 use PhpParser\Node\Scalar\String_;
 use PhpParser\Node\Stmt;
 use PhpParser\NodeVisitorAbstract;

rules/Configs/Rector/Class_/AutowireAttributeRector.php

@@ -4,11 +4,11 @@
 
 namespace Rector\Symfony\Configs\Rector\Class_;
 
-use PhpParser\Node\Expr;
 use PhpParser\Node;
 use PhpParser\Node\Arg;
 use PhpParser\Node\Attribute;
 use PhpParser\Node\AttributeGroup;
+use PhpParser\Node\Expr;
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Identifier;
 use PhpParser\Node\Name\FullyQualified;
@@ -19,6 +19,7 @@
 use Rector\Exception\ShouldNotHappenException;
 use Rector\Rector\AbstractRector;
 use Rector\Symfony\Configs\NodeAnalyser\ConfigServiceArgumentsResolver;
+use Rector\Symfony\Enum\SymfonyAttribute;
 use Rector\ValueObject\MethodName;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Finder\SplFileInfo;
@@ -36,11 +37,6 @@ final class AutowireAttributeRector extends AbstractRector implements Configurab
      */
     public const CONFIGS_DIRECTORY = 'configs_directory';
 
-    /**
-     * @var string
-     */
-    private const AUTOWIRE_CLASS = 'Symfony\Component\DependencyInjection\Attribute\Autowire';
-
     private ?string $configsDirectory = null;
 
     public function __construct(
@@ -209,6 +205,6 @@ private function createAutowireAttribute(string|Expr $value, string $argName): A
 
         $args = [new Arg($value, name: new Identifier($argName))];
 
-        return new Attribute(new FullyQualified(self::AUTOWIRE_CLASS), $args);
+        return new Attribute(new FullyQualified(SymfonyAttribute::AUTOWIRE), $args);
     }
 }

rules/Symfony63/Rector/Class_/ParamAndEnvAttributeRector.php

@@ -0,0 +1,160 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Symfony\Symfony63\Rector\Class_;
+
+use Nette\Utils\Strings;
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Scalar\String_;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\Rector\AbstractRector;
+use Rector\Symfony\Enum\SymfonyAttribute;
+use Rector\ValueObject\MethodName;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Symfony\Tests\Symfony63\Rector\Class_\ParamAndEnvAttributeRector\ParamAndEnvAttributeRectorTest
+ *
+ * @see https://symfony.com/blog/new-in-symfony-6-3-dependency-injection-improvements#new-options-for-autowire-attribute
+ */
+final class ParamAndEnvAttributeRector extends AbstractRector
+{
+    /**
+     * @var string
+     * @see https://regex101.com/r/7vwGbH/1
+     */
+    private const PARAMETER_REGEX = '#%(?<param>[\w\.]+)%$#';
+
+    /**
+     * @var string
+     * @see https://regex101.com/r/7xpVRP/1
+     */
+    private const ENV_REGEX = '#%env\((?<env>\w+)\)%$#';
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Make param/env use in #[Attribute] more precise',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+namespace App\Service;
+
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
+
+class MessageGenerator
+{
+    public function __construct(
+        #[Autowire('%kernel.debug%')]
+        bool $debugMode,
+
+        #[Autowire('%env(SOME_ENV_VAR)%')]
+        string $senderName,
+    ) {
+    }
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+namespace App\Service;
+
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
+
+class MessageGenerator
+{
+    public function __construct(
+        #[Autowire(param: 'kernel.debug')]
+        bool $debugMode,
+
+        #[Autowire(env: 'SOME_ENV_VAR')]
+        string $senderName,
+    ) {
+    }
+}
+CODE_SAMPLE
+                ),
+
+            ]
+        );
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [Class_::class];
+    }
+
+    /**
+     * @param Class_ $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        $classMethod = $node->getMethod(MethodName::CONSTRUCT);
+        if (! $classMethod instanceof ClassMethod) {
+            return null;
+        }
+
+        if ($classMethod->getParams() === []) {
+            return null;
+        }
+
+        $hasChanged = false;
+
+        foreach ($classMethod->params as $param) {
+            foreach ($param->attrGroups as $attrGroup) {
+                foreach ($attrGroup->attrs as $attribute) {
+                    if (! $this->isName($attribute->name, SymfonyAttribute::AUTOWIRE)) {
+                        continue;
+                    }
+
+                    foreach ($attribute->args as $attributeArg) {
+                        if ($this->isAlreadyEnvParamNamed($attributeArg)) {
+                            continue;
+                        }
+
+                        // we can handle only string values
+                        if (! $attributeArg->value instanceof String_) {
+                            continue;
+                        }
+
+                        $envMatch = Strings::match($attributeArg->value->value, self::ENV_REGEX);
+                        if (isset($envMatch['env'])) {
+                            $attributeArg->name = new Identifier('env');
+                            $attributeArg->value = new String_($envMatch['env']);
+
+                            $hasChanged = true;
+                            continue;
+                        }
+
+                        $paramMatch = Strings::match($attributeArg->value->value, self::PARAMETER_REGEX);
+                        if (isset($paramMatch['param'])) {
+                            $attributeArg->name = new Identifier('param');
+                            $attributeArg->value = new String_($paramMatch['param']);
+
+                            $hasChanged = true;
+                        }
+                    }
+                }
+            }
+        }
+
+        if ($hasChanged) {
+            return $node;
+        }
+
+        return null;
+    }
+
+    private function isAlreadyEnvParamNamed(Arg $arg): bool
+    {
+        if (! $arg->name instanceof Identifier) {
+            return false;
+        }
+
+        return in_array($arg->name->toString(), ['env', 'param'], true);
+    }
+}