Add simple description parser tests

Author: SerafimArts

Diff for: tests/Unit/DescriptionParserTest.php

@@ -0,0 +1,138 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TypeLang\PHPDoc\Tests\Unit;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use TypeLang\PHPDoc\Parser\Description\DescriptionParserInterface;
+use TypeLang\PHPDoc\Parser\Description\SprintfDescriptionParser;
+use TypeLang\PHPDoc\Parser\Tag\RegexTagParser;
+use TypeLang\PHPDoc\Tag\Content;
+use TypeLang\PHPDoc\Tag\Description;
+use TypeLang\PHPDoc\Tag\Factory\FactoryInterface;
+use TypeLang\PHPDoc\Tag\Factory\TagFactory;
+use TypeLang\PHPDoc\Tag\InvalidTag;
+use TypeLang\PHPDoc\Tag\Tag;
+use TypeLang\PHPDoc\Tag\TagInterface;
+
+final class DescriptionParserTest extends TestCase
+{
+    public static function parserDataProvider(): iterable
+    {
+        $tags = new TagFactory([
+            'error' => new class implements FactoryInterface {
+                public function create(string $name, Content $content, DescriptionParserInterface $descriptions): TagInterface
+                {
+                    throw new \LogicException('Error tag ' . $name);
+                }
+            },
+        ]);
+
+        yield SprintfDescriptionParser::class => [new SprintfDescriptionParser(
+            tags: new RegexTagParser($tags),
+        )];
+    }
+
+    #[DataProvider('parserDataProvider')]
+    public function testSimpleDescription(DescriptionParserInterface $parser): void
+    {
+        self::assertEquals(
+            expected: new Description('Hello World!'),
+            actual: $parser->parse('Hello World!'),
+        );
+    }
+
+    #[DataProvider('parserDataProvider')]
+    public function testDescriptionWithInlineTag(DescriptionParserInterface $parser): void
+    {
+        self::assertEquals(
+            expected: new Description('Hello {%1$s} World!', [
+                new Tag('tag'),
+            ]),
+            actual: $parser->parse('Hello {@tag} World!'),
+        );
+    }
+
+    #[DataProvider('parserDataProvider')]
+    public function testDescriptionWithDescribedInlineTag(DescriptionParserInterface $parser): void
+    {
+        self::assertEquals(
+            expected: new Description('Hello {%1$s} World!', [
+                new Tag('tag', 'description'),
+            ]),
+            actual: $parser->parse('Hello {@tag description} World!'),
+        );
+    }
+
+    #[DataProvider('parserDataProvider')]
+    public function testDescriptionWithMultipleInlineTags(DescriptionParserInterface $parser): void
+    {
+        self::assertEquals(
+            expected: new Description('Hello {%1$s} {%2$s} World!', [
+                new Tag('tag1'),
+                new Tag('tag2', '#desc'),
+            ]),
+            actual: $parser->parse('Hello {@tag1} {@tag2#desc} World!'),
+        );
+    }
+
+    #[DataProvider('parserDataProvider')]
+    public function testDescriptionWithSprintfSyntax(DescriptionParserInterface $parser): void
+    {
+        self::assertEquals(
+            expected: new Description('Hello %%s World!'),
+            actual: $parser->parse('Hello %s World!'),
+        );
+    }
+
+    #[DataProvider('parserDataProvider')]
+    public function testDescriptionWithSprintfSyntaxInsideInlineTag(DescriptionParserInterface $parser): void
+    {
+        self::assertEquals(
+            expected: new Description('Hello {%1$s} World!', [
+                new Tag('test-some', 'Desc %%s 42')
+            ]),
+            actual: $parser->parse('Hello {@test-some Desc %s 42} World!'),
+        );
+    }
+
+    #[DataProvider('parserDataProvider')]
+    public function testDescriptionWithNonNamedTag(DescriptionParserInterface $parser): void
+    {
+        self::assertEquals(
+            expected: new Description('Hello {@} World!'),
+            actual: $parser->parse('Hello {@} World!'),
+        );
+    }
+
+    #[DataProvider('parserDataProvider')]
+    public function testDescriptionWithBadTagName(DescriptionParserInterface $parser): void
+    {
+        $description = $parser->parse('Hello {@@} World!');
+
+        self::assertCount(1, $description);
+        self::assertInstanceOf(InvalidTag::class, $description[0]);
+
+        $reason = $description[0]->getReason();
+
+        self::assertSame('Tag name cannot be empty', $reason->getMessage());
+        self::assertSame(InvalidTag::DEFAULT_UNKNOWN_TAG_NAME, $description[0]->getName());
+        self::assertEquals(new Description('{@}'), $description[0]->getDescription());
+    }
+
+    #[DataProvider('parserDataProvider')]
+    public function testErrorWhileParsingInline(DescriptionParserInterface $parser): void
+    {
+        $description = $parser->parse('Hello {@error description} World!');
+
+        self::assertCount(1, $description);
+        self::assertInstanceOf(InvalidTag::class, $description[0]);
+
+        $reason = $description[0]->getReason();
+
+        self::assertSame('Error while parsing tag @error', $reason->getMessage());
+        self::assertSame('error', $description[0]->getName());
+        self::assertEquals(new Description('description'), $description[0]->getDescription());
+    }
+}