Bleeding edge - OverridingMethodRule - include template types in prot…

…otype declaring class
phpstan · Apr 4, 2023 · ca2c66c · ca2c66c
1 parent 5ff0a2e
commit ca2c66c
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 33 deletions.
diff --git a/conf/bleedingEdge.neon b/conf/bleedingEdge.neon
@@ -35,3 +35,4 @@ parameters:
 		allInvalidPhpDocs: true
 		strictStaticMethodTemplateTypeVariance: true
 		propertyVariance: true
+		genericPrototypeMessage: true
diff --git a/conf/config.level0.neon b/conf/config.level0.neon
@@ -145,6 +145,7 @@ services:
 		class: PHPStan\Rules\Methods\OverridingMethodRule
 		arguments:
 			checkPhpDocMethodSignatures: %checkPhpDocMethodSignatures%
+			genericPrototypeMessage: %featureToggles.genericPrototypeMessage%
 		tags:
 			- phpstan.rules.rule
 

diff --git a/conf/config.neon b/conf/config.neon
@@ -65,6 +65,7 @@ parameters:
 		allInvalidPhpDocs: false
 		strictStaticMethodTemplateTypeVariance: false
 		propertyVariance: false
+		genericPrototypeMessage: false
 	fileExtensions:
 		- php
 	checkAdvancedIsset: false
@@ -300,6 +301,7 @@ parametersSchema:
 		allInvalidPhpDocs: bool()
 		strictStaticMethodTemplateTypeVariance: bool()
 		propertyVariance: bool()
+		genericPrototypeMessage: bool()
 	])
 	fileExtensions: listOf(string())
 	checkAdvancedIsset: bool()
@@ -1085,6 +1087,8 @@ services:
 
 	-
 		class: PHPStan\Rules\Methods\MethodParameterComparisonHelper
+		arguments:
+			genericPrototypeMessage: %featureToggles.genericPrototypeMessage%
 
 	-
 		class: PHPStan\Rules\MissingTypehintCheck

diff --git a/src/PhpDoc/StubValidator.php b/src/PhpDoc/StubValidator.php
@@ -157,7 +157,7 @@ private function getRuleRegistry(Container $container): RuleRegistry
 			new ExistingClassesInTypehintsRule($functionDefinitionCheck),
 			new \PHPStan\Rules\Functions\ExistingClassesInTypehintsRule($functionDefinitionCheck),
 			new ExistingClassesInPropertiesRule($reflectionProvider, $classCaseSensitivityCheck, $unresolvableTypeHelper, $phpVersion, true, false),
-			new OverridingMethodRule($phpVersion, new MethodSignatureRule(true, true), true, new MethodParameterComparisonHelper($phpVersion)),
+			new OverridingMethodRule($phpVersion, new MethodSignatureRule(true, true), true, new MethodParameterComparisonHelper($phpVersion, $container->getParameter('featureToggles')['genericPrototypeMessage']), $container->getParameter('featureToggles')['genericPrototypeMessage']),
 			new DuplicateDeclarationRule(),
 
 			// level 2

diff --git a/src/Rules/Methods/MethodParameterComparisonHelper.php b/src/Rules/Methods/MethodParameterComparisonHelper.php
@@ -24,7 +24,7 @@
 class MethodParameterComparisonHelper
 {
 
-	public function __construct(private PhpVersion $phpVersion)
+	public function __construct(private PhpVersion $phpVersion, private bool $genericPrototypeMessage)
 	{
 	}
 
@@ -47,7 +47,7 @@ public function compare(MethodPrototypeReflection $prototype, PhpMethodFromParse
 					'Method %s::%s() overrides method %s::%s() but misses parameter #%d $%s.',
 					$method->getDeclaringClass()->getDisplayName(),
 					$method->getName(),
-					$prototype->getDeclaringClass()->getDisplayName(false),
+					$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 					$prototype->getName(),
 					$i + 1,
 					$prototypeParameter->getName(),
@@ -73,7 +73,7 @@ public function compare(MethodPrototypeReflection $prototype, PhpMethodFromParse
 						$method->getName(),
 						$i + 1,
 						$prototypeParameter->getName(),
-						$prototype->getDeclaringClass()->getDisplayName(false),
+						$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 						$prototype->getName(),
 					));
 
@@ -92,7 +92,7 @@ public function compare(MethodPrototypeReflection $prototype, PhpMethodFromParse
 					$method->getName(),
 					$i + 1,
 					$prototypeParameter->getName(),
-					$prototype->getDeclaringClass()->getDisplayName(false),
+					$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 					$prototype->getName(),
 				));
 
