feat: Add support for default option values

Author: phpdevcommunity

src/CommandParser.php

@@ -15,7 +15,7 @@ final class CommandParser
     private array $options = [];
     private array $arguments = [];
 
-    public function __construct(array $argv = null)
+    public function __construct(?array $argv = null)
     {
         $argv = $argv ?? $_SERVER['argv'] ?? [];
         array_shift($argv);

src/CommandRunner.php

@@ -23,10 +23,7 @@ final class CommandRunner
      */
     private array $commands = [];
 
-    /**
-     * @var CommandInterface
-     */
-    private CommandInterface $defaultCommand;
+    private HelpCommand $defaultCommand;
 
     /**
      * Application constructor.
@@ -117,10 +114,12 @@ private function execute(CommandInterface $command, CommandParser $commandParser
             }
         }
 
-        $options[] = new CommandOption('verbose', 'v', 'Enable verbose output', true);
+        $options[] = CommandOption::flag('verbose', 'v', 'Enable verbose output');
         foreach ($options as $option) {
             if ($option->isFlag()) {
                 $argvOptions["--{$option->getName()}"] = false;
+            }elseif ($option->getDefaultValue() !== null) {
+                $argvOptions["--{$option->getName()}"] = $option->getDefaultValue();
             }
         }
         foreach ($commandParser->getOptions() as $name => $value) {
@@ -203,6 +202,10 @@ private function showCommandHelp(CommandInterface $selectedCommand, OutputInterf
             if (!$option->isFlag()) {
                 $name = sprintf('%s=VALUE', $name);
             }
+            if ($option->getDefaultValue() !== null) {
+                $name = sprintf('%s (default: %s)', $name, $option->getDefaultValue());
+            }
+
             $options[$name] = $option->getDescription();
         }
         $consoleOutput->listKeyValues($options, true);

src/Option/CommandOption.php

@@ -9,11 +9,17 @@ final class CommandOption
     private ?string $description;
     private bool $isFlag;
 
+    /**
+     * @var bool|float|int|string
+     */
+    private $default = null;
+
     public function __construct(
         string  $name,
         ?string $shortcut = null,
         ?string $description = null,
-        bool    $isFlag = false
+        bool    $isFlag = false,
+        $default = null
     )
     {
 
@@ -31,10 +37,20 @@ public function __construct(
             throw new \InvalidArgumentException('Shortcut must be a single character and contain only letters. "' . $shortcut . '" is invalid.');
         }
 
+        if (!is_null($default) && !is_scalar($default)) {
+            throw new \InvalidArgumentException(
+                sprintf(
+                    'Invalid default value: expected a scalar (int, float, string, or bool), got "%s".',
+                    gettype($default)
+                )
+            );
+        }
+
         $this->name = strtolower($name);
         $this->shortcut = $shortcut !== null ? strtolower($shortcut) : null;
         $this->description = $description;
         $this->isFlag = $isFlag;
+        $this->default = $default;
     }
 
     public function getName(): string
@@ -57,11 +73,17 @@ public function isFlag(): bool
         return $this->isFlag;
     }
 
+    public function getDefaultValue()
+    {
+        return $this->default;
+    }
+
     public static function flag(string $name, ?string $shortcut = null, ?string $description = null): self {
-        return new self($name, $shortcut, $description, true);
+        return new self($name, $shortcut, $description, true, false);
     }
 
-    public static function withValue(string $name, ?string $shortcut = null, ?string $description = null): self {
-        return new self($name, $shortcut, $description, false);
+    public static function withValue(string $name, ?string $shortcut = null, ?string $description = null, $default = null): self {
+        return new self($name, $shortcut, $description, false, $default);
     }
-}
+
+}

tests/Command/UserListCommand.php

@@ -4,6 +4,7 @@
 
 use PhpDevCommunity\Console\Command\CommandInterface;
 use PhpDevCommunity\Console\InputInterface;
+use PhpDevCommunity\Console\Option\CommandOption;
 use PhpDevCommunity\Console\OutputInterface;
 
 class UserListCommand implements CommandInterface
@@ -21,6 +22,7 @@ public function getDescription(): string
     public function getOptions(): array
     {
         return [
+            CommandOption::withValue('limit', 'l', 'Limit the number of results', 100),
         ];
     }
 
@@ -33,5 +35,6 @@ public function getArguments(): array
     public function execute(InputInterface $input, OutputInterface $output): void
     {
         $output->write('Test OK : User list');
+        $output->write(sprintf('LIMIT : %d', $input->getOptionValue('limit')));
     }
 }

tests/CommandRunnerTest.php

@@ -53,6 +53,25 @@ protected function execute(): void
         $this->assertStringContains( $message, 'Execution time:');
         $this->assertStringContains( $message, 'Peak memory usage:');
         $this->assertEquals(0, $exitCode);
+
+
+        $messages = [];
+        $exitCode = $this->commandRunner->run(new CommandParser(self::createArgv(['app:user:list'])), new Output(function ($message) use(&$messages){
+                $messages[] = $message;
+            })
+        );
+        $this->assertEquals(0, $exitCode);
+        $this->assertEquals('Test OK : User list', $messages[0]);
+        $this->assertEquals('LIMIT : 100', $messages[1]);
+
+        $messages = [];
+        $exitCode = $this->commandRunner->run(new CommandParser(self::createArgv(['app:user:list', '-l', '1000'])), new Output(function ($message) use(&$messages){
+                $messages[] = $message;
+            })
+        );
+        $this->assertEquals(0, $exitCode);
+        $this->assertEquals('Test OK : User list', $messages[0]);
+        $this->assertEquals('LIMIT : 1000', $messages[1]);
     }
 
     private static function createArgv(array $argv): array