Skip to content

Commit dc5befe

Browse files
staabmstaabm
committed
Improve loose comparison on IntegerRange containing zero
1 parent a742e51 commit dc5befe

File tree

3 files changed

+119
-7
lines changed

3 files changed

+119
-7
lines changed

‎src/Type/IntegerRangeType.php

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,16 @@ public function isSmallerThan(Type $otherType, PhpVersion $phpVersion): TrinaryL
315315
$maxIsSmaller = (new ConstantIntegerType($this->max))->isSmallerThan($otherType, $phpVersion);
316316
}
317317

318+
// 0 can have different results in contrast to the interval edges, see https://3v4l.org/iGoti
319+
$zeroInt = new ConstantIntegerType(0);
320+
if (!$zeroInt->isSuperTypeOf($this)->no()) {
321+
return TrinaryLogic::extremeIdentity(
322+
$zeroInt->isSmallerThan($otherType, $phpVersion),
323+
$minIsSmaller,
324+
$maxIsSmaller,
325+
);
326+
}
327+
318328
return TrinaryLogic::extremeIdentity($minIsSmaller, $maxIsSmaller);
319329
}
320330

@@ -332,6 +342,16 @@ public function isSmallerThanOrEqual(Type $otherType, PhpVersion $phpVersion): T
332342
$maxIsSmaller = (new ConstantIntegerType($this->max))->isSmallerThanOrEqual($otherType, $phpVersion);
333343
}
334344

345+
// 0 can have different results in contrast to the interval edges, see https://3v4l.org/iGoti
346+
$zeroInt = new ConstantIntegerType(0);
347+
if (!$zeroInt->isSuperTypeOf($this)->no()) {
348+
return TrinaryLogic::extremeIdentity(
349+
$zeroInt->isSmallerThanOrEqual($otherType, $phpVersion),
350+
$minIsSmaller,
351+
$maxIsSmaller,
352+
);
353+
}
354+
335355
return TrinaryLogic::extremeIdentity($minIsSmaller, $maxIsSmaller);
336356
}
337357

@@ -349,6 +369,16 @@ public function isGreaterThan(Type $otherType, PhpVersion $phpVersion): TrinaryL
349369
$maxIsSmaller = $otherType->isSmallerThan((new ConstantIntegerType($this->max)), $phpVersion);
350370
}
351371

372+
// 0 can have different results in contrast to the interval edges, see https://3v4l.org/iGoti
373+
$zeroInt = new ConstantIntegerType(0);
374+
if (!$zeroInt->isSuperTypeOf($this)->no()) {
375+
return TrinaryLogic::extremeIdentity(
376+
$otherType->isSmallerThan($zeroInt, $phpVersion),
377+
$minIsSmaller,
378+
$maxIsSmaller,
379+
);
380+
}
381+
352382
return TrinaryLogic::extremeIdentity($minIsSmaller, $maxIsSmaller);
353383
}
354384

@@ -366,6 +396,16 @@ public function isGreaterThanOrEqual(Type $otherType, PhpVersion $phpVersion): T
366396
$maxIsSmaller = $otherType->isSmallerThanOrEqual((new ConstantIntegerType($this->max)), $phpVersion);
367397
}
368398

399+
// 0 can have different results in contrast to the interval edges, see https://3v4l.org/iGoti
400+
$zeroInt = new ConstantIntegerType(0);
401+
if (!$zeroInt->isSuperTypeOf($this)->no()) {
402+
return TrinaryLogic::extremeIdentity(
403+
$otherType->isSmallerThanOrEqual($zeroInt, $phpVersion),
404+
$minIsSmaller,
405+
$maxIsSmaller,
406+
);
407+
}
408+
369409
return TrinaryLogic::extremeIdentity($minIsSmaller, $maxIsSmaller);
370410
}
371411

@@ -694,7 +734,20 @@ public function toPhpDocNode(): TypeNode
694734

