Improve tag parsing

Author: Kirill Nesmeyanov

src/DocBlock/Tag/Factory/TagFactory.php

@@ -65,7 +65,7 @@ public function create(string $tag, string $content, DescriptionParserInterface
 
         $description = null;
 
-        if ($content === '') {
+        if ($content !== '') {
             $description = $descriptions->parse($content);
         }
 

src/DocBlock/Tag/InvalidTag.php

@@ -9,29 +9,35 @@ final class InvalidTag extends Tag implements InvalidTagInterface
     /**
      * @var non-empty-string
      */
-    public const DEFAULT_UNKNOWN_TAG_NAME = '<unknown>';
+    public const DEFAULT_UNKNOWN_TAG_NAME = 'invalid';
+
+    private readonly bool $isUnknownName;
 
     /**
      * @param non-empty-string $name
      */
     public function __construct(
         public readonly \Throwable $reason,
         \Stringable|string|null $description = null,
-        string $name = self::DEFAULT_UNKNOWN_TAG_NAME,
+        ?string $name = null,
     ) {
-        parent::__construct($name, $description);
+        $this->isUnknownName = $name === null;
+
+        parent::__construct($name ?? self::DEFAULT_UNKNOWN_TAG_NAME, $description);
     }
 
     public function __toString(): string
     {
-        $name = $this->name === self::DEFAULT_UNKNOWN_TAG_NAME ? '' : $this->name;
+        if ($this->isUnknownName) {
+            return \sprintf('@%s', $this->description);
+        }
 
         if ($this->description === null) {
-            return \sprintf('@%s', $name);
+            return \sprintf('@%s', $this->name);
         }
 
         return \rtrim(\vsprintf('@%s %s', [
-            $name,
+            $this->name,
             (string) $this->description,
         ]));
     }

src/Parser/Description/RegexDescriptionParser.php

@@ -54,7 +54,7 @@ public function parse(string $description): DescriptionInterface
     private function createFromChunk(string $chunk): DescriptionInterface|TagInterface
     {
         if ($chunk === '@') {
-            return new Description('{' . $chunk . '}');
+            return new Description('{@}');
         }
 
         if (\str_starts_with($chunk, '@')) {

src/Parser/Tag/RegexTagParser.php

@@ -67,9 +67,7 @@ public function parse(string $tag, DescriptionParserInterface $parser): TagInter
         try {
             $name = $this->getTagName($tag);
         } catch (InvalidTagNameException $e) {
-            return new InvalidTag($e, $parser->parse(
-                description: \substr($tag, 1),
-            ));
+            return new InvalidTag($e, description: $tag);
         }
 
         /** @var non-empty-string $name */

tests/Unit/DescriptionParserTest.php

@@ -5,10 +5,9 @@
 namespace TypeLang\PHPDoc\Tests\Unit;
 
 use PHPUnit\Framework\Attributes\DataProvider;
-use TypeLang\PHPDoc\DocBlock\Tag\Content\Stream;
-use TypeLang\PHPDoc\DocBlock\Tag\Description\Description;
-use TypeLang\PHPDoc\DocBlock\Tag\Description\TaggedDescription;
-use TypeLang\PHPDoc\DocBlock\Tag\Description\TaggedDescriptionInterface;
+use TypeLang\PHPDoc\DocBlock\Description\Description;
+use TypeLang\PHPDoc\DocBlock\Description\TaggedDescription;
+use TypeLang\PHPDoc\DocBlock\Description\TaggedDescriptionInterface;
 use TypeLang\PHPDoc\DocBlock\Tag\Factory\TagFactory;
 use TypeLang\PHPDoc\DocBlock\Tag\Factory\TagFactoryInterface;
 use TypeLang\PHPDoc\DocBlock\Tag\InvalidTag;
@@ -24,9 +23,12 @@ public static function parserDataProvider(): iterable
     {
         $tags = new TagFactory([
             'error' => new class implements TagFactoryInterface {
-                public function create(Stream $tag, DescriptionParserInterface $descriptions): TagInterface
-                {
-                    throw new \LogicException('Error tag ' . $tag->getName());
+                public function create(
+                    string $tag,
+                    string $content,
+                    DescriptionParserInterface $descriptions
+                ): TagInterface {
+                    throw new \LogicException('Error tag ' . $tag);
                 }
             },
         ]);
@@ -123,14 +125,15 @@ public function testDescriptionWithBadTagName(DescriptionParserInterface $parser
         $description = $parser->parse('Hello {@@} World!');
 
         self::assertInstanceOf(TaggedDescriptionInterface::class, $description);
-        self::assertCount(3, $description);
-        self::assertInstanceOf(InvalidTag::class, $description[1]);
+        self::assertCount(3, $description->components);
+        self::assertCount(1, $description);
+        self::assertInstanceOf(InvalidTag::class, $description[0]);
 
-        $reason = $description[1]->reason;
+        $reason = $description[0]->reason;
 
         self::assertSame('Tag name cannot be empty', $reason->getMessage());
-        self::assertSame(InvalidTag::DEFAULT_UNKNOWN_TAG_NAME, $description[1]->getName());
-        self::assertEquals(new Description('{@}'), $description[1]->getDescription());
+        self::assertSame(InvalidTag::DEFAULT_UNKNOWN_TAG_NAME, $description[0]->name);
+        self::assertEquals(new Description('@@'), $description[0]->description);
     }
 
     #[DataProvider('parserDataProvider')]
@@ -139,13 +142,14 @@ public function testErrorWhileParsingInline(DescriptionParserInterface $parser):
         $description = $parser->parse('Hello {@error description} World!');
 
         self::assertInstanceOf(TaggedDescriptionInterface::class, $description);
-        self::assertCount(3, $description);
-        self::assertInstanceOf(InvalidTag::class, $description[1]);
+        self::assertCount(3, $description->components);
+        self::assertCount(1, $description);
+        self::assertInstanceOf(InvalidTag::class, $description[0]);
 
-        $reason = $description[1]->reason;
+        $reason = $description[0]->reason;
 
         self::assertSame('Error while parsing tag @error', $reason->getMessage());
-        self::assertSame('error', $description[1]->getName());
-        self::assertEquals(new Description('description'), $description[1]->getDescription());
+        self::assertSame('error', $description[0]->name);
+        self::assertEquals(new Description('description'), $description[0]->description);
     }
 }