fix: validator tips not display on render help

php-toolkit · Feb 10, 2022 · b83477f · b83477f
1 parent 6246541
commit b83477f
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 14 deletions.
diff --git a/src/Concern/HelperRenderTrait.php b/src/Concern/HelperRenderTrait.php
@@ -216,12 +216,12 @@ protected function formatDesc(Argument|Option|array $define): array
 
         // validator limit
         if (!empty($define['validator'])) {
+            /** @see ValidatorInterface */
             $v = $define['validator'];
 
-            /** @see ValidatorInterface */
             if (is_object($v) && method_exists($v, '__toString')) {
                 $limit = (string)$v;
-                $desc  .= $limit ? ' ' . $limit : '';
+                $desc  .= $limit ? "\n" . $limit : '';
             }
         }
 

diff --git a/src/Flag/AbstractFlag.php b/src/Flag/AbstractFlag.php
@@ -102,7 +102,7 @@ abstract class AbstractFlag implements ArrayAccess, FlagInterface
      * @param string $name
      * @param string $desc
      * @param string $type
-     * @param bool   $required
+     * @param bool $required
      * @param mixed|null $default
      *
      * @return static
@@ -121,7 +121,7 @@ public static function new(
      * Create by array define
      *
      * @param string $name
-     * @param array  $define
+     * @param array $define
      *
      * @return static
      */
@@ -142,7 +142,7 @@ public static function newByArray(string $name, array $define): static
      * @param string $name
      * @param string $desc
      * @param string $type
-     * @param bool   $required
+     * @param bool $required
      * @param mixed|null $default The default value
      *                          - for Flag::ARG_OPTIONAL mode only
      *                          - must be null for Flag::OPT_BOOLEAN
@@ -354,14 +354,15 @@ public function setDesc(string $desc): void
     public function toArray(): array
     {
         return [
-            'name'     => $this->name,
-            'desc'     => $this->desc,
-            'type'     => $this->type,
-            'default'  => $this->default,
-            'envVar'   => $this->envVar,
-            'required' => $this->required,
-            'isArray'  => $this->isArray(),
-            'helpType' => $this->getHelpType(),
+            'name'      => $this->name,
+            'desc'      => $this->desc,
+            'type'      => $this->type,
+            'default'   => $this->default,
+            'envVar'    => $this->envVar,
+            'required'  => $this->required,
+            'validator' => $this->validator,
+            'isArray'   => $this->isArray(),
+            'helpType'  => $this->getHelpType(),
         ];
     }
 
@@ -431,6 +432,14 @@ public function setValidator(?callable $validator): void
         }
     }
 
+    /**
+     * @return callable|ValidatorInterface|null
+     */
+    public function getValidator(): callable|ValidatorInterface|null
+    {
+        return $this->validator;
+    }
+
     /**
      * @return string
      */

diff --git a/src/FlagsParser.php b/src/FlagsParser.php
@@ -370,6 +370,14 @@ public function displayHelp(): void
         Cli::println($this->buildHelp());
     }
 
+    /**
+     * @return string
+     */
+    public function toString(): string
+    {
+        return $this->buildHelp();
+    }
+
     /**
      * @return string
      */

diff --git a/src/Validator/EmptyValidator.php b/src/Validator/EmptyValidator.php
@@ -50,6 +50,6 @@ public function checkInput(mixed $value, string $name): bool
      */
     public function __toString(): string
     {
-        return 'Not empty';
+        return '';
     }
 }
diff --git a/test/FlagsParserTest.php b/test/FlagsParserTest.php
@@ -13,6 +13,7 @@
 use Toolkit\PFlag\Exception\FlagException;
 use Toolkit\PFlag\FlagsParser;
 use Toolkit\PFlag\FlagType;
+use Toolkit\PFlag\Validator\EnumValidator;
 use function get_class;
 
 /**
@@ -479,4 +480,27 @@ public function doTestParse_optValueIsKV(FlagsParser $fs): void
         $this->assertEquals('vars', $fs->resolveAlias('var'));
         $this->assertEquals(['key0=val0', 'port=3445'], $fs->getOpt('vars'));
     }
+
+    public function testRenderHelp_withValidator(): void
+    {
+        foreach ($this->createParsers() as $fs) {
+            $this->doTestRenderHelp_withValidator($fs);
+        }
+    }
+
+    public function doTestRenderHelp_withValidator(FlagsParser $fs): void
+    {
+        $fs->addOptsByRules([
+            'env, e'     => [
+                'type'     => FlagType::STRING,
+                'required' => true,
+                'desc'      => 'the env name, eg: qa',
+                'validator' => $v1 = new EnumValidator(['testing', 'qa']),
+            ],
+        ]);
+
+        $str = $fs->toString();
+        $this->assertStringContainsString('Allow: testing,qa', $str);
+        $this->assertStringContainsString((string)$v1, $str);
+    }
 }