Skip to content

Commit

Permalink
Prevent accurate comparison of floating-point numbers
Browse files Browse the repository at this point in the history
  • Loading branch information
dmytro-dymarchuk committed Oct 1, 2018
1 parent 18c0b6e commit 460df80
Show file tree
Hide file tree
Showing 3 changed files with 108 additions and 0 deletions.
62 changes: 62 additions & 0 deletions src/Rules/Operators/OperandsInComparisonRule.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<?php

declare(strict_types=1);

namespace PHPStan\Rules\Operators;

use PhpParser\Node;
use PhpParser\Node\Expr\BinaryOp;
use PHPStan\Analyser\Scope;
use PHPStan\Rules\Rule;
use PHPStan\Type\FloatType;

class OperandsInComparisonRule implements Rule
{
/**
* @return string
*/
public function getNodeType(): string
{
return BinaryOp::class;
}

/**
* @param Node $node
* @param Scope $scope
* @return array
*/
public function processNode(Node $node, Scope $scope): array
{
if (!$node instanceof BinaryOp\Equal
&& !$node instanceof BinaryOp\Identical
&& !$node instanceof BinaryOp\GreaterOrEqual
&& !$node instanceof BinaryOp\SmallerOrEqual
) {
return [];
}

$rightType = $scope->getType($node->right);
$leftType = $scope->getType($node->left);

if ($rightType instanceof FloatType || $leftType instanceof FloatType) {
if ($node instanceof BinaryOp\Equal || $node instanceof BinaryOp\Identical) {
return [
'You can not use an exact comparison for floating-point numbers.
Should use `abs($left - $right) < $epsilon`, where $epsilon maximum permissible error.',
];
}
if ($node instanceof BinaryOp\GreaterOrEqual) {
return [
'You can not use an exact comparison for floating-point numbers.
Should use `$left - $right >= $epsilon`, where $epsilon maximum permissible error.'
];
}
if ($node instanceof BinaryOp\SmallerOrEqual) {
return [
'You can not use an exact comparison for floating-point numbers.
Should use `$right - $left >= $epsilon`, where $epsilon maximum permissible error.'
];
}
}
}
}
41 changes: 41 additions & 0 deletions tests/Rules/Operators/OperandsInComparisonRuleTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<?php

declare(strict_types=1);

namespace PHPStan\Rules\Operators;

use PHPStan\Rules\Rule;

class OperandsInComparisonRuleTest extends \PHPStan\Testing\RuleTestCase
{
protected function getRule(): Rule
{
return new OperandsInComparisonRule();
}

public function testRule(): void
{
$this->analyse([__DIR__ . '/data/operators.php'], [
[
'You can not use an exact comparison for floating-point numbers.
Should use `abs($left - $right) < $epsilon`, where $epsilon maximum permissible error.',
113,
],
[
'You can not use an exact comparison for floating-point numbers.
Should use `abs($left - $right) < $epsilon`, where $epsilon maximum permissible error.',
114,
],
[
'You can not use an exact comparison for floating-point numbers.
Should use `$left - $right >= $epsilon`, where $epsilon maximum permissible error.',
115,
],
[
'You can not use an exact comparison for floating-point numbers.
Should use `$right - $left >= $epsilon`, where $epsilon maximum permissible error.',
116,
],
]);
}
}
5 changes: 5 additions & 0 deletions tests/Rules/Operators/data/operators.php
Original file line number Diff line number Diff line change
Expand Up @@ -109,3 +109,8 @@ function (array $array, int $int, $mixed) {

explode($mixed, $mixed) + $int;
};

$float === 123.2;
$float == 123.2;
$float >= 123.2;
$float <= 123.2;

0 comments on commit 460df80

Please sign in to comment.