Simplify and complete docblock parser

Author: Kirill Nesmeyanov

README.md

@@ -5,10 +5,10 @@
 ---
 
 <p align="center">
-    <a href="https://packagist.org/packages/type-lang/phpdoc"><img src="https://poser.pugx.org/type-lang/phpdoc/require/php?style=for-the-badge" alt="PHP 8.1+"></a>
-    <a href="https://packagist.org/packages/type-lang/phpdoc"><img src="https://poser.pugx.org/type-lang/phpdoc/version?style=for-the-badge" alt="Latest Stable Version"></a>
-    <a href="https://packagist.org/packages/type-lang/phpdoc"><img src="https://poser.pugx.org/type-lang/phpdoc/v/unstable?style=for-the-badge" alt="Latest Unstable Version"></a>
-    <a href="https://raw.githubusercontent.com/php-type-language/phpdoc-parser/blob/master/LICENSE"><img src="https://poser.pugx.org/type-lang/phpdoc/license?style=for-the-badge" alt="License MIT"></a>
+    <a href="https://packagist.org/packages/type-lang/phpdoc-parser"><img src="https://poser.pugx.org/type-lang/phpdoc-parser/require/php?style=for-the-badge" alt="PHP 8.1+"></a>
+    <a href="https://packagist.org/packages/type-lang/phpdoc-parser"><img src="https://poser.pugx.org/type-lang/phpdoc-parser/version?style=for-the-badge" alt="Latest Stable Version"></a>
+    <a href="https://packagist.org/packages/type-lang/phpdoc-parser"><img src="https://poser.pugx.org/type-lang/phpdoc-parser/v/unstable?style=for-the-badge" alt="Latest Unstable Version"></a>
+    <a href="https://raw.githubusercontent.com/php-type-language/phpdoc-parser/blob/master/LICENSE"><img src="https://poser.pugx.org/type-lang/phpdoc-parser/license?style=for-the-badge" alt="License MIT"></a>
 </p>
 <p align="center">
     <a href="https://github.com/php-type-language/phpdoc-parser/actions"><img src="https://github.com/php-type-language/phpdoc-parser/workflows/tests/badge.svg"></a>

composer.json

@@ -1,16 +1,15 @@
 {
-    "name": "type-lang/phpdoc",
+    "name": "type-lang/phpdoc-parser",
     "type": "library",
     "description": "PHPDoc",
     "keywords": ["language", "php", "phpdoc", "docblock", "tags", "dictionary"],
     "license": "MIT",
     "support": {
-        "source": "https://github.com/php-type-language/phpdoc",
-        "issues": "https://github.com/php-type-language/phpdoc/issues"
+        "source": "https://github.com/php-type-language/phpdoc-parser",
+        "issues": "https://github.com/php-type-language/phpdoc-parser/issues"
     },
     "require": {
         "php": "^8.1",
-        "composer/semver": "^2.0|^3.0",
         "type-lang/parser": "^1.0"
     },
     "autoload": {

src/Exception/InternalError.php

@@ -22,25 +22,18 @@
 /**
  * @psalm-suppress UndefinedAttributeClass : JetBrains language attribute may not be available
  */
-class DocBlockFactory implements DocBlockFactoryInterface
+class Parser implements ParserInterface
 {
-    private readonly CommentParserInterface $comment;
-
-    private readonly DescriptionParserInterface $description;
-
-    private readonly TagParserInterface $tags;
-
-    public function __construct()
-    {
-        $this->comment = new LexerAwareCommentParser();
-        $this->description = new SprintfDescriptionReader();
-        $this->tags = new TagParser();
-    }
+    public function __construct(
+        private readonly CommentParserInterface $comments = new LexerAwareCommentParser(),
+        private readonly DescriptionParserInterface $descriptions = new SprintfDescriptionReader(),
+        private readonly TagParserInterface $tags = new TagParser(),
+    ) {}
 
     /**
      * @throws RuntimeExceptionInterface
      */
-    public function create(#[Language('PHP')] string $docblock): DocBlock
+    public function parse(#[Language('PHP')] string $docblock): DocBlock
     {
         $mapper = new SourceMap();
 
@@ -88,9 +81,9 @@ private function analyze(string $docblock): \Generator
         foreach ($blocks->getReturn() as $block) {
             try {
                 if ($description === null) {
-                    $description = $this->description->parse($block, $this->tags);
+                    $description = $this->descriptions->parse($block, $this->tags);
                 } else {
-                    $tags[] = $this->tags->parse($block, $this->description);
+                    $tags[] = $this->tags->parse($block, $this->descriptions);
                 }
             } catch (RuntimeExceptionInterface $e) {
                 throw $e->withSource(
@@ -123,7 +116,7 @@ private function groupByCommentSections(string $docblock): \Generator
         $current = '';
         $blocks = [];
 
-        foreach ($this->comment->parse($docblock) as $segment) {
+        foreach ($this->comments->parse($docblock) as $segment) {
             yield $segment;
 
             if (\str_starts_with($segment->text, '@')) {

src/Exception/PHPDocException.php

@@ -9,10 +9,10 @@
 /**
  * @psalm-suppress UndefinedAttributeClass : JetBrains language attribute may not be available
  */
-interface DocBlockFactoryInterface
+interface ParserInterface
 {
     /**
      * @param string $docblock A string containing the DocBlock to parse.
      */
-    public function create(#[Language('PHP')] string $docblock): DocBlock;
+    public function parse(#[Language('PHP')] string $docblock): DocBlock;
 }