Take advantage of RestrictedMethodUsageExtension

Author: ondrejmirtes

Diff for: composer.json

@@ -7,7 +7,7 @@
 	],
 	"require": {
 		"php": "^7.4 || ^8.0",
-		"phpstan/phpstan": "^2.0"
+		"phpstan/phpstan": "^2.1.13"
 	},
 	"require-dev": {
 		"php-parallel-lint/php-parallel-lint": "^1.2",

Diff for: rules.neon

@@ -19,11 +19,15 @@ services:
 	-
 		class: PHPStan\Rules\Deprecations\CallWithDeprecatedIniOptionRule
 
+	-
+		class: PHPStan\Rules\Deprecations\RestrictedDeprecatedMethodUsageExtension
+		tags:
+			- phpstan.restrictedMethodUsageExtension
+
 rules:
 	- PHPStan\Rules\Deprecations\AccessDeprecatedPropertyRule
 	- PHPStan\Rules\Deprecations\AccessDeprecatedStaticPropertyRule
 	- PHPStan\Rules\Deprecations\CallToDeprecatedFunctionRule
-	- PHPStan\Rules\Deprecations\CallToDeprecatedMethodRule
 	- PHPStan\Rules\Deprecations\CallToDeprecatedStaticMethodRule
 	- PHPStan\Rules\Deprecations\FetchingClassConstOfDeprecatedClassRule
 	- PHPStan\Rules\Deprecations\FetchingDeprecatedConstRule

Diff for: src/Rules/Deprecations/CallToDeprecatedMethodRule.php

@@ -0,0 +1,60 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Deprecations;
+
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\ExtendedMethodReflection;
+use PHPStan\Rules\RestrictedUsage\RestrictedMethodUsageExtension;
+use PHPStan\Rules\RestrictedUsage\RestrictedUsage;
+use function sprintf;
+use function strtolower;
+
+class RestrictedDeprecatedMethodUsageExtension implements RestrictedMethodUsageExtension
+{
+
+	private DeprecatedScopeHelper $deprecatedScopeHelper;
+
+	public function __construct(DeprecatedScopeHelper $deprecatedScopeHelper)
+	{
+		$this->deprecatedScopeHelper = $deprecatedScopeHelper;
+	}
+
+	public function isRestrictedMethodUsage(
+		ExtendedMethodReflection $methodReflection,
+		Scope $scope
+	): ?RestrictedUsage
+	{
+		if ($this->deprecatedScopeHelper->isScopeDeprecated($scope)) {
+			return null;
+		}
+
+		if (!$methodReflection->isDeprecated()->yes()) {
+			return null;
+		}
+
+		$description = $methodReflection->getDeprecatedDescription();
+		if ($description === null) {
+			return RestrictedUsage::create(
+				sprintf(
+					'Call to deprecated method %s() of %s %s.',
+					$methodReflection->getName(),
+					strtolower($methodReflection->getDeclaringClass()->getClassTypeDescription()),
+					$methodReflection->getDeclaringClass()->getName(),
+				),
+				'method.deprecated',
+			);
+		}
+
+		return RestrictedUsage::create(
+			sprintf(
+				"Call to deprecated method %s() of %s %s:\n%s",
+				$methodReflection->getName(),
+				strtolower($methodReflection->getDeclaringClass()->getClassTypeDescription()),
+				$methodReflection->getDeclaringClass()->getName(),
+				$description,
+			),
+			'method.deprecated',
+		);
+	}
+
+}

Diff for: src/Rules/Deprecations/RestrictedDeprecatedMethodUsageExtension.php

@@ -2,21 +2,19 @@
 
 namespace PHPStan\Rules\Deprecations;
 
+use PHPStan\Rules\RestrictedUsage\RestrictedMethodUsageRule;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
 
 /**
- * @extends RuleTestCase<CallToDeprecatedMethodRule>
+ * @extends RuleTestCase<RestrictedMethodUsageRule>
  */
 class CallToDeprecatedMethodRuleTest extends RuleTestCase
 {
 
 	protected function getRule(): Rule
 	{
-		return new CallToDeprecatedMethodRule(
-			$this->createReflectionProvider(),
-			new DeprecatedScopeHelper([new DefaultDeprecatedScopeResolver()]),
-		);
+		return self::getContainer()->getByType(RestrictedMethodUsageRule::class);
 	}
 
 	public function testDeprecatedMethodCall(): void
@@ -53,4 +51,12 @@ public function testDeprecatedMethodCall(): void
 		);
 	}
 
+	public static function getAdditionalConfigFiles(): array
+	{
+		return [
+			__DIR__ . '/../../../rules.neon',
+			...parent::getAdditionalConfigFiles(),
+		];
+	}
+
 }

Diff for: tests/Rules/Deprecations/CallToDeprecatedMethodRuleTest.php

@@ -0,0 +1,19 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Deprecations;
+
+use PHPStan\Analyser\Scope;
+use function strpos;
+
+class CustomDeprecatedScopeResolver implements DeprecatedScopeResolver
+{
+
+	public function isScopeDeprecated(Scope $scope): bool
+	{
+		$function = $scope->getFunction();
+		return $function !== null
+			&& $function->getDocComment() !== null
+			&& strpos($function->getDocComment(), '@group legacy') !== false;
+	}
+
+}

Diff for: tests/Rules/Deprecations/CustomDeprecatedScopeResolver.php

@@ -2,38 +2,19 @@
 
 namespace PHPStan\Rules\Deprecations;
 
-use PHPStan\Analyser\Scope;
+use PHPStan\Rules\RestrictedUsage\RestrictedMethodUsageRule;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
-use function strpos;
 
 /**
- * @extends RuleTestCase<CallToDeprecatedMethodRule>
+ * @extends RuleTestCase<RestrictedMethodUsageRule>
  */
 final class CustomDeprecatedScopeResolverTest extends RuleTestCase
 {
 
 	protected function getRule(): Rule
 	{
-		$customScopeResolver = new class implements DeprecatedScopeResolver
-		{
-
-			public function isScopeDeprecated(Scope $scope): bool
-			{
-				$function = $scope->getFunction();
-				return $function !== null
-					&& $function->getDocComment() !== null
-					&& strpos($function->getDocComment(), '@group legacy') !== false;
-			}
-
-		};
-		return new CallToDeprecatedMethodRule(
-			$this->createReflectionProvider(),
-			new DeprecatedScopeHelper([
-				new DefaultDeprecatedScopeResolver(),
-				$customScopeResolver,
-			]),
-		);
+		return self::getContainer()->getByType(RestrictedMethodUsageRule::class);
 	}
 
 	public function testCustomScope(): void
@@ -50,4 +31,13 @@ public function testCustomScope(): void
 		);
 	}
 
+	public static function getAdditionalConfigFiles(): array
+	{
+		return [
+			__DIR__ . '/../../../rules.neon',
+			__DIR__ . '/custom-deprecated-scope.neon',
+			...parent::getAdditionalConfigFiles(),
+		];
+	}
+
 }

Diff for: tests/Rules/Deprecations/CustomDeprecatedScopeResolverTest.php

@@ -0,0 +1,5 @@
+services:
+	-
+		class: PHPStan\Rules\Deprecations\CustomDeprecatedScopeResolver
+		tags:
+			- phpstan.deprecations.deprecatedScopeResolver