Rewrite ApiClassConstFetchRule as a restricted class constant usage extension

Nonexistent constants are no longer reported, ClassConstantRule already
reports them.

Amp-Thread-ID: https://ampcode.com/threads/T-01a1bf5f-ca34-7733-8886-c850b9908584

Author: ondrejmirtes

src/Rules/Api/ApiClassConstFetchRule.php

@@ -0,0 +1,82 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Api;
+
+use PHPStan\Analyser\Scope;
+use PHPStan\DependencyInjection\AutowiredService;
+use PHPStan\Reflection\ClassConstantReflection;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Rules\RestrictedUsage\RestrictedClassConstantUsageExtension;
+use PHPStan\Rules\RestrictedUsage\RestrictedUsage;
+use function count;
+use function sprintf;
+use function str_contains;
+
+#[AutowiredService]
+final class ApiClassConstantUsageExtension implements RestrictedClassConstantUsageExtension
+{
+
+	public function __construct(private ApiRuleHelper $apiRuleHelper)
+	{
+	}
+
+	public function isRestrictedClassConstantUsage(
+		ClassConstantReflection $constantReflection,
+		Scope $scope,
+	): ?RestrictedUsage
+	{
+		$declaringClass = $constantReflection->getDeclaringClass();
+		if (!$this->apiRuleHelper->isPhpStanCode($scope, $declaringClass->getName(), $declaringClass->getFileName())) {
+			return null;
+		}
+
+		if ($this->isClassCovered($declaringClass)) {
+			return null;
+		}
+
+		if ($constantReflection->getName() === 'class') {
+			// Foo::class is fine when the class has a method covered by the backward compatibility promise
+			foreach ($declaringClass->getNativeReflection()->getMethods() as $methodReflection) {
+				$methodDocComment = $methodReflection->getDocComment();
+				if ($methodDocComment !== false && str_contains($methodDocComment, '@api')) {
+					return null;
+				}
+			}
+		} else {
+			$constantDocComment = $constantReflection->getDocComment();
+			if ($constantDocComment !== null && str_contains($constantDocComment, '@api')) {
+				return null;
+			}
+		}
+
+		return RestrictedUsage::create(
+			sprintf(
+				'Accessing %s::%s is not covered by backward compatibility promise. The class might change in a minor PHPStan version.',
+				$declaringClass->getDisplayName(),
+				$constantReflection->getName(),
+			),
+			'phpstanApi.classConstant',
+			sprintf(
+				"If you think it should be covered by backward compatibility promise, open a discussion:\n   %s\n\n   See also:\n   https://phpstan.org/developing-extensions/backward-compatibility-promise",
+				'https://github.com/phpstan/phpstan/discussions',
+			),
+		);
+	}
+
+	private function isClassCovered(ClassReflection $classReflection): bool
+	{
+		$docBlock = $classReflection->getResolvedPhpDoc();
+		if ($docBlock === null) {
+			return false;
+		}
+
+		foreach ($docBlock->getPhpDocNodes() as $phpDocNode) {
+			if (count($phpDocNode->getTagsByName('@api')) > 0) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+}

src/Rules/Api/ApiClassConstantUsageExtension.php

@@ -2,19 +2,20 @@
 
 namespace PHPStan\Rules\Api;
 
+use PHPStan\Rules\RestrictedUsage\RestrictedClassConstantUsageRule;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
 use function sprintf;
 
 /**
- * @extends RuleTestCase<ApiClassConstFetchRule>
+ * @extends RuleTestCase<RestrictedClassConstantUsageRule>
  */
-class ApiClassConstFetchRuleTest extends RuleTestCase
+class ApiClassConstantUsageExtensionTest extends RuleTestCase
 {
 
 	protected function getRule(): Rule
 	{
-		return new ApiClassConstFetchRule(new ApiRuleHelper(), self::createReflectionProvider());
+		return self::getContainer()->getByType(RestrictedClassConstantUsageRule::class);
 	}
 
 	public function testRuleInPhpStan(): void
@@ -35,11 +36,6 @@ public function testRuleOutOfPhpStan(): void
 				19,
 				$tip,
 			],
-			[
-				'Accessing PHPStan\Analyser\NodeScopeResolver::FOO is not covered by backward compatibility promise. The class might change in a minor PHPStan version.',
-				23,
-				$tip,
-			],
 			[
 				'Accessing PHPStan\Turbo\TurboExtensionSelector::MINIMUM_PHP_VERSION_ID is not covered by backward compatibility promise. The class might change in a minor PHPStan version.',
 				28,

…Rules/Api/ApiClassConstFetchRuleTest.php …i/ApiClassConstantUsageExtensionTest.phptests/PHPStan/Rules/Api/ApiClassConstFetchRuleTest.php renamed to tests/PHPStan/Rules/Api/ApiClassConstantUsageExtensionTest.php tests/PHPStan/Rules/Api/ApiClassConstFetchRuleTest.php renamed to tests/PHPStan/Rules/Api/ApiClassConstantUsageExtensionTest.php

@@ -20,7 +20,7 @@ public function doFoo()
 		echo NodeScopeResolver::class;
 		echo ScopeFactory::class;
 
-		echo NodeScopeResolver::FOO;
+		echo NodeScopeResolver::FOO; // nonexistent constants are reported by ClassConstantRule
 
 		echo Scope::SUPERGLOBAL_VARIABLES;
 		echo MutatingScope::SUPERGLOBAL_VARIABLES;