feat: add static factory methods for options and arguments

Author: phpdevcommunity

.gitignore

@@ -1,2 +1,3 @@
 /vendor/
-/.idea
+/.idea
+composer.lock

composer.json

@@ -11,7 +11,8 @@
   "require": {
     "php": ">=7.4",
     "ext-mbstring": "*",
-    "ext-json": "*"
+    "ext-json": "*",
+    "ext-ctype": "*"
   },
   "require-dev": {
     "phpdevcommunity/unitester": "^0.1.0@alpha"

src/Argument/CommandArgument.php

@@ -9,9 +9,20 @@ final class CommandArgument
     private $defaultValue;
     private ?string $description;
 
-    public function __construct(string $name, bool $isRequired = false, $defaultValue = null, ?string $description = null)
+    public  function __construct(string $name, bool $isRequired = false, $defaultValue = null, ?string $description = null)
     {
-        $this->name = $name;
+        if ($name === '') {
+            throw new \InvalidArgumentException("Option name cannot be empty.");
+        }
+        if (!ctype_alpha($name)) {
+            throw new \InvalidArgumentException("Option name must contain only letters. '$name' is invalid.");
+        }
+
+        if ($isRequired && $defaultValue !== null) {
+            throw new \LogicException("Argument '$name' cannot be required and have a default value.");
+        }
+
+        $this->name = strtolower($name);
         $this->isRequired = $isRequired;
         $this->defaultValue = $defaultValue;
         $this->description = $description;
@@ -47,4 +58,13 @@ public function getDescription(): ?string
         return $this->description;
     }
 
+    public static function required(string $name, ?string $description = null): self
+    {
+        return new self($name, true, null, $description);
+    }
+
+    public static function optional(string $name, $default = null, ?string $description = null): self
+    {
+        return new self($name, false, $default, $description);
+    }
 }

src/CommandRunner.php

@@ -140,14 +140,14 @@ private function execute(CommandInterface $command, CommandParser $commandParser
 
         $arguments = $command->getArguments();
         foreach ($arguments as $key => $argument) {
-            $key = strval($key);
-            if ($argument->isRequired() && empty($commandParser->getArgumentValue($key))) {
+            $key = $argument->getName();
+            if ($argument->isRequired() && (!$commandParser->hasArgument($key) || empty($commandParser->getArgumentValue($key)))) {
                 throw new InvalidArgumentException(sprintf('Argument "%s" is required for command "%s".', $argument->getName(), $command->getName()));
             }
             if ($commandParser->hasArgument($key)) {
-                $argv["--{$argument->getName()}"] = $commandParser->getArgumentValue($key);
+                $argv["--{$key}"] = $commandParser->getArgumentValue($key);
             }else {
-                $argv["--{$argument->getName()}"] = $argument->getDefaultValue();
+                $argv["--{$key}"] = $argument->getDefaultValue();
             }
         }
 

src/Input.php

@@ -49,7 +49,7 @@ public function getOptionValue(string $name)
         }
 
         if (!$this->hasOption($name)) {
-            throw new \InvalidArgumentException(sprintf('Option "%s" is not defined.', $name));
+            return null;
         }
         return $this->options[$name];
     }

src/Option/CommandOption.php

@@ -10,13 +10,29 @@ final class CommandOption
     private bool $isFlag;
 
     public function __construct(
-        string $name,
+        string  $name,
         ?string $shortcut = null,
         ?string $description = null,
-        bool $isFlag = false
-    ) {
-        $this->name = $name;
-        $this->shortcut = $shortcut;
+        bool    $isFlag = false
+    )
+    {
+
+        if ($name === '') {
+            throw new \InvalidArgumentException("Option name cannot be empty.");
+        }
+
+        foreach (explode('-', $name) as $part) {
+            if ($part === '' || !ctype_alpha($part)) {
+                throw new \InvalidArgumentException("Option name must contain only letters and dashes. '$name' is invalid.");
+            }
+        }
+
+        if ($shortcut !== null && (strlen($shortcut) !== 1 || !ctype_alpha($shortcut))) {
+            throw new \InvalidArgumentException('Shortcut must be a single character and contain only letters. "' . $shortcut . '" is invalid.');
+        }
+
+        $this->name = strtolower($name);
+        $this->shortcut = $shortcut !== null ? strtolower($shortcut) : null;
         $this->description = $description;
         $this->isFlag = $isFlag;
     }
@@ -40,4 +56,11 @@ public function isFlag(): bool
     {
         return $this->isFlag;
     }
+
+    public static function flag(string $name, ?string $shortcut = null, ?string $description = null): self {
+        return new self($name, $shortcut, $description, true);
+    }
+    public static function withValue(string $name, ?string $shortcut = null, ?string $description = null): self {
+        return new self($name, $shortcut, $description, false);
+    }
 }

src/Output/ConsoleOutput.php

@@ -111,6 +111,8 @@ public function listKeyValues(array $items, bool $inlined = false): void
         }
 
         foreach ($items as $key => $value) {
+            $value = $this->variableToString($value);
+            $value = implode(' ', explode(PHP_EOL, $value));
             $key = str_pad($key, $maxKeyLength, ' ', STR_PAD_RIGHT);
             $this->writeColor($key, 'green');
             $this->write(' : ');