Fix phpdoc parser compatibility

Author: Kirill Nesmeyanov

src/DocBlock/Extractor/TagTypeExtractor.php

@@ -7,17 +7,15 @@
 use TypeLang\Parser\Node\Name;
 use TypeLang\Parser\Node\Stmt\NamedTypeNode;
 use TypeLang\Parser\Node\Stmt\TypeStatement;
-use TypeLang\Parser\ParserInterface;
-use TypeLang\Parser\Traverser;
+use TypeLang\Parser\Parser;
 use TypeLang\PhpDocParser\Exception\InvalidTagTypeException;
-use TypeLang\PhpDocParser\Visitor\NodeCompleteOffsetVisitor;
 
 final class TagTypeExtractor
 {
     private static ?NamedTypeNode $mixed = null;
 
     public function __construct(
-        private readonly ParserInterface $parser,
+        private readonly Parser $parser,
     ) {}
 
     /**
@@ -31,7 +29,7 @@ public function extractTypeOrFail(string $body): array
             $type = $this->parser->parse($body);
 
             if ($type instanceof TypeStatement) {
-                return [$type, $this->slice($type, $body)];
+                return [$type, $this->slice($body)];
             }
 
             throw InvalidTagTypeException::fromNonTyped();
@@ -62,20 +60,10 @@ protected function createMixedType(): NamedTypeNode
     /**
      * @return non-empty-string|null
      */
-    private function slice(TypeStatement $type, string $body): ?string
+    private function slice(string $body): ?string
     {
-        $offset = $this->getTypeOffset($type);
+        $offset = $this->parser->lastProcessedTokenOffset;
 
-        return \ltrim(\substr($body, $offset)) ?: null;
-    }
-
-    /**
-     * @return int<0, max>
-     */
-    public function getTypeOffset(TypeStatement $stmt): int
-    {
-        $visitor = Traverser::through(new NodeCompleteOffsetVisitor(), [$stmt]);
-
-        return $visitor->offset;
+        return \trim(\substr($body, $offset)) ?: null;
     }
 }

src/DocBlock/Tag/CommonTypedTagFactory.php

@@ -4,6 +4,7 @@
 
 namespace TypeLang\PhpDocParser\DocBlock\Tag;
 
+use TypeLang\Parser\Parser;
 use TypeLang\Parser\ParserInterface;
 use TypeLang\PhpDocParser\DocBlock\DescriptionFactoryInterface;
 use TypeLang\PhpDocParser\Exception\InvalidTagException;
@@ -19,7 +20,7 @@ final class CommonTypedTagFactory extends TypedTagFactory
      */
     public function __construct(
         private readonly string $class,
-        ParserInterface $parser,
+        Parser $parser = new Parser(true),
         ?DescriptionFactoryInterface $descriptions = null,
     ) {
         parent::__construct($parser, $descriptions);

src/DocBlock/Tag/TypedTagFactory.php

@@ -4,6 +4,7 @@
 
 namespace TypeLang\PhpDocParser\DocBlock\Tag;
 
+use TypeLang\Parser\Parser;
 use TypeLang\Parser\ParserInterface;
 use TypeLang\PhpDocParser\DocBlock\DescriptionFactoryInterface;
 use TypeLang\PhpDocParser\DocBlock\Extractor\TagTypeExtractor;
@@ -18,7 +19,7 @@ abstract class TypedTagFactory extends TagFactory
     protected readonly TagTypeExtractor $types;
 
     public function __construct(
-        ParserInterface $parser,
+        Parser $parser = new Parser(true),
         ?DescriptionFactoryInterface $descriptions = null,
     ) {
         $this->types = new TagTypeExtractor($parser);

src/Visitor/NodeCompleteOffsetVisitor.php

@@ -36,6 +36,11 @@ public function testTagIsSupported(DocBlockFactoryInterface $factory, string $co
     {
         $phpdoc = $factory->create($comment);
 
-        $this->assertDocBlockNotContainsInvalidTags($phpdoc, self::NOT_IMPLEMENTED_TAGS);
+        try {
+            $this->assertDocBlockNotContainsInvalidTags($phpdoc, self::NOT_IMPLEMENTED_TAGS, $comment);
+        } catch (\Throwable $e) {
+            dump($phpdoc);
+            throw $e;
+        }
     }
 }

tests/Functional/DocBlockParsingTest.php

@@ -293,9 +293,10 @@ abstract class TestCase extends BaseTestCase
     protected function assertDocBlockNotContainsInvalidTags(
         DocBlock $docBlock,
         array $except = [],
+        string $message = '',
     ): void {
-        $this->assertDescriptionNotContainsInvalidTags($docBlock->getDescription(), $except);
-        $this->assertTagsNotContainsInvalidTags($docBlock->getTags(), $except);
+        $this->assertDescriptionNotContainsInvalidTags($docBlock->getDescription(), $except, $message);
+        $this->assertTagsNotContainsInvalidTags($docBlock->getTags(), $except, $message);
     }
 
     /**
@@ -304,29 +305,33 @@ protected function assertDocBlockNotContainsInvalidTags(
     protected function assertDescriptionNotContainsInvalidTags(
         \Stringable|string|null $description,
         array $except = [],
+        string $message = '',
     ): void {
         if ($description instanceof Description) {
-            $this->assertTagsNotContainsInvalidTags($description->getTags(), $except);
+            $this->assertTagsNotContainsInvalidTags($description->getTags(), $except, $message);
         }
     }
 
     /**
      * @param iterable<TagInterface> $tags
      * @param list<non-empty-string> $except
      */
-    protected function assertTagsNotContainsInvalidTags(iterable $tags, array $except = []): void
-    {
+    protected function assertTagsNotContainsInvalidTags(
+        iterable $tags,
+        array $except = [],
+        string $message = '',
+    ): void {
         // Suppress "no assertions" notice
         self::assertTrue(true);
 
         foreach ($tags as $tag) {
             if ($tag instanceof InvalidTagInterface) {
                 if (!$this->isSkipAllowed($tag)) {
-                    self::assertContains($tag->getName(), $except);
+                    self::assertContains($tag->getName(), $except, $message);
                 }
             }
 
-            $this->assertDescriptionNotContainsInvalidTags($tag->getDescription(), $except);
+            $this->assertDescriptionNotContainsInvalidTags($tag->getDescription(), $except, $message);
         }
     }