Skip to content

Update root-composer (major) #176

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.

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

Open
wants to merge 15 commits into
base: 1.9.x
Choose a base branch
from
Open
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/backward-compatibility.yml
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ on:
pull_request:
push:
branches:
- "1.9.x"
- "1.21.x"

jobs:
backward-compatibility:
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ on:
pull_request:
push:
branches:
- "1.9.x"
- "1.21.x"

jobs:
lint:
2 changes: 1 addition & 1 deletion .github/workflows/test-slevomat-coding-standard.yml
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ on:
pull_request:
push:
branches:
- "1.9.x"
- "1.21.x"

jobs:
tests:
24 changes: 12 additions & 12 deletions build-cs/composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
@@ -12,8 +12,8 @@
"phpstan/phpstan": "^1.5",
"phpstan/phpstan-phpunit": "^1.1",
"phpstan/phpstan-strict-rules": "^1.0",
"phpunit/phpunit": "^9.5",
"symfony/process": "^5.2"
"phpunit/phpunit": "^10.0",
"symfony/process": "^6.0"
},
"config": {
"platform": {
4 changes: 1 addition & 3 deletions src/Parser/PhpDocParser.php
Original file line number Diff line number Diff line change
@@ -333,9 +333,7 @@ public function parseTagValue(TokenIterator $tokens, string $tag): Ast\PhpDoc\Ph
private function parseParamTagValue(TokenIterator $tokens): Ast\PhpDoc\PhpDocTagValueNode
{
if (
$tokens->isCurrentTokenType(Lexer::TOKEN_REFERENCE)
|| $tokens->isCurrentTokenType(Lexer::TOKEN_VARIADIC)
|| $tokens->isCurrentTokenType(Lexer::TOKEN_VARIABLE)
$tokens->isCurrentTokenType(Lexer::TOKEN_REFERENCE, Lexer::TOKEN_VARIADIC, Lexer::TOKEN_VARIABLE)
) {
$type = null;
} else {
133 changes: 106 additions & 27 deletions src/Parser/TypeParser.php
Original file line number Diff line number Diff line change
@@ -522,47 +522,126 @@ private function parseCallableReturnType(TokenIterator $tokens): Ast\Type\TypeNo
$startLine = $tokens->currentTokenLine();
$startIndex = $tokens->currentTokenIndex();
if ($tokens->isCurrentTokenType(Lexer::TOKEN_NULLABLE)) {
$type = $this->parseNullable($tokens);
return $this->parseNullable($tokens);

} elseif ($tokens->tryConsumeTokenType(Lexer::TOKEN_OPEN_PARENTHESES)) {
$type = $this->parse($tokens);
$tokens->consumeTokenType(Lexer::TOKEN_CLOSE_PARENTHESES);
if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
$type = $this->tryParseArrayOrOffsetAccess($tokens, $type);
}

} else {
$type = new Ast\Type\IdentifierTypeNode($tokens->currentTokenValue());
$tokens->consumeTokenType(Lexer::TOKEN_IDENTIFIER);

if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_ANGLE_BRACKET)) {
$type = $this->parseGeneric(
$tokens,
$this->enrichWithAttributes(
$tokens,
$type,
$startLine,
$startIndex
)
);

} elseif (in_array($type->name, ['array', 'list'], true) && $tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_CURLY_BRACKET) && !$tokens->isPrecededByHorizontalWhitespace()) {
$type = $this->parseArrayShape($tokens, $this->enrichWithAttributes(
return $type;
} elseif ($tokens->tryConsumeTokenType(Lexer::TOKEN_THIS_VARIABLE)) {
$type = new Ast\Type\ThisTypeNode();
if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
$type = $this->tryParseArrayOrOffsetAccess($tokens, $this->enrichWithAttributes(
$tokens,
$type,
$startLine,
$startIndex
), $type->name);
));
}

return $type;
} else {
$currentTokenValue = $tokens->currentTokenValue();
$tokens->pushSavePoint(); // because of ConstFetchNode
if ($tokens->tryConsumeTokenType(Lexer::TOKEN_IDENTIFIER)) {
$type = new Ast\Type\IdentifierTypeNode($currentTokenValue);

if (!$tokens->isCurrentTokenType(Lexer::TOKEN_DOUBLE_COLON)) {
if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_ANGLE_BRACKET)) {
$type = $this->parseGeneric(
$tokens,
$this->enrichWithAttributes(
$tokens,
$type,
$startLine,
$startIndex
)
);
if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
$type = $this->tryParseArrayOrOffsetAccess($tokens, $this->enrichWithAttributes(
$tokens,
$type,
$startLine,
$startIndex
));
}

} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
$type = $this->tryParseArrayOrOffsetAccess($tokens, $this->enrichWithAttributes(
$tokens,
$type,
$startLine,
$startIndex
));

} elseif (in_array($type->name, ['array', 'list', 'object'], true) && $tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_CURLY_BRACKET) && !$tokens->isPrecededByHorizontalWhitespace()) {
if ($type->name === 'object') {
$type = $this->parseObjectShape($tokens);
} else {
$type = $this->parseArrayShape($tokens, $this->enrichWithAttributes(
$tokens,
$type,
$startLine,
$startIndex
), $type->name);
}

if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
$type = $this->tryParseArrayOrOffsetAccess($tokens, $this->enrichWithAttributes(
$tokens,
$type,
$startLine,
$startIndex
));
}
}

