Bleeding edge - validate overriding methods in stubs

phpstan · Jul 5, 2021 · c98d0a4 · c98d0a4
1 parent 3c3ea2f
commit c98d0a4
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 4 deletions.
diff --git a/conf/bleedingEdge.neon b/conf/bleedingEdge.neon
@@ -21,5 +21,6 @@ parameters:
 		apiRules: true
 		deepInspectTypes: true
 		neverInGenericReturnType: true
+		validateOverridingMethodsInStubs: true
 	stubFiles:
 		- ../stubs/arrayFunctions.stub
diff --git a/conf/config.neon b/conf/config.neon
@@ -44,6 +44,7 @@ parameters:
 		apiRules: false
 		deepInspectTypes: false
 		neverInGenericReturnType: false
+		validateOverridingMethodsInStubs: false
 	fileExtensions:
 		- php
 	checkAlwaysTrueCheckTypeFunctionCall: false
@@ -215,7 +216,8 @@ parametersSchema:
 		preciseExceptionTracking: bool(),
 		apiRules: bool(),
 		deepInspectTypes: bool(),
-		neverInGenericReturnType: bool()
+		neverInGenericReturnType: bool(),
+		validateOverridingMethodsInStubs: bool()
 	])
 	fileExtensions: listOf(string())
 	checkAlwaysTrueCheckTypeFunctionCall: bool()
@@ -418,6 +420,8 @@ services:
 
 	-
 		class: PHPStan\PhpDoc\StubValidator
+		arguments:
+			validateOverridingMethods: %featureToggles.validateOverridingMethodsInStubs%
 
 	-
 		class: PHPStan\Analyser\Analyser

diff --git a/src/PhpDoc/StubValidator.php b/src/PhpDoc/StubValidator.php
@@ -8,6 +8,7 @@
 use PHPStan\Broker\Broker;
 use PHPStan\DependencyInjection\Container;
 use PHPStan\DependencyInjection\DerivativeContainerFactory;
+use PHPStan\Php\PhpVersion;
 use PHPStan\PhpDocParser\Lexer\Lexer;
 use PHPStan\PhpDocParser\Parser\PhpDocParser;
 use PHPStan\Reflection\ReflectionProvider;
@@ -33,8 +34,10 @@
 use PHPStan\Rules\Generics\TraitTemplateTypeRule;
 use PHPStan\Rules\Generics\VarianceCheck;
 use PHPStan\Rules\Methods\ExistingClassesInTypehintsRule;
+use PHPStan\Rules\Methods\MethodSignatureRule;
 use PHPStan\Rules\Methods\MissingMethodParameterTypehintRule;
 use PHPStan\Rules\Methods\MissingMethodReturnTypehintRule;
+use PHPStan\Rules\Methods\OverridingMethodRule;
 use PHPStan\Rules\MissingTypehintCheck;
 use PHPStan\Rules\PhpDoc\IncompatiblePhpDocTypeRule;
 use PHPStan\Rules\PhpDoc\IncompatiblePropertyPhpDocTypeRule;
@@ -52,11 +55,15 @@ class StubValidator
 
 	private \PHPStan\DependencyInjection\DerivativeContainerFactory $derivativeContainerFactory;
 
+	private bool $validateOverridingMethods;
+
 	public function __construct(
-		DerivativeContainerFactory $derivativeContainerFactory
+		DerivativeContainerFactory $derivativeContainerFactory,
+		bool $validateOverridingMethods
 	)
 	{
 		$this->derivativeContainerFactory = $derivativeContainerFactory;
+		$this->validateOverridingMethods = $validateOverridingMethods;
 	}
 
 	/**
@@ -127,7 +134,7 @@ private function getRuleRegistry(Container $container): Registry
 		$missingTypehintCheck = $container->getByType(MissingTypehintCheck::class);
 		$unresolvableTypeHelper = $container->getByType(UnresolvableTypeHelper::class);
 
-		return new Registry([
+		$rules = [
 			// level 0
 			new ExistingClassesInClassImplementsRule($classCaseSensitivityCheck, $reflectionProvider),
 			new ExistingClassesInInterfaceExtendsRule($classCaseSensitivityCheck, $reflectionProvider),
@@ -165,7 +172,17 @@ private function getRuleRegistry(Container $container): Registry
 			new MissingMethodParameterTypehintRule($missingTypehintCheck),
 			new MissingMethodReturnTypehintRule($missingTypehintCheck),
 			new MissingPropertyTypehintRule($missingTypehintCheck),
-		]);
+		];
+
+		if ($this->validateOverridingMethods) {
+			$rules[] = new OverridingMethodRule(
+				$container->getByType(PhpVersion::class),
+				new MethodSignatureRule(true, true),
+				true
+			);
+		}
+
+		return new Registry($rules);
 	}
 
 }