Skip to content

Commit 5745775

Browse files
ondrejmirtesondrejmirtes
committed
Fix parsing Doctrine strings
1 parent 4a1ab8e commit 5745775

File tree

7 files changed

+320
-38
lines changed

7 files changed

+320
-38
lines changed

‎phpstan.neon‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ parameters:
77
- tests
88
excludePaths:
99
- tests/PHPStan/*/data/*
10+
- tests/PHPStan/Parser/Doctrine/ApiResource.php
1011
level: 8
1112
ignoreErrors:
1213
- '#^Dynamic call to static method PHPUnit\\Framework\\Assert#'

‎src/Ast/ConstExpr/DoctrineConstExprStringNode.php‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\PhpDocParser\Ast\ConstExpr;
4+
5+
use PHPStan\PhpDocParser\Ast\NodeAttributes;
6+
use function sprintf;
7+
use function str_replace;
8+
use function strlen;
9+
use function substr;
10+
11+
class DoctrineConstExprStringNode extends ConstExprStringNode
12+
{
13+
14+
use NodeAttributes;
15+
16+
/** @var string */
17+
public $value;
18+
19+
public function __construct(string $value)
20+
{
21+
parent::__construct($value);
22+
$this->value = $value;
23+
}
24+
25+
public function __toString(): string
26+
{
27+
return self::escape($this->value);
28+
}
29+
30+
public static function unescape(string $value): string
31+
{
32+
// from https://github.com/doctrine/annotations/blob/a9ec7af212302a75d1f92fa65d3abfbd16245a2a/lib/Doctrine/Common/Annotations/DocLexer.php#L103-L107
33+
return str_replace('""', '"', substr($value, 1, strlen($value) - 2));
34+
}
35+
36+
private static function escape(string $value): string
37+
{
38+
// from https://github.com/phpstan/phpdoc-parser/issues/205#issuecomment-1662323656
39+
return sprintf('"%s"', str_replace('"', '""', $value));
40+
}
41+
42+
}

‎src/Lexer/Lexer.php‎

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,20 @@ class Lexer
3535
public const TOKEN_INTEGER = 20;
3636
public const TOKEN_SINGLE_QUOTED_STRING = 21;
3737
public const TOKEN_DOUBLE_QUOTED_STRING = 22;
38-
public const TOKEN_IDENTIFIER = 23;
39-
public const TOKEN_THIS_VARIABLE = 24;
40-
public const TOKEN_VARIABLE = 25;
41-
public const TOKEN_HORIZONTAL_WS = 26;
42-
public const TOKEN_PHPDOC_EOL = 27;
43-
public const TOKEN_OTHER = 28;
44-
public const TOKEN_END = 29;
45-
public const TOKEN_COLON = 30;
46-
public const TOKEN_WILDCARD = 31;
47-
public const TOKEN_OPEN_CURLY_BRACKET = 32;
48-
public const TOKEN_CLOSE_CURLY_BRACKET = 33;
49-
public const TOKEN_NEGATED = 34;
50-
public const TOKEN_ARROW = 35;
38+
public const TOKEN_DOCTRINE_ANNOTATION_STRING = 23;
39+
public const TOKEN_IDENTIFIER = 24;
40+
public const TOKEN_THIS_VARIABLE = 25;
41+
public const TOKEN_VARIABLE = 26;
42+
public const TOKEN_HORIZONTAL_WS = 27;
43+
public const TOKEN_PHPDOC_EOL = 28;
44+
public const TOKEN_OTHER = 29;
45+
public const TOKEN_END = 30;
46+
public const TOKEN_COLON = 31;
47+
public const TOKEN_WILDCARD = 32;
48+
public const TOKEN_OPEN_CURLY_BRACKET = 33;
49+
public const TOKEN_CLOSE_CURLY_BRACKET = 34;
50+
public const TOKEN_NEGATED = 35;
51+
public const TOKEN_ARROW = 36;
5152

