A little code improvements

Author: Kirill Nesmeyanov

src/DocBlock.php

@@ -46,36 +46,6 @@ public function __construct(
         $this->bootTagProvider($tags);
     }
 
-    public function offsetExists(mixed $offset): bool
-    {
-        return isset($this->tags[$offset]);
-    }
-
-    public function offsetGet(mixed $offset): ?TagInterface
-    {
-        return $this->tags[$offset] ?? null;
-    }
-
-    /**
-     * {@inheritDoc}
-     *
-     * @throws \BadMethodCallException
-     */
-    public function offsetSet(mixed $offset, mixed $value): void
-    {
-        throw new \BadMethodCallException(self::class . ' objects are immutable');
-    }
-
-    /**
-     * {@inheritDoc}
-     *
-     * @throws \BadMethodCallException
-     */
-    public function offsetUnset(mixed $offset): void
-    {
-        throw new \BadMethodCallException(self::class . ' objects are immutable');
-    }
-
     public function getDescription(): DescriptionInterface
     {
         return $this->description;

src/Parser.php

@@ -5,17 +5,15 @@
 namespace TypeLang\PHPDoc;
 
 use JetBrains\PhpStorm\Language;
-use TypeLang\PHPDoc\Exception\InvalidTagException;
-use TypeLang\PHPDoc\Exception\InvalidTagNameException;
 use TypeLang\PHPDoc\Exception\ParsingException;
 use TypeLang\PHPDoc\Exception\RuntimeExceptionInterface;
 use TypeLang\PHPDoc\Parser\Comment\CommentParserInterface;
 use TypeLang\PHPDoc\Parser\Comment\RegexCommentParser;
 use TypeLang\PHPDoc\Parser\Comment\Segment;
 use TypeLang\PHPDoc\Parser\Description\DescriptionParserInterface;
-use TypeLang\PHPDoc\Parser\Description\SprintfDescriptionReader;
+use TypeLang\PHPDoc\Parser\Description\SprintfDescriptionParser;
 use TypeLang\PHPDoc\Parser\SourceMap;
-use TypeLang\PHPDoc\Parser\Tag\TagParser;
+use TypeLang\PHPDoc\Parser\Tag\RegexTagParser;
 use TypeLang\PHPDoc\Parser\Tag\TagParserInterface;
 use TypeLang\PHPDoc\Tag\Factory\FactoryInterface;
 use TypeLang\PHPDoc\Tag\Factory\TagFactory;
@@ -31,8 +29,8 @@ class Parser implements ParserInterface
     public function __construct(
         FactoryInterface $tags = new TagFactory(),
     ) {
-        $this->tags = new TagParser($tags);
-        $this->descriptions = new SprintfDescriptionReader($this->tags);
+        $this->tags = new RegexTagParser($tags);
+        $this->descriptions = new SprintfDescriptionParser($this->tags);
         $this->comments = new RegexCommentParser();
     }
 

src/Parser/Comment/Segment.php

@@ -4,18 +4,13 @@
 
 namespace TypeLang\PHPDoc\Parser\Comment;
 
-final class Segment implements \Stringable
+final class Segment
 {
     /**
      * @param int<0, max> $offset
      */
     public function __construct(
-        public string $text = '',
-        public int $offset = 0,
+        public readonly string $text = '',
+        public readonly int $offset = 0,
     ) {}
-
-    public function __toString(): string
-    {
-        return $this->text;
-    }
 }

src/Parser/Description/DescriptionParser.php

@@ -4,13 +4,14 @@
 
 namespace TypeLang\PHPDoc\Parser\Description;
 
+use TypeLang\PHPDoc\Parser\Tag\RegexTagParser;
 use TypeLang\PHPDoc\Parser\Tag\TagParserInterface;
 use TypeLang\PHPDoc\Tag\Description;
 
 abstract class DescriptionParser implements DescriptionParserInterface
 {
     public function __construct(
-        private readonly TagParserInterface $tags,
+        private readonly TagParserInterface $tags = new RegexTagParser(),
     ) {}
 
     public function parse(string $description): Description

src/Parser/Description/SprintfDescriptionReader.php renamed to src/Parser/Description/SprintfDescriptionParser.php

@@ -4,7 +4,7 @@
 
 namespace TypeLang\PHPDoc\Parser\Description;
 
-final class SprintfDescriptionReader extends DescriptionParser
+final class SprintfDescriptionParser extends DescriptionParser
 {
     /**
      * @param int<0, max> $tagId

src/Parser/Tag/TagParser.php renamed to src/Parser/Tag/RegexTagParser.php

@@ -9,18 +9,19 @@
 use TypeLang\PHPDoc\Parser\Description\DescriptionParserInterface;
 use TypeLang\PHPDoc\Tag\Factory\FactoryInterface;
 use TypeLang\PHPDoc\Tag\Content;
+use TypeLang\PHPDoc\Tag\Factory\TagFactory;
 use TypeLang\PHPDoc\Tag\InvalidTag;
 use TypeLang\PHPDoc\Tag\TagInterface;
 
-final class TagParser implements TagParserInterface
+final class RegexTagParser implements TagParserInterface
 {
     /**
      * @var non-empty-string
      */
     private const PATTERN_TAG = '\G@[a-zA-Z_\x80-\xff\\\][\w\x80-\xff\-:\\\]*';
 
     public function __construct(
-        private readonly FactoryInterface $tags,
+        private readonly FactoryInterface $tags = new TagFactory(),
     ) {}
 
     /**

src/Tag/Description.php

@@ -6,8 +6,9 @@
 
 /**
  * @template-implements \IteratorAggregate<int<0, max>, TagInterface>
+ * @template-implements \ArrayAccess<int<0, max>, TagInterface|null>
  */
-class Description implements DescriptionInterface, \IteratorAggregate
+class Description implements DescriptionInterface, \IteratorAggregate, \ArrayAccess
 {
     use TagsProvider;
 

src/Tag/Factory/TagFactory.php

@@ -55,6 +55,12 @@ public function create(string $name, Content $content, DescriptionParserInterfac
             }
         }
 
-        return new Tag($name, $content->toDescription($descriptions));
+        $description = null;
+
+        if ($content->value !== '') {
+            $description = $content->toDescription($descriptions);
+        }
+
+        return new Tag($name, $description);
     }
 }

src/Tag/TagsProvider.php

@@ -7,9 +7,11 @@
 /**
  * @mixin TagsProviderInterface
  * @mixin \IteratorAggregate
+ * @mixin \ArrayAccess
  *
  * @psalm-require-implements TagsProviderInterface
  * @psalm-require-implements \IteratorAggregate
+ * @psalm-require-implements \ArrayAccess
  *
  * @internal This is an internal library trait, please do not use it in your code.
  * @psalm-internal TypeLang\PHPDoc\Tag
@@ -41,6 +43,36 @@ public function getTags(): array
         return $this->tags;
     }
 
+    public function offsetExists(mixed $offset): bool
+    {
+        return isset($this->tags[$offset]);
+    }
+
+    public function offsetGet(mixed $offset): ?TagInterface
+    {
+        return $this->tags[$offset] ?? null;
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @throws \BadMethodCallException
+     */
+    public function offsetSet(mixed $offset, mixed $value): void
+    {
+        throw new \BadMethodCallException(self::class . ' objects are immutable');
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @throws \BadMethodCallException
+     */
+    public function offsetUnset(mixed $offset): void
+    {
+        throw new \BadMethodCallException(self::class . ' objects are immutable');
+    }
+
     /**
      * @return \Traversable<int<0, max>, TagInterface>
      */