Modernize rules to use RuleErrorBuilder and report error identifiers

phpstan · Aug 5, 2023 · 2313a63 · 2313a63
1 parent ca9e4fd
commit 2313a63
Show file tree

Hide file tree

Showing 18 changed files with 197 additions and 145 deletions.
diff --git a/composer.json b/composer.json
@@ -7,7 +7,7 @@
 	],
 	"require": {
 		"php": "^7.2 || ^8.0",
-		"phpstan/phpstan": "^1.10.3"
+		"phpstan/phpstan": "^1.11"
 	},
 	"require-dev": {
 		"php-parallel-lint/php-parallel-lint": "^1.2",

diff --git a/src/Rules/Deprecations/AccessDeprecatedPropertyRule.php b/src/Rules/Deprecations/AccessDeprecatedPropertyRule.php
@@ -10,7 +10,9 @@
 use PHPStan\Reflection\MissingPropertyFromReflectionException;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use function sprintf;
+use function strtolower;
 
 /**
  * @implements Rule<PropertyFetch>
@@ -57,19 +59,25 @@ public function processNode(Node $node, Scope $scope): array
 				if ($propertyReflection->isDeprecated()->yes()) {
 					$description = $propertyReflection->getDeprecatedDescription();
 					if ($description === null) {
-						return [sprintf(
-							'Access to deprecated property $%s of class %s.',
-							$propertyName,
-							$propertyReflection->getDeclaringClass()->getName()
-						)];
+						return [
+							RuleErrorBuilder::message(sprintf(
+								'Access to deprecated property $%s of %s %s.',
+								$propertyName,
+								strtolower($propertyReflection->getDeclaringClass()->getClassTypeDescription()),
+								$propertyReflection->getDeclaringClass()->getName()
+							))->identifier('property.deprecated')->build(),
+						];
 					}
 
-					return [sprintf(
-						"Access to deprecated property $%s of class %s:\n%s",
-						$propertyName,
-						$propertyReflection->getDeclaringClass()->getName(),
-						$description
-					)];
+					return [
+						RuleErrorBuilder::message(sprintf(
+							"Access to deprecated property $%s of %s %s:\n%s",
+							$propertyName,
+							strtolower($propertyReflection->getDeclaringClass()->getClassTypeDescription()),
+							$propertyReflection->getDeclaringClass()->getName(),
+							$description
+						))->identifier('property.deprecated')->build(),
+					];
 				}
 			} catch (ClassNotFoundException $e) {
 				// Other rules will notify if the class is not found

diff --git a/src/Rules/Deprecations/AccessDeprecatedStaticPropertyRule.php b/src/Rules/Deprecations/AccessDeprecatedStaticPropertyRule.php
@@ -11,10 +11,12 @@
 use PHPStan\Reflection\MissingPropertyFromReflectionException;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Rules\RuleLevelHelper;
 use PHPStan\Type\ErrorType;
 use PHPStan\Type\Type;
 use function sprintf;
+use function strtolower;
 
 /**
  * @implements Rule<StaticPropertyFetch>
@@ -88,19 +90,25 @@ static function (Type $type) use ($propertyName): bool {
 			if ($property->isDeprecated()->yes()) {
 				$description = $property->getDeprecatedDescription();
 				if ($description === null) {
-					return [sprintf(
-						'Access to deprecated static property $%s of class %s.',
-						$propertyName,
-						$property->getDeclaringClass()->getName()
-					)];
+					return [
+						RuleErrorBuilder::message(sprintf(
+							'Access to deprecated static property $%s of %s %s.',
+							$propertyName,
+							strtolower($property->getDeclaringClass()->getClassTypeDescription()),
+							$property->getDeclaringClass()->getName()
+						))->identifier('staticProperty.deprecated')->build(),
+					];
 				}
 
-				return [sprintf(
-					"Access to deprecated static property $%s of class %s:\n%s",
-					$propertyName,
-					$property->getDeclaringClass()->getName(),
-					$description
-				)];
+				return [
+					RuleErrorBuilder::message(sprintf(
+						"Access to deprecated static property $%s of %s %s:\n%s",
+						$propertyName,
+						strtolower($property->getDeclaringClass()->getClassTypeDescription()),
+						$property->getDeclaringClass()->getName(),
+						$description
+					))->identifier('staticProperty.deprecated')->build(),
+				];
 			}
 		}
 

diff --git a/src/Rules/Deprecations/CallToDeprecatedFunctionRule.php b/src/Rules/Deprecations/CallToDeprecatedFunctionRule.php
@@ -9,6 +9,7 @@
 use PHPStan\Broker\FunctionNotFoundException;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use function sprintf;
 
 /**
@@ -54,17 +55,21 @@ public function processNode(Node $node, Scope $scope): array
 		if ($function->isDeprecated()->yes()) {
 			$description = $function->getDeprecatedDescription();
 			if ($description === null) {
-				return [sprintf(
-					'Call to deprecated function %s().',
-					$function->getName()
-				)];
+				return [
+					RuleErrorBuilder::message(sprintf(
+						'Call to deprecated function %s().',
+						$function->getName()
+					))->identifier('function.deprecated')->build(),
+				];
 			}
 
-			return [sprintf(
-				"Call to deprecated function %s():\n%s",
-				$function->getName(),
-				$description
-			)];
+			return [
+				RuleErrorBuilder::message(sprintf(
+					"Call to deprecated function %s():\n%s",
+					$function->getName(),
+					$description
+				))->identifier('function.deprecated')->build(),
+			];
 		}
 
 		return [];

diff --git a/src/Rules/Deprecations/CallToDeprecatedMethodRule.php b/src/Rules/Deprecations/CallToDeprecatedMethodRule.php
@@ -10,7 +10,9 @@
 use PHPStan\Reflection\MissingMethodFromReflectionException;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use function sprintf;
+use function strtolower;
 
 /**
  * @implements Rule<MethodCall>
@@ -60,19 +62,25 @@ public function processNode(Node $node, Scope $scope): array
 
 				$description = $methodReflection->getDeprecatedDescription();
 				if ($description === null) {
-					return [sprintf(
-						'Call to deprecated method %s() of class %s.',
-						$methodReflection->getName(),
-						$methodReflection->getDeclaringClass()->getName()
-					)];
+					return [
+						RuleErrorBuilder::message(sprintf(
+							'Call to deprecated method %s() of %s %s.',
+							$methodReflection->getName(),
+							strtolower($methodReflection->getDeclaringClass()->getClassTypeDescription()),
+							$methodReflection->getDeclaringClass()->getName()
+						))->identifier('method.deprecated')->build(),
+					];
 				}
 
-				return [sprintf(
-					"Call to deprecated method %s() of class %s:\n%s",
-					$methodReflection->getName(),
-					$methodReflection->getDeclaringClass()->getName(),
-					$description
-				)];
+				return [
+					RuleErrorBuilder::message(sprintf(
+						"Call to deprecated method %s() of %s %s:\n%s",
+						$methodReflection->getName(),
+						strtolower($methodReflection->getDeclaringClass()->getClassTypeDescription()),
+						$methodReflection->getDeclaringClass()->getName(),
+						$description
+					))->identifier('method.deprecated')->build(),
+				];
 			} catch (ClassNotFoundException $e) {
 				// Other rules will notify if the class is not found
 			} catch (MissingMethodFromReflectionException $e) {

diff --git a/src/Rules/Deprecations/CallToDeprecatedStaticMethodRule.php b/src/Rules/Deprecations/CallToDeprecatedStaticMethodRule.php
@@ -11,10 +11,12 @@
 use PHPStan\Reflection\MissingMethodFromReflectionException;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Rules\RuleLevelHelper;
 use PHPStan\Type\ErrorType;
 use PHPStan\Type\Type;
 use function sprintf;
+use function strtolower;
 
 /**
  * @implements Rule<StaticCall>
@@ -90,18 +92,20 @@ static function (Type $type) use ($methodName): bool {
 			if ($class->isDeprecated()) {
 				$classDescription = $class->getDeprecatedDescription();
 				if ($classDescription === null) {
-					$errors[] = sprintf(
-						'Call to method %s() of deprecated class %s.',
+					$errors[] = RuleErrorBuilder::message(sprintf(
+						'Call to method %s() of deprecated %s %s.',
 						$methodReflection->getName(),
+						strtolower($methodReflection->getDeclaringClass()->getClassTypeDescription()),
 						$methodReflection->getDeclaringClass()->getName()
-					);
+					))->identifier(sprintf('staticMethod.deprecated%s', $methodReflection->getDeclaringClass()->getClassTypeDescription()))->build();
 				} else {
-					$errors[] = sprintf(
-						"Call to method %s() of deprecated class %s:\n%s",
+					$errors[] = RuleErrorBuilder::message(sprintf(
+						"Call to method %s() of deprecated %s %s:\n%s",
 						$methodReflection->getName(),
+						strtolower($methodReflection->getDeclaringClass()->getClassTypeDescription()),
 						$methodReflection->getDeclaringClass()->getName(),
 						$classDescription
-					);
+					))->identifier(sprintf('staticMethod.deprecated%s', $methodReflection->getDeclaringClass()->getClassTypeDescription()))->build();
 				}
 			}
 
@@ -111,18 +115,20 @@ static function (Type $type) use ($methodName): bool {
 
 			$description = $methodReflection->getDeprecatedDescription();
 			if ($description === null) {
-				$errors[] = sprintf(
-					'Call to deprecated method %s() of class %s.',
+				$errors[] = RuleErrorBuilder::message(sprintf(
+					'Call to deprecated method %s() of %s %s.',
 					$methodReflection->getName(),
+					strtolower($methodReflection->getDeclaringClass()->getClassTypeDescription()),
 					$methodReflection->getDeclaringClass()->getName()
-				);
+				))->identifier('staticMethod.deprecated')->build();
 			} else {
-				$errors[] = sprintf(
-					"Call to deprecated method %s() of class %s:\n%s",
+				$errors[] = RuleErrorBuilder::message(sprintf(
+					"Call to deprecated method %s() of %s %s:\n%s",
 					$methodReflection->getName(),
+					strtolower($methodReflection->getDeclaringClass()->getClassTypeDescription()),
 					$methodReflection->getDeclaringClass()->getName(),
 					$description
-				);
+				))->identifier('staticMethod.deprecated')->build();
 			}
 		}
 

diff --git a/src/Rules/Deprecations/DeprecatedClassHelper.php b/src/Rules/Deprecations/DeprecatedClassHelper.php
@@ -18,15 +18,6 @@ public function __construct(ReflectionProvider $reflectionProvider)
 		$this->reflectionProvider = $reflectionProvider;
 	}
 
-	public function getClassType(ClassReflection $class): string
-	{
-		if ($class->isInterface()) {
-			return 'interface';
-		}
-
-		return 'class';
-	}
-
 	public function getClassDeprecationDescription(ClassReflection $class): string
 	{
 		$description = $class->getDeprecatedDescription();

diff --git a/src/Rules/Deprecations/FetchingClassConstOfDeprecatedClassRule.php b/src/Rules/Deprecations/FetchingClassConstOfDeprecatedClassRule.php
@@ -10,6 +10,7 @@
 use PHPStan\Broker\ClassNotFoundException;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Rules\RuleLevelHelper;
 use PHPStan\Type\ErrorType;
 use PHPStan\Type\Type;
@@ -87,18 +88,20 @@ static function (Type $type) use ($constantName): bool {
 			if ($class->isDeprecated()) {
 				$classDescription = $class->getDeprecatedDescription();
 				if ($classDescription === null) {
-					$errors[] = sprintf(
-						'Fetching class constant %s of deprecated class %s.',
+					$errors[] = RuleErrorBuilder::message(sprintf(
+						'Fetching class constant %s of deprecated %s %s.',
 						$constantName,
+						strtolower($class->getClassTypeDescription()),
 						$referencedClass
-					);
+					))->identifier(sprintf('classConstant.deprecated%s', $class->getClassTypeDescription()))->build();
 				} else {
-					$errors[] = sprintf(
-						"Fetching class constant %s of deprecated class %s:\n%s",
+					$errors[] = RuleErrorBuilder::message(sprintf(
+						"Fetching class constant %s of deprecated %s %s:\n%s",
 						$constantName,
+						strtolower($class->getClassTypeDescription()),
 						$referencedClass,
 						$classDescription
-					);
+					))->identifier(sprintf('classConstant.deprecated%s', $class->getClassTypeDescription()))->build();
 				}
 			}
 
@@ -118,18 +121,20 @@ static function (Type $type) use ($constantName): bool {
 
 			$description = $constantReflection->getDeprecatedDescription();
 			if ($description === null) {
-				$errors[] = sprintf(
-					'Fetching deprecated class constant %s of class %s.',
+				$errors[] = RuleErrorBuilder::message(sprintf(
+					'Fetching deprecated class constant %s of %s %s.',
 					$constantName,
+					strtolower($class->getClassTypeDescription()),
 					$referencedClass
-				);
+				))->identifier('classConstant.deprecated')->build();
 			} else {
-				$errors[] = sprintf(
-					"Fetching deprecated class constant %s of class %s:\n%s",
+				$errors[] = RuleErrorBuilder::message(sprintf(
+					"Fetching deprecated class constant %s of %s %s:\n%s",
 					$constantName,
+					strtolower($class->getClassTypeDescription()),
 					$referencedClass,
 					$description
-				);
+				))->identifier('classConstant.deprecated')->build();
 			}
 		}
 

diff --git a/src/Rules/Deprecations/FetchingDeprecatedConstRule.php b/src/Rules/Deprecations/FetchingDeprecatedConstRule.php
@@ -7,6 +7,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use function sprintf;
 use const PHP_VERSION_ID;
 
@@ -55,17 +56,21 @@ public function processNode(Node $node, Scope $scope): array
 		$constantReflection = $this->reflectionProvider->getConstant($node->name, $scope);
 
 		if ($constantReflection->isDeprecated()->yes()) {
-			return [sprintf(
-				$constantReflection->getDeprecatedDescription() ?? 'Use of constant %s is deprecated.',
-				$constantReflection->getName()
-			)];
+			return [
+				RuleErrorBuilder::message(sprintf(
+					$constantReflection->getDeprecatedDescription() ?? 'Use of constant %s is deprecated.',
+					$constantReflection->getName()
+				))->identifier('constant.deprecated')->build(),
+			];
 		}
 
 		if (isset($this->deprecatedConstants[$constantReflection->getName()])) {
-			return [sprintf(
-				$this->deprecatedConstants[$constantReflection->getName()],
-				$constantReflection->getName()
-			)];
+			return [
+				RuleErrorBuilder::message(sprintf(
+					$this->deprecatedConstants[$constantReflection->getName()],
+					$constantReflection->getName()
+				))->identifier('constant.deprecated')->build(),
+			];
 		}
 
 		return [];