Refactor duplicated template parsing code into TemplateTagParser.

mad-briller · mad-briller · commit 9266cca04372 · 2024-02-23T13:28:30.000Z
diff --git a/src/Ast/Type/CallableTypeNode.php b/src/Ast/Type/CallableTypeNode.php
@@ -13,7 +13,7 @@ class CallableTypeNode implements TypeNode
 	/** @var IdentifierTypeNode */
 	public $identifier;
 
-	/** @var CallableTypeTemplateNode[] */
+	/** @var templateTagValueNode[] */
 	public $templates;
 
 	/** @var CallableTypeParameterNode[] */
@@ -24,7 +24,7 @@ class CallableTypeNode implements TypeNode
 
 	/**
 	 * @param CallableTypeParameterNode[] $parameters
-	 * @param CallableTypeTemplateNode[]  $templates
+	 * @param TemplateTagValueNode[]  $templates
 	 */
 	public function __construct(IdentifierTypeNode $identifier, array $parameters, TypeNode $returnType, array $templates = [])
 	{
diff --git a/src/Ast/Type/CallableTypeTemplateNode.php b/src/Ast/Type/CallableTypeTemplateNode.php
diff --git a/src/Parser/PhpDocParser.php b/src/Parser/PhpDocParser.php
@@ -439,7 +439,13 @@ public function parseTagValue(TokenIterator $tokens, string $tag): Ast\PhpDoc\Ph
 				case '@template-contravariant':
 				case '@phpstan-template-contravariant':
 				case '@psalm-template-contravariant':
-					$tagValue = $this->parseTemplateTagValue($tokens, true);
+					$tagValue = TemplateTagParser::parseTemplateTagValue(
+						$this->typeParser,
+						$tokens,
+						function ($tokens) {
+							return $this->parseOptionalDescription($tokens);
+						}
+					);
 					break;
 
 				case '@extends':
@@ -923,7 +929,12 @@ private function parseMethodTagValue(TokenIterator $tokens): Ast\PhpDoc\MethodTa
 			do {
 				$startLine = $tokens->currentTokenLine();
 				$startIndex = $tokens->currentTokenIndex();
-				$templateTypes[] = $this->enrichWithAttributes($tokens, $this->parseTemplateTagValue($tokens, false), $startLine, $startIndex);
+				$templateTypes[] = $this->enrichWithAttributes(
+					$tokens,
+					TemplateTagParser::parseTemplateTagValue($this->typeParser, $tokens),
+					$startLine,
+					$startIndex
+				);
 			} while ($tokens->tryConsumeTokenType(Lexer::TOKEN_COMMA));
 			$tokens->consumeTokenType(Lexer::TOKEN_CLOSE_ANGLE_BRACKET);
 		}
@@ -979,33 +990,6 @@ private function parseMethodTagValueParameter(TokenIterator $tokens): Ast\PhpDoc
 		);
 	}
 