@@ -133,7 +133,7 @@ public function compare(MethodPrototypeReflection $prototype, PhpMethodFromParse
 							$method->getName(),
 							$i + 1,
 							$prototypeParameter->getName(),
-							$prototype->getDeclaringClass()->getDisplayName(false),
+							$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 							$prototype->getName(),
 						));
 
@@ -181,7 +181,7 @@ public function compare(MethodPrototypeReflection $prototype, PhpMethodFromParse
 							$i + $j + 1,
 							$remainingPrototypeParameter->getName(),
 							$remainingPrototypeParameter->getNativeType()->describe(VerbosityLevel::typeOnly()),
-							$prototype->getDeclaringClass()->getDisplayName(false),
+							$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 							$prototype->getName(),
 						));
 
@@ -201,7 +201,7 @@ public function compare(MethodPrototypeReflection $prototype, PhpMethodFromParse
 					$method->getName(),
 					$i + 1,
 					$prototypeParameter->getName(),
-					$prototype->getDeclaringClass()->getDisplayName(false),
+					$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 					$prototype->getName(),
 				));
 
@@ -223,7 +223,7 @@ public function compare(MethodPrototypeReflection $prototype, PhpMethodFromParse
 					$method->getName(),
 					$i + 1,
 					$prototypeParameter->getName(),
-					$prototype->getDeclaringClass()->getDisplayName(false),
+					$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 					$prototype->getName(),
 				));
 
@@ -253,7 +253,7 @@ public function compare(MethodPrototypeReflection $prototype, PhpMethodFromParse
 						$i + 1,
 						$prototypeParameter->getName(),
 						$prototypeParameterType->describe(VerbosityLevel::typeOnly()),
-						$prototype->getDeclaringClass()->getDisplayName(false),
+						$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 						$prototype->getName(),
 					));
 
@@ -281,7 +281,7 @@ public function compare(MethodPrototypeReflection $prototype, PhpMethodFromParse
 					$i + 1,
 					$prototypeParameter->getName(),
 					$prototypeParameterType->describe(VerbosityLevel::typeOnly()),
-					$prototype->getDeclaringClass()->getDisplayName(false),
+					$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 					$prototype->getName(),
 				));
 
@@ -301,7 +301,7 @@ public function compare(MethodPrototypeReflection $prototype, PhpMethodFromParse
 					$i + 1,
 					$prototypeParameter->getName(),
 					$prototypeParameterType->describe(VerbosityLevel::typeOnly()),
-					$prototype->getDeclaringClass()->getDisplayName(false),
+					$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 					$prototype->getName(),
 				));
 

diff --git a/src/Rules/Methods/OverridingMethodRule.php b/src/Rules/Methods/OverridingMethodRule.php
@@ -29,6 +29,7 @@ public function __construct(
 		private MethodSignatureRule $methodSignatureRule,
 		private bool $checkPhpDocMethodSignatures,
 		private MethodParameterComparisonHelper $methodParameterComparisonHelper,
+		private bool $genericPrototypeMessage,
 	)
 	{
 	}
@@ -53,7 +54,7 @@ public function processNode(Node $node, Scope $scope): array
 								'Method %s::%s() overrides final method %s::%s().',
 								$method->getDeclaringClass()->getDisplayName(),
 								$method->getName(),
-								$parent->getDisplayName(false),
+								$parent->getDisplayName($this->genericPrototypeMessage),
 								$parentConstructor->getName(),
 							))->nonIgnorable()->build(),
 						], $node, $scope);
@@ -74,7 +75,7 @@ public function processNode(Node $node, Scope $scope): array
 				'Method %s::%s() overrides final method %s::%s().',
 				$method->getDeclaringClass()->getDisplayName(),
 				$method->getName(),
-				$prototype->getDeclaringClass()->getDisplayName(false),
+				$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 				$prototype->getName(),
 			))->nonIgnorable()->build();
 		}
@@ -85,7 +86,7 @@ public function processNode(Node $node, Scope $scope): array
 					'Non-static method %s::%s() overrides static method %s::%s().',
 					$method->getDeclaringClass()->getDisplayName(),
 					$method->getName(),
-					$prototype->getDeclaringClass()->getDisplayName(false),
+					$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 					$prototype->getName(),
 				))->nonIgnorable()->build();
 			}
