Skip to content

Add multiline generic support #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 6, 2020
Merged

Add multiline generic support #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
73d91aa
Add multiline generic support
May 4, 2020
c17c3bc
Update Codestyle issues
May 4, 2020
ed755ef
Add test for docblock parsing
May 4, 2020
b2030f6
Add possibility for leading comma
May 5, 2020
183925f
Add support for trailing comma
May 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/Parser/TypeParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,13 +165,24 @@ private function parseNullable(TokenIterator $tokens): Ast\Type\TypeNode
public function parseGeneric(TokenIterator $tokens, Ast\Type\IdentifierTypeNode $baseType): Ast\Type\GenericTypeNode
{
$tokens->consumeTokenType(Lexer::TOKEN_OPEN_ANGLE_BRACKET);
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
$genericTypes = [$this->parse($tokens)];

$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);

while ($tokens->tryConsumeTokenType(Lexer::TOKEN_COMMA)) {
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
if ($tokens->tryConsumeTokenType(Lexer::TOKEN_CLOSE_ANGLE_BRACKET)) {
// trailing comma case
return new Ast\Type\GenericTypeNode($baseType, $genericTypes);
}
$genericTypes[] = $this->parse($tokens);
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
}

$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
$tokens->consumeTokenType(Lexer::TOKEN_CLOSE_ANGLE_BRACKET);

return new Ast\Type\GenericTypeNode($baseType, $genericTypes);
}

Expand Down
74 changes: 74 additions & 0 deletions tests/PHPStan/Parser/PhpDocParserTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3054,6 +3054,80 @@ public function provideRealWorldExampleData(): \Iterator
new PhpDocTagNode('@param', new InvalidTagValueNode('Foo::** $a', new \PHPStan\PhpDocParser\Parser\ParserException('*', Lexer::TOKEN_WILDCARD, 17, Lexer::TOKEN_VARIABLE))),
]),
];

yield [
'multiline generic types',
'/**' . PHP_EOL .
' * @implements Foo<' . PHP_EOL .
' * A, B' . PHP_EOL .
' * >' . PHP_EOL .
' */',
new PhpDocNode([
new PhpDocTagNode(
'@implements',
new ImplementsTagValueNode(
new GenericTypeNode(
new IdentifierTypeNode('Foo'),
[
new IdentifierTypeNode('A'),
new IdentifierTypeNode('B'),
]
),
''
)
),
]),
];

yield [
'multiline generic types - leading comma',
'/**' . PHP_EOL .
' * @implements Foo<' . PHP_EOL .
' * A' . PHP_EOL .
' * , B' . PHP_EOL .
' * >' . PHP_EOL .
' */',
new PhpDocNode([
new PhpDocTagNode(
'@implements',
new ImplementsTagValueNode(
new GenericTypeNode(
new IdentifierTypeNode('Foo'),
[
new IdentifierTypeNode('A'),
new IdentifierTypeNode('B'),
]
),
''
)
),
]),
];

yield [
'multiline generic types - traling comma',
'/**' . PHP_EOL .
' * @implements Foo<' . PHP_EOL .
' * A,' . PHP_EOL .
' * B,' . PHP_EOL .
' * >' . PHP_EOL .
' */',
new PhpDocNode([
new PhpDocTagNode(
'@implements',
new ImplementsTagValueNode(
new GenericTypeNode(
new IdentifierTypeNode('Foo'),
[
new IdentifierTypeNode('A'),
new IdentifierTypeNode('B'),
]
),
''
)
),
]),
];
}

public function dataParseTagValue(): array
Expand Down
76 changes: 76 additions & 0 deletions tests/PHPStan/Parser/TypeParserTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -899,6 +899,82 @@ public function provideParseData(): array
new ConstTypeNode(new ConstFetchNode('QueueAttributeName', '*')),
]),
],
[
'array<' . PHP_EOL .
' Foo' . PHP_EOL .
'>',
new GenericTypeNode(
new IdentifierTypeNode('array'),
[
new IdentifierTypeNode('Foo'),
]
),
],
[
'array<' . PHP_EOL .
' Foo,' . PHP_EOL .
' Bar' . PHP_EOL .
'>',
new GenericTypeNode(
new IdentifierTypeNode('array'),
[
new IdentifierTypeNode('Foo'),
new IdentifierTypeNode('Bar'),
]
),
],
[
'array<' . PHP_EOL .
' Foo, Bar' . PHP_EOL .
'>',
new GenericTypeNode(
new IdentifierTypeNode('array'),
[
new IdentifierTypeNode('Foo'),
new IdentifierTypeNode('Bar'),
]
),
],
[
'array<' . PHP_EOL .
' Foo,' . PHP_EOL .
' array<' . PHP_EOL .
' Bar' . PHP_EOL .
' >' . PHP_EOL .
'>',
new GenericTypeNode(
new IdentifierTypeNode('array'),
[
new IdentifierTypeNode('Foo'),
new GenericTypeNode(
new IdentifierTypeNode('array'),
[
new IdentifierTypeNode('Bar'),
]
),
]
),
],
[
'array<' . PHP_EOL .
' Foo,' . PHP_EOL .
' array<' . PHP_EOL .
' Bar,' . PHP_EOL .
' >' . PHP_EOL .
'>',
new GenericTypeNode(
new IdentifierTypeNode('array'),
[
new IdentifierTypeNode('Foo'),
new GenericTypeNode(
new IdentifierTypeNode('array'),
[
new IdentifierTypeNode('Bar'),
]
),
]
),
],
];
}

Expand Down