Do not allow Scope::filterByTruthyValue() in the Generator namespace

Author: ondrejmirtes

build/PHPStan/Build/ScopeGetTypeInGeneratorNamespaceRule.php

@@ -7,7 +7,6 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\ObjectType;
 use PHPUnit\Framework\TestCase;
 use function in_array;
@@ -41,10 +40,6 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		if (!in_array($node->name->toLowerString(), ['gettype', 'getnativetype'], true)) {
-			return [];
-		}
-
 		$scopeType = new ObjectType(Scope::class);
 		$calledOnType =  $scope->getType($node->var);
 		if (!$scopeType->isSuperTypeOf($calledOnType)->yes()) {
@@ -60,19 +55,33 @@ public function processNode(Node $node, Scope $scope): array
 
 		$methodReflection = $scope->getMethodReflection($calledOnType, $node->name->toString());
 		if ($methodReflection === null) {
-			throw new ShouldNotHappenException();
+			return [];
+		}
+
+		$message = sprintf(
+			'Scope::%s() cannot be called in %s namespace.',
+			$methodReflection->getName(),
+			$invalidNamespace,
+		);
+
+		if (in_array($methodReflection->getName(), ['getType', 'getNativeType'], true)) {
+			return [
+				RuleErrorBuilder::message($message)
+					->identifier('phpstan.scopeGetType')
+					->tip('Use yield new ExprAnalysisRequest or query the ExprAnalysisResultStorage instead.')
+					->build(),
+			];
+		}
+
+		if (in_array($methodReflection->getName(), ['filterByTruthyValue', 'filterByFalseyValue'], true)) {
+			return [
+				RuleErrorBuilder::message($message)
+					->identifier('phpstan.scopeFilter')
+					->build(),
+			];
 		}
 
-		return [
-			RuleErrorBuilder::message(sprintf(
-				'Scope::%s() cannot be called in %s namespace.',
-				$methodReflection->getName(),
-				$invalidNamespace,
-			))
-				->identifier('phpstan.scopeGetType')
-				->tip('Use yield new ExprAnalysisRequest or query the ExprAnalysisResultStorage instead.')
-				->build(),
-		];
+		return [];
 	}
 
 }

tests/PHPStan/Build/ScopeGetTypeInGeneratorNamespaceRuleTest.php

@@ -39,6 +39,22 @@ public function testRule(): void
 				49,
 				'Use yield new ExprAnalysisRequest or query the ExprAnalysisResultStorage instead.',
 			],
+			[
+				'Scope::filterByTruthyValue() cannot be called in PHPStan\Analyser\Generator namespace.',
+				59,
+			],
+			[
+				'Scope::filterByFalseyValue() cannot be called in PHPStan\Analyser\Generator namespace.',
+				60,
+			],
+			[
+				'Scope::filterByTruthyValue() cannot be called in PHPStan\Analyser\Generator namespace.',
+				65,
+			],
+			[
+				'Scope::filterByFalseyValue() cannot be called in PHPStan\Analyser\Generator namespace.',
+				66,
+			],
 		]);
 	}
 

tests/PHPStan/Build/data/scope-get-type-generator-ns.php

@@ -50,4 +50,21 @@ public function doBar(GeneratorScope $scope): void
 		}
 
 	}
+
+	class Bar
+	{
+
+		public function doFoo(Scope $scope): void
+		{
+			$scope->filterByTruthyValue();
+			$scope->filterByFalseyValue();
+		}
+
+		public function doBar(GeneratorScope $scope): void
+		{
+			$scope->filterByTruthyValue();
+			$scope->filterByFalseyValue();
+		}
+
+	}
 }