feat: sflag parser support value validate

Author: inhere

README.md

@@ -33,9 +33,9 @@ $flags = ['--name', 'inhere', '--age', '99', '--tag', 'php', '-t', 'go', '--tag'
 
 $optRules = [
     'name', // string
-    'age'    => 'int,required', // set required
+    'age'   => 'int,required', // set required
     'tag,t' => FlagType::ARRAY,
-    'f'      => FlagType::BOOL,
+    'f'     => FlagType::BOOL,
 ];
 $argRules = [
     // some argument rules
@@ -140,10 +140,60 @@ $tags = $fs->getOption('tags'); // array{"php", "go", "java"}
 $arg0 = $fs->getArg(0); // string(arg0)
 // get an array arg
 $arrArg = $fs->getArg(1); // array{"arr0", "arr1"}
-// use name
+// get value by name
 $arrArg = $fs->getArg('arrArg'); // array{"arr0", "arr1"}
 ```
 
+### Flag Rule
+
+The options/arguments rules
+
+- string value is rule(`type,required,default,desc`).
+- array is define item `SFlags::DEFINE_ITEM`
+- supportted type see `FlagType::*`
+
+```php
+$rules = [
+     // v: only value, as name and use default type FlagType::STRING
+     // k-v: key is name, value can be string|array
+     'long,s',
+     // name => rule
+     'long,s' => 'int',
+     'f'      => 'bool',
+     'long'   => FlagType::STRING,
+     'tags'   => 'array', // can also: int[], string[]
+     'name'   => 'type,required,default,the description message', // with default, desc, required
+]
+```
+
+**For options**
+
+> TIP: name `long,s` - first is the option name. remaining is short names.
+
+**For arguments**
+
+- arguemnt no alias/shorts
+- array value only allow defined last
+
+**Definition item**
+
+The const `SFlags::DEFINE_ITEM`:
+
+```php
+    public const DEFINE_ITEM = [
+        'name'      => '',
+        'desc'      => '',
+        'type'      => FlagType::STRING,
+        // 'index'    => 0, // only for argument
+        'required'  => false,
+        'default'   => null,
+        'aliases'   => [], // only for option
+        // value validator
+        'validator' => null,
+        // 'category' => null
+    ];
+```
+
 ## License
 
 [MIT](LICENSE)

src/AbstractParser.php

@@ -24,23 +24,23 @@ abstract class AbstractParser implements ParserInterface
     protected $parsed = false;
 
     /**
-     * The raw input flags
+     * The input flags
      *
-     * @var array
+     * @var string[]
      */
-    protected $rawFlags = [];
+    protected $flags = [];
 
     /**
      * The remaining raw args, after option parsed from {@see $rawFlags}
      *
-     * @var array
+     * @var string[]
      */
     protected $rawArgs = [];
 
     /**
      * The required option names.
      *
-     * @var array
+     * @var string[]
      */
     protected $requiredOpts = [];
 
@@ -123,17 +123,17 @@ public function getRequiredOpts(): array
     /**
      * @return array
      */
-    public function getRawArgs(): array
+    public function getFlags(): array
     {
-        return $this->rawArgs;
+        return $this->flags;
     }
 
     /**
      * @return array
      */
-    public function getRawFlags(): array
+    public function getRawArgs(): array
     {
-        return $this->rawFlags;
+        return $this->rawArgs;
     }
 
     /**

src/Contract/ParserInterface.php

@@ -21,19 +21,19 @@ interface ParserInterface
     /**
      * @return array
      */
-    public function getRawFlags(): array;
+    public function getFlags(): array;
 
     /**
      * @return array
      */
     public function getRawArgs(): array;
 
     /**
-     * @param array $rawFlags
+     * @param array $flags
      *
      * @return AbstractParser|SFlags|Flags
      */
-    public function parse(array $rawFlags);
+    public function parse(array $flags);
 
     /**
      * Get an option value by name

src/Contract/ValidatorInterface.php

@@ -0,0 +1,22 @@
+<?php declare(strict_types=1);
+
+namespace Toolkit\PFlag\Contract;
+
+/**
+ * interface ValidatorInterface
+ */
+interface ValidatorInterface
+{
+    /**
+     * @param mixed  $value
+     * @param string $name
+     *
+     * @return bool
+     */
+    public function __invoke($value, string $name): bool;
+
+    /**
+     * @return string
+     */
+    public function __toString(): string;
+}

src/Exception/FlagException.php

@@ -9,13 +9,13 @@
 
 namespace Toolkit\PFlag\Exception;
 
-use RuntimeException;
+use InvalidArgumentException;
 
 /**
  * Class FlagException
  *
  * @package Toolkit\PFlag\Exception
  */
-class FlagException extends RuntimeException
+class FlagException extends InvalidArgumentException
 {
 }

src/Flag/AbstractFlag.php

@@ -53,6 +53,9 @@ abstract class AbstractFlag implements FlagInterface
      */
     protected $value;
 
+    // TODO category
+    // protected $category = '';
+
     /**
      * @var bool
      */

src/Flags.php

@@ -100,7 +100,7 @@ public function parse(array $args = null): self
         }
 
         $this->parsed  = true;
-        $this->rawArgs = $this->rawFlags = $args;
+        $this->rawArgs = $this->flags = $args;
 
         $breakStatus = self::STATUS_OK;
         while (true) {