update some logic, add more tests

Author: inhere

README.md

@@ -168,6 +168,8 @@ $rules = [
 
 **For options**
 
+- option allow set alias/shorts
+
 > TIP: name `long,s` - first is the option name. remaining is short names.
 
 **For arguments**
@@ -187,13 +189,19 @@ The const `SFlags::DEFINE_ITEM`:
         // 'index'    => 0, // only for argument
         'required'  => false,
         'default'   => null,
-        'aliases'   => [], // only for option
+        'shorts'    => [], // only for option
         // value validator
         'validator' => null,
         // 'category' => null
     ];
 ```
 
+## Unit tests
+
+```bash
+phpunit
+```
+
 ## License
 
 [MIT](LICENSE)

src/Contract/FlagInterface.php

@@ -28,6 +28,11 @@ public function getType(): string;
      */
     public function getName(): string;
 
+    /**
+     * @return string
+     */
+    public function getHelpName(): string;
+
     /**
      * @return string
      */

src/Contract/ValidatorInterface.php

@@ -8,12 +8,21 @@
 interface ValidatorInterface
 {
     /**
+     * Validate input value
+     * - you can throw FlagException on fail
+     *
+     * Returns:
+     * - bool `False` mark fail
+     * - array [bool, value]
+     *    - bool `False` mark fail
+     *    - value filtered new value
+     *
      * @param mixed  $value
      * @param string $name
      *
-     * @return bool
+     * @return bool|array
      */
-    public function __invoke($value, string $name): bool;
+    public function __invoke($value, string $name);
 
     /**
      * @return string

src/Flag/AbstractFlag.php

@@ -11,8 +11,11 @@
 
 use Toolkit\Cli\Helper\FlagHelper;
 use Toolkit\PFlag\Contract\FlagInterface;
+use Toolkit\PFlag\Contract\ValidatorInterface;
 use Toolkit\PFlag\Exception\FlagException;
 use Toolkit\PFlag\FlagType;
+use function is_array;
+use function is_bool;
 
 /**
  * Class Flag
@@ -63,9 +66,9 @@ abstract class AbstractFlag implements FlagInterface
 
     /**
      * The flag value validator
-     * - if validate fail, please throw FlagException
+     * - if validate fail, please return for OR throw FlagException
      *
-     * @var callable
+     * @var callable|ValidatorInterface
      */
     protected $validator;
 
@@ -142,10 +145,12 @@ public function setValue($value): void
         // has validator
         if ($cb = $this->validator) {
             $ok  = true;
-            $ret = $cb($value);
+            $ret = $cb($value, $this->name);
 
-            if ($ret) {
+            if (is_array($ret)) {
                 [$ok, $value] = $ret;
+            } elseif (is_bool($ret)) {
+                $ok = $ret;
             }
 
             if (false === $ok) {
@@ -184,10 +189,6 @@ public function hasDefault(): bool
         return $this->default !== null;
     }
 
-    /******************************************************************
-     *
-     *****************************************************************/
-
     /**
      * @return string
      */
@@ -196,6 +197,10 @@ public function getNameMark(): string
         return $this->name;
     }
 
+    /******************************************************************
+     * getter/setter methods
+     *****************************************************************/
+
     /**
      * @return string
      */

src/Flag/Argument.php

@@ -47,6 +47,14 @@ public function getNameMark(): string
         return sprintf('#%d%s', $this->index, $mark);
     }
 
+    /**
+     * @return string
+     */
+    public function getHelpName(): string
+    {
+        return $this->name ?: 'ARG' . $this->index;
+    }
+
     /**
      * @return int
      */

src/Flag/Option.php

@@ -10,7 +10,10 @@
 namespace Toolkit\PFlag\Flag;
 
 use Toolkit\PFlag\FlagType;
+use function array_filter;
 use function implode;
+use function rtrim;
+use function trim;
 
 /**
  * Class Option
@@ -62,6 +65,10 @@ public function getAlias(): string
      */
     public function setAlias(string $alias): void
     {
+        if ($alias = trim($alias)) {
+
+        }
+
         $this->alias = $alias;
     }
 
@@ -74,14 +81,13 @@ public function getShortcut(): string
     }
 
     /**
-     * @param string $shortcut eg: 'a,b' Or '-a,-b'
+     * @param string $shortcut eg: 'a,b' Or '-a,-b' Or '-a, -b'
      */
     public function setShortcut(string $shortcut): void
     {
-        $shortcuts = preg_split('{(,)-?}', ltrim($shortcut, '-'));
-        $shortcuts = array_filter($shortcuts);
+        $shortcuts = preg_split('{,\s?-?}', ltrim($shortcut, '-'));
 
-        $this->setShorts($shortcuts);
+        $this->setShorts(array_filter($shortcuts));
     }
 
     /**
@@ -98,6 +104,35 @@ public function getShorts(): array
     public function setShorts(array $shorts): void
     {
         $this->shorts   = $shorts;
-        $this->shortcut = implode('|', $shorts);
+        $this->shortcut = '-' . rtrim(implode(', -', $shorts));
+    }
+
+    /**
+     * @return string
+     */
+    public function getHelpName(): string
+    {
+        $shorts = $this->shortcut;
+
+        $names = [];
+        if ($this->alias) {
+            $names[] = $this->alias;
+        }
+
+        $names[] = $this->name;
+
+        return '-' . rtrim(implode(', -', $shorts));
+    }
+
+    /**
+     * @return array
+     */
+    public function toArray(): array
+    {
+        $info = parent::toArray();
+
+        $info['alias']  = $this->alias;
+        $info['shorts'] = $this->shorts;
+        return $info;
     }
 }

src/SFlags.php

@@ -50,7 +50,7 @@ class SFlags extends AbstractParser
         // 'index'    => 0, // only for argument
         'required'  => false,
         'default'   => null,
-        'aliases'   => [], // only for option
+        'shorts'    => [], // only for option. ['a', 'b']
         // value validator
         'validator' => null,
         // 'category' => null
@@ -75,7 +75,7 @@ class SFlags extends AbstractParser
      *  //  - array is define item self::DEFINE_ITEM
      *  'long,s',
      *  // name => rule
-     *  // TIP: name 'long,s' - first is the option name. remaining is aliases.
+     *  // TIP: name 'long,s' - first is the option name. remaining is shorts.
      *  'long,s' => int,
      *  'f'      => bool,
      *  'long'   => string,
@@ -499,25 +499,43 @@ public function parseDefinedArgs(array $argRules): void
 
             // collect value
             if ($isArray) {
-                $this->args[$index] = array_slice($args, $index); // remain args
+                $arrValues = array_slice($args, $index); // remain args
+                foreach ($arrValues as $arrValue) {
+                    $this->collectArgValue($arrValue, $index, true, $define);
+                }
             } else {
                 $value = $args[$index];
-
-                // has validator
-                if ($cb = $define['validator']) {
-                    $ok = $cb($value, $name ?: "#$index");
-                    if ($ok === false) {
-                        throw new FlagException("flag argument '$name' value not pass validate");
-                    }
-                }
-
-                $this->args[$index] = $value;
+                $this->collectArgValue($value, $index, false, $define);
             }
 
             $index++;
         }
     }
 
+    /**
+     * @param mixed $value
+     * @param int   $index
+     * @param bool  $isArray
+     * @param array $define
+     */
+    protected function collectArgValue($value, int $index, bool $isArray, array $define): void
+    {
+        // has validator
+        if ($cb = $define['validator']) {
+            $name = $define['name'] ?: "#$index";
+
+            $ok = $cb($value, $define['name'] ?: "#$index");
+            if ($ok === false) {
+                throw new FlagException("flag argument '$name' value not pass validate");
+            }
+        }
+
+        if ($isArray) {
+            $this->args[$index][] = $value;
+        } else {
+            $this->args[$index] = $value;
+        }
+    }
 
     /**
      * @param int          $index
@@ -588,11 +606,11 @@ protected function parseOptRules(array $rules): void
     }
 
     /**
-     * Parse option name and aliases
+     * Parse option name and shorts
      *
      * @param string $key 'lang,s' => option name is 'lang', alias 's'
      *
-     * @return array [name, aliases]
+     * @return array [name, shorts]
      */
     protected function parseRuleOptName(string $key): array
     {
@@ -609,18 +627,18 @@ protected function parseRuleOptName(string $key): array
         $name = '';
         $keys = Str::explode($key, ',');
 
-        // TIP: first is the option name. remaining is aliases.
-        $aliases = [];
+        // TIP: first is the option name. remaining is shorts.
+        $shorts = [];
         foreach ($keys as $i => $k) {
             if ($i === 0) {
                 $name = $k;
             } else {
-                $aliases[] = $k;
+                $shorts[] = $k;
                 $this->setAlias($name, $k, true);
             }
         }
 
-        return [$name, $aliases];
+        return [$name, $shorts];
     }
 
     /**
@@ -651,11 +669,11 @@ protected function parseRuleOptName(string $key): array
      */
     protected function parseRule($rule, string $name = '', int $index = 0, bool $isOption = true): array
     {
-        $aliasesFromArr = [];
+        $shortsFromArr = [];
         if (is_array($rule)) {
             $item = Arr::replace(self::DEFINE_ITEM, $rule);
             // set alias by array item
-            $aliasesFromArr = $item['aliases'];
+            $shortsFromArr = $item['shorts'];
         } else { // parse string rule.
             $item = self::DEFINE_ITEM;
             $rule = trim((string)$rule, self::TRIM_CHARS);
@@ -683,10 +701,10 @@ protected function parseRule($rule, string $name = '', int $index = 0, bool $isO
         $name = $name ?: $item['name'];
         if ($isOption) {
             // parse option name.
-            [$name, $aliases] = $this->parseRuleOptName($name);
+            [$name, $shorts] = $this->parseRuleOptName($name);
 
             // save alias
-            $item['aliases'] = $aliases ?: $aliasesFromArr;
+            $item['shorts'] = $shorts ?: $shortsFromArr;
             if ($item['required']) {
                 $this->requiredOpts[] = $name;
             }
@@ -832,7 +850,6 @@ public function getArgs(): array
      ***************************************************************/
 
 
-
     /**
      * @return array
      */