-
Notifications
You must be signed in to change notification settings - Fork 51
Rules to only allow loose comparison with numeric operands #41
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
832a1d4
Added rules for loose comparison
jasny c2de273
Make the types that are allowed for loose comparison configurable.
jasny 57efa54
Removed non-sence mixed array check in `OperandsInComparison` rules.
jasny 34715c2
Fixed tests for operands in comparison rules.
jasny 29aaa0f
Update README.md
jasny File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
<?php declare(strict_types = 1); | ||
|
||
namespace PHPStan\Rules\Operators; | ||
|
||
use PHPStan\Type\VerbosityLevel; | ||
|
||
class OperandsInComparisonEqualRule implements \PHPStan\Rules\Rule | ||
{ | ||
|
||
/** @var OperatorRuleHelper */ | ||
private $helper; | ||
|
||
public function __construct(OperatorRuleHelper $helper) | ||
{ | ||
$this->helper = $helper; | ||
} | ||
|
||
public function getNodeType(): string | ||
{ | ||
return \PhpParser\Node\Expr\BinaryOp\Equal::class; | ||
} | ||
|
||
/** | ||
* @param \PhpParser\Node\Expr\BinaryOp\Equal $node | ||
* @param \PHPStan\Analyser\Scope $scope | ||
* @return string[] errors | ||
*/ | ||
public function processNode(\PhpParser\Node $node, \PHPStan\Analyser\Scope $scope): array | ||
{ | ||
$leftType = $scope->getType($node->left); | ||
$rightType = $scope->getType($node->right); | ||
|
||
$messages = []; | ||
if (!$this->helper->isValidForLooseComparisonOperation($scope, $node->left)) { | ||
$messages[] = sprintf( | ||
'Only %s is allowed in ==, %s given on the left side.', | ||
$this->helper->getAllowedLooseComparison(), | ||
$leftType->describe(VerbosityLevel::typeOnly()) | ||
); | ||
} | ||
if (!$this->helper->isValidForLooseComparisonOperation($scope, $node->right)) { | ||
$messages[] = sprintf( | ||
'Only %s is allowed in ==, %s given on the right side.', | ||
$this->helper->getAllowedLooseComparison(), | ||
$rightType->describe(VerbosityLevel::typeOnly()) | ||
); | ||
} | ||
|
||
return $messages; | ||
} | ||
|
||
} |
52 changes: 52 additions & 0 deletions
52
src/Rules/Operators/OperandsInComparisonGreaterOrEqualRule.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
<?php declare(strict_types = 1); | ||
|
||
namespace PHPStan\Rules\Operators; | ||
|
||
use PHPStan\Type\VerbosityLevel; | ||
|
||
class OperandsInComparisonGreaterOrEqualRule implements \PHPStan\Rules\Rule | ||
{ | ||
|
||
/** @var OperatorRuleHelper */ | ||
private $helper; | ||
|
||
public function __construct(OperatorRuleHelper $helper) | ||
{ | ||
$this->helper = $helper; | ||
} | ||
|
||
public function getNodeType(): string | ||
{ | ||
return \PhpParser\Node\Expr\BinaryOp\GreaterOrEqual::class; | ||
} | ||
|
||
/** | ||
* @param \PhpParser\Node\Expr\BinaryOp\Equal $node | ||
* @param \PHPStan\Analyser\Scope $scope | ||
* @return string[] errors | ||
*/ | ||
public function processNode(\PhpParser\Node $node, \PHPStan\Analyser\Scope $scope): array | ||
{ | ||
$leftType = $scope->getType($node->left); | ||
$rightType = $scope->getType($node->right); | ||
|
||
$messages = []; | ||
if (!$this->helper->isValidForLooseComparisonOperation($scope, $node->left)) { | ||
$messages[] = sprintf( | ||
'Only %s is allowed in >=, %s given on the left side.', | ||
$this->helper->getAllowedLooseComparison(), | ||
$leftType->describe(VerbosityLevel::typeOnly()) | ||
); | ||
} | ||
if (!$this->helper->isValidForLooseComparisonOperation($scope, $node->right)) { | ||
$messages[] = sprintf( | ||
'Only %s is allowed in >=, %s given on the right side.', | ||
$this->helper->getAllowedLooseComparison(), | ||
$rightType->describe(VerbosityLevel::typeOnly()) | ||
); | ||
} | ||
|
||
return $messages; | ||
} | ||
|
||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
<?php declare(strict_types = 1); | ||
|
||
namespace PHPStan\Rules\Operators; | ||
|
||
use PHPStan\Type\VerbosityLevel; | ||
|
||
class OperandsInComparisonGreaterRule implements \PHPStan\Rules\Rule | ||
{ | ||
|
||
/** @var OperatorRuleHelper */ | ||
private $helper; | ||
|
||
public function __construct(OperatorRuleHelper $helper) | ||
{ | ||
$this->helper = $helper; | ||
} | ||
|
||
public function getNodeType(): string | ||
{ | ||
return \PhpParser\Node\Expr\BinaryOp\Greater::class; | ||
} | ||
|
||
/** | ||
* @param \PhpParser\Node\Expr\BinaryOp\Equal $node | ||
* @param \PHPStan\Analyser\Scope $scope | ||
* @return string[] errors | ||
*/ | ||
public function processNode(\PhpParser\Node $node, \PHPStan\Analyser\Scope $scope): array | ||
{ | ||
$leftType = $scope->getType($node->left); | ||
$rightType = $scope->getType($node->right); | ||
|
||
$messages = []; | ||
if (!$this->helper->isValidForLooseComparisonOperation($scope, $node->left)) { | ||
$messages[] = sprintf( | ||
'Only %s is allowed in >, %s given on the left side.', | ||
$this->helper->getAllowedLooseComparison(), | ||
$leftType->describe(VerbosityLevel::typeOnly()) | ||
); | ||
} | ||
if (!$this->helper->isValidForLooseComparisonOperation($scope, $node->right)) { | ||
$messages[] = sprintf( | ||
'Only %s is allowed in >, %s given on the right side.', | ||
$this->helper->getAllowedLooseComparison(), | ||
$rightType->describe(VerbosityLevel::typeOnly()) | ||
); | ||
} | ||
|
||
return $messages; | ||
} | ||
|
||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
<?php declare(strict_types = 1); | ||
|
||
namespace PHPStan\Rules\Operators; | ||
|
||
use PHPStan\Type\VerbosityLevel; | ||
|
||
class OperandsInComparisonNotEqualRule implements \PHPStan\Rules\Rule | ||
{ | ||
|
||
/** @var OperatorRuleHelper */ | ||
private $helper; | ||
|
||
public function __construct(OperatorRuleHelper $helper) | ||
{ | ||
$this->helper = $helper; | ||
} | ||
|
||
public function getNodeType(): string | ||
{ | ||
return \PhpParser\Node\Expr\BinaryOp\NotEqual::class; | ||
} | ||
|
||
/** | ||
* @param \PhpParser\Node\Expr\BinaryOp\BooleanAnd $node | ||
* @param \PHPStan\Analyser\Scope $scope | ||
* @return string[] errors | ||
*/ | ||
public function processNode(\PhpParser\Node $node, \PHPStan\Analyser\Scope $scope): array | ||
{ | ||
$leftType = $scope->getType($node->left); | ||
$rightType = $scope->getType($node->right); | ||
|
||
$messages = []; | ||
if (!$this->helper->isValidForLooseComparisonOperation($scope, $node->left)) { | ||
$messages[] = sprintf( | ||
'Only %s is allowed in !=, %s given on the left side.', | ||
$this->helper->getAllowedLooseComparison(), | ||
$leftType->describe(VerbosityLevel::typeOnly()) | ||
); | ||
} | ||
if (!$this->helper->isValidForLooseComparisonOperation($scope, $node->right)) { | ||
$messages[] = sprintf( | ||
'Only %s is allowed in !=, %s given on the right side.', | ||
$this->helper->getAllowedLooseComparison(), | ||
$rightType->describe(VerbosityLevel::typeOnly()) | ||
); | ||
} | ||
|
||
return $messages; | ||
} | ||
|
||
} |
52 changes: 52 additions & 0 deletions
52
src/Rules/Operators/OperandsInComparisonSmallerOrEqualRule.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
<?php declare(strict_types = 1); | ||
|
||
namespace PHPStan\Rules\Operators; | ||
|
||
use PHPStan\Type\VerbosityLevel; | ||
|
||
class OperandsInComparisonSmallerOrEqualRule implements \PHPStan\Rules\Rule | ||
{ | ||
|
||
/** @var OperatorRuleHelper */ | ||
private $helper; | ||
|
||
public function __construct(OperatorRuleHelper $helper) | ||
{ | ||
$this->helper = $helper; | ||
} | ||
|
||
public function getNodeType(): string | ||
{ | ||
return \PhpParser\Node\Expr\BinaryOp\SmallerOrEqual::class; | ||
} | ||
|
||
/** | ||
* @param \PhpParser\Node\Expr\BinaryOp\Equal $node | ||
* @param \PHPStan\Analyser\Scope $scope | ||
* @return string[] errors | ||
*/ | ||
public function processNode(\PhpParser\Node $node, \PHPStan\Analyser\Scope $scope): array | ||
{ | ||
$leftType = $scope->getType($node->left); | ||
$rightType = $scope->getType($node->right); | ||
|
||
$messages = []; | ||
if (!$this->helper->isValidForLooseComparisonOperation($scope, $node->left)) { | ||
$messages[] = sprintf( | ||
'Only %s is allowed in <=, %s given on the left side.', | ||
$this->helper->getAllowedLooseComparison(), | ||
$leftType->describe(VerbosityLevel::typeOnly()) | ||
); | ||
} | ||
if (!$this->helper->isValidForLooseComparisonOperation($scope, $node->right)) { | ||
$messages[] = sprintf( | ||
'Only %s is allowed in <=, %s given on the right side.', | ||
$this->helper->getAllowedLooseComparison(), | ||
$rightType->describe(VerbosityLevel::typeOnly()) | ||
); | ||
} | ||
|
||
return $messages; | ||
} | ||
|
||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
<?php declare(strict_types = 1); | ||
|
||
namespace PHPStan\Rules\Operators; | ||
|
||
use PHPStan\Type\VerbosityLevel; | ||
|
||
class OperandsInComparisonSmallerRule implements \PHPStan\Rules\Rule | ||
{ | ||
|
||
/** @var OperatorRuleHelper */ | ||
private $helper; | ||
|
||
public function __construct(OperatorRuleHelper $helper) | ||
{ | ||
$this->helper = $helper; | ||
} | ||
|
||
public function getNodeType(): string | ||
{ | ||
return \PhpParser\Node\Expr\BinaryOp\Smaller::class; | ||
} | ||
|
||
/** | ||
* @param \PhpParser\Node\Expr\BinaryOp\Equal $node | ||
* @param \PHPStan\Analyser\Scope $scope | ||
* @return string[] errors | ||
*/ | ||
public function processNode(\PhpParser\Node $node, \PHPStan\Analyser\Scope $scope): array | ||
{ | ||
$leftType = $scope->getType($node->left); | ||
$rightType = $scope->getType($node->right); | ||
|
||
$messages = []; | ||
if (!$this->helper->isValidForLooseComparisonOperation($scope, $node->left)) { | ||
$messages[] = sprintf( | ||
'Only %s is allowed in <, %s given on the left side.', | ||
$this->helper->getAllowedLooseComparison(), | ||
$leftType->describe(VerbosityLevel::typeOnly()) | ||
); | ||
} | ||
if (!$this->helper->isValidForLooseComparisonOperation($scope, $node->right)) { | ||
$messages[] = sprintf( | ||
'Only %s is allowed in <, %s given on the right side.', | ||
$this->helper->getAllowedLooseComparison(), | ||
$rightType->describe(VerbosityLevel::typeOnly()) | ||
); | ||
} | ||
|
||
return $messages; | ||
} | ||
|
||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.