@@ -94,7 +95,7 @@ public function processNode(Node $node, Scope $scope): array
 				'Static method %s::%s() overrides non-static method %s::%s().',
 				$method->getDeclaringClass()->getDisplayName(),
 				$method->getName(),
-				$prototype->getDeclaringClass()->getDisplayName(false),
+				$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 				$prototype->getName(),
 			))->nonIgnorable()->build();
 		}
@@ -106,7 +107,7 @@ public function processNode(Node $node, Scope $scope): array
 					$method->isPrivate() ? 'Private' : 'Protected',
 					$method->getDeclaringClass()->getDisplayName(),
 					$method->getName(),
-					$prototype->getDeclaringClass()->getDisplayName(false),
+					$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 					$prototype->getName(),
 				))->nonIgnorable()->build();
 			}
@@ -115,7 +116,7 @@ public function processNode(Node $node, Scope $scope): array
 				'Private method %s::%s() overriding protected method %s::%s() should be protected or public.',
 				$method->getDeclaringClass()->getDisplayName(),
 				$method->getName(),
-				$prototype->getDeclaringClass()->getDisplayName(false),
+				$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 				$prototype->getName(),
 			))->nonIgnorable()->build();
 		}
@@ -143,7 +144,7 @@ public function processNode(Node $node, Scope $scope): array
 					$method->getDeclaringClass()->getDisplayName(),
 					$method->getName(),
 					$prototype->getTentativeReturnType()->describe(VerbosityLevel::typeOnly()),
-					$prototype->getDeclaringClass()->getDisplayName(false),
+					$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 					$prototype->getName(),
 				))->tip('Make it covariant, or use the #[\ReturnTypeWillChange] attribute to temporarily suppress the error.')->nonIgnorable()->build();
 			}
@@ -165,7 +166,7 @@ public function processNode(Node $node, Scope $scope): array
 					$method->getDeclaringClass()->getDisplayName(),
 					$method->getName(),
 					$prototypeReturnType->describe(VerbosityLevel::typeOnly()),
-					$prototype->getDeclaringClass()->getDisplayName(false),
+					$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 					$prototype->getName(),
 				))->nonIgnorable()->build();
 			} else {
@@ -175,7 +176,7 @@ public function processNode(Node $node, Scope $scope): array
 					$method->getDeclaringClass()->getDisplayName(),
 					$method->getName(),
 					$prototypeReturnType->describe(VerbosityLevel::typeOnly()),
-					$prototype->getDeclaringClass()->getDisplayName(false),
+					$prototype->getDeclaringClass()->getDisplayName($this->genericPrototypeMessage),
 					$prototype->getName(),
 				))->nonIgnorable()->build();
 			}

diff --git a/tests/PHPStan/Rules/Methods/MethodSignatureRuleTest.php b/tests/PHPStan/Rules/Methods/MethodSignatureRuleTest.php
@@ -25,7 +25,8 @@ protected function getRule(): Rule
 			$phpVersion,
 			new MethodSignatureRule($this->reportMaybes, $this->reportStatic),
 			true,
-			new MethodParameterComparisonHelper($phpVersion),
+			new MethodParameterComparisonHelper($phpVersion, true),
+			true,
 		);
 	}
 
@@ -384,7 +385,7 @@ public function testBug7652(): void
 		$this->reportStatic = true;
 		$this->analyse([__DIR__ . '/data/bug-7652.php'], [
 			[
-				'Return type mixed of method Bug7652\Options::offsetGet() is not covariant with tentative return type mixed of method ArrayAccess::offsetGet().',
+				'Return type mixed of method Bug7652\Options::offsetGet() is not covariant with tentative return type mixed of method ArrayAccess<key-of<TArray of array>,value-of<TArray of array>>::offsetGet().',
 				23,
 				'Make it covariant, or use the #[\ReturnTypeWillChange] attribute to temporarily suppress the error.',
 			],

diff --git a/tests/PHPStan/Rules/Methods/OverridingMethodRuleTest.php b/tests/PHPStan/Rules/Methods/OverridingMethodRuleTest.php
@@ -25,7 +25,8 @@ protected function getRule(): Rule
 			$phpVersion,
 			new MethodSignatureRule(true, true),
 			false,
-			new MethodParameterComparisonHelper($phpVersion),
+			new MethodParameterComparisonHelper($phpVersion, true),
+			true,
 		);
 	}
 
