[console] [7.3] Add support for default values in InvokableCommandInputAttributeRector (#841)

* add default value fixture

* add full fixture, avoid passign null or string as default values

* add support for default values in InvokableCommandInputAttributeRector

Author: TomasVotruba

rules-tests/Symfony73/Rector/Class_/InvokableCommandInputAttributeRector/Fixture/argument_with_default_value.php.inc

@@ -0,0 +1,56 @@
+<?php
+
+namespace Rector\Symfony\Tests\Symfony73\Rector\Class_\InvokableCommandInputAttributeRector\Fixture;
+
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+#[AsCommand(
+    name: 'app:hello',
+)]
+class ArgumentWithDefaultValue extends Command
+{
+    protected function configure(): void
+    {
+        $this->addArgument('first', InputArgument::OPTIONAL, null, 'optional value');
+        $this->addArgument('second', InputArgument::REQUIRED, null, 'required value');
+        $this->addOption('third', null, null, '', 'third value');
+    }
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Symfony\Tests\Symfony73\Rector\Class_\InvokableCommandInputAttributeRector\Fixture;
+
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+#[AsCommand(
+    name: 'app:hello',
+)]
+class ArgumentWithDefaultValue
+{
+    public function __invoke(
+        #[\Symfony\Component\Console\Attribute\Argument(name: 'first')]
+        ?string $first = 'optional value',
+        #[\Symfony\Component\Console\Attribute\Argument(name: 'second')]
+        string $second = 'required value',
+        #[\Symfony\Component\Console\Attribute\Option(name: 'third')]
+        $third = 'third value'
+    ): int
+    {
+    }
+}
+
+?>

rules/Symfony73/NodeAnalyzer/CommandArgumentsResolver.php

@@ -35,6 +35,7 @@ public function resolve(ClassMethod $configureClassMethod): array
                 $addArgumentArgs[0]->value,
                 $addArgumentArgs[1]->value ?? null,
                 $addArgumentArgs[2]->value ?? null,
+                $addArgumentArgs[3]->value ?? null,
             );
         }
 

rules/Symfony73/NodeAnalyzer/CommandOptionsResolver.php

@@ -36,7 +36,8 @@ public function resolve(ClassMethod $configureClassMethod): array
                 $addOptionArgs[0]->value,
                 $addOptionArgs[1]->value ?? null,
                 $addOptionArgs[2]->value ?? null,
-                $addOptionArgs[3]->value ?? null
+                $addOptionArgs[3]->value ?? null,
+                $addOptionArgs[4]->value ?? null
             );
         }
 

rules/Symfony73/NodeFactory/CommandInvokeParamsFactory.php

@@ -49,22 +49,21 @@ private function createArgumentParams(array $commandArguments): array
         foreach ($commandArguments as $commandArgument) {
             $variableName = $this->createCamelCase($commandArgument->getNameValue());
             $argumentParam = new Param(new Variable($variableName));
-
             $argumentParam->type = new Identifier('string');
 
-            // is argument optional?
-            if ($commandArgument->getMode() === null) {
-                $argumentParam->type = new NullableType($argumentParam->type);
-            } elseif ($this->valueResolver->isValue($commandArgument->getMode(), 2)) {
+            if ($commandArgument->getDefault() instanceof Expr) {
+                $argumentParam->default = $commandArgument->getDefault();
+            }
+
+            if ($this->isOptionalArgument($commandArgument)) {
                 $argumentParam->type = new NullableType($argumentParam->type);
             }
 
-            // @todo fill type or default value
             // @todo default string, multiple values array
 
             $argumentArgs = [new Arg(value: $commandArgument->getName(), name: new Identifier('name'))];
 
-            if ($commandArgument->getDescription() instanceof Expr) {
+            if ($this->hasUsefulDescription($commandArgument)) {
                 $argumentArgs[] = new Arg(value: $commandArgument->getDescription(), name: new Identifier(
                     'description'
                 ));
@@ -92,17 +91,25 @@ private function createOptionParams(array $commandOptions): array
             $variableName = $this->createCamelCase($commandOption->getNameValue());
             $optionParam = new Param(new Variable($variableName));
 
+            if ($commandOption->getDefault() instanceof Expr) {
+                $optionParam->default = $commandOption->getDefault();
+            }
+
             $optionArgs = [new Arg(value: $commandOption->getName(), name: new Identifier('name'))];
 
-            if ($commandOption->getShortcut() instanceof Expr) {
+            if ($commandOption->getShortcut() instanceof Expr && ! $this->valueResolver->isNull(
+                $commandOption->getShortcut()
+            )) {
                 $optionArgs[] = new Arg(value: $commandOption->getShortcut(), name: new Identifier('shortcut'));
             }
 
-            if ($commandOption->getMode() instanceof Expr) {
+            if ($commandOption->getMode() instanceof Expr && ! $this->valueResolver->isNull(
+                $commandOption->getMode()
+            )) {
                 $optionArgs[] = new Arg(value: $commandOption->getMode(), name: new Identifier('mode'));
             }
 
-            if ($commandOption->getDescription() instanceof Expr) {
+            if ($this->hasUsefulDescription($commandOption)) {
                 $optionArgs[] = new Arg(value: $commandOption->getDescription(), name: new Identifier('description'));
             }
 
@@ -127,4 +134,27 @@ private function createCamelCase(string $value): string
         // Lowercase first character to make it camelCase
         return lcfirst($value);
     }
+
+    private function hasUsefulDescription(CommandArgument|CommandOption $commandArgumentOrOption): bool
+    {
+        if (! $commandArgumentOrOption->getDescription() instanceof Expr) {
+            return false;
+        }
+
+        $expr = $commandArgumentOrOption->getDescription();
+        if ($this->valueResolver->isNull($expr)) {
+            return false;
+        }
+
+        return ! $this->valueResolver->isValue($expr, '');
+    }
+
+    private function isOptionalArgument(CommandArgument $commandArgument): bool
+    {
+        if (! $commandArgument->getMode() instanceof Expr) {
+            return true;
+        }
+
+        return $this->valueResolver->isValue($commandArgument->getMode(), 2);
+    }
 }

rules/Symfony73/ValueObject/CommandArgument.php

@@ -12,7 +12,8 @@ public function __construct(
         private string $nameValue,
         private Expr $name,
         private ?Expr $mode,
-        private ?Expr $description
+        private ?Expr $description,
+        private ?Expr $default,
     ) {
     }
 
@@ -35,4 +36,9 @@ public function getDescription(): ?Expr
     {
         return $this->description;
     }
+
+    public function getDefault(): ?Expr
+    {
+        return $this->default;
+    }
 }

rules/Symfony73/ValueObject/CommandOption.php

@@ -14,6 +14,7 @@ public function __construct(
         private ?Expr $shortcut,
         private ?Expr $mode,
         private ?Expr $description,
+        private ?Expr $default,
     ) {
     }
 
@@ -41,4 +42,9 @@ public function getNameValue(): string
     {
         return $this->nameValue;
     }
+
+    public function getDefault(): ?Expr
+    {
+        return $this->default;
+    }
 }