up: add more tests for flags add

Author: inhere

.github/workflows/php.yml

@@ -55,7 +55,7 @@ jobs:
 
       - name: Run test suite
         run: |
-          phpunit -v
+          phpunit -v --debug
           php example flags-demo.php
           php example sflags-demo.php
 

README.md

@@ -77,11 +77,13 @@ $fs->addOpt('age', 'a', 'this is a int option', FlagType::INT);
 
 // - use string rule
 $fs->addOptByRule('name,n', 'string;this is a string option;true');
+
 // -- add multi option at once.
 $fs->addOptsByRules([
     'tag,t' => 'strings;array option, allow set multi times',
     'f'     => 'bool;this is an bool option',
 ]);
+
 // - use array rule
 /** @see Flags::DEFINE_ITEM for array rule */
 $fs->addOptByRule('name-is-very-lang', [
@@ -375,7 +377,13 @@ public const DEFINE_ITEM = [
 ## Unit tests
 
 ```bash
-phpunit
+phpunit --debug
+```
+
+test with coverage:
+
+```bash
+phpdbg -qrr $(which phpunit) --coverage-text
 ```
 
 ## License

composer.json

@@ -27,6 +27,6 @@
     }
   },
   "scripts": {
-    "test": "php vender/bin/phpunit"
+    "test": "php vender/bin/phpunit -v --debug"
   }
 }

phpunit.xml

@@ -1,17 +1,24 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" backupStaticAttributes="false"
-         bootstrap="test/bootstrap.php" colors="false" convertErrorsToExceptions="true" convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         colors="true"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="test/bootstrap.php"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         stopOnFailure="false"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
 
     <testsuites>
         <testsuite name="Library Test Suite">
             <directory>test/</directory>
         </testsuite>
     </testsuites>
 
-    <filter>
-        <whitelist>
-            <directory suffix=".php">app</directory>
-        </whitelist>
-    </filter>
+    <coverage>
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
 </phpunit>

src/Contract/FlagInterface.php

@@ -66,4 +66,9 @@ public function isRequired(): bool;
      * @return bool
      */
     public function isOptional(): bool;
+
+    /**
+     * @return string
+     */
+    public function getKind(): string;
 }

src/Contract/ParserInterface.php

@@ -14,6 +14,9 @@
  */
 interface ParserInterface
 {
+    public const KIND_OPT = 'option';
+    public const KIND_ARG = 'argument';
+
     /**
      * @return array
      * @psalm-return list<string>
@@ -36,6 +39,11 @@ public function isEmpty(): bool;
      */
     public function isNotEmpty(): bool;
 
+    /**
+     * @return bool
+     */
+    public function hasShortOpts(): bool;
+
     /**
      * Add option
      *

src/Exception/FlagParseException.php

@@ -3,6 +3,7 @@
 namespace Toolkit\PFlag\Exception;
 
 use Throwable;
+use Toolkit\PFlag\FlagsParser;
 
 /**
  * class FlagParseException
@@ -12,9 +13,9 @@ class FlagParseException extends FlagException
     /**
      * @var string
      */
-    public $flagType = 'option';
+    public $flagType = FlagsParser::KIND_OPT;
 
-    public function __construct(string $message, int $code = 0, string $flagType = 'option')
+    public function __construct(string $message, int $code = 0, string $flagType = FlagsParser::KIND_OPT)
     {
         $this->flagType = $flagType;
 

src/Flag/AbstractFlag.php

@@ -14,6 +14,7 @@
 use Toolkit\PFlag\Contract\FlagInterface;
 use Toolkit\PFlag\Contract\ValidatorInterface;
 use Toolkit\PFlag\Exception\FlagException;
+use Toolkit\PFlag\FlagsParser;
 use Toolkit\PFlag\FlagType;
 use Toolkit\Stdlib\Obj;
 use Toolkit\Stdlib\OS;
@@ -203,7 +204,8 @@ public function setValue($value): void
             }
 
             if (false === $ok) {
-                throw new FlagException('invalid value for flag: ' . $this->getNameMark());
+                $kind = $this->getKind();
+                throw new FlagException("set invalid value for flag $kind: " . $this->getNameMark());
             }
         }
 
@@ -242,6 +244,14 @@ public function getNameMark(): string
         return $this->name;
     }
 
+    /**
+     * @return string
+     */
+    public function getKind(): string
+    {
+        return FlagsParser::KIND_OPT;
+    }
+
     /******************************************************************
      * getter/setter methods
      *****************************************************************/
@@ -285,7 +295,8 @@ public function getName(): string
     public function setName(string $name): void
     {
         if (!FlagHelper::isValidName($name)) {
-            throw new FlagException('invalid flag name: ' . $name);
+            $kind = $this->getKind();
+            throw new FlagException("invalid flag $kind name: " . $name);
         }
 
         $this->name = $name;

src/Flag/Argument.php

@@ -9,6 +9,7 @@
 
 namespace Toolkit\PFlag\Flag;
 
+use Toolkit\PFlag\FlagsParser;
 use Toolkit\Stdlib\Str;
 use function sprintf;
 
@@ -37,6 +38,14 @@ public function setName(string $name): void
         }
     }
 
+    /**
+     * @return string
+     */
+    public function getKind(): string
+    {
+        return FlagsParser::KIND_ARG;
+    }
+
     /**
      * @return string
      */

src/Flags.php

@@ -420,7 +420,7 @@ public function bindingArguments(): self
      */
     public function buildHelp(bool $withColor = true): string
     {
-        return $this->doBuildHelp($this->arguments, $this->options, $withColor, $this->countAlias() > 0);
+        return $this->doBuildHelp($this->arguments, $this->options, $withColor, $this->hasShortOpts());
     }
 
     /**