feat: refacting the arg rule parse logic

Author: inhere

src/AbstractParser.php

@@ -23,6 +23,13 @@ abstract class AbstractParser implements ParserInterface
      */
     protected $parsed = false;
 
+    /**
+     * The usage description
+     *
+     * @var string
+     */
+    protected $desc = '';
+
     /**
      * The input flags
      *
@@ -75,6 +82,11 @@ abstract class AbstractParser implements ParserInterface
 
     protected $ignoreUnknown = false;
 
+    /**
+     * @var callable
+     */
+    protected $helpRenderer;
+
     /**
      * Class constructor.
      *
@@ -86,14 +98,16 @@ public function __construct(array $config = [])
     }
 
     /**
+     * @param array $rawArgs
+     *
      * @return array
      */
-    protected function parseRawArgs(): array
+    protected function parseRawArgs(array $rawArgs): array
     {
         $args = [];
 
         // parse arguments
-        foreach ($this->rawArgs as $arg) {
+        foreach ($rawArgs as $arg) {
             // value specified inline (<arg>=<value>)
             if (strpos($arg, '=') > 0) {
                 [$name, $value] = explode('=', $arg, 2);
@@ -112,6 +126,22 @@ protected function parseRawArgs(): array
         return $args;
     }
 
+    /**
+     * @return callable
+     */
+    public function getHelpRenderer(): callable
+    {
+        return $this->helpRenderer;
+    }
+
+    /**
+     * @param callable $helpRenderer
+     */
+    public function setHelpRenderer(callable $helpRenderer): void
+    {
+        $this->helpRenderer = $helpRenderer;
+    }
+
     /**
      * @return array
      */
@@ -120,6 +150,22 @@ public function getRequiredOpts(): array
         return $this->requiredOpts;
     }
 
+    /**
+     * @return string
+     */
+    public function getDesc(): string
+    {
+        return $this->desc;
+    }
+
+    /**
+     * @param string $desc
+     */
+    public function setDesc(string $desc): void
+    {
+        $this->desc = $desc;
+    }
+
     /**
      * @return array
      */

src/Contract/FlagInterface.php

@@ -34,9 +34,11 @@ public function getName(): string;
     public function getHelpName(): string;
 
     /**
+     * @param bool $forHelp
+     *
      * @return string
      */
-    public function getDesc(): string;
+    public function getDesc(bool $forHelp = false): string;
 
     /**
      * Get the flag value

src/Flag/AbstractFlag.php

@@ -14,6 +14,8 @@
 use Toolkit\PFlag\Contract\ValidatorInterface;
 use Toolkit\PFlag\Exception\FlagException;
 use Toolkit\PFlag\FlagType;
+use Toolkit\Stdlib\Obj;
+use Toolkit\Stdlib\Str;
 use function is_array;
 use function is_bool;
 
@@ -26,11 +28,15 @@
 abstract class AbstractFlag implements FlagInterface
 {
     /**
+     * Flag name
+     *
      * @var string
      */
-    protected $name;
+    protected $name = '';
 
     /**
+     * Flag description
+     *
      * @var string
      */
     protected $desc = '';
@@ -91,6 +97,20 @@ public static function new(
         return new static($name, $desc, $type, $required, $default);
     }
 
+    /**
+     * @param string $name
+     * @param array  $config
+     *
+     * @return static|Argument|Option
+     */
+    public static function newByArray(string $name, array $config): self
+    {
+        $flag = new static($name);
+        Obj::init($flag,$config);
+
+        return $flag;
+    }
+
     /**
      * Class constructor.
      *
@@ -262,14 +282,6 @@ public function setDefault($default): void
         $this->default = $default;
     }
 
-    /**
-     * @return string
-     */
-    public function getDesc(): string
-    {
-        return $this->desc;
-    }
-
     /**
      * @param string $desc
      */

src/Flag/Argument.php

@@ -9,6 +9,7 @@
 
 namespace Toolkit\PFlag\Flag;
 
+use Toolkit\Stdlib\Str;
 use function sprintf;
 
 /**
@@ -47,12 +48,27 @@ public function getNameMark(): string
         return sprintf('#%d%s', $this->index, $mark);
     }
 
+    /**
+     * @param bool $forHelp
+     *
+     * @return string
+     */
+    public function getDesc(bool $forHelp = false): string
+    {
+        $desc = $this->desc;
+        if ($forHelp) {
+            $desc = $desc ? Str::ucfirst($desc) : 'Argument ' . $this->index;
+        }
+
+        return $desc;
+    }
+
     /**
      * @return string
      */
     public function getHelpName(): string
     {
-        return $this->name ?: 'ARG' . $this->index;
+        return $this->name ?: 'arg' . $this->index;
     }
 
     /**

src/Flag/Option.php

@@ -12,6 +12,7 @@
 use Toolkit\Cli\Helper\FlagHelper;
 use Toolkit\PFlag\Exception\FlagException;
 use Toolkit\PFlag\FlagType;
+use Toolkit\Stdlib\Str;
 use function array_filter;
 use function array_map;
 use function array_unshift;
@@ -120,22 +121,37 @@ public function setShorts(array $shorts): void
         }
     }
 
+    /**
+     * @param bool $forHelp
+     *
+     * @return string
+     */
+    public function getDesc(bool $forHelp = false): string
+    {
+        $desc = $this->desc;
+        if ($forHelp) {
+            $desc = $desc ? Str::ucfirst($desc) : 'Option ' . $this->name;
+        }
+
+        return $desc;
+    }
+
     /**
      * @return string
      */
     public function getHelpName(): string
     {
-        $names = [];
+        $longs = [];
         if ($this->alias) {
-            $names[] = $this->alias;
+            $longs[] = $this->alias;
         }
 
-        $names[] = $this->name;
+        $longs[] = $this->name;
 
         // prepend '--'
         $nodes = array_map(static function (string $name) {
             return (strlen($name) > 1 ? '--' : '-') . $name;
-        }, $names);
+        }, $longs);
 
         if ($this->shortcut) {
             array_unshift($nodes, $this->shortcut);

src/FlagUtil.php

@@ -0,0 +1,38 @@
+<?php declare(strict_types=1);
+
+namespace Toolkit\PFlag;
+
+use function array_map;
+use function implode;
+use function strlen;
+
+/**
+ * class FlagUtil
+ */
+class FlagUtil
+{
+    /**
+     * @param array $names
+     *
+     * @return string
+     */
+    public static function buildOptHelpName(array $names): string
+    {
+        $nodes = array_map(static function (string $name) {
+            return (strlen($name) > 1 ? '--' : '-') . $name;
+        }, $names);
+
+        return implode(', ', $nodes);
+    }
+
+    /**
+     * @param int $val1
+     * @param int $val2
+     *
+     * @return int
+     */
+    public static function getMaxInt(int $val1, int $val2): int
+    {
+        return $val1 > $val2 ? $val1 : $val2;
+    }
+}

src/Flags.php

@@ -36,11 +36,6 @@ class Flags extends AbstractParser
      */
     private static $std;
 
-    /**
-     * @var callable
-     */
-    private $helpRenderer;
-
     /**
      * @var bool
      */
@@ -270,7 +265,7 @@ public function reset(bool $clearDefined = false): void
     public function bindingArguments(): self
     {
         // parse arguments
-        $args = $this->parseRawArgs();
+        $args = $this->parseRawArgs($this->rawArgs);
 
         // collect argument values
         foreach ($this->arguments as $index => $arg) {
@@ -294,22 +289,6 @@ public function bindingArguments(): self
         return $this;
     }
 
-    /**
-     * @return callable
-     */
-    public function getHelpRenderer(): callable
-    {
-        return $this->helpRenderer;
-    }
-
-    /**
-     * @param callable $helpRenderer
-     */
-    public function setHelpRenderer(callable $helpRenderer): void
-    {
-        $this->helpRenderer = $helpRenderer;
-    }
-
     /**
      * @return bool
      */