5253
public const TOKEN_LABELS = [
5354
self::TOKEN_REFERENCE => '\'&\'',
@@ -79,6 +80,7 @@ class Lexer
7980
self::TOKEN_INTEGER => 'TOKEN_INTEGER',
8081
self::TOKEN_SINGLE_QUOTED_STRING => 'TOKEN_SINGLE_QUOTED_STRING',
8182
self::TOKEN_DOUBLE_QUOTED_STRING => 'TOKEN_DOUBLE_QUOTED_STRING',
83+
self::TOKEN_DOCTRINE_ANNOTATION_STRING => 'TOKEN_DOCTRINE_ANNOTATION_STRING',
8284
self::TOKEN_IDENTIFIER => 'type',
8385
self::TOKEN_THIS_VARIABLE => '\'$this\'',
8486
self::TOKEN_VARIABLE => 'variable',
@@ -180,6 +182,7 @@ private function generateRegexp(): string
180182

181183
if ($this->parseDoctrineAnnotations) {
182184
$patterns[self::TOKEN_DOCTRINE_TAG] = '@[a-z_\\\\][a-z0-9_\:\\\\]*[a-z_][a-z0-9_]*';
185+
$patterns[self::TOKEN_DOCTRINE_ANNOTATION_STRING] = '"(?:""|[^"])*+"';
183186
}
184187

185188
// anything but TOKEN_CLOSE_PHPDOC or TOKEN_HORIZONTAL_WS or TOKEN_EOL

‎src/Parser/ConstExprParser.php‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ class ConstExprParser
2323
/** @var bool */
2424
private $useIndexAttributes;
2525

26+
/** @var bool */
27+
private $parseDoctrineStrings;
28+
2629
/**
2730
* @param array{lines?: bool, indexes?: bool} $usedAttributes
2831
*/
@@ -36,6 +39,24 @@ public function __construct(
3639
$this->quoteAwareConstExprString = $quoteAwareConstExprString;
3740
$this->useLinesAttributes = $usedAttributes['lines'] ?? false;
3841
$this->useIndexAttributes = $usedAttributes['indexes'] ?? false;
42+
$this->parseDoctrineStrings = false;
43+
}
44+
45+
/**
46+
* @internal
47+
*/
48+
public function toDoctrine(): self
49+
{
50+
$self = new self(
51+
$this->unescapeStrings,
52+
$this->quoteAwareConstExprString,
53+
[
54+
'lines' => $this->useLinesAttributes,
55+
'indexes' => $this->useIndexAttributes,
56+
]
57+
);
58+
$self->parseDoctrineStrings = true;
59+
return $self;
3960
}
4061

4162
public function parse(TokenIterator $tokens, bool $trimStrings = false): Ast\ConstExpr\ConstExprNode
@@ -66,7 +87,41 @@ public function parse(TokenIterator $tokens, bool $trimStrings = false): Ast\Con
6687
);
6788
}
6889