return $type;
} else {
$tokens->rollback(); // because of ConstFetchNode
}
} else {
$tokens->dropSavePoint(); // because of ConstFetchNode
}
}

if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
$type = $this->tryParseArrayOrOffsetAccess($tokens, $this->enrichWithAttributes(
$tokens,
$type,
$startLine,
$startIndex
));
$exception = new ParserException(
$tokens->currentTokenValue(),
$tokens->currentTokenType(),
$tokens->currentTokenOffset(),
Lexer::TOKEN_IDENTIFIER,
null,
$tokens->currentTokenLine()
);

if ($this->constExprParser === null) {
throw $exception;
}

return $type;
try {
$constExpr = $this->constExprParser->parse($tokens, true);
if ($constExpr instanceof Ast\ConstExpr\ConstExprArrayNode) {
throw $exception;
}

$type = new Ast\Type\ConstTypeNode($constExpr);
if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
$type = $this->tryParseArrayOrOffsetAccess($tokens, $this->enrichWithAttributes(
$tokens,
$type,
$startLine,
$startIndex
));
}

return $type;
} catch (LogicException $e) {
throw $exception;
}
}


87 changes: 87 additions & 0 deletions tests/PHPStan/Parser/TypeParserTest.php
Original file line number Diff line number Diff line change
@@ -770,6 +770,22 @@ public function provideParseData(): array
)
),
],
[
'callable(): Foo<Bar>[]',
new CallableTypeNode(
new IdentifierTypeNode('callable'),
[],
new ArrayTypeNode(new GenericTypeNode(
new IdentifierTypeNode('Foo'),
[
new IdentifierTypeNode('Bar'),
],
[
GenericTypeNode::VARIANCE_INVARIANT,
]
))
),
],
[
'callable(): Foo|Bar',
new UnionTypeNode([
@@ -1956,6 +1972,77 @@ public function provideParseData(): array
'callable(): ?int',
new CallableTypeNode(new IdentifierTypeNode('callable'), [], new NullableTypeNode(new IdentifierTypeNode('int'))),
],
[
'callable(): object{foo: int}',
new CallableTypeNode(new IdentifierTypeNode('callable'), [], new ObjectShapeNode([
new ObjectShapeItemNode(new IdentifierTypeNode('foo'), false, new IdentifierTypeNode('int')),
])),
],
[
'callable(): object{foo: int}[]',
new CallableTypeNode(
new IdentifierTypeNode('callable'),
[],
new ArrayTypeNode(
new ObjectShapeNode([
new ObjectShapeItemNode(new IdentifierTypeNode('foo'), false, new IdentifierTypeNode('int')),
])
)
),
],
[
'callable(): $this',
new CallableTypeNode(new IdentifierTypeNode('callable'), [], new ThisTypeNode()),
],
[
'callable(): $this[]',
new CallableTypeNode(new IdentifierTypeNode('callable'), [], new ArrayTypeNode(new ThisTypeNode())),
],
[
'2.5|3',
new UnionTypeNode([
new ConstTypeNode(new ConstExprFloatNode('2.5')),
new ConstTypeNode(new ConstExprIntegerNode('3')),
]),
],
[
'callable(): 3.5',
new CallableTypeNode(new IdentifierTypeNode('callable'), [], new ConstTypeNode(new ConstExprFloatNode('3.5'))),
],
[
'callable(): 3.5[]',
new CallableTypeNode(new IdentifierTypeNode('callable'), [], new ArrayTypeNode(
new ConstTypeNode(new ConstExprFloatNode('3.5'))
)),
],
[
'callable(): Foo',
new CallableTypeNode(new IdentifierTypeNode('callable'), [], new IdentifierTypeNode('Foo')),
],
[
'callable(): (Foo)[]',
new CallableTypeNode(new IdentifierTypeNode('callable'), [], new ArrayTypeNode(new IdentifierTypeNode('Foo'))),
],
[
'callable(): Foo::BAR',
new CallableTypeNode(new IdentifierTypeNode('callable'), [], new ConstTypeNode(new ConstFetchNode('Foo', 'BAR'))),
],
[
'callable(): Foo::*',
new CallableTypeNode(new IdentifierTypeNode('callable'), [], new ConstTypeNode(new ConstFetchNode('Foo', '*'))),
],
[
'?Foo[]',
new NullableTypeNode(new ArrayTypeNode(new IdentifierTypeNode('Foo'))),
],
[
'callable(): ?Foo',
new CallableTypeNode(new IdentifierTypeNode('callable'), [], new NullableTypeNode(new IdentifierTypeNode('Foo'))),
],
[
'callable(): ?Foo[]',
new CallableTypeNode(new IdentifierTypeNode('callable'), [], new NullableTypeNode(new ArrayTypeNode(new IdentifierTypeNode('Foo')))),
],
];
}

