ScopeGetTypeInGeneratorNamespaceRule

Author: ondrejmirtes

build/PHPStan/Build/ScopeGetTypeInGeneratorNamespaceRule.php

@@ -0,0 +1,70 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Build;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Type\ObjectType;
+use PHPUnit\Framework\TestCase;
+use function sprintf;
+use function str_starts_with;
+
+/**
+ * @implements Rule<MethodCall>
+ */
+final class ScopeGetTypeInGeneratorNamespaceRule implements Rule
+{
+
+	public function getNodeType(): string
+	{
+		return MethodCall::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$namespace = $scope->getNamespace();
+		if ($namespace === null) {
+			return [];
+		}
+
+		$invalidNamespace = 'PHPStan\\Analyser\\Generator';
+		if (!str_starts_with($namespace . '\\', $invalidNamespace . '\\')) {
+			return [];
+		}
+
+		if (!$node->name instanceof Node\Identifier) {
+			return [];
+		}
+
+		if ($node->name->toLowerString() !== 'gettype') {
+			return [];
+		}
+
+		$scopeType = new ObjectType(Scope::class);
+		$calledOnType =  $scope->getType($node->var);
+		if (!$scopeType->isSuperTypeOf($calledOnType)->yes()) {
+			return [];
+		}
+
+		if ($scope->isInClass()) {
+			$inClass = $scope->getClassReflection();
+			if ($inClass->is(TestCase::class)) {
+				return [];
+			}
+		}
+
+		return [
+			RuleErrorBuilder::message(sprintf(
+				'Scope::getType() cannot be called in %s namespace.',
+				$invalidNamespace,
+			))
+				->identifier('phpstan.scopeGetType')
+				->tip('Use new ExprAnalysisRequest instead.')
+				->build(),
+		];
+	}
+
+}

build/phpstan.neon

@@ -140,6 +140,7 @@ rules:
 	- PHPStan\Build\SkipTestsWithRequiresPhpAttributeRule
 	- PHPStan\Build\MemoizationPropertyRule
 	- PHPStan\Build\OrChainIdenticalComparisonToInArrayRule
+	- PHPStan\Build\ScopeGetTypeInGeneratorNamespaceRule
 
 services:
 	-

tests/PHPStan/Build/ScopeGetTypeInGeneratorNamespaceRuleTest.php

@@ -0,0 +1,40 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Build;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<ScopeGetTypeInGeneratorNamespaceRule>
+ */
+class ScopeGetTypeInGeneratorNamespaceRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new ScopeGetTypeInGeneratorNamespaceRule();
+	}
+
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/scope-get-type-generator-ns.php'], [
+			[
+				'Scope::getType() cannot be called in PHPStan\Analyser\Generator namespace.',
+				27,
+				'Use new ExprAnalysisRequest instead.',
+			],
+			[
+				'Scope::getType() cannot be called in PHPStan\Analyser\Generator namespace.',
+				43,
+				'Use new ExprAnalysisRequest instead.',
+			],
+			[
+				'Scope::getType() cannot be called in PHPStan\Analyser\Generator namespace.',
+				48,
+				'Use new ExprAnalysisRequest instead.',
+			],
+		]);
+	}
+
+}

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

@@ -0,0 +1,52 @@
+<?php
+
+namespace ScopeGetTypeGeneratorNs {
+
+	use PHPStan\Analyser\Scope;
+
+	class Foo
+	{
+
+		public function doFoo(Scope $scope): void
+		{
+			$scope->getType();
+		}
+
+	}
+}
+
+namespace PHPStan\Analyser\Generator {
+
+	use PHPStan\Analyser\Scope;
+
+	class Foo
+	{
+
+		public function doFoo(Scope $scope): void
+		{
+			$scope->getType();
+		}
+
+	}
+}
+
+namespace PHPStan\Analyser\Generator\ExprHandler {
+
+	use PHPStan\Analyser\Generator\GeneratorScope;
+	use PHPStan\Analyser\Scope;
+
+	class Foo
+	{
+
+		public function doFoo(Scope $scope): void
+		{
+			$scope->getType();
+		}
+
+		public function doBar(GeneratorScope $scope): void
+		{
+			$scope->getType();
+		}
+
+	}
+}