90+
if ($this->parseDoctrineStrings && $tokens->isCurrentTokenType(Lexer::TOKEN_DOCTRINE_ANNOTATION_STRING)) {
91+
$value = $tokens->currentTokenValue();
92+
$tokens->next();
93+
94+
return $this->enrichWithAttributes(
95+
$tokens,
96+
new Ast\ConstExpr\DoctrineConstExprStringNode(Ast\ConstExpr\DoctrineConstExprStringNode::unescape($value)),
97+
$startLine,
98+
$startIndex
99+
);
100+
}
101+
69102
if ($tokens->isCurrentTokenType(Lexer::TOKEN_SINGLE_QUOTED_STRING, Lexer::TOKEN_DOUBLE_QUOTED_STRING)) {
103+
if ($this->parseDoctrineStrings) {
104+
if ($tokens->isCurrentTokenType(Lexer::TOKEN_SINGLE_QUOTED_STRING)) {
105+
throw new ParserException(
106+
$tokens->currentTokenValue(),
107+
$tokens->currentTokenType(),
108+
$tokens->currentTokenOffset(),
109+
Lexer::TOKEN_DOUBLE_QUOTED_STRING,
110+
null,
111+
$tokens->currentTokenLine()
112+
);
113+
}
114+
115+
$value = $tokens->currentTokenValue();
116+
$tokens->next();
117+
118+
return $this->enrichWithAttributes(
119+
$tokens,
120+
$this->parseDoctrineString($value, $tokens),
121+
$startLine,
122+
$startIndex
123+
);
124+
}
70125
$value = $tokens->currentTokenValue();
71126
$type = $tokens->currentTokenType();
72127
if ($trimStrings) {
@@ -214,6 +269,19 @@ private function parseArray(TokenIterator $tokens, int $endToken, int $startInde
214269
}
215270

216271

272+
public function parseDoctrineString(string $value, TokenIterator $tokens): Ast\ConstExpr\DoctrineConstExprStringNode
273+
{
274+
$text = $value;
275+
276+
while ($tokens->isCurrentTokenType(Lexer::TOKEN_DOUBLE_QUOTED_STRING, Lexer::TOKEN_DOCTRINE_ANNOTATION_STRING)) {
277+
$text .= $tokens->currentTokenValue();
278+
$tokens->next();
279+
}
280+
281+
return new Ast\ConstExpr\DoctrineConstExprStringNode(Ast\ConstExpr\DoctrineConstExprStringNode::unescape($text));
282+
}
283+
284+
217285
private function parseArrayItem(TokenIterator $tokens): Ast\ConstExpr\ConstExprArrayItemNode
218286
{
219287
$startLine = $tokens->currentTokenLine();

‎src/Parser/PhpDocParser.php‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ class PhpDocParser
3535
/** @var ConstExprParser */
3636
private $constantExprParser;
3737

38+
/** @var ConstExprParser */
39+
private $doctrineConstantExprParser;
40+
3841
/** @var bool */
3942
private $requireWhitespaceBeforeDescription;
4043

@@ -68,6 +71,7 @@ public function __construct(
6871
{
6972
$this->typeParser = $typeParser;
7073
$this->constantExprParser = $constantExprParser;
74+
$this->doctrineConstantExprParser = $constantExprParser->toDoctrine();
7175
$this->requireWhitespaceBeforeDescription = $requireWhitespaceBeforeDescription;
7276
$this->preserveTypeAliasesWithInvalidTypes = $preserveTypeAliasesWithInvalidTypes;
7377
$this->parseDoctrineAnnotations = $parseDoctrineAnnotations;
@@ -688,7 +692,7 @@ private function parseDoctrineArgumentValue(TokenIterator $tokens)
688692
);
689693

690694
try {
691-
$constExpr = $this->constantExprParser->parse($tokens, true);
695+
$constExpr = $this->doctrineConstantExprParser->parse($tokens, true);
692696
if ($constExpr instanceof Ast\ConstExpr\ConstExprArrayNode) {
693697
throw $exception;
694698
}
@@ -750,14 +754,15 @@ private function parseDoctrineArrayKey(TokenIterator $tokens)
750754
$key = new Ast\ConstExpr\ConstExprIntegerNode(str_replace('_', '', $tokens->currentTokenValue()));
751755
$tokens->next();
752756

753-
} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_SINGLE_QUOTED_STRING)) {
754-
$key = new Ast\ConstExpr\QuoteAwareConstExprStringNode(StringUnescaper::unescapeString($tokens->currentTokenValue()), Ast\ConstExpr\QuoteAwareConstExprStringNode::SINGLE_QUOTED);
757+
} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_DOCTRINE_ANNOTATION_STRING)) {
758+
$key = new Ast\ConstExpr\DoctrineConstExprStringNode(Ast\ConstExpr\DoctrineConstExprStringNode::unescape($tokens->currentTokenValue()));
759+
755760
$tokens->next();
756761

757762
} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_DOUBLE_QUOTED_STRING)) {
758-
$key = new Ast\ConstExpr\QuoteAwareConstExprStringNode(StringUnescaper::unescapeString($tokens->currentTokenValue()), Ast\ConstExpr\QuoteAwareConstExprStringNode::DOUBLE_QUOTED);
759-
763+
$value = $tokens->currentTokenValue();
760764
$tokens->next();
765+
$key = $this->doctrineConstantExprParser->parseDoctrineString($value, $tokens);
761766

762767
} else {
763768
$currentTokenValue = $tokens->currentTokenValue();
@@ -786,7 +791,7 @@ private function parseDoctrineArrayKey(TokenIterator $tokens)
786791
}
787792

788793
$tokens->rollback();
789-
$constExpr = $this->constantExprParser->parse($tokens, true);
794+
$constExpr = $this->doctrineConstantExprParser->parse($tokens, true);
790795
if (!$constExpr instanceof Ast\ConstExpr\ConstFetchNode) {
791796
throw new ParserException(
792797
$tokens->currentTokenValue(),

‎tests/PHPStan/Parser/Doctrine/ApiResource.php‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\PhpDocParser\Parser\Doctrine;
4+
5+
/**
6+
* ApiResource annotation.
7+
*
8+
* @author Kévin Dunglas <dunglas@gmail.com>
9+
*
10+
* @Annotation
11+
* @Target({"CLASS"})
12+
*/
13+
final class ApiResource
14+
{
15+
16+
/** @var string */
17+
public $shortName;
18+
19+
/** @var string */
20+
public $description;
21+
22+
/** @var string */
23+
public $iri;
24+
25+
/** @var array */
26+
public $itemOperations;
27+
28+
/** @var array */
29+
public $collectionOperations;
30+
31+
/** @var array */
32+
public $attributes = [];
33+
34+
}

0 commit comments

Comments
 (0)