ImpossibleCheckTypeStaticMethodCallRule - respect reportAlwaysTrueInLastCondition

Author: ondrejmirtes

conf/config.level4.neon

@@ -120,6 +120,7 @@ services:
 		arguments:
 			checkAlwaysTrueCheckTypeFunctionCall: %checkAlwaysTrueCheckTypeFunctionCall%
 			treatPhpDocTypesAsCertain: %treatPhpDocTypesAsCertain%
+			reportAlwaysTrueInLastCondition: %reportAlwaysTrueInLastCondition%
 		tags:
 			- phpstan.rules.rule
 

src/Rules/Comparison/ImpossibleCheckTypeStaticMethodCallRule.php

@@ -22,6 +22,7 @@ public function __construct(
 		private ImpossibleCheckTypeHelper $impossibleCheckTypeHelper,
 		private bool $checkAlwaysTrueCheckTypeFunctionCall,
 		private bool $treatPhpDocTypesAsCertain,
+		private bool $reportAlwaysTrueInLastCondition,
 	)
 	{
 	}
@@ -67,20 +68,23 @@ public function processNode(Node $node, Scope $scope): array
 				)))->build(),
 			];
 		} elseif ($this->checkAlwaysTrueCheckTypeFunctionCall) {
-			if ($node->getAttribute(LastConditionVisitor::ATTRIBUTE_NAME) === true) {
+			$isLast = $node->getAttribute(LastConditionVisitor::ATTRIBUTE_NAME);
+			if ($isLast === true && !$this->reportAlwaysTrueInLastCondition) {
 				return [];
 			}
 
 			$method = $this->getMethod($node->class, $node->name->name, $scope);
+			$errorBuilder = $addTip(RuleErrorBuilder::message(sprintf(
+				'Call to static method %s::%s()%s will always evaluate to true.',
+				$method->getDeclaringClass()->getDisplayName(),
+				$method->getName(),
+				$this->impossibleCheckTypeHelper->getArgumentsDescription($scope, $node->getArgs()),
+			)));
+			if ($isLast === false && !$this->reportAlwaysTrueInLastCondition) {
+				$errorBuilder->tip('Remove remaining cases below this one and this error will disappear too.');
+			}
 
-			return [
-				$addTip(RuleErrorBuilder::message(sprintf(
-					'Call to static method %s::%s()%s will always evaluate to true.',
-					$method->getDeclaringClass()->getDisplayName(),
-					$method->getName(),
-					$this->impossibleCheckTypeHelper->getArgumentsDescription($scope, $node->getArgs()),
-				)))->build(),
-			];
+			return [$errorBuilder->build()];
 		}
 
 		return [];

tests/PHPStan/Rules/Comparison/ImpossibleCheckTypeStaticMethodCallRuleTest.php

@@ -13,6 +13,8 @@ class ImpossibleCheckTypeStaticMethodCallRuleTest extends RuleTestCase
 
 	private bool $treatPhpDocTypesAsCertain;
 
+	private bool $reportAlwaysTrueInLastCondition = false;
+
 	public function getRule(): Rule
 	{
 		return new ImpossibleCheckTypeStaticMethodCallRule(
@@ -25,6 +27,7 @@ public function getRule(): Rule
 			),
 			true,
 			$this->treatPhpDocTypesAsCertain,
+			$this->reportAlwaysTrueInLastCondition,
 		);
 	}
 
@@ -64,6 +67,7 @@ public function testRule(): void
 			[
 				'Call to static method ImpossibleStaticMethodCall\ConditionalAlwaysTrue::isInt() with int will always evaluate to true.',
 				66,
+				'Remove remaining cases below this one and this error will disappear too.',
 			],
 		]);
 	}
@@ -109,6 +113,38 @@ public function testAssertUnresolvedGeneric(): void
 		$this->analyse([__DIR__ . '/data/assert-unresolved-generic.php'], []);
 	}
 
+	public function dataReportAlwaysTrueInLastCondition(): iterable
+	{
+		yield [false, [
+			[
+				'Call to static method PHPStan\Tests\AssertionClass::assertInt() with int will always evaluate to true.',
+				23,
+				'Remove remaining cases below this one and this error will disappear too.',
+			],
+		]];
+		yield [true, [
+			[
+				'Call to static method PHPStan\Tests\AssertionClass::assertInt() with int will always evaluate to true.',
+				14,
+			],
+			[
+				'Call to static method PHPStan\Tests\AssertionClass::assertInt() with int will always evaluate to true.',
+				23,
+			],
+		]];
+	}
+
+	/**
+	 * @dataProvider dataReportAlwaysTrueInLastCondition
+	 * @param list<array{0: string, 1: int, 2?: string}> $expectedErrors
+	 */
+	public function testReportAlwaysTrueInLastCondition(bool $reportAlwaysTrueInLastCondition, array $expectedErrors): void
+	{
+		$this->treatPhpDocTypesAsCertain = true;
+		$this->reportAlwaysTrueInLastCondition = $reportAlwaysTrueInLastCondition;
+		$this->analyse([__DIR__ . '/data/impossible-static-method-report-always-true-last-condition.php'], $expectedErrors);
+	}
+
 	public static function getAdditionalConfigFiles(): array
 	{
 		return [

tests/PHPStan/Rules/Comparison/data/impossible-static-method-report-always-true-last-condition.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace ImpossibleStaticMethodReportAlwaysTrueLastCondition;
+
+use PHPStan\Tests\AssertionClass;
+
+class Foo
+{
+
+	public function doFoo(int $i)
+	{
+		if (rand(0, 1)) {
+
+		} elseif (AssertionClass::assertInt($i)) {
+
+		}
+	}
+
+	public function doBar(int $i)
+	{
+		if (rand(0, 1)) {
+
+		} elseif (AssertionClass::assertInt($i)) {
+
+		} else {
+
+		}
+	}
+
+}