-	private function parseTemplateTagValue(TokenIterator $tokens, bool $parseDescription): Ast\PhpDoc\TemplateTagValueNode
-	{
-		$name = $tokens->currentTokenValue();
-		$tokens->consumeTokenType(Lexer::TOKEN_IDENTIFIER);
-
-		if ($tokens->tryConsumeTokenValue('of') || $tokens->tryConsumeTokenValue('as')) {
-			$bound = $this->typeParser->parse($tokens);
-
-		} else {
-			$bound = null;
-		}
-
-		if ($tokens->tryConsumeTokenValue('=')) {
-			$default = $this->typeParser->parse($tokens);
-		} else {
-			$default = null;
-		}
-
-		if ($parseDescription) {
-			$description = $this->parseOptionalDescription($tokens);
-		} else {
-			$description = '';
-		}
-
-		return new Ast\PhpDoc\TemplateTagValueNode($name, $bound, $description, $default);
-	}
-
 	private function parseExtendsTagValue(string $tagName, TokenIterator $tokens): Ast\PhpDoc\PhpDocTagValueNode
 	{
 		$startLine = $tokens->currentTokenLine();
diff --git a/src/Parser/TemplateTagParser.php b/src/Parser/TemplateTagParser.php
@@ -0,0 +1,45 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\PhpDocParser\Parser;
+
+use PHPStan\PhpDocParser\Ast;
+use PHPStan\PhpDocParser\Ast\PhpDoc\TemplateTagValueNode;
+use PHPStan\PhpDocParser\Lexer\Lexer;
+
+class TemplateTagParser
+{
+	/**
+	 * @throws ParserException
+	 * @param ?callable(TokenIterator): string $parseDescription
+	 */
+	public static function parseTemplateTagValue(
+		TypeParser $typeParser,
+		TokenIterator $tokens,
+		?callable $parseDescription = null
+	): TemplateTagValueNode
+	{
+		$name = $tokens->currentTokenValue();
+		$tokens->consumeTokenType(Lexer::TOKEN_IDENTIFIER);
+
+		if ($tokens->tryConsumeTokenValue('of') || $tokens->tryConsumeTokenValue('as')) {
+			$bound = $typeParser->parse($tokens);
+
+		} else {
+			$bound = null;
+		}
+
+		if ($tokens->tryConsumeTokenValue('=')) {
+			$default = $typeParser->parse($tokens);
+		} else {
+			$default = null;
+		}
+
+		if ($parseDescription !== null) {
+			$description = $parseDescription($tokens);
+		} else {
+			$description = '';
+		}
+
+		return new Ast\PhpDoc\TemplateTagValueNode($name, $bound, $description, $default);
+	}
+}
diff --git a/src/Parser/TypeParser.php b/src/Parser/TypeParser.php
@@ -497,7 +497,7 @@ private function parseCallable(TokenIterator $tokens, Ast\Type\IdentifierTypeNod
 
 
 	/**
-	 * @return Ast\Type\CallableTypeTemplateNode[]
+	 * @return Ast\Type\TemplateTagValueNode[]
 	 *
 	 * @phpstan-impure
 	 */
@@ -527,27 +527,14 @@ private function parseCallableTemplates(TokenIterator $tokens): array
 	}
 
 
-	private function parseCallableTemplateArgument(TokenIterator $tokens): Ast\Type\CallableTypeTemplateNode
+	private function parseCallableTemplateArgument(TokenIterator $tokens): Ast\PhpDoc\TemplateTagValueNode
 	{
 		$startLine = $tokens->currentTokenLine();
 		$startIndex = $tokens->currentTokenIndex();
 
-		$identifier = $this->enrichWithAttributes(
-			$tokens,
-			new Ast\Type\IdentifierTypeNode($tokens->currentTokenValue()),
-			$startLine,
-			$startIndex
-		);
-		$tokens->consumeTokenType(Lexer::TOKEN_IDENTIFIER);
-
-		$bound = null;
-		if ($tokens->tryConsumeTokenValue('of')) {
-			$bound = $this->parse($tokens);
-		}
-
 		return $this->enrichWithAttributes(
 			$tokens,
-			new Ast\Type\CallableTypeTemplateNode($identifier, $bound),
+			TemplateTagParser::parseTemplateTagValue($this, $tokens),
 			$startLine,
 			$startIndex
 		);
diff --git a/src/Printer/Printer.php b/src/Printer/Printer.php
@@ -41,7 +41,6 @@
 use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\CallableTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\CallableTypeParameterNode;
-use PHPStan\PhpDocParser\Ast\Type\CallableTypeTemplateNode;
 use PHPStan\PhpDocParser\Ast\Type\ConditionalTypeForParameterNode;
 use PHPStan\PhpDocParser\Ast\Type\ConditionalTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\ConstTypeNode;
@@ -226,11 +225,6 @@ function (PhpDocChildNode $child): string {
 			$isOptional = $node->isOptional ? '=' : '';
 			return trim("{$type}{$isReference}{$isVariadic}{$node->parameterName}") . $isOptional;
 		}
-		if ($node instanceof CallableTypeTemplateNode) {
-			$identifier = $this->printType($node->identifier);
-			$bound = $node->bound !== null ? ' of ' . $this->printType($node->bound) : '';
-			return "{$identifier}{$bound}";
-		}
 		if ($node instanceof DoctrineAnnotation) {
 			return (string) $node;
 		}
@@ -378,7 +372,7 @@ private function printType(TypeNode $node): string
 				$returnType = $this->printType($node->returnType);
 			}
 			$template = $node->templates !== []
-				? '<' . implode(', ', array_map(function (CallableTypeTemplateNode $templateNode): string {
+				? '<' . implode(', ', array_map(function (TemplateTagValueNode $templateNode): string {
 					return $this->print($templateNode);
 				}, $node->templates)) . '>'
 				: '';
diff --git a/tests/PHPStan/Parser/TypeParserTest.php b/tests/PHPStan/Parser/TypeParserTest.php
@@ -10,12 +10,12 @@
 use PHPStan\PhpDocParser\Ast\ConstExpr\QuoteAwareConstExprStringNode;
 use PHPStan\PhpDocParser\Ast\Node;
 use PHPStan\PhpDocParser\Ast\NodeTraverser;
+use PHPStan\PhpDocParser\Ast\PhpDoc\TemplateTagValueNode;
 use PHPStan\PhpDocParser\Ast\Type\ArrayShapeItemNode;
 use PHPStan\PhpDocParser\Ast\Type\ArrayShapeNode;
 use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\CallableTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\CallableTypeParameterNode;
-use PHPStan\PhpDocParser\Ast\Type\CallableTypeTemplateNode;
 use PHPStan\PhpDocParser\Ast\Type\ConditionalTypeForParameterNode;
 use PHPStan\PhpDocParser\Ast\Type\ConditionalTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\ConstTypeNode;
@@ -913,7 +913,7 @@ public function provideParseData(): array
 					],
 					new IdentifierTypeNode('C'),
 					[
-						new CallableTypeTemplateNode(new IdentifierTypeNode('A'), null),
+						new TemplateTagValueNode('A', null, ''),
 					]
 				),
 			],
@@ -951,7 +951,7 @@ public function provideParseData(): array
 						new IdentifierTypeNode('false'),
 					]),
 					[
-						new CallableTypeTemplateNode(new IdentifierTypeNode('T'), new IdentifierTypeNode('Model')),
+						new TemplateTagValueNode('T', new IdentifierTypeNode('Model'), ''),
 					]
 				),
 			],