@@ -84,7 +85,7 @@ public function testOverridingFinalMethod(int $phpVersion, string $contravariant
 				115,
 			],
 			[
-				'Parameter #1 $size (int) of method OverridingFinalMethod\FixedArray::setSize() is not ' . $contravariantMessage . ' with parameter #1 $size (mixed) of method SplFixedArray::setSize().',
+				'Parameter #1 $size (int) of method OverridingFinalMethod\FixedArray::setSize() is not ' . $contravariantMessage . ' with parameter #1 $size (mixed) of method SplFixedArray<mixed>::setSize().',
 				125,
 			],
 			[
@@ -120,7 +121,7 @@ public function testOverridingFinalMethod(int $phpVersion, string $contravariant
 				280,
 			],
 			[
-				'Parameter #1 $index (int) of method OverridingFinalMethod\FixedArrayOffsetExists::offsetExists() is not ' . $contravariantMessage . ' with parameter #1 $offset (mixed) of method ArrayAccess::offsetExists().',
+				'Parameter #1 $index (int) of method OverridingFinalMethod\FixedArrayOffsetExists::offsetExists() is not ' . $contravariantMessage . ' with parameter #1 $offset (mixed) of method ArrayAccess<int,mixed>::offsetExists().',
 				313,
 			],
 		];
@@ -472,37 +473,37 @@ public function dataTentativeReturnTypes(): array
 				80100,
 				[
 					[
-						'Return type mixed of method TentativeReturnTypes\Foo::getIterator() is not covariant with tentative return type Traversable of method IteratorAggregate::getIterator().',
+						'Return type mixed of method TentativeReturnTypes\Foo::getIterator() is not covariant with tentative return type Traversable of method IteratorAggregate<mixed,mixed>::getIterator().',
 						8,
 						'Make it covariant, or use the #[\ReturnTypeWillChange] attribute to temporarily suppress the error.',
 					],
 					[
-						'Return type string of method TentativeReturnTypes\Lorem::getIterator() is not covariant with tentative return type Traversable of method IteratorAggregate::getIterator().',
+						'Return type string of method TentativeReturnTypes\Lorem::getIterator() is not covariant with tentative return type Traversable of method IteratorAggregate<mixed,mixed>::getIterator().',
 						40,
 						'Make it covariant, or use the #[\ReturnTypeWillChange] attribute to temporarily suppress the error.',
 					],
 					[
-						'Return type mixed of method TentativeReturnTypes\UntypedIterator::current() is not covariant with tentative return type mixed of method Iterator::current().',
+						'Return type mixed of method TentativeReturnTypes\UntypedIterator::current() is not covariant with tentative return type mixed of method Iterator<mixed,mixed>::current().',
 						75,
 						'Make it covariant, or use the #[\ReturnTypeWillChange] attribute to temporarily suppress the error.',
 					],
 					[
-						'Return type mixed of method TentativeReturnTypes\UntypedIterator::next() is not covariant with tentative return type void of method Iterator::next().',
+						'Return type mixed of method TentativeReturnTypes\UntypedIterator::next() is not covariant with tentative return type void of method Iterator<mixed,mixed>::next().',
 						79,
 						'Make it covariant, or use the #[\ReturnTypeWillChange] attribute to temporarily suppress the error.',
 					],
 					[
-						'Return type mixed of method TentativeReturnTypes\UntypedIterator::key() is not covariant with tentative return type mixed of method Iterator::key().',
+						'Return type mixed of method TentativeReturnTypes\UntypedIterator::key() is not covariant with tentative return type mixed of method Iterator<mixed,mixed>::key().',
 						83,
 						'Make it covariant, or use the #[\ReturnTypeWillChange] attribute to temporarily suppress the error.',
 					],
 					[
-						'Return type mixed of method TentativeReturnTypes\UntypedIterator::valid() is not covariant with tentative return type bool of method Iterator::valid().',
+						'Return type mixed of method TentativeReturnTypes\UntypedIterator::valid() is not covariant with tentative return type bool of method Iterator<mixed,mixed>::valid().',
 						87,
 						'Make it covariant, or use the #[\ReturnTypeWillChange] attribute to temporarily suppress the error.',
 					],
 					[
-						'Return type mixed of method TentativeReturnTypes\UntypedIterator::rewind() is not covariant with tentative return type void of method Iterator::rewind().',
+						'Return type mixed of method TentativeReturnTypes\UntypedIterator::rewind() is not covariant with tentative return type void of method Iterator<mixed,mixed>::rewind().',
 						91,
 						'Make it covariant, or use the #[\ReturnTypeWillChange] attribute to temporarily suppress the error.',
 					],