Array shapes - support single-quoted and double-quoted strings

Author: ondrejmirtes

src/Ast/Type/ArrayShapeItemNode.php

@@ -3,11 +3,12 @@
 namespace PHPStan\PhpDocParser\Ast\Type;
 
 use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprIntegerNode;
+use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprStringNode;
 
 class ArrayShapeItemNode implements TypeNode
 {
 
-	/** @var ConstExprIntegerNode|IdentifierTypeNode|null */
+	/** @var ConstExprIntegerNode|ConstExprStringNode|IdentifierTypeNode|null */
 	public $keyName;
 
 	/** @var bool */
@@ -17,7 +18,7 @@ class ArrayShapeItemNode implements TypeNode
 	public $valueType;
 
 	/**
-	 * @param ConstExprIntegerNode|IdentifierTypeNode|null $keyName
+	 * @param ConstExprIntegerNode|ConstExprStringNode|IdentifierTypeNode|null $keyName
 	 */
 	public function __construct($keyName, bool $optional, TypeNode $valueType)
 	{

src/Parser/TypeParser.php

@@ -280,14 +280,22 @@ private function parseArrayShapeItem(TokenIterator $tokens): Ast\Type\ArrayShape
 	}
 
 	/**
-	 * @return Ast\ConstExpr\ConstExprIntegerNode|Ast\Type\IdentifierTypeNode
+	 * @return Ast\ConstExpr\ConstExprIntegerNode|Ast\ConstExpr\ConstExprStringNode|Ast\Type\IdentifierTypeNode
 	 */
 	private function parseArrayShapeKey(TokenIterator $tokens)
 	{
 		if ($tokens->isCurrentTokenType(Lexer::TOKEN_INTEGER)) {
 			$key = new Ast\ConstExpr\ConstExprIntegerNode($tokens->currentTokenValue());
 			$tokens->next();
 
+		} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_SINGLE_QUOTED_STRING)) {
+			$key = new Ast\ConstExpr\ConstExprStringNode(trim($tokens->currentTokenValue(), "'"));
+			$tokens->next();
+
+		} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_DOUBLE_QUOTED_STRING)) {
+			$key = new Ast\ConstExpr\ConstExprStringNode(trim($tokens->currentTokenValue(), '"'));
+			$tokens->next();
+
 		} else {
 			$key = new Ast\Type\IdentifierTypeNode($tokens->currentTokenValue());
 			$tokens->consumeTokenType(Lexer::TOKEN_IDENTIFIER);

tests/PHPStan/Parser/TypeParserTest.php

@@ -3,6 +3,7 @@
 namespace PHPStan\PhpDocParser\Parser;
 
 use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprIntegerNode;
+use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprStringNode;
 use PHPStan\PhpDocParser\Ast\Type\ArrayShapeItemNode;
 use PHPStan\PhpDocParser\Ast\Type\ArrayShapeNode;
 use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
@@ -51,6 +52,7 @@ public function testParse(string $input, $expectedResult, int $nextTokenType = L
 		$typeNode = $this->typeParser->parse($tokens);
 
 		$this->assertSame((string) $expectedResult, (string) $typeNode);
+		$this->assertInstanceOf(get_class($expectedResult), $typeNode);
 		$this->assertEquals($expectedResult, $typeNode);
 		$this->assertSame($nextTokenType, $tokens->currentTokenType());
 	}
@@ -449,21 +451,43 @@ public function provideParseData(): array
 			],
 			[
 				'array{"a": int}',
-				new \PHPStan\PhpDocParser\Parser\ParserException(
-					'"a"',
-					Lexer::TOKEN_DOUBLE_QUOTED_STRING,
-					6,
-					Lexer::TOKEN_IDENTIFIER
-				),
+				new ArrayShapeNode([
+					new ArrayShapeItemNode(
+						new ConstExprStringNode('a'),
+						false,
+						new IdentifierTypeNode('int')
+					),
+				]),
 			],
 			[
 				'array{\'a\': int}',
-				new \PHPStan\PhpDocParser\Parser\ParserException(
-					'\'a\'',
-					Lexer::TOKEN_SINGLE_QUOTED_STRING,
-					6,
-					Lexer::TOKEN_IDENTIFIER
-				),
+				new ArrayShapeNode([
+					new ArrayShapeItemNode(
+						new ConstExprStringNode('a'),
+						false,
+						new IdentifierTypeNode('int')
+					),
+				]),
+			],
+			[
+				'array{\'$ref\': int}',
+				new ArrayShapeNode([
+					new ArrayShapeItemNode(
+						new ConstExprStringNode('$ref'),
+						false,
+						new IdentifierTypeNode('int')
+					),
+				]),
+			],
+			[
+				'array{"$ref": int}',
+				new ArrayShapeNode([
+					new ArrayShapeItemNode(
+						new ConstExprStringNode('$ref'),
+						false,
+						new IdentifierTypeNode('int')
+					),
+				]),
 			],
 			[
 				'array{