Optimize tags parsing logic

Kirill Nesmeyanov · Kirill Nesmeyanov · commit a76c3f0bcc35 · 2025-03-10T05:02:01.000+03:00
diff --git a/src/DocBlock/Tag/MethodTag/MethodTagFactory.php b/src/DocBlock/Tag/MethodTag/MethodTagFactory.php
@@ -8,7 +8,7 @@
 use TypeLang\Parser\Parser as TypesParser;
 use TypeLang\Parser\ParserInterface as TypesParserInterface;
 use TypeLang\PHPDoc\DocBlock\Tag\Factory\TagFactoryInterface;
-use TypeLang\PHPDoc\Parser\Content\OptionalTypeParserReader;
+use TypeLang\PHPDoc\Parser\Content\OptionalTypeReader;
 use TypeLang\PHPDoc\Parser\Content\OptionalValueReader;
 use TypeLang\PHPDoc\Parser\Content\Stream;
 use TypeLang\PHPDoc\Parser\Content\TypeParserReader;
@@ -27,11 +27,11 @@ public function __construct(
 
     public function create(string $tag, string $content, DescriptionParserInterface $descriptions): MethodTag
     {
-        $stream = new Stream($content);
+        $stream = new Stream($tag, $content);
 
         $isStatic = $stream->apply(new OptionalValueReader('static')) !== null;
-        $returnType = $stream->apply(new TypeParserReader($tag, $this->parser));
-        $callableType = $stream->apply(new OptionalTypeParserReader($this->parser));
+        $returnType = $stream->apply(new TypeParserReader($this->parser));
+        $callableType = $stream->apply(new OptionalTypeReader($this->parser));
 
         // In case of return type has not been defined then we swap first
         // defined type as method signature definition.
@@ -63,9 +63,7 @@ public function create(string $tag, string $content, DescriptionParserInterface
             name: $tag,
             type: $callableType,
             static: $isStatic,
-            description: \trim($stream->value) !== ''
-                ? $descriptions->parse(\rtrim($stream->value))
-                : null,
+            description: $stream->toOptionalDescription($descriptions),
         );
     }
 }
diff --git a/src/DocBlock/Tag/ParamTag/ParamTagFactory.php b/src/DocBlock/Tag/ParamTag/ParamTagFactory.php
@@ -33,13 +33,13 @@ private function isVariable(string $content): bool
 
     public function create(string $tag, string $content, DescriptionParserInterface $descriptions): ParamTag
     {
-        $stream = new Stream($content);
+        $stream = new Stream($tag, $content);
 
         $type = null;
         $output = $variadic = false;
 
         if (!$this->isVariable($stream->value)) {
-            $type = $stream->apply(new TypeParserReader($tag, $this->parser));
+            $type = $stream->apply(new TypeParserReader($this->parser));
         }
 
         if (\str_starts_with($stream->value, '&')) {
@@ -52,17 +52,15 @@ public function create(string $tag, string $content, DescriptionParserInterface
             $variadic = true;
         }
 
-        $variable = $stream->apply(new VariableNameReader($tag));
+        $variable = $stream->apply(new VariableNameReader());
 
         return new ParamTag(
             name: $tag,
             type: $type,
             variable: $variable,
             isVariadic: $variadic,
             isOutput: $output,
-            description: \trim($stream->value) !== ''
-                ? $descriptions->parse(\rtrim($stream->value))
-                : null,
+            description: $stream->toOptionalDescription($descriptions),
         );
     }
 }
diff --git a/src/DocBlock/Tag/PropertyTag/PropertyTagFactory.php b/src/DocBlock/Tag/PropertyTag/PropertyTagFactory.php
@@ -25,22 +25,20 @@ public function __construct(
 
     public function create(string $tag, string $content, DescriptionParserInterface $descriptions): PropertyTag
     {
-        $stream = new Stream($content);
+        $stream = new Stream($tag, $content);
         $type = null;
 
         if (!\str_starts_with($stream->value, '$')) {
-            $type = $stream->apply(new TypeParserReader($tag, $this->parser));
+            $type = $stream->apply(new TypeParserReader($this->parser));
         }
 
-        $variable = $stream->apply(new VariableNameReader($tag));
+        $variable = $stream->apply(new VariableNameReader());
 
         return new PropertyTag(
             name: $tag,
             type: $type,
             variable: $variable,
-            description: \trim($stream->value) !== ''
-                ? $descriptions->parse(\rtrim($stream->value))
-                : null,
+            description: $stream->toOptionalDescription($descriptions),
         );
     }
 }
