Format errors to comply with PHPStan pattern

Author: paxal

src/Rules/Deprecations/TypeHintDeprecatedInClassMethodSignatureRule.php

@@ -6,6 +6,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Broker\Broker;
 use PHPStan\Node\InClassMethodNode;
+use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\ParameterReflection;
 use PHPStan\Reflection\ParametersAcceptorSelector;
@@ -40,31 +41,68 @@ public function processNode(Node $node, Scope $scope): array
 		}
 		$methodSignature = ParametersAcceptorSelector::selectSingle($method->getVariants());
 
-		$errorLists = [];
+		$errors = [];
 		foreach ($methodSignature->getParameters() as $i => $parameter) {
 			/** @var ParameterReflection $parameter */
-			$errorLists[] = $this->checkClasses(
-				$parameter->getType()->getReferencedClasses(),
-				'argument #' . $i
+			$deprecatedClasses = $this->filterDeprecatedClasses($parameter->getType()->getReferencedClasses());
+			foreach ($deprecatedClasses as $deprecatedClass) {
+				$errors[] = sprintf(
+					'Parameter $%s of method %s::%s() has typehint with deprecated %s %s%s',
+					$parameter->getName(),
+					$method->getDeclaringClass()->getName(),
+					$method->getName(),
+					$this->getClassType($deprecatedClass),
+					$deprecatedClass->getName(),
+					$this->getClassDeprecationDescription($deprecatedClass)
+				);
+			}
+		}
+
+		$deprecatedClasses = $this->filterDeprecatedClasses($methodSignature->getReturnType()->getReferencedClasses());
+		foreach ($deprecatedClasses as $deprecatedClass) {
+			$errors[] = sprintf(
+				'Return type of method %s::%s() has typehint with deprecated %s %s%s',
+				$method->getDeclaringClass()->getName(),
+				$method->getName(),
+				$this->getClassType($deprecatedClass),
+				$deprecatedClass->getName(),
+				$this->getClassDeprecationDescription($deprecatedClass)
 			);
 		}
 
-		$errorLists[] = $this->checkClasses(
-			$methodSignature->getReturnType()->getReferencedClasses(),
-			'return type'
-		);
+		return $errors;
+	}
+
+	private function getClassType(ClassReflection $class): string
+	{
+		if ($class->isInterface()) {
+			return 'interface';
+		}
 
-		return array_merge(...$errorLists);
+		return 'class';
+	}
+
+	private function getClassDeprecationDescription(ClassReflection $class): string
+	{
+		$description = null;
+		if (method_exists($class, 'getDeprecatedDescription')) {
+			$description = $class->getDeprecatedDescription();
+		}
+
+		if ($description === null) {
+			return '.';
+		}
+
+		return sprintf(":\n%s", $description);
 	}
 
 	/**
 	 * @param string[] $referencedClasses
-	 * @param string $where
-	 * @return string[]
+	 * @return ClassReflection[]
 	 */
-	private function checkClasses(array $referencedClasses, string $where): array
+	private function filterDeprecatedClasses(array $referencedClasses): array
 	{
-		$errors = [];
+		$deprecatedClasses = [];
 		foreach ($referencedClasses as $referencedClass) {
 			try {
 				$class = $this->broker->getClass($referencedClass);
@@ -76,28 +114,10 @@ private function checkClasses(array $referencedClasses, string $where): array
 				continue;
 			}
 
-			$classDescription = null;
-			if (method_exists($class, 'getDeprecatedDescription')) {
-				$classDescription = $class->getDeprecatedDescription();
-			}
-
-			if ($classDescription === null) {
-				$errors[] = sprintf(
-					'Usage of deprecated class %s in %s.',
-					$referencedClass,
-					$where
-				);
-			} else {
-				$errors[] = sprintf(
-					"Usage of deprecated class %s in %s:\n%s",
-					$referencedClass,
-					$where,
-					$classDescription
-				);
-			}
+			$deprecatedClasses[] = $class;
 		}
 
-		return $errors;
+		return $deprecatedClasses;
 	}
 
 }

tests/Rules/Deprecations/TypeHintDeprecatedInClassMethodSignatureRuleTest.php

@@ -18,10 +18,11 @@ public function test(): void
 		$this->analyse(
 			[__DIR__ . '/data/typehint-deprecated-class.php'],
 			[
-				['Usage of deprecated class TypeHintDeprecatedInFunctionSignature\DeprecatedProperty in argument #0.', 13],
-				['Usage of deprecated class TypeHintDeprecatedInFunctionSignature\DeprecatedProperty in argument #1.', 13],
-				['Usage of deprecated class TypeHintDeprecatedInFunctionSignature\DeprecatedProperty in argument #5.', 13],
-				['Usage of deprecated class TypeHintDeprecatedInFunctionSignature\DeprecatedProperty in return type.', 13],
+				['Parameter $property of method TypeHintDeprecatedInFunctionSignature\Foo::setProperties() has typehint with deprecated class TypeHintDeprecatedInFunctionSignature\DeprecatedProperty.', 13],
+				['Parameter $property2 of method TypeHintDeprecatedInFunctionSignature\Foo::setProperties() has typehint with deprecated interface TypeHintDeprecatedInFunctionSignature\DeprecatedInterface.', 13],
+				["Parameter \$property4 of method TypeHintDeprecatedInFunctionSignature\Foo::setProperties() has typehint with deprecated class TypeHintDeprecatedInFunctionSignature\VerboseDeprecatedProperty:\nI'll be back", 13],
+				['Parameter $property6 of method TypeHintDeprecatedInFunctionSignature\Foo::setProperties() has typehint with deprecated class TypeHintDeprecatedInFunctionSignature\DeprecatedProperty.', 13],
+				['Return type of method TypeHintDeprecatedInFunctionSignature\Foo::setProperties() has typehint with deprecated class TypeHintDeprecatedInFunctionSignature\DeprecatedProperty.', 13],
 			]
 		);
 	}

tests/Rules/Deprecations/data/typehint-deprecated-class-definition.php

@@ -10,6 +10,22 @@ class DeprecatedProperty
 
 }
 
+/**
+ * @deprecated I'll be back
+ */
+class VerboseDeprecatedProperty
+{
+
+}
+
+/**
+ * @deprecated
+ */
+interface DeprecatedInterface
+{
+
+}
+
 class Property
 {
 

tests/Rules/Deprecations/data/typehint-deprecated-class.php

@@ -12,9 +12,9 @@ class Foo
      */
     public function setProperties(
         DeprecatedProperty $property,
-        ?DeprecatedProperty $property2,
+        ?DeprecatedInterface $property2,
         $property3,
-        Property $property4,
+        VerboseDeprecatedProperty $property4,
         string $property5,
         $property6
     ): DeprecatedProperty {