Skip to content
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

Support typing extra items in unsealed array shapes #250

Merged
merged 6 commits into from
Aug 29, 2024
Merged

Support typing extra items in unsealed array shapes #250

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a034ac3
Support typing extra items in unsealed array shapes
tscni Aug 25, 2024
f374c5e
Use separate extra key/value types instead of a generic type
tscni Aug 25, 2024
a2268bb
Combine types into an ArrayShapeUnsealedTypeNode
tscni Aug 28, 2024
8a0bb94
More tests
ondrejmirtes Aug 28, 2024
35b60c2
Make ArrayShapeUnsealedTypeNode just a Node
tscni Aug 28, 2024
dde139f
Add more PrinterTest cases for list shapes
tscni Aug 28, 2024
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
13 changes: 11 additions & 2 deletions src/Ast/Type/ArrayShapeNode.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,24 @@ class ArrayShapeNode implements TypeNode
/** @var self::KIND_* */
public $kind;

/** @var ArrayShapeUnsealedTypeNode|null */
public $unsealedType;

/**
* @param ArrayShapeItemNode[] $items
* @param self::KIND_* $kind
*/
public function __construct(array $items, bool $sealed = true, string $kind = self::KIND_ARRAY)
public function __construct(
array $items,
bool $sealed = true,
string $kind = self::KIND_ARRAY,
?ArrayShapeUnsealedTypeNode $unsealedType = null
)
{
$this->items = $items;
$this->sealed = $sealed;
$this->kind = $kind;
$this->unsealedType = $unsealedType;
}


Expand All @@ -39,7 +48,7 @@ public function __toString(): string
$items = $this->items;

if (! $this->sealed) {
$items[] = '...';
$items[] = '...' . $this->unsealedType;
}

return $this->kind . '{' . implode(', ', $items) . '}';
Expand Down
33 changes: 33 additions & 0 deletions src/Ast/Type/ArrayShapeUnsealedTypeNode.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?php declare(strict_types = 1);

namespace PHPStan\PhpDocParser\Ast\Type;

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

class ArrayShapeUnsealedTypeNode implements TypeNode
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be just a Node, not TypeNode. It doesn't make sense standalone.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. ArrayShapeItemNode shouldn't have been one either then I guess, oh well.
Done.

{

use NodeAttributes;

/** @var TypeNode */
public $valueType;

/** @var TypeNode|null */
public $keyType;

public function __construct(TypeNode $valueType, ?TypeNode $keyType)
{
$this->valueType = $valueType;
$this->keyType = $keyType;
}

public function __toString(): string
{
if ($this->keyType !== null) {
return sprintf('<%s, %s>', $this->keyType, $this->valueType);
}
return sprintf('<%s>', $this->valueType);
}

}
71 changes: 70 additions & 1 deletion src/Parser/TypeParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -848,6 +848,7 @@ private function parseArrayShape(TokenIterator $tokens, Ast\Type\TypeNode $type,

$items = [];
$sealed = true;
$unsealedType = null;

do {
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
Expand All @@ -858,6 +859,17 @@ private function parseArrayShape(TokenIterator $tokens, Ast\Type\TypeNode $type,

if ($tokens->tryConsumeTokenType(Lexer::TOKEN_VARIADIC)) {
$sealed = false;

$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_ANGLE_BRACKET)) {
if ($kind === Ast\Type\ArrayShapeNode::KIND_ARRAY) {
$unsealedType = $this->parseArrayShapeUnsealedType($tokens);
} else {
$unsealedType = $this->parseListShapeUnsealedType($tokens);
}
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
}

$tokens->tryConsumeTokenType(Lexer::TOKEN_COMMA);
break;
}
Expand All @@ -870,7 +882,7 @@ private function parseArrayShape(TokenIterator $tokens, Ast\Type\TypeNode $type,
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
$tokens->consumeTokenType(Lexer::TOKEN_CLOSE_CURLY_BRACKET);

return new Ast\Type\ArrayShapeNode($items, $sealed, $kind);
return new Ast\Type\ArrayShapeNode($items, $sealed, $kind, $unsealedType);
}


Expand Down Expand Up @@ -949,6 +961,63 @@ private function parseArrayShapeKey(TokenIterator $tokens)
);
}

/**
* @phpstan-impure
*/
private function parseArrayShapeUnsealedType(TokenIterator $tokens): Ast\Type\ArrayShapeUnsealedTypeNode
{
$startLine = $tokens->currentTokenLine();
$startIndex = $tokens->currentTokenIndex();

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

$valueType = $this->parse($tokens);
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);

$keyType = null;
if ($tokens->tryConsumeTokenType(Lexer::TOKEN_COMMA)) {
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);

$keyType = $valueType;
$valueType = $this->parse($tokens);
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
}

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

return $this->enrichWithAttributes(
$tokens,
new Ast\Type\ArrayShapeUnsealedTypeNode($valueType, $keyType),
$startLine,
$startIndex
);
}

/**
* @phpstan-impure
*/
private function parseListShapeUnsealedType(TokenIterator $tokens): Ast\Type\ArrayShapeUnsealedTypeNode
{
$startLine = $tokens->currentTokenLine();
$startIndex = $tokens->currentTokenIndex();

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

$valueType = $this->parse($tokens);
$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);

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

return $this->enrichWithAttributes(
$tokens,
new Ast\Type\ArrayShapeUnsealedTypeNode($valueType, null),
$startLine,
$startIndex
);
}

/**
* @phpstan-impure
*/
Expand Down
9 changes: 8 additions & 1 deletion src/Printer/Printer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
use PHPStan\PhpDocParser\Ast\PhpDoc\VarTagValueNode;
use PHPStan\PhpDocParser\Ast\Type\ArrayShapeItemNode;
use PHPStan\PhpDocParser\Ast\Type\ArrayShapeNode;
use PHPStan\PhpDocParser\Ast\Type\ArrayShapeUnsealedTypeNode;
use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
use PHPStan\PhpDocParser\Ast\Type\CallableTypeNode;
use PHPStan\PhpDocParser\Ast\Type\CallableTypeParameterNode;
Expand Down Expand Up @@ -366,7 +367,7 @@ private function printType(TypeNode $node): string
}, $node->items);

if (! $node->sealed) {
$items[] = '...';
$items[] = '...' . ($node->unsealedType === null ? '' : $this->printType($node->unsealedType));
}

return $node->kind . '{' . implode(', ', $items) . '}';
Expand All @@ -383,6 +384,12 @@ private function printType(TypeNode $node): string

return $this->printType($node->valueType);
}
if ($node instanceof ArrayShapeUnsealedTypeNode) {
if ($node->keyType !== null) {
return sprintf('<%s, %s>', $this->printType($node->keyType), $this->printType($node->valueType));
}
return sprintf('<%s>', $this->printType($node->valueType));
}
if ($node instanceof ArrayTypeNode) {
return $this->printOffsetAccessType($node->type) . '[]';
}
Expand Down
Loading