diff --git a/src/DocBlock/Tag/ReturnTag/ReturnTagFactory.php b/src/DocBlock/Tag/ReturnTag/ReturnTagFactory.php
@@ -24,14 +24,12 @@ public function __construct(
 
     public function create(string $tag, string $content, DescriptionParserInterface $descriptions): ReturnTag
     {
-        $stream = new Stream($content);
+        $stream = new Stream($tag, $content);
 
         return new ReturnTag(
             name: $tag,
-            type: $stream->apply(new TypeParserReader($tag, $this->parser)),
-            description: \trim($stream->value) !== ''
-                ? $descriptions->parse(\rtrim($stream->value))
-                : null,
+            type: $stream->apply(new TypeParserReader($this->parser)),
+            description: $stream->toOptionalDescription($descriptions),
         );
     }
 }
diff --git a/src/DocBlock/Tag/TemplateExtendsTag/TemplateExtendsTagFactory.php b/src/DocBlock/Tag/TemplateExtendsTag/TemplateExtendsTagFactory.php
@@ -25,16 +25,14 @@ public function __construct(
 
     public function create(string $tag, string $content, DescriptionParserInterface $descriptions): TemplateExtendsTag
     {
-        $stream = new Stream($content);
+        $stream = new Stream($tag, $content);
 
-        $type = $stream->apply(new TypeParserReader($tag, $this->parser));
+        $type = $stream->apply(new TypeParserReader($this->parser));
 
         return new TemplateExtendsTag(
             name: $tag,
             type: $type,
-            description: \trim($stream->value) !== ''
-                ? $descriptions->parse(\rtrim($stream->value))
-                : null,
+            description: $stream->toOptionalDescription($descriptions),
         );
     }
 }
diff --git a/src/DocBlock/Tag/TemplateTag/TemplateTagFactory.php b/src/DocBlock/Tag/TemplateTag/TemplateTagFactory.php
@@ -8,7 +8,7 @@
 use TypeLang\Parser\ParserInterface as TypesParserInterface;
 use TypeLang\PHPDoc\DocBlock\Tag\Factory\TagFactoryInterface;
 use TypeLang\PHPDoc\Parser\Content\IdentifierReader;
-use TypeLang\PHPDoc\Parser\Content\OptionalTypeParserReader;
+use TypeLang\PHPDoc\Parser\Content\OptionalTypeReader;
 use TypeLang\PHPDoc\Parser\Content\OptionalValueReader;
 use TypeLang\PHPDoc\Parser\Content\Stream;
 use TypeLang\PHPDoc\Parser\Description\DescriptionParserInterface;