695735
public function looseCompare(Type $type, PhpVersion $phpVersion): BooleanType
696736
{
697-
if ($this->isSmallerThan($type, $phpVersion)->yes() || $this->isGreaterThan($type, $phpVersion)->yes()) {
737+
$zeroInt = new ConstantIntegerType(0);
738+
if ($zeroInt->isSuperTypeOf($this)->no()) {
739+
if ($type->isTrue()->yes()) {
740+
return new ConstantBooleanType(true);
741+
}
742+
if ($type->isFalse()->yes()) {
743+
return new ConstantBooleanType(false);
744+
}
745+
}
746+
747+
if (
748+
$this->isSmallerThan($type, $phpVersion)->yes()
749+
|| $this->isGreaterThan($type, $phpVersion)->yes()
750+
) {
698751
return new ConstantBooleanType(false);
699752
}
700753

‎tests/PHPStan/Analyser/nsrt/loose-comparisons.php

Lines changed: 57 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -712,7 +712,9 @@ public function sayEmptyStr(
712712
* @param array{} $emptyArr
713713
* @param 'php' $phpStr
714714
* @param '' $emptyStr
715-
* @param int<10, 20> $intRange
715+
* @param int<10, 20> $positiveIntRange
716+
* @param int<-20, -10> $negativeIntRange
717+
* @param int<-10, 10> $minusTenToTen
716718
*/
717719
public function sayInt(
718720
$true,
@@ -728,7 +730,9 @@ public function sayInt(
728730
$emptyArr,
729731
array $array,
730732
int $int,
731-
int $intRange,
733+
int $positiveIntRange,
734+
int $negativeIntRange,
735+
int $minusTenToTen,
732736
): void
733737
{
734738
assertType('bool', $int == $true);
@@ -744,8 +748,57 @@ public function sayInt(
744748
assertType('false', $int == $emptyArr);
745749
assertType('false', $int == $array);
746750

747-
assertType('false', $intRange == $emptyArr);
748-
assertType('false', $intRange == $array);
751+
assertType('true', $positiveIntRange == $true);
752+
assertType('false', $positiveIntRange == $false);
753+
assertType('false', $positiveIntRange == $one);
754+
assertType('false', $positiveIntRange == $zero);
755+
assertType('false', $positiveIntRange == $minusOne);
756+
assertType('false', $positiveIntRange == $oneStr);
757+
assertType('false', $positiveIntRange == $zeroStr);
758+
assertType('false', $positiveIntRange == $minusOneStr);
759+
assertType('false', $positiveIntRange == $plusOneStr);
760+
assertType('false', $positiveIntRange == $null);
761+
assertType('false', $positiveIntRange == $emptyArr);
762+
assertType('false', $positiveIntRange == $array);
763+
764+
assertType('true', $negativeIntRange == $true);
765+
assertType('false', $negativeIntRange == $false);
766+
assertType('false', $negativeIntRange == $one);
767+
assertType('false', $negativeIntRange == $zero);
768+
assertType('false', $negativeIntRange == $minusOne);
769+
assertType('false', $negativeIntRange == $oneStr);
770+
assertType('false', $negativeIntRange == $zeroStr);
771+
assertType('false', $negativeIntRange == $minusOneStr);
772+
assertType('false', $negativeIntRange == $plusOneStr);
773+
assertType('false', $negativeIntRange == $null);
774+
assertType('false', $negativeIntRange == $emptyArr);
775+
assertType('false', $negativeIntRange == $array);
776+
777+
// see https://3v4l.org/VudDK
778+
assertType('bool', $minusTenToTen == $true);
779+
assertType('bool', $minusTenToTen == $false);
780+
assertType('bool', $minusTenToTen == $one);
781+
assertType('bool', $minusTenToTen == $zero);
782+
assertType('bool', $minusTenToTen == $minusOne);
783+
assertType('bool', $minusTenToTen == $oneStr);
784+
assertType('bool', $minusTenToTen == $zeroStr);
785+
assertType('bool', $minusTenToTen == $minusOneStr);
786+
assertType('bool', $minusTenToTen == $plusOneStr);
787+
assertType('bool', $minusTenToTen == $null);
788+
assertType('false', $minusTenToTen == $emptyArr);
789+
assertType('false', $minusTenToTen == $array);
790+
791+
// see https://3v4l.org/oJl3K
792+
assertType('false', $minusTenToTen < $null);
793+
assertType('bool', $minusTenToTen > $null);
794+
assertType('bool', $minusTenToTen <= $null);
795+
assertType('true', $minusTenToTen >= $null);
796+
797+
// see https://3v4l.org/oRSgU
798+
assertType('bool', $null < $minusTenToTen);
799+
assertType('false', $null > $minusTenToTen);
800+
assertType('true', $null <= $minusTenToTen);
801+
assertType('bool', $null >= $minusTenToTen);
749802

750803
}
751804

‎tests/PHPStan/Rules/Comparison/ConstantLooseComparisonRuleTest.php

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,15 +210,21 @@ public function testBug11694(): void
210210
39,
211211
'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.',
212212
],
213+
[
214+
'Loose comparison using == between true and int<10, 20> will always evaluate to true.',
215+
41,
216+
],
217+
[
218+
'Loose comparison using == between int<10, 20> and true will always evaluate to true.',
219+
42,
220+
],
213221
[
214222
'Loose comparison using == between false and int<10, 20> will always evaluate to false.',
215223
44,
216-
'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.',
217224
],
218225
[
219226
'Loose comparison using == between int<10, 20> and false will always evaluate to false.',
220227
45,
221-
'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.',
222228
],
223229
]);
224230

0 commit comments

Comments
 (0)