add some tests for parse doc

Author: inhere

src/Obj/Traits/NameAliasTrait.php

@@ -3,6 +3,7 @@
 namespace Toolkit\Stdlib\Obj\Traits;
 
 use InvalidArgumentException;
+use function count;
 
 /**
  * trait NameAliasTrait
@@ -57,6 +58,14 @@ public function hasAlias(string $alias): bool
         return isset($this->aliases[$alias]);
     }
 
+    /**
+     * @return int
+     */
+    public function countAlias(): int
+    {
+        return count($this->aliases);
+    }
+
     /**
      * @param string $name
      *

src/Util/PhpDoc.php

@@ -12,14 +12,14 @@
 use function array_merge;
 use function in_array;
 use function is_array;
+use function preg_match;
+use function preg_replace;
 use function preg_split;
 use function str_replace;
-use function preg_replace;
-use function preg_match;
 use function substr;
 use function trim;
-use const PREG_SPLIT_NO_EMPTY;
 use const PREG_OFFSET_CAPTURE;
+use const PREG_SPLIT_NO_EMPTY;
 
 /**
  * Class PhpDoc
@@ -36,11 +36,14 @@ class PhpDoc
      * Parses the comment block into tags.
      *
      * @param string $comment The comment block text
-     * @param array  $options
+     * @param array $options
      *                        - 'allow'  // only allowed tags
+     *                        - 'multi'  // allowed multi tag names
      *                        - 'ignore' // ignored tags
      *                        - 'default' => 'description', // default tag name, first line text will attach to it.
      *
+     * @psalm-param array{allow: array, multi: array, ignore: array, default: string} $options
+     *
      * @return array The parsed tags
      */
     public static function getTags(string $comment, array $options = []): array
@@ -51,16 +54,22 @@ public static function getTags(string $comment, array $options = []): array
 
         $options = array_merge([
             'allow'   => [], // only allowed tags
-            'ignore'  => ['param', 'return'], // ignore tags
+            'multi'   => [], // allowed multi tags
+            'ignore'  => ['param', 'return'], // ignored tags
             'default' => 'description', // default tag name, first line text will attach to it.
         ], $options);
 
-        $allow   = (array)$options['allow'];
+        $multi   = (array)$options['multi'];
+        $allowed = (array)$options['allow'];
         $ignored = (array)$options['ignore'];
         $default = (string)$options['default'];
 
         $comment = str_replace("\r\n", "\n", $comment);
-        $comment = "@{$default} \n" . str_replace("\r", '', trim(preg_replace('/^\s*\**( |\t)?/m', '', $comment)));
+        $comment = "@$default \n" . str_replace(
+                "\r",
+                '',
+                trim(preg_replace('/^\s*\**( |\t)?/m', '', $comment))
+            );
 
         $tags  = [];
         $parts = preg_split('/^\s*@/m', $comment, -1, PREG_SPLIT_NO_EMPTY);
@@ -73,7 +82,7 @@ public static function getTags(string $comment, array $options = []): array
                 }
 
                 // always allow default tag
-                if ($default !== $name && $allow && !in_array($name, $allow, true)) {
+                if ($default !== $name && $allowed && !in_array($name, $allowed, true)) {
                     continue;
                 }
 

test/Helper/DataHelperTest.php

@@ -38,7 +38,7 @@ public function testToString(): void
         self::assertEquals('abc', DataHelper::toString('abc'));
         self::assertEquals('bool(TRUE)', DataHelper::toString(true));
         self::assertEquals('bool(FALSE)', DataHelper::toString(false));
-        self::assertEquals('<NULL>', DataHelper::toString(null));
+        self::assertEquals('NULL', DataHelper::toString(null));
         self::assertEquals('["ab",23]', DataHelper::toString(['ab', 23]));
 
         $str = DataHelper::toString((object)['ab', 23]);

test/Util/PhpDocTest.php

@@ -0,0 +1,48 @@
+<?php declare(strict_types=1);
+
+namespace Toolkit\StdlibTest\Util;
+
+use PHPUnit\Framework\TestCase;
+use ReflectionMethod;
+use Toolkit\Stdlib\Util\PhpDoc;
+use function vdump;
+
+/**
+ * class PhpDocTest
+ */
+class PhpDocTest extends TestCase
+{
+    /**
+     * Open an github repository by browser
+     *
+     * @options
+     *  -r, --remote         The git remote name. default is `origin`
+     *      --main           Use the config `mainRemote` name
+     *
+     * @arguments
+     *  repoPath    The remote git repo URL or repository group/name.
+     *              If not input, will auto parse from current work directory
+     *
+     * @param string $input
+     * @param int $output
+     *
+     * @example
+     *  {fullCmd}  php-toolkit/cli-utils
+     *  {fullCmd}  https://github.com/php-toolkit/cli-utils
+     */
+    public function testDoc_basic(): void
+    {
+        $rftMth = new ReflectionMethod($this, 'testDoc_basic');
+
+        $tags = PhpDoc::getTags($rftMth->getDocComment(), [
+            'default' => 'desc',
+        ]);
+
+        $this->assertArrayHasKey('desc', $tags);
+        $this->assertArrayHasKey('example', $tags);
+        $this->assertArrayHasKey('options', $tags);
+        $this->assertArrayHasKey('arguments', $tags);
+
+        $this->assertEquals('Open an github repository by browser', $tags['desc']);
+    }
+}