@@ -988,11 +988,11 @@ public function provideParseData(): array
 						),
 					]),
 					[
-						new CallableTypeTemplateNode(new IdentifierTypeNode('Tx'), new UnionTypeNode([
+						new TemplateTagValueNode('Tx', new UnionTypeNode([
 							new IdentifierTypeNode('X'),
 							new IdentifierTypeNode('Z'),
-						])),
-						new CallableTypeTemplateNode(new IdentifierTypeNode('Ty'), new IdentifierTypeNode('Y')),
+						]), ''),
+						new TemplateTagValueNode('Ty', new IdentifierTypeNode('Y'), ''),
 					]
 				),
 			],
diff --git a/tests/PHPStan/Printer/PrinterTest.php b/tests/PHPStan/Printer/PrinterTest.php
@@ -28,7 +28,6 @@
 use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\CallableTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\CallableTypeParameterNode;
-use PHPStan\PhpDocParser\Ast\Type\CallableTypeTemplateNode;
 use PHPStan\PhpDocParser\Ast\Type\ConstTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
@@ -595,9 +594,10 @@ public function enterNode(Node $node)
 			public function enterNode(Node $node)
 			{
 				if ($node instanceof CallableTypeNode) {
-					$node->templates[] = new CallableTypeTemplateNode(
-						new IdentifierTypeNode('T'),
-						new IdentifierTypeNode('int')
+					$node->templates[] = new TemplateTagValueNode(
+						'T',
+						new IdentifierTypeNode('int'),
+						''
 					);
 				}
 
