Skip to content

Commit 413545d

Browse files
author
Kirill Nesmeyanov
committed
Add parser ^2.0 compatibility and phpdoc serialization support
1 parent 5b44a41 commit 413545d

33 files changed

+584
-41
lines changed

‎composer.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,18 @@
1111
"require": {
1212
"php": "^8.1",
1313
"psr/http-message": "^1.0|^2.0",
14-
"type-lang/parser": "^1.0"
14+
"type-lang/parser": "^2.0"
1515
},
1616
"autoload": {
1717
"psr-4": {
1818
"TypeLang\\PhpDocParser\\": "src"
1919
}
2020
},
2121
"require-dev": {
22-
"friendsofphp/php-cs-fixer": "^3.35",
23-
"phpunit/phpunit": "^10.4",
22+
"friendsofphp/php-cs-fixer": "^3.42",
23+
"phpunit/phpunit": "^10.5",
2424
"rector/rector": "^0.18",
25-
"vimeo/psalm": "^5.15"
25+
"vimeo/psalm": "^5.18"
2626
},
2727
"autoload-dev": {
2828
"psr-4": {

‎phpunit.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3-
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.4/phpunit.xsd"
3+
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
44
colors="true"
55
backupGlobals="true"
66
stopOnFailure="false"

‎src/DocBlock.php‎

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@
44

55
namespace TypeLang\PhpDocParser;
66

7+
use TypeLang\Parser\Node\SerializableInterface;
78
use TypeLang\PhpDocParser\DocBlock\Description;
89
use TypeLang\PhpDocParser\DocBlock\Tag\TagInterface;
910
use TypeLang\PhpDocParser\DocBlock\TagProvider;
1011
use TypeLang\PhpDocParser\DocBlock\TagProviderInterface;
1112

12-
final class DocBlock implements TagProviderInterface
13+
final class DocBlock implements TagProviderInterface, SerializableInterface
1314
{
1415
use TagProvider {
1516
getIterator as private getTagProviderIterator;
@@ -30,6 +31,43 @@ public function getDescription(): Description
3031
return $this->description;
3132
}
3233

34+
/**
35+
* @return array{
36+
* description: array{
37+
* template: string,
38+
* tags: list<array>
39+
* },
40+
* tags: list<array>
41+
* }
42+
*/
43+
public function toArray(): array
44+
{
45+
$tags = [];
46+
47+
foreach ($this->tags as $tag) {
48+
$tags[] = $tag->toArray();
49+
}
50+
51+
return [
52+
'description' => $this->description->toArray(),
53+
'tags' => $tags,
54+
];
55+
}
56+
57+
/**
58+
* @return array{
59+
* description: array{
60+
* template: string,
61+
* tags: list<array>
62+
* },
63+
* tags: list<array>
64+
* }
65+
*/
66+
public function jsonSerialize(): array
67+
{
68+
return $this->toArray();
69+
}
70+
3371
public function getIterator(): \Traversable
3472
{
3573
yield from $this->description;

‎src/DocBlock/Description.php‎

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,21 @@
44

55
namespace TypeLang\PhpDocParser\DocBlock;
66

7+
use TypeLang\Parser\Node\SerializableInterface;
78
use TypeLang\PhpDocParser\DocBlock\Tag\TagInterface;
89

9-
final class Description implements TagProviderInterface, \Stringable
10+
final class Description implements
11+
TagProviderInterface,
12+
SerializableInterface,
13+
\Stringable
1014
{
1115
use TagProvider;
1216

1317
/**
1418
* @param iterable<array-key, TagInterface> $tags
1519
*/
1620
public function __construct(
17-
private readonly string $bodyTemplate = '',
21+
private readonly string $template = '',
1822
iterable $tags = [],
1923
) {
2024
$this->initializeTags($tags);
@@ -30,9 +34,40 @@ public static function create(string $body): self
3034
*
3135
* @psalm-immutable
3236
*/
33-
public function getBodyTemplate(): string
37+
public function getTemplate(): string
3438
{
35-
return $this->bodyTemplate;
39+
return $this->template;
40+
}
41+
42+
/**
43+
* @return array{
44+
* template: string,
45+
* tags: list<array>
46+
* }
47+
*/
48+
public function toArray(): array
49+
{
50+
$tags = [];
51+
52+
foreach ($this->tags as $tag) {
53+
$tags[] = $tag->toArray();
54+
}
55+
56+
return [
57+
'template' => $this->template,
58+
'tags' => $tags,
59+
];
60+
}
61+
62+
/**
63+
* @return array{
64+
* template: string,
65+
* tags: list<array>
66+
* }
67+
*/
68+
public function jsonSerialize(): array
69+
{
70+
return $this->toArray();
3671
}
3772

3873
/**
@@ -41,6 +76,6 @@ public function getBodyTemplate(): string
4176
public function __toString(): string
4277
{
4378
/** @psalm-suppress ImplicitToStringCast */
44-
return \vsprintf($this->bodyTemplate, $this->tags);
79+
return \vsprintf($this->template, $this->tags);
4580
}
4681
}

‎src/DocBlock/Extractor/TagReferenceExtractor.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public function extract(string $body): array
4040

4141
private function parseReference(string $body): ReferenceInterface
4242
{
43-
if ($result = $this->tryParseUriReference($body)) {
43+
if (($result = $this->tryParseUriReference($body)) !== null) {
4444
return $result;
4545
}
4646

@@ -57,7 +57,7 @@ private function parseReference(string $body): ReferenceInterface
5757
return $result ?? new GenericReference($body);
5858
}
5959

60-
if ($result = $this->tryParseNameReference($body)) {
60+
if (($result = $this->tryParseNameReference($body)) !== null) {
6161
return $result;
6262
}
6363

‎src/DocBlock/Reference/ClassConstReference.php‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,30 @@
1010
/**
1111
* Representation of the "Foo\Any::CONST" format.
1212
*/
13-
final class ClassConstReference implements ReferenceInterface
13+
final class ClassConstReference extends Reference
1414
{
1515
public function __construct(
1616
public readonly Name $class,
1717
public readonly Identifier $const,
1818
) {}
1919

20+
/**
21+
* @return array{
22+
* kind: int<0, max>,
23+
* class: class-string,
24+
* const: non-empty-string
25+
* }
26+
*/
27+
public function toArray(): array
28+
{
29+
return [
30+
...parent::toArray(),
31+
'kind' => ReferenceKind::CLASS_CONST_KIND,
32+
'class' => $this->class->toString(),
33+
'const' => $this->const->toString(),
34+
];
35+
}
36+
2037
public function __toString(): string
2138
{
2239
return \vsprintf('%s::%s', [

‎src/DocBlock/Reference/ClassPropertyReference.php‎

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,35 @@
1010
/**
1111
* Representation of the "Foo\Any::$property" format.
1212
*/
13-
final class ClassPropertyReference implements ReferenceInterface
13+
final class ClassPropertyReference extends Reference
1414
{
1515
public function __construct(
1616
public readonly Name $class,
17-
public readonly VariableLiteralNode $var,
17+
public readonly VariableLiteralNode $property,
1818
) {}
1919

20+
/**
21+
* @return array{
22+
* kind: int<0, max>,
23+
* class: class-string,
24+
* property: non-empty-string
25+
* }
26+
*/
27+
public function toArray(): array
28+
{
29+
return [
30+
...parent::toArray(),
31+
'kind' => ReferenceKind::CLASS_PROPERTY_KIND,
32+
'class' => $this->class->toString(),
33+
'property' => $this->property->getValue(),
34+
];
35+
}
36+
2037
public function __toString(): string
2138
{
2239
return \vsprintf('%s::%s', [
2340
$this->class->toString(),
24-
$this->var->getRawValue(),
41+
$this->property->getRawValue(),
2542
]);
2643
}
2744
}

‎src/DocBlock/Reference/FunctionReference.php‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,27 @@
99
/**
1010
* Representation of the "foo()" format.
1111
*/
12-
final class FunctionReference implements ReferenceInterface
12+
final class FunctionReference extends Reference
1313
{
1414
public function __construct(
1515
public readonly Name $function,
1616
) {}
1717

18+
/**
19+
* @return array{
20+
* kind: int<0, max>,
21+
* function: non-empty-string
22+
* }
23+
*/
24+
public function toArray(): array
25+
{
26+
return [
27+
...parent::toArray(),
28+
'kind' => ReferenceKind::FUNCTION_KIND,
29+
'function' => $this->function->toString(),
30+
];
31+
}
32+
1833
public function __toString(): string
1934
{
2035
return $this->function->toString() . '()';

‎src/DocBlock/Reference/GenericReference.php‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
* Representation of a reference in the case that the reference could not
99
* be processed in any way.
1010
*/
11-
final class GenericReference implements ReferenceInterface
11+
final class GenericReference extends Reference
1212
{
1313
/**
1414
* @param non-empty-string $reference
@@ -17,6 +17,21 @@ public function __construct(
1717
public readonly string $reference,
1818
) {}
1919

20+
/**
21+
* @return array{
22+
* kind: int<0, max>,
23+
* reference: non-empty-string
24+
* }
25+
*/
26+
public function toArray(): array
27+
{
28+
return [
29+
...parent::toArray(),
30+
'kind' => ReferenceKind::GENERIC_KIND,
31+
'reference' => $this->reference,
32+
];
33+
}
34+
2035
/**
2136
* @return non-empty-string
2237
*/

‎src/DocBlock/Reference/MethodReference.php‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,30 @@
1010
/**
1111
* Representation of the "Foo\Any::foo()" format.
1212
*/
13-
final class MethodReference implements ReferenceInterface
13+
final class MethodReference extends Reference
1414
{
1515
public function __construct(
1616
public readonly Name $class,
1717
public readonly Identifier $method,
1818
) {}
1919

20+
/**
21+
* @return array{
22+
* kind: int<0, max>,
23+
* class: class-string,
24+
* method: non-empty-string
25+
* }
26+
*/
27+
public function toArray(): array
28+
{
29+
return [
30+
...parent::toArray(),
31+
'kind' => ReferenceKind::CLASS_METHOD_KIND,
32+
'class' => $this->class->toString(),
33+
'method' => $this->method->toString(),
34+
];
35+
}
36+
2037
public function __toString(): string
2138
{
2239
return \vsprintf('%s::%s()', [

0 commit comments

Comments
 (0)