ConstantStringType always needs to export toPhpDocNode as ConstExprSt…

…ringNode
rajyan · Apr 18, 2023 · 80f7ff7 · 80f7ff7
1 parent fd05813
commit 80f7ff7
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 22 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1003,6 +1003,11 @@ parameters:
 			count: 3
 			path: src/Type/Generic/TemplateConstantStringType.php
 
+		-
+			message: "#^Method PHPStan\\\\Type\\\\Generic\\\\TemplateConstantStringType\\:\\:toPhpDocNode\\(\\) should return PHPStan\\\\PhpDocParser\\\\Ast\\\\Type\\\\ConstTypeNode but returns PHPStan\\\\PhpDocParser\\\\Ast\\\\Type\\\\IdentifierTypeNode\\.$#"
+			count: 1
+			path: src/Type/Generic/TemplateConstantStringType.php
+
 		-
 			message: "#^Doing instanceof PHPStan\\\\Type\\\\IntersectionType is error\\-prone and deprecated\\.$#"
 			count: 3

diff --git a/src/Type/Constant/ConstantArrayType.php b/src/Type/Constant/ConstantArrayType.php
@@ -3,11 +3,13 @@
 namespace PHPStan\Type\Constant;
 
 use PHPStan\Php\PhpVersion;
+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\ConstTypeNode;
+use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
+use PHPStan\PhpDocParser\Parser\StringUnescaper;
 use PHPStan\Reflection\ClassMemberAccessAnswerer;
 use PHPStan\Reflection\InaccessibleMethod;
 use PHPStan\Reflection\ParametersAcceptor;
@@ -58,6 +60,7 @@
 use function sort;
 use function sprintf;
 use function strpos;
+use function substr;
 
 /**
  * @api
@@ -1558,10 +1561,16 @@ public function toPhpDocNode(): TypeNode
 		$items = [];
 		foreach ($this->keyTypes as $i => $keyType) {
 			$valueType = $this->valueTypes[$i];
-			$keyNode = $keyType->toPhpDocNode();
-			if ($keyNode instanceof ConstTypeNode) {
-				/** @var ConstExprStringNode $keyNode */
-				$keyNode = $keyNode->constExpr;
+
+			/** @var ConstExprStringNode|ConstExprIntegerNode $keyNode */
+			$keyNode = $keyType->toPhpDocNode()->constExpr;
+			if ($keyNode instanceof ConstExprStringNode) {
+				$quoteAwareString = (string) $keyNode;
+				$unescaped = StringUnescaper::unescapeString($quoteAwareString);
+
+				if (substr($quoteAwareString, 1, -1) === $unescaped) {
+					$keyNode = new IdentifierTypeNode($keyNode->value);
+				}
 			}
 			$items[] = new ArrayShapeItemNode(
 				$keyNode,

diff --git a/src/Type/Constant/ConstantStringType.php b/src/Type/Constant/ConstantStringType.php
@@ -7,9 +7,7 @@
 use PhpParser\Node\Name;
 use PHPStan\PhpDocParser\Ast\ConstExpr\QuoteAwareConstExprStringNode;
 use PHPStan\PhpDocParser\Ast\Type\ConstTypeNode;
-use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
-use PHPStan\PhpDocParser\Parser\StringUnescaper;
 use PHPStan\Reflection\ClassMemberAccessAnswerer;
 use PHPStan\Reflection\ConstantReflection;
 use PHPStan\Reflection\InaccessibleMethod;
@@ -493,19 +491,11 @@ private function getObjectType(): ObjectType
 	}
 
 	/**
-	 * @return ConstTypeNode|IdentifierTypeNode
+	 * @return ConstTypeNode
 	 */
 	public function toPhpDocNode(): TypeNode
 	{
-		$quoteAware = (new QuoteAwareConstExprStringNode($this->value, QuoteAwareConstExprStringNode::SINGLE_QUOTED));
-		$quoteAwareString = (string) $quoteAware;
-		$unescaped = StringUnescaper::unescapeString($quoteAwareString);
-
-		if (substr($quoteAwareString, 1, -1) === $unescaped) {
-			return new IdentifierTypeNode($this->value);
-		}
-
-		return new ConstTypeNode($quoteAware);
+		return new ConstTypeNode(new QuoteAwareConstExprStringNode($this->value, QuoteAwareConstExprStringNode::SINGLE_QUOTED));
 	}
 
 	/**

diff --git a/src/Type/ObjectShapeType.php b/src/Type/ObjectShapeType.php
@@ -5,10 +5,11 @@
 use PHPStan\Analyser\OutOfClassScope;
 use PHPStan\Broker\Broker;
 use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprStringNode;
-use PHPStan\PhpDocParser\Ast\Type\ConstTypeNode;
+use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\ObjectShapeItemNode;
 use PHPStan\PhpDocParser\Ast\Type\ObjectShapeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
+use PHPStan\PhpDocParser\Parser\StringUnescaper;
 use PHPStan\Reflection\ClassMemberAccessAnswerer;
 use PHPStan\Reflection\MissingPropertyFromReflectionException;
 use PHPStan\Reflection\Php\UniversalObjectCratesClassReflectionExtension;
@@ -32,6 +33,7 @@
 use function implode;
 use function in_array;
 use function sprintf;
+use function substr;
 
 /** @api */
 class ObjectShapeType implements Type
@@ -496,10 +498,13 @@ public function toPhpDocNode(): TypeNode
 	{
 		$items = [];
 		foreach ($this->properties as $name => $type) {
-			$keyNode = (new ConstantStringType($name))->toPhpDocNode();
-			if ($keyNode instanceof ConstTypeNode) {
-				/** @var ConstExprStringNode $keyNode */
-				$keyNode = $keyNode->constExpr;
+			/** @var ConstExprStringNode $keyNode */
+			$keyNode = (new ConstantStringType($name))->toPhpDocNode()->constExpr;
+			$quoteAwareString = (string) $keyNode;
+			$unescaped = StringUnescaper::unescapeString($quoteAwareString);
+
+			if (substr($quoteAwareString, 1, -1) === $unescaped) {
+				$keyNode = new IdentifierTypeNode($keyNode->value);
 			}
 			$items[] = new ObjectShapeItemNode(
 				$keyNode,

diff --git a/tests/PHPStan/Type/TypeToPhpDocNodeTest.php b/tests/PHPStan/Type/TypeToPhpDocNodeTest.php
@@ -62,6 +62,19 @@ public function dataToPhpDocNode(): iterable
 			'array{foo: 1, bar: 2, baz?: 3}',
 		];
 
+		yield [
+			new ConstantArrayType([
+				new ConstantIntegerType(1),
+				new ConstantIntegerType(2),
+				new ConstantIntegerType(3),
+			], [
+				new ConstantStringType('foo'),
+				new ConstantStringType('bar'),
+				new ConstantStringType('baz'),
+			], [0], [2]),
+			'array{1: \'foo\', 2: \'bar\', 3?: \'baz\'}',
+		];
+
 		yield [
 			new ConstantIntegerType(42),
 			'42',
@@ -82,6 +95,11 @@ public function dataToPhpDocNode(): iterable
 			'false',
 		];
 
+		yield [
+			new ConstantStringType('foo'),
+			"'foo'",
+		];
+
 		yield [
 			new GenericClassStringType(new ObjectType('stdClass')),
 			'class-string<stdClass>',