CleaningParser - do not remove inline @var tags

phpstan · Nov 16, 2021 · 2652f2d · 2652f2d
1 parent 7c8e81d
commit 2652f2d
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 7 deletions.
diff --git a/src/Parser/CleaningVisitor.php b/src/Parser/CleaningVisitor.php
@@ -20,17 +20,17 @@ public function __construct()
 	public function enterNode(Node $node): ?Node
 	{
 		if ($node instanceof Node\Stmt\Function_) {
-			$node->stmts = $this->keepVariadicsAndYields($node->stmts);
+			$node->stmts = $this->keepVariadicsAndYieldsAndInlineVars($node->stmts);
 			return $node;
 		}
 
 		if ($node instanceof Node\Stmt\ClassMethod && $node->stmts !== null) {
-			$node->stmts = $this->keepVariadicsAndYields($node->stmts);
+			$node->stmts = $this->keepVariadicsAndYieldsAndInlineVars($node->stmts);
 			return $node;
 		}
 
 		if ($node instanceof Node\Expr\Closure) {
-			$node->stmts = $this->keepVariadicsAndYields($node->stmts);
+			$node->stmts = $this->keepVariadicsAndYieldsAndInlineVars($node->stmts);
 			return $node;
 		}
 
@@ -41,7 +41,7 @@ public function enterNode(Node $node): ?Node
 	 * @param Node\Stmt[] $stmts
 	 * @return Node\Stmt[]
 	 */
-	private function keepVariadicsAndYields(array $stmts): array
+	private function keepVariadicsAndYieldsAndInlineVars(array $stmts): array
 	{
 		$results = $this->nodeFinder->find($stmts, static function (Node $node): bool {
 			if ($node instanceof Node\Expr\YieldFrom || $node instanceof Node\Expr\Yield_) {
@@ -50,6 +50,9 @@ private function keepVariadicsAndYields(array $stmts): array
 			if ($node instanceof Node\Expr\FuncCall && $node->name instanceof Node\Name) {
 				return in_array($node->name->toLowerString(), ParametersAcceptor::VARIADIC_FUNCTIONS, true);
 			}
+			if ($node instanceof Node\Stmt && $node->getDocComment() !== null) {
+				return strpos($node->getDocComment()->getText(), '@var') !== false;
+			}
 
 			return false;
 		});
@@ -59,11 +62,12 @@ private function keepVariadicsAndYields(array $stmts): array
 				$newStmts[] = new Node\Stmt\Expression($result);
 				continue;
 			}
-			if (!$result instanceof Node\Expr\FuncCall) {
+			if ($result instanceof Node\Expr\FuncCall && $result->name instanceof Node\Name) {
+				$newStmts[] = new Node\Stmt\Expression(new Node\Expr\FuncCall(new Node\Name\FullyQualified($result->name), [], $result->getAttributes()));
 				continue;
 			}
 
-			$newStmts[] = new Node\Stmt\Expression(new Node\Expr\FuncCall(new Node\Name\FullyQualified('func_get_args')));
+			$newStmts[] = new Node\Stmt\Nop($result->getAttributes());
 		}
 
 		return $newStmts;

diff --git a/src/Type/FileTypeMapper.php b/src/Type/FileTypeMapper.php
@@ -217,7 +217,7 @@ private function shouldPhpDocNodeBeCachedToDisk(PhpDocNode $phpDocNode): bool
 	private function getResolvedPhpDocMap(string $fileName): array
 	{
 		if (!isset($this->memoryCache[$fileName])) {
-			$cacheKey = sprintf('%s-phpdocstring-v10-function-name-stack', $fileName);
+			$cacheKey = sprintf('%s-phpdocstring-v11-inline-vars', $fileName);
 			$variableCacheKey = implode(',', array_map(static function (array $file): string {
 				return sprintf('%s-%d', $file['filename'], $file['modifiedTime']);
 			}, $this->getCachedDependentFilesWithTimestamps($fileName)));

diff --git a/tests/PHPStan/Parser/data/cleaning-1-after.php b/tests/PHPStan/Parser/data/cleaning-1-after.php
@@ -31,3 +31,14 @@ public function both()
         \func_get_args();
     }
 }
+class InlineVars
+{
+    public function doFoo()
+    {
+        /** @var Test */
+        /** @var Test2 */
+        /** @var Test3 */
+        yield;
+        \func_get_args();
+    }
+}
diff --git a/tests/PHPStan/Parser/data/cleaning-1-before.php b/tests/PHPStan/Parser/data/cleaning-1-before.php
@@ -54,3 +54,25 @@ public function both()
 	}
 
 }
+
+class InlineVars
+{
+	public function doFoo()
+	{
+		/** @var Test */
+		$foo = doFoo();
+
+		/** @var Test2 */
+		$foo = doFoo();
+
+		/** @var Test3 */
+		$foo = doFoo();
+
+		if (rand(0, 1)) {
+			yield;
+		}
+		if (rand(0, 1)) {
+			func_get_args();
+		}
+	}
+}