Skip to content

Commit 1befc84

Browse files
author
Kirill Nesmeyanov
committed
Simplify docblock parser
1 parent 1786d82 commit 1befc84

38 files changed

Lines changed: 48 additions & 1451 deletions

‎src/DocBlock.php‎

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ final class DocBlock implements
2222
use TagProvider;
2323

2424
/**
25-
* @param iterable<TagInterface> $tags
25+
* @param iterable<array-key, TagInterface> $tags
2626
*/
2727
public function __construct(
2828
private readonly DescriptionInterface $description = new Description(),
@@ -33,11 +33,8 @@ public function __construct(
3333

3434
/**
3535
* @return array{
36-
* description: array{
37-
* template: string,
38-
* tags: list<array>
39-
* },
40-
* tags: list<array>
36+
* description: array<array-key, mixed>,
37+
* tags: list<array<array-key, mixed>>
4138
* }
4239
*/
4340
public function toArray(): array
@@ -56,11 +53,8 @@ public function toArray(): array
5653

5754
/**
5855
* @return array{
59-
* description: array{
60-
* template: string,
61-
* tags: list<array>
62-
* },
63-
* tags: list<array>
56+
* description: array<array-key, mixed>,
57+
* tags: list<array<array-key, mixed>>
6458
* }
6559
*/
6660
public function jsonSerialize(): array

‎src/DocBlockFactory.php‎

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,6 @@
1818
use TypeLang\PHPDoc\Parser\SourceMap;
1919
use TypeLang\PHPDoc\Parser\Tag\TagParser;
2020
use TypeLang\PHPDoc\Parser\Tag\TagParserInterface;
21-
use TypeLang\PHPDoc\Tag\MutableRepositoryInterface;
22-
use TypeLang\PHPDoc\Tag\Repository;
23-
use TypeLang\PHPDoc\Tag\RepositoryInterface;
2421

2522
/**
2623
* @psalm-suppress UndefinedAttributeClass : JetBrains language attribute may not be available
@@ -31,26 +28,13 @@ class DocBlockFactory implements DocBlockFactoryInterface
3128

3229
private readonly DescriptionParserInterface $description;
3330

34-
private readonly MutableRepositoryInterface $tags;
31+
private readonly TagParserInterface $tags;
3532

36-
private readonly TagParserInterface $parser;
37-
38-
public function __construct(?RepositoryInterface $tags = null)
33+
public function __construct()
3934
{
4035
$this->comment = new LexerAwareCommentParser();
4136
$this->description = new SprintfDescriptionReader();
42-
43-
$this->tags = $this->createRepository($tags);
44-
$this->parser = new TagParser($this->tags);
45-
}
46-
47-
private function createRepository(?RepositoryInterface $tags): MutableRepositoryInterface
48-
{
49-
if ($tags instanceof MutableRepositoryInterface) {
50-
return $tags;
51-
}
52-
53-
return new Repository($tags);
37+
$this->tags = new TagParser();
5438
}
5539

5640
/**
@@ -61,7 +45,10 @@ public function create(#[Language('PHP')] string $docblock): DocBlock
6145
$mapper = new SourceMap();
6246

6347
try {
64-
/** @var Segment $segment */
48+
/**
49+
* @var Segment $segment
50+
* @psalm-suppress InvalidIterator
51+
*/
6552
foreach ($result = $this->analyze($docblock) as $segment) {
6653
$mapper->add($segment->offset, $segment->text);
6754
}
@@ -91,6 +78,7 @@ public function create(#[Language('PHP')] string $docblock): DocBlock
9178
*/
9279
private function analyze(string $docblock): \Generator
9380
{
81+
/** @psalm-suppress InvalidIterator */
9482
yield from $blocks = $this->groupByCommentSections($docblock);
9583

9684
$description = null;
@@ -100,9 +88,9 @@ private function analyze(string $docblock): \Generator
10088
foreach ($blocks->getReturn() as $block) {
10189
try {
10290
if ($description === null) {
103-
$description = $this->description->parse($block, $this->parser);
91+
$description = $this->description->parse($block, $this->tags);
10492
} else {
105-
$tags[] = $this->parser->parse($block);
93+
$tags[] = $this->tags->parse($block, $this->description);
10694
}
10795
} catch (RuntimeExceptionInterface $e) {
10896
throw $e->withSource(

‎src/Exception/InvalidTagNameException.php‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,10 @@ class InvalidTagNameException extends InvalidTagException
1818

1919
/**
2020
* Occurs when a tag name is empty.
21+
*
22+
* @param int<0, max> $offset
2123
*/
22-
public static function fromEmptyTag(int $offset = 0): self
24+
public static function fromEmptyTag(int $offset = 0): static
2325
{
2426
$message = 'Can not read tag name from empty value';
2527

@@ -28,21 +30,25 @@ public static function fromEmptyTag(int $offset = 0): self
2830

2931
/**
3032
* Occurs when a tag name contains only the "@" character.
33+
*
34+
* @param int<0, max> $offset
3135
*/
32-
public static function fromEmptyTagName(ReadableInterface|string $source, int $offset = 0): self
36+
public static function fromEmptyTagName(ReadableInterface|string $source, int $offset = 0): static
3337
{
3438
$message = 'Tag name cannot be empty';
3539

36-
return new self($source, $offset, $message, self::ERROR_CODE_EMPTY_NAME);
40+
return new static($source, $offset, $message, self::ERROR_CODE_EMPTY_NAME);
3741
}
3842

3943
/**
4044
* Occurs when a tag name does not start with the "@" character.
45+
*
46+
* @param int<0, max> $offset
4147
*/
42-
public static function fromInvalidTagPrefix(ReadableInterface|string $source, int $offset = 0): self
48+
public static function fromInvalidTagPrefix(ReadableInterface|string $source, int $offset = 0): static
4349
{
4450
$message = 'The tag name must starts with the "@" character';
4551

46-
return new self($source, $offset, $message, self::ERROR_CODE_INVALID_PREFIX);
52+
return new static($source, $offset, $message, self::ERROR_CODE_INVALID_PREFIX);
4753
}
4854
}

‎src/Exception/RuntimeExceptionInterface.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ interface RuntimeExceptionInterface extends PHPDocExceptionInterface
1616
*
1717
* @param int<0, max> $offset
1818
*/
19-
public function withSource(ReadableInterface $source, int $offset): self;
19+
public function withSource(ReadableInterface|string $source, int $offset): self;
2020

2121
/**
2222
* Returns the full content in which the error occurred.

‎src/Parser/Description/DescriptionParser.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ private function doParseDescription(string $description, TagParserInterface $par
3333

3434
if (\str_starts_with($chunk, '@')) {
3535
try {
36-
$tags[] = $parser->parse($chunk);
36+
$tags[] = $parser->parse($chunk, $this);
3737
$result .= $this->createDescriptionChunkPlaceholder(++$tagIdentifier);
3838
} catch (\Throwable) {
3939
$result .= "{{$chunk}}";

‎src/Parser/SourceMap.php‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ public function add(int $offset, string $segment): void
3434
$this->offset += $length;
3535
}
3636

37+
/**
38+
* @return int<0, max>
39+
*/
3740
public function getOffset(int $offset): int
3841
{
3942
if ($offset >= $this->offset) {
@@ -44,12 +47,12 @@ public function getOffset(int $offset): int
4447

4548
foreach ($this->mappings as $from => $to) {
4649
if ($from > $offset) {
47-
return $result + $offset;
50+
return \max(0, $result + $offset);
4851
}
4952

5053
$result = $to - $from;
5154
}
5255

53-
return $result + $offset;
56+
return \max(0, $result + $offset);
5457
}
5558
}

‎src/Parser/Tag/TagParser.php‎

Lines changed: 11 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,16 @@
55
namespace TypeLang\PHPDoc\Parser\Tag;
66

77
use TypeLang\PHPDoc\Exception\InvalidTagNameException;
8-
use TypeLang\PHPDoc\Tag\Definition\DefinitionInterface;
9-
use TypeLang\PHPDoc\Tag\Definition\ParsableInterface;
10-
use TypeLang\PHPDoc\Tag\Definition\UnknownDefinition;
11-
use TypeLang\PHPDoc\Tag\RepositoryInterface;
8+
use TypeLang\PHPDoc\Parser\Description\DescriptionParserInterface;
9+
use TypeLang\PHPDoc\Tag\Tag;
1210
use TypeLang\PHPDoc\Tag\TagInterface;
13-
use TypeLang\PHPDoc\Tag\UnknownTag;
1411

1512
final class TagParser implements TagParserInterface
1613
{
1714
/**
1815
* @var non-empty-string
1916
*/
20-
private const PATTERN_TAG = '\G@[a-zA-Z_\x80-\xff][\w\x80-\xff\-:]*';
21-
22-
public function __construct(
23-
private readonly RepositoryInterface $tags,
24-
private readonly DefinitionInterface $unknown = new UnknownDefinition(),
25-
) {}
17+
private const PATTERN_TAG = '\G@[a-zA-Z_\x80-\xff\\\][\w\x80-\xff\-:\\\]*';
2618

2719
/**
2820
* Read tag name from passed content.
@@ -64,6 +56,7 @@ private function getTagName(string $content): string
6456

6557
/**
6658
* @return array{non-empty-string, string}
59+
* @throws InvalidTagNameException
6760
*/
6861
private function getTagParts(string $content): array
6962
{
@@ -77,30 +70,18 @@ private function getTagParts(string $content): array
7770
return [$name, $content];
7871
}
7972

80-
public function parse(string $tag): TagInterface
73+
/**
74+
* @throws InvalidTagNameException
75+
*/
76+
public function parse(string $tag, DescriptionParserInterface $parser = null): TagInterface
8177
{
8278
// Tag name like ["var", "example"] extracted from "@var example"
8379
[$name, $content] = $this->getTagParts($tag);
8480

85-
$definition = $this->tags->findByName($name);
86-
87-
if ($definition === null) {
88-
return new UnknownTag(
89-
definition: $this->unknown,
90-
name: $name,
91-
description: $content,
92-
);
93-
}
94-
95-
return $this->getTagFromDefinition($definition, $name, $content);
96-
}
97-
98-
private function getTagFromDefinition(DefinitionInterface $definition, string $name, string $content): TagInterface
99-
{
100-
if ($definition instanceof ParsableInterface) {
101-
return $definition->parse($name, $content);
81+
if ($parser !== null) {
82+
$content = $parser->parse($content, $this);
10283
}
10384

104-
dd('ToDO');
85+
return new Tag($name, $content);
10586
}
10687
}

‎src/Parser/Tag/TagParserInterface.php‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
namespace TypeLang\PHPDoc\Parser\Tag;
66

7+
use TypeLang\PHPDoc\Parser\Description\DescriptionParserInterface;
78
use TypeLang\PHPDoc\Tag\TagInterface;
89

910
interface TagParserInterface
@@ -22,8 +23,6 @@ interface TagParserInterface
2223
* // description: object(Description) { ... },
2324
* // }
2425
* ```
25-
*
26-
* @param non-empty-string $tag
2726
*/
28-
public function parse(string $tag): TagInterface;
27+
public function parse(string $tag, DescriptionParserInterface $parser = null): TagInterface;
2928
}

‎src/Tag/Definition/Definition.php‎

Lines changed: 0 additions & 53 deletions
This file was deleted.

‎src/Tag/Definition/DefinitionInterface.php‎

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)