Add more tag tests

Author: SerafimArts

libs/phpdoc/tests/DocBlock/Tag/AuthorTagTest.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TypeLang\PhpDoc\Tests\DocBlock\Tag;
+
+use PHPUnit\Framework\Attributes\Test;
+use TypeLang\PhpDoc\DocBlock\Grammar\AuthorNameGrammarRule;
+use TypeLang\PhpDoc\DocBlock\Grammar\EmailGrammarRule;
+use TypeLang\PhpDoc\DocBlock\Tag\AuthorTag\AuthorTag;
+use TypeLang\PhpDoc\DocBlock\Tag\AuthorTag\AuthorTagDefinition;
+use TypeLang\PhpDoc\DocBlockParser;
+use TypeLang\PhpDoc\TagFactory;
+use TypeLang\PhpDoc\Tests\TestCase;
+
+final class AuthorTagTest extends TestCase
+{
+    #[Test]
+    public function parsesNameAndEmail(): void
+    {
+        $tag = self::factory()->create('author', 'John Doe <john@example.com>');
+
+        self::assertInstanceOf(AuthorTag::class, $tag);
+        self::assertSame('author', $tag->name);
+        self::assertSame('John Doe', $tag->author);
+        self::assertSame('john@example.com', $tag->email);
+        self::assertSame('@author John Doe <john@example.com>', (string) $tag);
+    }
+
+    #[Test]
+    public function parsesNameWithoutEmail(): void
+    {
+        $tag = self::factory()->create('author', 'Jane Roe');
+
+        self::assertInstanceOf(AuthorTag::class, $tag);
+        self::assertSame('Jane Roe', $tag->author);
+        self::assertNull($tag->email);
+        self::assertSame('@author Jane Roe', (string) $tag);
+    }
+
+    #[Test]
+    public function resolvesThroughTheRealParser(): void
+    {
+        $block = new DocBlockParser()->parse('/** @author Kirill <k@example.com> */');
+
+        self::assertCount(1, $block->tags);
+        self::assertInstanceOf(AuthorTag::class, $block->tags[0]);
+        self::assertSame('k@example.com', $block->tags[0]->email);
+    }
+
+    private static function factory(): TagFactory
+    {
+        return new TagFactory(
+            definitions: [
+                AuthorTagDefinition::NAME => new AuthorTagDefinition(),
+            ],
+            rules: [
+                AuthorNameGrammarRule::NAME => new AuthorNameGrammarRule(),
+                EmailGrammarRule::NAME => new EmailGrammarRule(),
+            ],
+        );
+    }
+}

libs/phpdoc/tests/DocBlock/Tag/ReferenceTagTest.php

