Rework prototype searching in OverridingMethodRule

phpstan · Nov 8, 2023 · 4b2ffb8 · 4b2ffb8
1 parent cb9571b
commit 4b2ffb8
Show file tree

Hide file tree

Showing 20 changed files with 225 additions and 75 deletions.
diff --git a/src/Reflection/Annotations/AnnotationMethodReflection.php b/src/Reflection/Annotations/AnnotationMethodReflection.php
@@ -96,6 +96,11 @@ public function isFinal(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isFinalByKeyword(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isInternal(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();

diff --git a/src/Reflection/Dummy/ChangedTypeMethodReflection.php b/src/Reflection/Dummy/ChangedTypeMethodReflection.php
@@ -75,6 +75,11 @@ public function isFinal(): TrinaryLogic
 		return $this->reflection->isFinal();
 	}
 
+	public function isFinalByKeyword(): TrinaryLogic
+	{
+		return $this->reflection->isFinalByKeyword();
+	}
+
 	public function isInternal(): TrinaryLogic
 	{
 		return $this->reflection->isInternal();

diff --git a/src/Reflection/Dummy/DummyConstructorReflection.php b/src/Reflection/Dummy/DummyConstructorReflection.php
@@ -2,16 +2,18 @@
 
 namespace PHPStan\Reflection\Dummy;
 
+use PHPStan\Reflection\Assertions;
 use PHPStan\Reflection\ClassMemberReflection;
 use PHPStan\Reflection\ClassReflection;
-use PHPStan\Reflection\FunctionVariant;
-use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\ExtendedMethodReflection;
+use PHPStan\Reflection\FunctionVariantWithPhpDocs;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Generic\TemplateTypeMap;
+use PHPStan\Type\MixedType;
 use PHPStan\Type\Type;
 use PHPStan\Type\VoidType;
 
-class DummyConstructorReflection implements MethodReflection
+class DummyConstructorReflection implements ExtendedMethodReflection
 {
 
 	public function __construct(private ClassReflection $declaringClass)
@@ -51,12 +53,15 @@ public function getPrototype(): ClassMemberReflection
 	public function getVariants(): array
 	{
 		return [
-			new FunctionVariant(
+			new FunctionVariantWithPhpDocs(
 				TemplateTypeMap::createEmpty(),
 				null,
 				[],
 				false,
 				new VoidType(),
+				new MixedType(),
+				new MixedType(),
+				null,
 			),
 		];
 	}
@@ -96,4 +101,24 @@ public function getDocComment(): ?string
 		return null;
 	}
 
+	public function getAsserts(): Assertions
+	{
+		return Assertions::createEmpty();
+	}
+
+	public function getSelfOutType(): ?Type
+	{
+		return null;
+	}
+
+	public function returnsByReference(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
+	public function isFinalByKeyword(): TrinaryLogic
+	{
+		return TrinaryLogic::createMaybe();
+	}
+
 }
diff --git a/src/Reflection/Dummy/DummyMethodReflection.php b/src/Reflection/Dummy/DummyMethodReflection.php
@@ -73,6 +73,11 @@ public function isFinal(): TrinaryLogic
 		return TrinaryLogic::createMaybe();
 	}
 
+	public function isFinalByKeyword(): TrinaryLogic
+	{
+		return TrinaryLogic::createMaybe();
+	}
+
 	public function isInternal(): TrinaryLogic
 	{
 		return TrinaryLogic::createMaybe();

diff --git a/src/Reflection/ExtendedMethodReflection.php b/src/Reflection/ExtendedMethodReflection.php
@@ -33,4 +33,6 @@ public function getSelfOutType(): ?Type;
 
 	public function returnsByReference(): TrinaryLogic;
 
+	public function isFinalByKeyword(): TrinaryLogic;
+
 }
diff --git a/src/Reflection/Native/NativeMethodReflection.php b/src/Reflection/Native/NativeMethodReflection.php
@@ -121,6 +121,11 @@ public function isFinal(): TrinaryLogic
 		return TrinaryLogic::createFromBoolean($this->reflection->isFinal());
 	}
 
+	public function isFinalByKeyword(): TrinaryLogic
+	{
+		return $this->isFinal();
+	}
+
 	public function getThrowType(): ?Type
 	{
 		return $this->throwType;

diff --git a/src/Reflection/Php/ClosureCallMethodReflection.php b/src/Reflection/Php/ClosureCallMethodReflection.php
@@ -117,6 +117,11 @@ public function isFinal(): TrinaryLogic
 		return $this->nativeMethodReflection->isFinal();
 	}
 
+	public function isFinalByKeyword(): TrinaryLogic
+	{
+		return $this->nativeMethodReflection->isFinalByKeyword();
+	}
+
 	public function isInternal(): TrinaryLogic
 	{
 		return $this->nativeMethodReflection->isInternal();

diff --git a/src/Reflection/Php/EnumCasesMethodReflection.php b/src/Reflection/Php/EnumCasesMethodReflection.php
@@ -90,6 +90,11 @@ public function isFinal(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isFinalByKeyword(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function isInternal(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();

diff --git a/src/Reflection/Php/PhpFunctionFromParserNodeReflection.php b/src/Reflection/Php/PhpFunctionFromParserNodeReflection.php
@@ -189,6 +189,15 @@ public function isFinal(): TrinaryLogic
 		return TrinaryLogic::createFromBoolean($finalMethod || $this->isFinal);
 	}
 
+	public function isFinalByKeyword(): TrinaryLogic
+	{
+		$finalMethod = false;
+		if ($this->functionLike instanceof ClassMethod) {
+			$finalMethod = $this->functionLike->isFinal();
+		}
+		return TrinaryLogic::createFromBoolean($finalMethod);
+	}
+
 	public function getThrowType(): ?Type
 	{
 		return $this->throwType;

diff --git a/src/Reflection/Php/PhpMethodReflection.php b/src/Reflection/Php/PhpMethodReflection.php
@@ -397,6 +397,11 @@ public function isFinal(): TrinaryLogic
 		return TrinaryLogic::createFromBoolean($this->isFinal || $this->reflection->isFinal());
 	}
 
+	public function isFinalByKeyword(): TrinaryLogic
+	{
+		return TrinaryLogic::createFromBoolean($this->reflection->isFinal());
+	}
+
 	public function isAbstract(): bool
 	{
 		return $this->reflection->isAbstract();

diff --git a/src/Reflection/ResolvedMethodReflection.php b/src/Reflection/ResolvedMethodReflection.php
@@ -109,6 +109,11 @@ public function isFinal(): TrinaryLogic
 		return $this->reflection->isFinal();
 	}
 
+	public function isFinalByKeyword(): TrinaryLogic
+	{
+		return $this->reflection->isFinalByKeyword();
+	}
+
 	public function isInternal(): TrinaryLogic
 	{
 		return $this->reflection->isInternal();

diff --git a/src/Reflection/Type/IntersectionTypeMethodReflection.php b/src/Reflection/Type/IntersectionTypeMethodReflection.php
@@ -125,6 +125,11 @@ public function isFinal(): TrinaryLogic
 		return TrinaryLogic::lazyMaxMin($this->methods, static fn (MethodReflection $method): TrinaryLogic => $method->isFinal());
 	}
 
+	public function isFinalByKeyword(): TrinaryLogic
+	{
+		return TrinaryLogic::lazyMaxMin($this->methods, static fn (ExtendedMethodReflection $method): TrinaryLogic => $method->isFinalByKeyword());
+	}
+
 	public function isInternal(): TrinaryLogic
 	{
 		return TrinaryLogic::lazyMaxMin($this->methods, static fn (MethodReflection $method): TrinaryLogic => $method->isInternal());

diff --git a/src/Reflection/Type/UnionTypeMethodReflection.php b/src/Reflection/Type/UnionTypeMethodReflection.php
@@ -113,6 +113,11 @@ public function isFinal(): TrinaryLogic
 		return TrinaryLogic::lazyExtremeIdentity($this->methods, static fn (MethodReflection $method): TrinaryLogic => $method->isFinal());
 	}
 
+	public function isFinalByKeyword(): TrinaryLogic
+	{
+		return TrinaryLogic::lazyExtremeIdentity($this->methods, static fn (ExtendedMethodReflection $method): TrinaryLogic => $method->isFinalByKeyword());
+	}
+
 	public function isInternal(): TrinaryLogic
 	{
 		return TrinaryLogic::lazyExtremeIdentity($this->methods, static fn (MethodReflection $method): TrinaryLogic => $method->isInternal());

diff --git a/src/Reflection/WrappedExtendedMethodReflection.php b/src/Reflection/WrappedExtendedMethodReflection.php
@@ -100,6 +100,11 @@ public function isFinal(): TrinaryLogic
 		return $this->method->isFinal();
 	}
 
+	public function isFinalByKeyword(): TrinaryLogic
+	{
+		return $this->isFinal();
+	}
+
 	public function isInternal(): TrinaryLogic
 	{
 		return $this->method->isInternal();

diff --git a/src/Rules/Methods/ConsistentConstructorRule.php b/src/Rules/Methods/ConsistentConstructorRule.php
@@ -5,10 +5,7 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\InClassMethodNode;
-use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\Dummy\DummyConstructorReflection;
-use PHPStan\Reflection\MethodPrototypeReflection;
-use PHPStan\Reflection\Php\PhpMethodReflection;
 use PHPStan\Rules\Rule;
 use function strtolower;
 
@@ -43,54 +40,14 @@ public function processNode(Node $node, Scope $scope): array
 		if ($parent->hasConstructor()) {
 			$parentConstructor = $parent->getConstructor();
 		} else {
-			$parentConstructor = $this->getEmptyConstructor($parent);
-		}
-
-		if (! $parentConstructor instanceof PhpMethodReflection && ! $parentConstructor instanceof MethodPrototypeReflection) {
-			return [];
+			$parentConstructor = new DummyConstructorReflection($parent);
 		}
 
 		if (! $parentConstructor->getDeclaringClass()->hasConsistentConstructor()) {
 			return [];
 		}
 
-		if (! $parentConstructor instanceof MethodPrototypeReflection) {
-			$parentConstructor = $this->getMethodPrototypeReflection($parentConstructor, $parent);
-		}
-
 		return $this->methodParameterComparisonHelper->compare($parentConstructor, $method, true);
 	}
 
-	private function getMethodPrototypeReflection(PhpMethodReflection $methodReflection, ClassReflection $classReflection): MethodPrototypeReflection
-	{
-		return new MethodPrototypeReflection(
-			$methodReflection->getName(),
-			$classReflection,
-			$methodReflection->isStatic(),
-			$methodReflection->isPrivate(),
-			$methodReflection->isPublic(),
-			$methodReflection->isAbstract(),
-			$methodReflection->isFinal()->yes(),
-			$classReflection->getNativeMethod($methodReflection->getName())->getVariants(),
-			null,
-		);
-	}
-
-	private function getEmptyConstructor(ClassReflection $classReflection): MethodPrototypeReflection
-	{
-		$emptyConstructor = new DummyConstructorReflection($classReflection);
-
-		return new MethodPrototypeReflection(
-			$emptyConstructor->getName(),
-			$classReflection,
-			$emptyConstructor->isStatic(),
-			$emptyConstructor->isPrivate(),
-			$emptyConstructor->isPublic(),
-			false,
-			$emptyConstructor->isFinal()->yes(),
-			$emptyConstructor->getVariants(),
-			null,
-		);
-	}
-
 }
diff --git a/src/Rules/Methods/MethodParameterComparisonHelper.php b/src/Rules/Methods/MethodParameterComparisonHelper.php
@@ -3,8 +3,7 @@
 namespace PHPStan\Rules\Methods;
 
 use PHPStan\Php\PhpVersion;
-use PHPStan\Reflection\MethodPrototypeReflection;
-use PHPStan\Reflection\ParameterReflectionWithPhpDocs;
+use PHPStan\Reflection\ExtendedMethodReflection;
 use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\Reflection\Php\PhpMethodFromParserNodeReflection;
 use PHPStan\Rules\RuleError;
@@ -31,7 +30,7 @@ public function __construct(private PhpVersion $phpVersion, private bool $generi
 	/**
 	 * @return RuleError[]
 	 */
-	public function compare(MethodPrototypeReflection $prototype, PhpMethodFromParserNodeReflection $method, bool $ignorable = false): array
+	public function compare(ExtendedMethodReflection $prototype, PhpMethodFromParserNodeReflection $method, bool $ignorable = false): array
 	{
 		/** @var RuleError[] $messages */
 		$messages = [];
@@ -164,9 +163,6 @@ public function compare(MethodPrototypeReflection $prototype, PhpMethodFromParse
 				if ($this->phpVersion->supportsLessOverridenParametersWithVariadic()) {
 					$remainingPrototypeParameters = array_slice($prototypeVariant->getParameters(), $i);
 					foreach ($remainingPrototypeParameters as $j => $remainingPrototypeParameter) {
-						if (!$remainingPrototypeParameter instanceof ParameterReflectionWithPhpDocs) {
-							continue;
-						}
 						if ($methodParameter->getNativeType()->isSuperTypeOf($remainingPrototypeParameter->getNativeType())->yes()) {
 							continue;
 						}
@@ -236,10 +232,6 @@ public function compare(MethodPrototypeReflection $prototype, PhpMethodFromParse
 
 			$methodParameterType = $methodParameter->getNativeType();
 
-			if (!$prototypeParameter instanceof ParameterReflectionWithPhpDocs) {
-				continue;
-			}
-
 			$prototypeParameterType = $prototypeParameter->getNativeType();
 			if (!$this->phpVersion->supportsParameterTypeWidening()) {
 				if (!$methodParameterType->equals($prototypeParameterType)) {
Original file line number	Diff line number	Diff line change
Expand Up		@@ -33,4 +33,6 @@ public function getSelfOutType(): ?Type;

		public function returnsByReference(): TrinaryLogic;

		public function isFinalByKeyword(): TrinaryLogic;

		}