Skip to content

Add ObjectShapeNode to support @var object{foo: string} $foo #145

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

Closed
samsonasik wants to merge 1 commit into from
Closed

Add ObjectShapeNode to support @var object{foo: string} $foo #145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions src/Ast/Type/ObjectShapeItemNode.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?php declare(strict_types = 1);

namespace PHPStan\PhpDocParser\Ast\Type;

class ObjectShapeItemNode extends ArrayShapeItemNode
{
}
27 changes: 27 additions & 0 deletions src/Ast/Type/ObjectShapeNode.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?php declare(strict_types = 1);

namespace PHPStan\PhpDocParser\Ast\Type;

use PHPStan\PhpDocParser\Ast\NodeAttributes;
use function implode;

class ObjectShapeNode implements TypeNode
{

use NodeAttributes;

/** @var ObjectShapeItemNode[] */
public $items;

public function __construct(array $items)
{
$this->items = $items;
}


public function __toString(): string
{
return 'object{' . implode(', ', $this->items) . '}';
}

}
30 changes: 15 additions & 15 deletions src/Parser/TypeParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,8 @@ private function parseAtomic(TokenIterator $tokens): Ast\Type\TypeNode
} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
$type = $this->tryParseArrayOrOffsetAccess($tokens, $type);

} elseif ($type->name === 'array' && $tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_CURLY_BRACKET) && !$tokens->isPrecededByHorizontalWhitespace()) {
$type = $this->parseArrayShape($tokens, $type);
} elseif (in_array($type->name, ['array', 'object'], true) && $tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_CURLY_BRACKET) && !$tokens->isPrecededByHorizontalWhitespace()) {
$type = $this->parseArrayOrObjectShape($tokens, $type);

if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
$type = $this->tryParseArrayOrOffsetAccess($tokens, $type);
Expand Down Expand Up @@ -409,8 +409,8 @@ private function parseCallableReturnType(TokenIterator $tokens): Ast\Type\TypeNo
if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_ANGLE_BRACKET)) {
$type = $this->parseGeneric($tokens, $type);

} elseif ($type->name === 'array' && $tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_CURLY_BRACKET) && !$tokens->isPrecededByHorizontalWhitespace()) {
$type = $this->parseArrayShape($tokens, $type);
} elseif (in_array($type->name, ['array', 'object'], true) && $tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_CURLY_BRACKET) && !$tokens->isPrecededByHorizontalWhitespace()) {
$type = $this->parseArrayOrObjectShape($tokens, $type);
}
}

