ConstantLooseComparisonRule - respect treatPhpDocTypesAsCertain

ondrejmirtes · ondrejmirtes · commit 72472dd441e4 · 2023-03-29T17:28:50.000+02:00
diff --git a/conf/config.level4.neon b/conf/config.level4.neon
@@ -155,6 +155,7 @@ services:
 		class: PHPStan\Rules\Comparison\ConstantLooseComparisonRule
 		arguments:
 			checkAlwaysTrueLooseComparison: %checkAlwaysTrueLooseComparison%
+			treatPhpDocTypesAsCertain: %treatPhpDocTypesAsCertain%
 			reportAlwaysTrueInLastCondition: %reportAlwaysTrueInLastCondition%
 
 	-
diff --git a/src/Rules/Comparison/ConstantLooseComparisonRule.php b/src/Rules/Comparison/ConstantLooseComparisonRule.php
@@ -19,6 +19,7 @@ class ConstantLooseComparisonRule implements Rule
 
 	public function __construct(
 		private bool $checkAlwaysTrueLooseComparison,
+		private bool $treatPhpDocTypesAsCertain,
 		private bool $reportAlwaysTrueInLastCondition,
 	)
 	{
@@ -35,7 +36,7 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		$nodeType = $scope->getType($node);
+		$nodeType = $this->treatPhpDocTypesAsCertain ? $scope->getType($node) : $scope->getNativeType($node);
 		if (!$nodeType instanceof ConstantBooleanType) {
 			return [];
 		}
diff --git a/tests/PHPStan/Rules/Comparison/ConstantLooseComparisonRuleTest.php b/tests/PHPStan/Rules/Comparison/ConstantLooseComparisonRuleTest.php
@@ -14,11 +14,13 @@ class ConstantLooseComparisonRuleTest extends RuleTestCase
 
 	private bool $checkAlwaysTrueStrictComparison;
 
+	private bool $treatPhpDocTypesAsCertain = true;
+
 	private bool $reportAlwaysTrueInLastCondition = false;
 
 	protected function getRule(): Rule
 	{
-		return new ConstantLooseComparisonRule($this->checkAlwaysTrueStrictComparison, $this->reportAlwaysTrueInLastCondition);
+		return new ConstantLooseComparisonRule($this->checkAlwaysTrueStrictComparison, $this->treatPhpDocTypesAsCertain, $this->reportAlwaysTrueInLastCondition);
 	}
 
 	public function testRule(): void
@@ -131,4 +133,26 @@ public function testReportAlwaysTrueInLastCondition(bool $reportAlwaysTrueInLast
 		$this->analyse([__DIR__ . '/data/loose-comparison-report-always-true-last-condition.php'], $expectedErrors);
 	}
 
+	public function dataTreatPhpDocTypesAsCertain(): iterable
+	{
+		yield [false, []];
+		yield [true, [
+			[
+				'Loose comparison using == between 3 and 3 will always evaluate to true.',
+				14,
+			],
+		]];
+	}
+
+	/**
+	 * @dataProvider dataTreatPhpDocTypesAsCertain
+	 * @param list<array{0: string, 1: int, 2?: string}> $expectedErrors
+	 */
+	public function testTreatPhpDocTypesAsCertain(bool $treatPhpDocTypesAsCertain, array $expectedErrors): void
+	{
+		$this->checkAlwaysTrueStrictComparison = true;
+		$this->treatPhpDocTypesAsCertain = $treatPhpDocTypesAsCertain;
+		$this->analyse([__DIR__ . '/data/loose-comparison-treat-phpdoc-types.php'], $expectedErrors);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Comparison/data/loose-comparison-treat-phpdoc-types.php b/tests/PHPStan/Rules/Comparison/data/loose-comparison-treat-phpdoc-types.php
@@ -0,0 +1,19 @@
+<?php
+
+namespace LooseComparisonTreatPhpDocTypes;
+
+class Foo
+{
+
+	/**
+	 * @param 3 $i
+	 * @return void
+	 */
+	public function doFoo(int $i): void
+	{
+		if ($i == 3) {
+
+		}
+	}
+
+}

Original file line number	Diff line number	Diff line change
`@@ -155,6 +155,7 @@ services:`
`155`	`155`	`class: PHPStan\Rules\Comparison\ConstantLooseComparisonRule`
`156`	`156`	`arguments:`
`157`	`157`	`checkAlwaysTrueLooseComparison: %checkAlwaysTrueLooseComparison%`
	`158`	`+ treatPhpDocTypesAsCertain: %treatPhpDocTypesAsCertain%`
`158`	`159`	`reportAlwaysTrueInLastCondition: %reportAlwaysTrueInLastCondition%`
`159`	`160`
`160`	`161`	`-`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ class ConstantLooseComparisonRule implements Rule`
`19`	`19`
`20`	`20`	`public function __construct(`
`21`	`21`	`private bool $checkAlwaysTrueLooseComparison,`
	`22`	`+ private bool $treatPhpDocTypesAsCertain,`
`22`	`23`	`private bool $reportAlwaysTrueInLastCondition,`
`23`	`24`	`)`
`24`	`25`	`{`
`@@ -35,7 +36,7 @@ public function processNode(Node $node, Scope $scope): array`
`35`	`36`	`return [];`
`36`	`37`	`}`
`37`	`38`
`38`		`- $nodeType = $scope->getType($node);`
	`39`	`+ $nodeType = $this->treatPhpDocTypesAsCertain ? $scope->getType($node) : $scope->getNativeType($node);`
`39`	`40`	`if (!$nodeType instanceof ConstantBooleanType) {`
`40`	`41`	`return [];`
`41`	`42`	`}`