Bleeding edge - check invalid PHPDocs in previously unchecked stateme…

…nt types
phpstan · Mar 9, 2023 · 9780d35 · 9780d35
1 parent 694f392
commit 9780d35
Show file tree

Hide file tree

Showing 10 changed files with 185 additions and 29 deletions.
diff --git a/conf/bleedingEdge.neon b/conf/bleedingEdge.neon
@@ -32,3 +32,4 @@ parameters:
 		newRuleLevelHelper: true
 		instanceofType: true
 		paramOutVariance: true
+		allInvalidPhpDocs: true
diff --git a/conf/config.level2.neon b/conf/config.level2.neon
@@ -39,8 +39,6 @@ rules:
 	- PHPStan\Rules\PhpDoc\IncompatibleClassConstantPhpDocTypeRule
 	- PHPStan\Rules\PhpDoc\IncompatiblePhpDocTypeRule
 	- PHPStan\Rules\PhpDoc\IncompatiblePropertyPhpDocTypeRule
-	- PHPStan\Rules\PhpDoc\InvalidPhpDocTagValueRule
-	- PHPStan\Rules\PhpDoc\InvalidPHPStanDocTagRule
 	- PHPStan\Rules\PhpDoc\InvalidThrowsPhpDocValueRule
 	- PHPStan\Rules\Properties\AccessPrivatePropertyThroughStaticRule
 
@@ -77,13 +75,25 @@ services:
 		class: PHPStan\Rules\Methods\IllegalConstructorMethodCallRule
 	-
 		class: PHPStan\Rules\Methods\IllegalConstructorStaticCallRule
+	-
+		class: PHPStan\Rules\PhpDoc\InvalidPhpDocTagValueRule
+		arguments:
+			checkAllInvalidPhpDocs: %featureToggles.allInvalidPhpDocs%
+		tags:
+			- phpstan.rules.rule
 	-
 		class: PHPStan\Rules\PhpDoc\InvalidPhpDocVarTagTypeRule
 		arguments:
 			checkClassCaseSensitivity: %checkClassCaseSensitivity%
 			checkMissingVarTagTypehint: %checkMissingVarTagTypehint%
 		tags:
 			- phpstan.rules.rule
+	-
+		class: PHPStan\Rules\PhpDoc\InvalidPHPStanDocTagRule
+		arguments:
+			checkAllInvalidPhpDocs: %featureToggles.allInvalidPhpDocs%
+		tags:
+			- phpstan.rules.rule
 	-
 		class: PHPStan\Rules\PhpDoc\VarTagChangedExpressionTypeRule
 	-

diff --git a/conf/config.neon b/conf/config.neon
@@ -62,6 +62,7 @@ parameters:
 		newRuleLevelHelper: false
 		instanceofType: false
 		paramOutVariance: false
+		allInvalidPhpDocs: false
 	fileExtensions:
 		- php
 	checkAdvancedIsset: false
@@ -291,6 +292,7 @@ parametersSchema:
 		newRuleLevelHelper: bool()
 		instanceofType: bool()
 		paramOutVariance: bool()
+		allInvalidPhpDocs: bool()
 	])
 	fileExtensions: listOf(string())
 	checkAdvancedIsset: bool()

diff --git a/src/PhpDoc/StubValidator.php b/src/PhpDoc/StubValidator.php
@@ -178,6 +178,7 @@ private function getRuleRegistry(Container $container): RuleRegistry
 			new InvalidPhpDocTagValueRule(
 				$container->getByType(Lexer::class),
 				$container->getByType(PhpDocParser::class),
+				$container->getParameter('featureToggles')['allInvalidPhpDocs'],
 			),
 			new InvalidThrowsPhpDocValueRule($fileTypeMapper),
 

diff --git a/src/Rules/PhpDoc/InvalidPHPStanDocTagRule.php b/src/Rules/PhpDoc/InvalidPHPStanDocTagRule.php
@@ -4,6 +4,7 @@
 
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
+use PHPStan\Node\VirtualNode;
 use PHPStan\PhpDocParser\Lexer\Lexer;
 use PHPStan\PhpDocParser\Parser\PhpDocParser;
 use PHPStan\PhpDocParser\Parser\TokenIterator;
@@ -53,7 +54,11 @@ class InvalidPHPStanDocTagRule implements Rule
 		'@phpstan-readonly-allow-private-mutation',
 	];
 
-	public function __construct(private Lexer $phpDocLexer, private PhpDocParser $phpDocParser)
+	public function __construct(
+		private Lexer $phpDocLexer,
+		private PhpDocParser $phpDocParser,
+		private bool $checkAllInvalidPhpDocs,
+	)
 	{
 	}
 