Expand Down Expand Up @@ -470,60 +470,60 @@ private function tryParseArrayOrOffsetAccess(TokenIterator $tokens, Ast\Type\Typ


/** @phpstan-impure */
private function parseArrayShape(TokenIterator $tokens, Ast\Type\TypeNode $type): Ast\Type\ArrayShapeNode
private function parseArrayOrObjectShape(TokenIterator $tokens, Ast\Type\TypeNode $type): Ast\Type\ArrayShapeNode|Ast\Type\ObjectShapeNode
{
$tokens->consumeTokenType(Lexer::TOKEN_OPEN_CURLY_BRACKET);
if ($tokens->tryConsumeTokenType(Lexer::TOKEN_CLOSE_CURLY_BRACKET)) {
return new Ast\Type\ArrayShapeNode([]);
return $type->name === 'array' ? new Ast\Type\ArrayShapeNode([]) : new Ast\Type\ObjectShapeNode([]);
}

$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
$items = [$this->parseArrayShapeItem($tokens)];
$items = [$this->parseArrayOrObjectShapeItem($tokens, $type)];

$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
while ($tokens->tryConsumeTokenType(Lexer::TOKEN_COMMA)) {
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
if ($tokens->tryConsumeTokenType(Lexer::TOKEN_CLOSE_CURLY_BRACKET)) {
// trailing comma case
return new Ast\Type\ArrayShapeNode($items);
return $type->name === 'array' ? new Ast\Type\ArrayShapeNode($items) : new Ast\Type\ObjectShapeNode($items);
}

$items[] = $this->parseArrayShapeItem($tokens);
$items[] = $this->parseArrayOrObjectShapeItem($tokens, $type);
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
}

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

return new Ast\Type\ArrayShapeNode($items);
return $type->name === 'array' ? new Ast\Type\ArrayShapeNode($items): new Ast\Type\ObjectShapeNode($items);
}


/** @phpstan-impure */
private function parseArrayShapeItem(TokenIterator $tokens): Ast\Type\ArrayShapeItemNode
private function parseArrayOrObjectShapeItem(TokenIterator $tokens, Ast\Type\TypeNode $type): Ast\Type\ArrayShapeItemNode|Ast\Type\ObjectShapeItemNode
{
try {
$tokens->pushSavePoint();
$key = $this->parseArrayShapeKey($tokens);
$key = $this->parseArrayOrObjectShapeKey($tokens);
$optional = $tokens->tryConsumeTokenType(Lexer::TOKEN_NULLABLE);
$tokens->consumeTokenType(Lexer::TOKEN_COLON);
$value = $this->parse($tokens);
$tokens->dropSavePoint();

return new Ast\Type\ArrayShapeItemNode($key, $optional, $value);
return $type->name === 'array' ? new Ast\Type\ArrayShapeItemNode($key, $optional, $value) : new Ast\Type\ObjectShapeItemNode($key, $optional, $value);
} catch (ParserException $e) {
$tokens->rollback();
$value = $this->parse($tokens);

return new Ast\Type\ArrayShapeItemNode(null, false, $value);
return $type->name === 'array' ? new Ast\Type\ArrayShapeItemNode(null, false, $value) : new Ast\Type\ObjectShapeItemNode(null, false, $value);
}
}

/**
* @phpstan-impure
* @return Ast\ConstExpr\ConstExprIntegerNode|Ast\ConstExpr\ConstExprStringNode|Ast\Type\IdentifierTypeNode
*/
private function parseArrayShapeKey(TokenIterator $tokens)
private function parseArrayOrObjectShapeKey(TokenIterator $tokens)
{
if ($tokens->isCurrentTokenType(Lexer::TOKEN_INTEGER)) {
$key = new Ast\ConstExpr\ConstExprIntegerNode($tokens->currentTokenValue());
Expand Down
65 changes: 65 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 @@ -44,6 +44,8 @@
use PHPStan\PhpDocParser\Ast\Type\UnionTypeNode;
use PHPStan\PhpDocParser\Lexer\Lexer;
use PHPUnit\Framework\TestCase;
use PHPStan\PhpDocParser\Ast\Type\ObjectShapeNode;
use PHPStan\PhpDocParser\Ast\Type\ObjectShapeItemNode;
use const PHP_EOL;

class PhpDocParserTest extends TestCase
Expand Down Expand Up @@ -894,6 +896,69 @@ public function provideVarTagsData(): Iterator
),
]),
];

yield [
'OK without variable and description object shape',
'/** @var object{a: int} */',
new PhpDocNode([
new PhpDocTagNode(
'@var',
new VarTagValueNode(
new ObjectShapeNode([
new ObjectShapeItemNode(
new IdentifierTypeNode('a'),
false,
new IdentifierTypeNode('int')
)
]),
'',
''
)
),
]),
];

yield [
'OK with variable object shape',
'/** @var object{a: int} $foo */',
new PhpDocNode([
new PhpDocTagNode(
'@var',
new VarTagValueNode(
new ObjectShapeNode([
new ObjectShapeItemNode(
new IdentifierTypeNode('a'),
false,
new IdentifierTypeNode('int')
)
]),
'$foo',
''
)
),
]),
];

yield [
'OK with variable and description object shape',
'/** @var object{a: int} $foo some description */',
new PhpDocNode([
new PhpDocTagNode(
'@var',
new VarTagValueNode(
new ObjectShapeNode([
new ObjectShapeItemNode(
new IdentifierTypeNode('a'),
false,
new IdentifierTypeNode('int')
)
]),
'$foo',
'some description'
)
),
]),
];
}


Expand Down
14 changes: 14 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 @@ -19,6 +19,8 @@
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use PHPStan\PhpDocParser\Ast\Type\IntersectionTypeNode;
use PHPStan\PhpDocParser\Ast\Type\NullableTypeNode;
use PHPStan\PhpDocParser\Ast\Type\ObjectShapeItemNode;
use PHPStan\PhpDocParser\Ast\Type\ObjectShapeNode;
use PHPStan\PhpDocParser\Ast\Type\OffsetAccessTypeNode;
use PHPStan\PhpDocParser\Ast\Type\ThisTypeNode;
use PHPStan\PhpDocParser\Ast\Type\TypeNode;
Expand Down Expand Up @@ -592,6 +594,18 @@ public function provideParseData(): array
),
]),
],
[
'object{
a: int
}',
new ObjectShapeNode([
new ObjectShapeItemNode(
new IdentifierTypeNode('a'),
false,
new IdentifierTypeNode('int')
)
]),
],
[
'callable(): Foo',
new CallableTypeNode(
Expand Down