Fix CleaningParserTest for generators and variadics

Author: ondrejmirtes

src/Parser/CleaningVisitor.php

@@ -3,29 +3,70 @@
 namespace PHPStan\Parser;
 
 use PhpParser\Node;
+use PhpParser\NodeFinder;
 use PhpParser\NodeVisitorAbstract;
+use PHPStan\Reflection\ParametersAcceptor;
 
 class CleaningVisitor extends NodeVisitorAbstract
 {
 
+	private NodeFinder $nodeFinder;
+
+	public function __construct()
+	{
+		$this->nodeFinder = new NodeFinder();
+	}
+
 	public function enterNode(Node $node): ?Node
 	{
 		if ($node instanceof Node\Stmt\Function_) {
-			$node->stmts = [];
+			$node->stmts = $this->keepVariadicsAndYields($node->stmts);
 			return $node;
 		}
 
 		if ($node instanceof Node\Stmt\ClassMethod && $node->stmts !== null) {
-			$node->stmts = [];
+			$node->stmts = $this->keepVariadicsAndYields($node->stmts);
 			return $node;
 		}
 
 		if ($node instanceof Node\Expr\Closure) {
-			$node->stmts = [];
+			$node->stmts = $this->keepVariadicsAndYields($node->stmts);
 			return $node;
 		}
 
 		return null;
 	}
 
+	/**
+	 * @param Node\Stmt[] $stmts
+	 * @return Node\Stmt[]
+	 */
+	private function keepVariadicsAndYields(array $stmts): array
+	{
+		$results = $this->nodeFinder->find($stmts, static function (Node $node): bool {
+			if ($node instanceof Node\Expr\YieldFrom || $node instanceof Node\Expr\Yield_) {
+				return true;
+			}
+			if ($node instanceof Node\Expr\FuncCall && $node->name instanceof Node\Name) {
+				return in_array($node->name->toLowerString(), ParametersAcceptor::VARIADIC_FUNCTIONS, true);
+			}
+
+			return false;
+		});
+		$newStmts = [];
+		foreach ($results as $result) {
+			if ($result instanceof Node\Expr\Yield_ || $result instanceof Node\Expr\YieldFrom) {
+				$newStmts[] = new Node\Stmt\Expression($result);
+				continue;
+			}
+			if (!$result instanceof Node\Expr\FuncCall) {
+				continue;
+			}
+
+			$newStmts[] = new Node\Stmt\Expression(new Node\Expr\FuncCall(new Node\Name\FullyQualified('func_get_args')));
+		}
+
+		return $newStmts;
+	}
+
 }

src/Reflection/Php/PhpFunctionReflection.php

@@ -170,7 +170,7 @@ private function isVariadic(): bool
 				if ($modifiedTime === false) {
 					$modifiedTime = time();
 				}
-				$variableCacheKey = sprintf('%d-v2', $modifiedTime);
+				$variableCacheKey = sprintf('%d-v3', $modifiedTime);
 				$key = sprintf('variadic-function-%s-%s', $functionName, $fileName);
 				$cachedResult = $this->cache->load($key, $variableCacheKey);
 				if ($cachedResult === null) {

src/Reflection/Php/PhpMethodReflection.php

@@ -274,7 +274,7 @@ private function isVariadic(): bool
 				$modifiedTime = time();
 			}
 			$key = sprintf('variadic-method-%s-%s-%s', $declaringClass->getName(), $this->reflection->getName(), $filename);
-			$variableCacheKey = sprintf('%d-v3', $modifiedTime);
+			$variableCacheKey = sprintf('%d-v4', $modifiedTime);
 			$cachedResult = $this->cache->load($key, $variableCacheKey);
 			if ($cachedResult === null || !is_bool($cachedResult)) {
 				$nodes = $this->parser->parseFile($filename);

tests/PHPStan/Parser/CleaningParserTest.php

@@ -0,0 +1,46 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Parser;
+
+use PhpParser\Lexer\Emulative;
+use PhpParser\NodeVisitor\NameResolver;
+use PhpParser\Parser\Php7;
+use PhpParser\PrettyPrinter\Standard;
+use PHPStan\File\FileReader;
+use PHPStan\Testing\PHPStanTestCase;
+
+class CleaningParserTest extends PHPStanTestCase
+{
+
+	public function dataParse(): iterable
+	{
+		return [
+			[
+				__DIR__ . '/data/cleaning-1-before.php',
+				__DIR__ . '/data/cleaning-1-after.php',
+			],
+		];
+	}
+
+	/**
+	 * @dataProvider dataParse
+	 * @param string $beforeFile
+	 * @param string $afterFile
+	 */
+	public function testParse(
+		string $beforeFile,
+		string $afterFile
+	): void
+	{
+		$parser = new CleaningParser(
+			new SimpleParser(
+				new Php7(new Emulative()),
+				new NameResolver()
+			)
+		);
+		$printer = new Standard();
+		$ast = $parser->parseFile($beforeFile);
+		$this->assertSame(FileReader::read($afterFile), "<?php\n" . $printer->prettyPrint($ast) . "\n");
+	}
+
+}

tests/PHPStan/Parser/data/cleaning-1-after.php

@@ -0,0 +1,33 @@
+<?php
+namespace Test;
+
+class Foo
+{
+    public function doFoo()
+    {
+    }
+}
+interface Bar
+{
+    public function doBar();
+}
+class Baz
+{
+    public function someGenerator()
+    {
+        yield;
+    }
+    public function someGenerator2()
+    {
+        yield from [1, 2, 3];
+    }
+    public function someVariadics()
+    {
+        \func_get_args();
+    }
+    public function both()
+    {
+        yield;
+        \func_get_args();
+    }
+}

tests/PHPStan/Parser/data/cleaning-1-before.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Test;
+
+class Foo
+{
+
+	public function doFoo()
+	{
+		test();
+	}
+
+}
+
+interface Bar
+{
+
+	public function doBar();
+
+}
+
+class Baz
+{
+
+	public function someGenerator()
+	{
+		if (rand(0, 1)) {
+			yield;
+		}
+	}
+
+	public function someGenerator2()
+	{
+		if (rand(0, 1)) {
+			yield from [1, 2, 3];
+		}
+	}
+
+	public function someVariadics()
+	{
+		if (rand(0, 1)) {
+			func_get_args();
+		}
+	}
+
+	public function both()
+	{
+		if (rand(0, 1)) {
+			yield;
+		}
+		if (rand(0, 1)) {
+			func_get_args();
+		}
+	}
+
+}