@@ -0,0 +1,73 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TypeLang\PhpDoc\Tests\DocBlock\Tag;
+
+use PHPUnit\Framework\Attributes\Test;
+use TypeLang\PhpDoc\DocBlock\Grammar\DescriptionGrammarRule;
+use TypeLang\PhpDoc\DocBlock\Grammar\ReferenceGrammarRule;
+use TypeLang\PhpDoc\DocBlock\Reference\ClassMethodReference;
+use TypeLang\PhpDoc\DocBlock\Tag\InvalidTag;
+use TypeLang\PhpDoc\DocBlock\Tag\ReferencedTagInterface;
+use TypeLang\PhpDoc\DocBlock\Tag\UsedByTag\UsedByTag;
+use TypeLang\PhpDoc\DocBlock\Tag\UsedByTag\UsedByTagDefinition;
+use TypeLang\PhpDoc\DocBlock\Tag\UsesTag\UsesTag;
+use TypeLang\PhpDoc\DocBlock\Tag\UsesTag\UsesTagDefinition;
+use TypeLang\PhpDoc\DocBlockParser;
+use TypeLang\PhpDoc\Exception\MalformedTagException;
+use TypeLang\PhpDoc\TagFactory;
+use TypeLang\PhpDoc\Tests\TestCase;
+
+final class ReferenceTagTest extends TestCase
+{
+    #[Test]
+    public function parsesCodeReferenceWithDescription(): void
+    {
+        $tag = self::factory()->create('uses', 'Mailer::send() The underlying transport.');
+
+        self::assertInstanceOf(UsesTag::class, $tag);
+        self::assertInstanceOf(ReferencedTagInterface::class, $tag);
+        self::assertSame('uses', $tag->name);
+        self::assertInstanceOf(ClassMethodReference::class, $tag->reference);
+        self::assertSame('The underlying transport.', (string) $tag->description);
+        self::assertSame('@uses Mailer::send() The underlying transport.', (string) $tag);
+    }
+
+    #[Test]
+    public function usedByResolvesThroughTheRealParser(): void
+    {
+        $block = new DocBlockParser()->parse('/** @used-by Service::run() */');
+
+        self::assertCount(1, $block->tags);
+        self::assertInstanceOf(UsedByTag::class, $block->tags[0]);
+        self::assertSame('used-by', $block->tags[0]->name);
+    }
+
+    /**
+     * Unlike "@see", the "@uses" tag references a code element only, so a URI
+     * is not a valid target.
+     */
+    #[Test]
+    public function uriIsNotAccepted(): void
+    {
+        $tag = self::factory()->create('uses', 'https://example.com');
+
+        self::assertInstanceOf(InvalidTag::class, $tag);
+        self::assertInstanceOf(MalformedTagException::class, $tag->reason);
+    }
+
+    private static function factory(): TagFactory
+    {
+        return new TagFactory(
+            definitions: [
+                UsesTagDefinition::NAME => new UsesTagDefinition(),
+                UsedByTagDefinition::NAME => new UsedByTagDefinition(),
+            ],
+            rules: [
+                ReferenceGrammarRule::NAME => new ReferenceGrammarRule(),
+                DescriptionGrammarRule::NAME => new DescriptionGrammarRule(self::createDescriptionParser()),
+            ],
+        );
+    }
+}

libs/phpdoc/tests/DocBlock/Tag/TypedTagTest.php

@@ -9,18 +9,18 @@
 use TypeLang\Parser\TypeParser;
 use TypeLang\PhpDoc\DocBlock\Grammar\DescriptionGrammarRule;
 use TypeLang\PhpDoc\DocBlock\Grammar\TypeGrammarRule;
+use TypeLang\PhpDoc\DocBlock\Reference\TypeReference;
 use TypeLang\PhpDoc\DocBlock\Tag\InheritanceTag\ExtendsTag;
 use TypeLang\PhpDoc\DocBlock\Tag\InheritanceTag\ExtendsTagDefinition;
 use TypeLang\PhpDoc\DocBlock\Tag\InheritanceTag\InheritanceTag;
+use TypeLang\PhpDoc\DocBlock\Tag\InvalidTag;
 use TypeLang\PhpDoc\DocBlock\Tag\MixinTag\MixinTag;
 use TypeLang\PhpDoc\DocBlock\Tag\MixinTag\MixinTagDefinition;
 use TypeLang\PhpDoc\DocBlock\Tag\ReturnTag\ReturnTag;
 use TypeLang\PhpDoc\DocBlock\Tag\ReturnTag\ReturnTagDefinition;
 use TypeLang\PhpDoc\DocBlock\Tag\ThrowsTag\ThrowsTag;
-use TypeLang\PhpDoc\DocBlock\Tag\InvalidTag;
 use TypeLang\PhpDoc\DocBlock\Tag\ThrowsTag\ThrowsTagDefinition;
 use TypeLang\PhpDoc\DocBlock\Tag\TypedTagInterface;
-use TypeLang\PhpDoc\DocBlock\Type\TypeStatement;
 use TypeLang\PhpDoc\Exception\MalformedTagException;
 use TypeLang\PhpDoc\Parser\Grammar\MatchedResult;
 use TypeLang\PhpDoc\TagFactory;
@@ -82,7 +82,7 @@ public function missingRequiredTypeProducesInvalidTag(): void
     #[Test]
     public function nameIsIntrinsicToTheTag(): void
     {
-        $statement = new TypeStatement(new TypeParser()->parse('bool'), 'bool');
+        $statement = new TypeReference(new TypeParser()->parse('bool'), 'bool');
 
         $tag = new ReturnTagDefinition()
             ->create('whatever-was-written', new MatchedResult(['type' => [$statement]]));