@@ -64,15 +69,28 @@ public function getNodeType(): string
 
 	public function processNode(Node $node, Scope $scope): array
 	{
-		if (
-			!$node instanceof Node\Stmt\ClassLike
-			&& !$node instanceof Node\FunctionLike
-			&& !$node instanceof Node\Stmt\Foreach_
-			&& !$node instanceof Node\Stmt\Property
-			&& !$node instanceof Node\Expr\Assign
-			&& !$node instanceof Node\Expr\AssignRef
-		) {
-			return [];
+		if (!$this->checkAllInvalidPhpDocs) {
+			if (
+				!$node instanceof Node\Stmt\ClassLike
+				&& !$node instanceof Node\FunctionLike
+				&& !$node instanceof Node\Stmt\Foreach_
+				&& !$node instanceof Node\Stmt\Property
+				&& !$node instanceof Node\Expr\Assign
+				&& !$node instanceof Node\Expr\AssignRef
+			) {
+				return [];
+			}
+		} else {
+			// mirrored with InvalidPhpDocTagValueRule
+			if ($node instanceof VirtualNode) {
+				return [];
+			}
+			if ($node instanceof Node\Stmt\Expression) {
+				return [];
+			}
+			if ($node instanceof Node\Expr && !$node instanceof Node\Expr\Assign && !$node instanceof Node\Expr\AssignRef) {
+				return [];
+			}
 		}
 
 		$docComment = $node->getDocComment();

diff --git a/src/Rules/PhpDoc/InvalidPhpDocTagValueRule.php b/src/Rules/PhpDoc/InvalidPhpDocTagValueRule.php
@@ -4,6 +4,7 @@
 
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
+use PHPStan\Node\VirtualNode;
 use PHPStan\PhpDocParser\Ast\PhpDoc\InvalidTagValueNode;
 use PHPStan\PhpDocParser\Lexer\Lexer;
 use PHPStan\PhpDocParser\Parser\PhpDocParser;
@@ -19,7 +20,11 @@
 class InvalidPhpDocTagValueRule implements Rule
 {
 
-	public function __construct(private Lexer $phpDocLexer, private PhpDocParser $phpDocParser)
+	public function __construct(
+		private Lexer $phpDocLexer,
+		private PhpDocParser $phpDocParser,
+		private bool $checkAllInvalidPhpDocs,
+	)
 	{
 	}
 
@@ -30,16 +35,29 @@ public function getNodeType(): string
 
 	public function processNode(Node $node, Scope $scope): array
 	{
-		if (
-			!$node instanceof Node\Stmt\ClassLike
-			&& !$node instanceof Node\FunctionLike
-			&& !$node instanceof Node\Stmt\Foreach_
-			&& !$node instanceof Node\Stmt\Property
-			&& !$node instanceof Node\Expr\Assign
-			&& !$node instanceof Node\Expr\AssignRef
-			&& !$node instanceof Node\Stmt\ClassConst
-		) {
-			return [];
+		if (!$this->checkAllInvalidPhpDocs) {
+			if (
+				!$node instanceof Node\Stmt\ClassLike
+				&& !$node instanceof Node\FunctionLike
+				&& !$node instanceof Node\Stmt\Foreach_
+				&& !$node instanceof Node\Stmt\Property
+				&& !$node instanceof Node\Expr\Assign
+				&& !$node instanceof Node\Expr\AssignRef
+				&& !$node instanceof Node\Stmt\ClassConst
+			) {
+				return [];
+			}
+		} else {
+			// mirrored with InvalidPHPStanDocTagRule
+			if ($node instanceof VirtualNode) {
+				return [];
+			}
+			if ($node instanceof Node\Stmt\Expression) {
+				return [];
+			}
+			if ($node instanceof Node\Expr && !$node instanceof Node\Expr\Assign && !$node instanceof Node\Expr\AssignRef) {
+				return [];
+			}
 		}
 
 		$docComment = $node->getDocComment();

diff --git a/tests/PHPStan/Rules/PhpDoc/InvalidPHPStanDocTagRuleTest.php b/tests/PHPStan/Rules/PhpDoc/InvalidPHPStanDocTagRuleTest.php
@@ -6,24 +6,28 @@
 use PHPStan\PhpDocParser\Parser\PhpDocParser;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
+use function array_merge;
 
 /**
  * @extends RuleTestCase<InvalidPHPStanDocTagRule>
  */
 class InvalidPHPStanDocTagRuleTest extends RuleTestCase
 {
 
+	private bool $checkAllInvalidPhpDocs;
+
 	protected function getRule(): Rule
 	{
 		return new InvalidPHPStanDocTagRule(
 			self::getContainer()->getByType(Lexer::class),
 			self::getContainer()->getByType(PhpDocParser::class),
+			$this->checkAllInvalidPhpDocs,
 		);
 	}
 
-	public function testRule(): void
+	public function dataRule(): iterable
 	{
-		$this->analyse([__DIR__ . '/data/invalid-phpstan-doc.php'], [
+		$errors = [
 			[
 				'Unknown PHPDoc tag: @phpstan-extens',
 				7,
@@ -32,11 +36,37 @@ public function testRule(): void
 				'Unknown PHPDoc tag: @phpstan-pararm',
 				14,
 			],
-		]);
+			[
+				'Unknown PHPDoc tag: @phpstan-varr',
+				44,
+			],
+		];
+		yield [false, $errors];
+		yield [true, array_merge($errors, [
+			[
+				'Unknown PHPDoc tag: @phpstan-varr',
+				47,
+			],
+			[
+				'Unknown PHPDoc tag: @phpstan-varr',
+				57,
+			],
+		])];
+	}
+
+	/**
+	 * @dataProvider dataRule
+	 * @param list<array{0: string, 1: int, 2?: string}> $expectedErrors
+	 */
+	public function testRule(bool $checkAllInvalidPhpDocs, array $expectedErrors): void
+	{
+		$this->checkAllInvalidPhpDocs = $checkAllInvalidPhpDocs;
+		$this->analyse([__DIR__ . '/data/invalid-phpstan-doc.php'], $expectedErrors);
 	}
 
 	public function testBug8697(): void
 	{
+		$this->checkAllInvalidPhpDocs = true;
 		$this->analyse([__DIR__ . '/data/bug-8697.php'], []);
 	}
 

diff --git a/tests/PHPStan/Rules/PhpDoc/InvalidPhpDocTagValueRuleTest.php b/tests/PHPStan/Rules/PhpDoc/InvalidPhpDocTagValueRuleTest.php
@@ -6,24 +6,28 @@
 use PHPStan\PhpDocParser\Parser\PhpDocParser;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
+use function array_merge;
 
 /**
  * @extends RuleTestCase<InvalidPhpDocTagValueRule>
  */
 class InvalidPhpDocTagValueRuleTest extends RuleTestCase
 {
 
+	private bool $checkAllInvalidPhpDocs;
+
 	protected function getRule(): Rule
 	{
 		return new InvalidPhpDocTagValueRule(
 			self::getContainer()->getByType(Lexer::class),
 			self::getContainer()->getByType(PhpDocParser::class),
+			$this->checkAllInvalidPhpDocs,
 		);
 	}
 
-	public function testRule(): void
+	public function dataRule(): iterable
 	{
-		$this->analyse([__DIR__ . '/data/invalid-phpdoc.php'], [
+		$errors = [
 			[
 				'PHPDoc tag @param has invalid value (): Unexpected token "\n * ", expected type at offset 13',
 				25,
@@ -84,16 +88,44 @@ public function testRule(): void
 				'PHPDoc tag @var has invalid value ((Foo|Bar): Unexpected token "*/", expected \')\' at offset 18',
 				81,
 			],
-		]);
+			[
+				'PHPDoc tag @var has invalid value ((Foo&): Unexpected token "*/", expected type at offset 15',
+				89,
+			],
+			[
+				'PHPDoc tag @var has invalid value ((Foo&): Unexpected token "*/", expected type at offset 15',
+				92,
+			],
+		];
+
+		yield [false, $errors];
+		yield [true, array_merge($errors, [
+			[
+				'PHPDoc tag @var has invalid value ((Foo&): Unexpected token "*/", expected type at offset 15',
+				102,
+			],
+		])];
+	}
+
+	/**
+	 * @dataProvider dataRule
+	 * @param list<array{0: string, 1: int, 2?: string}> $expectedErrors
+	 */
+	public function testRule(bool $checkAllInvalidPhpDocs, array $expectedErrors): void
+	{
+		$this->checkAllInvalidPhpDocs = $checkAllInvalidPhpDocs;
+		$this->analyse([__DIR__ . '/data/invalid-phpdoc.php'], $expectedErrors);
 	}
 
 	public function testBug4731(): void
 	{
+		$this->checkAllInvalidPhpDocs = true;
 		$this->analyse([__DIR__ . '/data/bug-4731.php'], []);
 	}
 
 	public function testBug4731WithoutFirstTag(): void
 	{
+		$this->checkAllInvalidPhpDocs = true;
 		$this->analyse([__DIR__ . '/data/bug-4731-no-first-tag.php'], []);
 	}
 

diff --git a/tests/PHPStan/Rules/PhpDoc/data/invalid-phpdoc.php b/tests/PHPStan/Rules/PhpDoc/data/invalid-phpdoc.php
@@ -81,3 +81,25 @@ class ClassConstant
 	const FOO = 1;
 
 }
+
+class AboveProperty
+{
+
+	/** @var (Foo& */
+	private $foo;
+
+	/** @var (Foo& */
+	private const TEST = 1;
+
+}
+
+class AboveReturn
+{
+
+	public function doFoo(): string
+	{
+		/** @var (Foo& */
+		return doFoo();
+	}
+
+}
diff --git a/tests/PHPStan/Rules/PhpDoc/data/invalid-phpstan-doc.php b/tests/PHPStan/Rules/PhpDoc/data/invalid-phpstan-doc.php
@@ -36,3 +36,25 @@ function any()
 
 	}
 }
+
+class AboveProperty
+{
+
+	/** @phpstan-varr 1 */
+	private $foo;
+
+	/** @phpstan-varr 1 */
+	private const TEST = 1;
+
+}
+
+class AboveReturn
+{
+
+	public function doFoo(): string
+	{
+		/** @phpstan-varr string */
+		return doFoo();
+	}
+
+}