100 changes: 87 additions & 13 deletions tests/PHPStan/Printer/PrinterTest.php
Original file line number Diff line number Diff line change
@@ -26,6 +26,7 @@
use PHPStan\PhpDocParser\Ast\Type\ObjectShapeItemNode;
use PHPStan\PhpDocParser\Ast\Type\ObjectShapeNode;
use PHPStan\PhpDocParser\Ast\Type\OffsetAccessTypeNode;
use PHPStan\PhpDocParser\Ast\Type\TypeNode;
use PHPStan\PhpDocParser\Ast\Type\UnionTypeNode;
use PHPStan\PhpDocParser\Lexer\Lexer;
use PHPStan\PhpDocParser\Parser\ConstExprParser;
@@ -42,6 +43,26 @@
class PrinterTest extends TestCase
{

/** @var TypeParser */
private $typeParser;

/** @var PhpDocParser */
private $phpDocParser;

protected function setUp(): void
{
$usedAttributes = ['lines' => true, 'indexes' => true];
$constExprParser = new ConstExprParser(true, true, $usedAttributes);
$this->typeParser = new TypeParser($constExprParser, true, $usedAttributes);
$this->phpDocParser = new PhpDocParser(
$this->typeParser,
$constExprParser,
true,
true,
$usedAttributes
);
}

/**
* @return iterable<array{string, string, NodeVisitor}>
*/
@@ -1153,18 +1174,9 @@ public function enterNode(Node $node)
*/
public function testPrintFormatPreserving(string $phpDoc, string $expectedResult, NodeVisitor $visitor): void
{
$usedAttributes = ['lines' => true, 'indexes' => true];
$constExprParser = new ConstExprParser(true, true, $usedAttributes);
$phpDocParser = new PhpDocParser(
new TypeParser($constExprParser, true, $usedAttributes),
$constExprParser,
true,
true,
$usedAttributes
);
$lexer = new Lexer();
$tokens = new TokenIterator($lexer->tokenize($phpDoc));
$phpDocNode = $phpDocParser->parse($tokens);
$phpDocNode = $this->phpDocParser->parse($tokens);
$cloningTraverser = new NodeTraverser([new NodeVisitor\CloningVisitor()]);
$newNodes = $cloningTraverser->traverse([$phpDocNode]);

@@ -1177,14 +1189,13 @@ public function testPrintFormatPreserving(string $phpDoc, string $expectedResult
$newPhpDoc = $printer->printFormatPreserving($newNode, $phpDocNode, $tokens);
$this->assertSame($expectedResult, $newPhpDoc);

$newTokens = new TokenIterator($lexer->tokenize($newPhpDoc));
$this->assertEquals(
$this->unsetAttributes($newNode),
$this->unsetAttributes($phpDocParser->parse($newTokens))
$this->unsetAttributes($this->phpDocParser->parse(new TokenIterator($lexer->tokenize($newPhpDoc))))
);
}

private function unsetAttributes(PhpDocNode $node): PhpDocNode
private function unsetAttributes(Node $node): Node
{
$visitor = new class extends AbstractNodeVisitor {

@@ -1207,4 +1218,67 @@ public function enterNode(Node $node)
return $traverser->traverse([$node])[0];
}

/**
* @return iterable<list{TypeNode, string}>
*/
public function dataPrintType(): iterable
{
yield [
new IdentifierTypeNode('int'),
'int',
];
}

/**
* @dataProvider dataPrintType
*/
public function testPrintType(TypeNode $node, string $expectedResult): void
{
$printer = new Printer();
$phpDoc = $printer->print($node);
$this->assertSame($expectedResult, $phpDoc);

$lexer = new Lexer();
$this->assertEquals(
$this->unsetAttributes($node),
$this->unsetAttributes($this->typeParser->parse(new TokenIterator($lexer->tokenize($phpDoc))))
);
}

/**
* @return iterable<list{PhpDocNode, string}>
*/
public function dataPrintPhpDocNode(): iterable
{
yield [
new PhpDocNode([
new PhpDocTagNode('@param', new ParamTagValueNode(
new IdentifierTypeNode('int'),
false,
'$a',
''
)),
]),
'/**
* @param int $a
*/',
];
}

/**
* @dataProvider dataPrintPhpDocNode
*/
public function testPrintPhpDocNode(PhpDocNode $node, string $expectedResult): void
{
$printer = new Printer();
$phpDoc = $printer->print($node);
$this->assertSame($expectedResult, $phpDoc);

$lexer = new Lexer();
$this->assertEquals(
$this->unsetAttributes($node),
$this->unsetAttributes($this->phpDocParser->parse(new TokenIterator($lexer->tokenize($phpDoc))))
);
}

}