@@ -26,15 +26,15 @@ public function __construct(
 
     public function create(string $tag, string $content, DescriptionParserInterface $descriptions): TemplateTag
     {
-        $stream = new Stream($content);
+        $stream = new Stream($tag, $content);
 
-        $template = $stream->apply(new IdentifierReader($tag));
+        $template = $stream->apply(new IdentifierReader());
 
         $type = null;
 
         $stream->lookahead(function (Stream $stream) use (&$type): bool {
             if ($stream->apply(new OptionalValueReader('of')) !== null) {
-                $type = $stream->apply(new OptionalTypeParserReader($this->parser));
+                $type = $stream->apply(new OptionalTypeReader($this->parser));
             }
 
             return $type !== null;
@@ -44,9 +44,7 @@ public function create(string $tag, string $content, DescriptionParserInterface
             name: $tag,
             template: $template,
             type: $type,
-            description: \trim($stream->value) !== ''
-                ? $descriptions->parse(\rtrim($stream->value))
-                : null,
+            description: $stream->toOptionalDescription($descriptions),
         );
     }
 }
diff --git a/src/DocBlock/Tag/ThrowsTag/ThrowsTagFactory.php b/src/DocBlock/Tag/ThrowsTag/ThrowsTagFactory.php
@@ -24,14 +24,12 @@ public function __construct(
 
     public function create(string $tag, string $content, DescriptionParserInterface $descriptions): ThrowsTag
     {
-        $stream = new Stream($content);
+        $stream = new Stream($tag, $content);
 
         return new ThrowsTag(
             name: $tag,
-            type: $stream->apply(new TypeParserReader($tag, $this->parser)),
-            description: \trim($stream->value) !== ''
-                ? $descriptions->parse(\rtrim($stream->value))
-                : null,
+            type: $stream->apply(new TypeParserReader($this->parser)),
+            description: $stream->toOptionalDescription($descriptions),
         );
     }
 }
diff --git a/src/DocBlock/Tag/VarTag/VarTagFactory.php b/src/DocBlock/Tag/VarTag/VarTagFactory.php
@@ -25,18 +25,16 @@ public function __construct(
 
     public function create(string $tag, string $content, DescriptionParserInterface $descriptions): VarTag
     {
-        $stream = new Stream($content);
+        $stream = new Stream($tag, $content);
 
-        $type = $stream->apply(new TypeParserReader($tag, $this->parser));
+        $type = $stream->apply(new TypeParserReader($this->parser));
         $variable = $stream->apply(new OptionalVariableNameReader());
 
         return new VarTag(
             name: $tag,
             type: $type,
             variable: $variable,
-            description: \trim($stream->value) !== ''
-                ? $descriptions->parse(\rtrim($stream->value))
-                : null,
+            description: $stream->toOptionalDescription($descriptions),
         );
     }
 }
diff --git a/src/Parser/Content/IdentifierReader.php b/src/Parser/Content/IdentifierReader.php
@@ -13,12 +13,8 @@ final class IdentifierReader extends Reader
 {
     private readonly OptionalIdentifierReader $id;
 
-    /**
-     * @param non-empty-string $tag
-     */
-    public function __construct(
-        private readonly string $tag,
-    ) {
+    public function __construct()
+    {
         $this->id = new OptionalIdentifierReader();
     }
 
@@ -31,7 +27,7 @@ public function __invoke(Stream $stream): string
         return ($this->id)($stream)
             ?? throw $stream->toException(\sprintf(
                 'Tag @%s contains an incorrect identifier value',
-                $this->tag,
+                $stream->tag,
             ));
     }
 }
diff --git a/src/Parser/Content/OptionalTypeReader.php b/src/Parser/Content/OptionalTypeReader.php
@@ -12,7 +12,7 @@
 /**
  * @template-extends Reader<TypeStatement|null>
  */
-final class OptionalTypeParserReader extends Reader
+final class OptionalTypeReader extends Reader
 {
     public function __construct(
         private readonly TypesParserInterface $parser,
diff --git a/src/Parser/Content/Stream.php b/src/Parser/Content/Stream.php
@@ -17,8 +17,13 @@ final class Stream implements \Stringable
      */
     public int $offset = 0;
 
-    public function __construct(public string $value)
-    {
+    public function __construct(
+        /**
+         * @var non-empty-string
+         */
+        public readonly string $tag,
+        public string $value,
+    ) {
         $this->source = $this->value;
     }
 
diff --git a/src/Parser/Content/TypeParserReader.php b/src/Parser/Content/TypeParserReader.php
@@ -14,11 +14,7 @@
  */
 final class TypeParserReader extends Reader
 {
-    /**
-     * @param non-empty-string $tag
-     */
     public function __construct(
-        private readonly string $tag,
         private readonly TypesParserInterface $parser,
     ) {}
 
@@ -32,7 +28,7 @@ public function __invoke(Stream $stream): TypeStatement
             $type = $this->parser->parse($stream->value);
         } catch (ParserExceptionInterface $e) {
             throw $stream->toException(
-                message: \sprintf('Tag @%s contains an incorrect type', $this->tag),
+                message: \sprintf('Tag @%s contains an incorrect type', $stream->tag),
                 previous: $e,
             );
         }
diff --git a/src/Parser/Content/ValueReader.php b/src/Parser/Content/ValueReader.php
@@ -18,11 +18,9 @@ final class ValueReader extends Reader
     private readonly OptionalValueReader $identifier;
 
     /**
-     * @param non-empty-string $tag
      * @param T $value
      */
     public function __construct(
-        private readonly string $tag,
         private readonly string $value,
     ) {
         $this->identifier = new OptionalValueReader($value);
@@ -38,7 +36,7 @@ public function __invoke(Stream $stream): string
         return ($this->identifier)($stream)
             ?? throw $stream->toException(\sprintf(
                 'Tag @%s contains an incorrect identifier value "%s"',
-                $this->tag,
+                $stream->tag,
                 $this->value,
             ));
     }
diff --git a/src/Parser/Content/VariableNameReader.php b/src/Parser/Content/VariableNameReader.php
@@ -13,12 +13,8 @@ final class VariableNameReader extends Reader
 {
     private readonly OptionalVariableNameReader $var;
 
-    /**
-     * @param non-empty-string $tag
-     */
-    public function __construct(
-        private readonly string $tag,
-    ) {
+    public function __construct()
+    {
         $this->var = new OptionalVariableNameReader();
     }
 
@@ -31,7 +27,7 @@ public function __invoke(Stream $stream): string
         return ($this->var)($stream)
             ?? throw $stream->toException(\sprintf(
                 'Tag @%s contains an incorrect variable name',
-                $this->tag,
+                $stream->tag,
             ));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -33,13 +33,13 @@ private function isVariable(string $content): bool`
`33`	`33`
`34`	`34`	`public function create(string $tag, string $content, DescriptionParserInterface $descriptions): ParamTag`
`35`	`35`	`{`
`36`		`- $stream = new Stream($content);`
	`36`	`+ $stream = new Stream($tag, $content);`
`37`	`37`
`38`	`38`	`$type = null;`
`39`	`39`	`$output = $variadic = false;`
`40`	`40`
`41`	`41`	`if (!$this->isVariable($stream->value)) {`
`42`		`- $type = $stream->apply(new TypeParserReader($tag, $this->parser));`
	`42`	`+ $type = $stream->apply(new TypeParserReader($this->parser));`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`if (\str_starts_with($stream->value, '&')) {`
`@@ -52,17 +52,15 @@ public function create(string $tag, string $content, DescriptionParserInterface`
`52`	`52`	`$variadic = true;`
`53`	`53`	`}`
`54`	`54`
`55`		`- $variable = $stream->apply(new VariableNameReader($tag));`
	`55`	`+ $variable = $stream->apply(new VariableNameReader());`
`56`	`56`
`57`	`57`	`return new ParamTag(`
`58`	`58`	`name: $tag,`
`59`	`59`	`type: $type,`
`60`	`60`	`variable: $variable,`
`61`	`61`	`isVariadic: $variadic,`
`62`	`62`	`isOutput: $output,`
`63`		`- description: \trim($stream->value) !== ''`
`64`		`- ? $descriptions->parse(\rtrim($stream->value))`
`65`		`- : null,`
	`63`	`+ description: $stream->toOptionalDescription($descriptions),`
`66`	`64`	`);`
`67`	`65`	`}`
`68`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,22 +25,20 @@ public function __construct(`
`25`	`25`
`26`	`26`	`public function create(string $tag, string $content, DescriptionParserInterface $descriptions): PropertyTag`
`27`	`27`	`{`
`28`		`- $stream = new Stream($content);`
	`28`	`+ $stream = new Stream($tag, $content);`
`29`	`29`	`$type = null;`
`30`	`30`
`31`	`31`	`if (!\str_starts_with($stream->value, '$')) {`
`32`		`- $type = $stream->apply(new TypeParserReader($tag, $this->parser));`
	`32`	`+ $type = $stream->apply(new TypeParserReader($this->parser));`
`33`	`33`	`}`
`34`	`34`
`35`		`- $variable = $stream->apply(new VariableNameReader($tag));`
	`35`	`+ $variable = $stream->apply(new VariableNameReader());`
`36`	`36`
`37`	`37`	`return new PropertyTag(`
`38`	`38`	`name: $tag,`
`39`	`39`	`type: $type,`
`40`	`40`	`variable: $variable,`
`41`		`- description: \trim($stream->value) !== ''`
`42`		`- ? $descriptions->parse(\rtrim($stream->value))`
`43`		`- : null,`
	`41`	`+ description: $stream->toOptionalDescription($descriptions),`
`44`	`42`	`);`
`45`	`43`	`}`
`46`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,14 +24,12 @@ public function __construct(`
`24`	`24`
`25`	`25`	`public function create(string $tag, string $content, DescriptionParserInterface $descriptions): ReturnTag`
`26`	`26`	`{`
`27`		`- $stream = new Stream($content);`
	`27`	`+ $stream = new Stream($tag, $content);`
`28`	`28`
`29`	`29`	`return new ReturnTag(`
`30`	`30`	`name: $tag,`
`31`		`- type: $stream->apply(new TypeParserReader($tag, $this->parser)),`
`32`		`- description: \trim($stream->value) !== ''`
`33`		`- ? $descriptions->parse(\rtrim($stream->value))`
`34`		`- : null,`
	`31`	`+ type: $stream->apply(new TypeParserReader($this->parser)),`
	`32`	`+ description: $stream->toOptionalDescription($descriptions),`
`35`	`33`	`);`
`36`	`34`	`}`
`37`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,16 +25,14 @@ public function __construct(`
`25`	`25`
`26`	`26`	`public function create(string $tag, string $content, DescriptionParserInterface $descriptions): TemplateExtendsTag`
`27`	`27`	`{`
`28`		`- $stream = new Stream($content);`
	`28`	`+ $stream = new Stream($tag, $content);`
`29`	`29`
`30`		`- $type = $stream->apply(new TypeParserReader($tag, $this->parser));`
	`30`	`+ $type = $stream->apply(new TypeParserReader($this->parser));`
`31`	`31`
`32`	`32`	`return new TemplateExtendsTag(`
`33`	`33`	`name: $tag,`
`34`	`34`	`type: $type,`
`35`		`- description: \trim($stream->value) !== ''`
`36`		`- ? $descriptions->parse(\rtrim($stream->value))`
`37`		`- : null,`
	`35`	`+ description: $stream->toOptionalDescription($descriptions),`
`38`	`36`	`);`
`39`	`37`	`}`
`40`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,18 +25,16 @@ public function __construct(`
`25`	`25`
`26`	`26`	`public function create(string $tag, string $content, DescriptionParserInterface $descriptions): VarTag`
`27`	`27`	`{`
`28`		`- $stream = new Stream($content);`
	`28`	`+ $stream = new Stream($tag, $content);`
`29`	`29`
`30`		`- $type = $stream->apply(new TypeParserReader($tag, $this->parser));`
	`30`	`+ $type = $stream->apply(new TypeParserReader($this->parser));`
`31`	`31`	`$variable = $stream->apply(new OptionalVariableNameReader());`
`32`	`32`
`33`	`33`	`return new VarTag(`
`34`	`34`	`name: $tag,`
`35`	`35`	`type: $type,`
`36`	`36`	`variable: $variable,`
`37`		`- description: \trim($stream->value) !== ''`
`38`		`- ? $descriptions->parse(\rtrim($stream->value))`
`39`		`- : null,`
	`37`	`+ description: $stream->toOptionalDescription($descriptions),`
`40`	`38`	`);`
`41`	`39`	`}`
`42`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,12 +13,8 @@ final class IdentifierReader extends Reader`
`13`	`13`	`{`
`14`	`14`	`private readonly OptionalIdentifierReader $id;`
`15`	`15`
`16`		`- /**`
`17`		`- * @param non-empty-string $tag`
`18`		`- */`
`19`		`- public function __construct(`
`20`		`- private readonly string $tag,`
`21`		`- ) {`
	`16`	`+ public function __construct()`
	`17`	`+ {`
`22`	`18`	`$this->id = new OptionalIdentifierReader();`
`23`	`19`	`}`
`24`	`20`
`@@ -31,7 +27,7 @@ public function __invoke(Stream $stream): string`
`31`	`27`	`return ($this->id)($stream)`
`32`	`28`	`?? throw $stream->toException(\sprintf(`
`33`	`29`	`'Tag @%s contains an incorrect identifier value',`
`34`		`- $this->tag,`
	`30`	`+ $stream->tag,`
`35`	`31`	`));`
`36`	`32`	`}`
`37`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`/**`
`13`	`13`	`* @template-extends Reader<TypeStatement\|null>`
`14`	`14`	`*/`
`15`		`-final class OptionalTypeParserReader extends Reader`
	`15`	`+final class OptionalTypeReader extends Reader`
`16`	`16`	`{`
`17`	`17`	`public function __construct(`
`18`	`18`	`private readonly TypesParserInterface $parser,`