mirror of
https://github.com/rectorphp/rector.git
synced 2024-05-29 07:20:52 +00:00
96112cb1f0
2da49992cc
[Downgrade] [PHP 7.2] Make DowngradeParameterTypeWideningRector always downgrade to phpdoc type (#390)
172 lines
6.6 KiB
PHP
172 lines
6.6 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\CodeQuality\Rector\If_;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Expr;
|
|
use PhpParser\Node\Expr\BinaryOp\Identical;
|
|
use PhpParser\Node\Expr\BinaryOp\NotIdentical;
|
|
use PhpParser\Node\Expr\BooleanNot;
|
|
use PhpParser\Node\Stmt\If_;
|
|
use PhpParser\Node\Stmt\Return_;
|
|
use Rector\BetterPhpDocParser\Comment\CommentsMerger;
|
|
use Rector\CodeQuality\NodeManipulator\ExprBoolCaster;
|
|
use Rector\Core\Rector\AbstractRector;
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
/**
|
|
* @see \Rector\Tests\CodeQuality\Rector\If_\SimplifyIfReturnBoolRector\SimplifyIfReturnBoolRectorTest
|
|
*/
|
|
final class SimplifyIfReturnBoolRector extends \Rector\Core\Rector\AbstractRector
|
|
{
|
|
/**
|
|
* @var \Rector\BetterPhpDocParser\Comment\CommentsMerger
|
|
*/
|
|
private $commentsMerger;
|
|
/**
|
|
* @var \Rector\CodeQuality\NodeManipulator\ExprBoolCaster
|
|
*/
|
|
private $exprBoolCaster;
|
|
public function __construct(\Rector\BetterPhpDocParser\Comment\CommentsMerger $commentsMerger, \Rector\CodeQuality\NodeManipulator\ExprBoolCaster $exprBoolCaster)
|
|
{
|
|
$this->commentsMerger = $commentsMerger;
|
|
$this->exprBoolCaster = $exprBoolCaster;
|
|
}
|
|
public function getRuleDefinition() : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
|
|
{
|
|
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition('Shortens if return false/true to direct return', [new \Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample(<<<'CODE_SAMPLE'
|
|
if (strpos($docToken->getContent(), "\n") === false) {
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
CODE_SAMPLE
|
|
, 'return strpos($docToken->getContent(), "\\n") === false;')]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [\PhpParser\Node\Stmt\If_::class];
|
|
}
|
|
/**
|
|
* @param If_ $node
|
|
*/
|
|
public function refactor(\PhpParser\Node $node) : ?\PhpParser\Node
|
|
{
|
|
if ($this->shouldSkip($node)) {
|
|
return null;
|
|
}
|
|
/** @var Return_ $ifInnerNode */
|
|
$ifInnerNode = $node->stmts[0];
|
|
/** @var Return_ $nextNode */
|
|
$nextNode = $node->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::NEXT_NODE);
|
|
/** @var Node $innerIfInnerNode */
|
|
$innerIfInnerNode = $ifInnerNode->expr;
|
|
if ($this->valueResolver->isTrue($innerIfInnerNode)) {
|
|
$newReturnNode = $this->processReturnTrue($node, $nextNode);
|
|
} elseif ($this->valueResolver->isFalse($innerIfInnerNode)) {
|
|
$newReturnNode = $this->processReturnFalse($node, $nextNode);
|
|
} else {
|
|
return null;
|
|
}
|
|
if ($newReturnNode === null) {
|
|
return null;
|
|
}
|
|
$this->commentsMerger->keepComments($newReturnNode, [$node, $ifInnerNode, $nextNode, $newReturnNode]);
|
|
$this->removeNode($nextNode);
|
|
return $newReturnNode;
|
|
}
|
|
private function shouldSkip(\PhpParser\Node\Stmt\If_ $if) : bool
|
|
{
|
|
if ($if->elseifs !== []) {
|
|
return \true;
|
|
}
|
|
if ($this->isElseSeparatedThenIf($if)) {
|
|
return \true;
|
|
}
|
|
if (!$this->isIfWithSingleReturnExpr($if)) {
|
|
return \true;
|
|
}
|
|
/** @var Return_ $ifInnerNode */
|
|
$ifInnerNode = $if->stmts[0];
|
|
/** @var Expr $returnedExpr */
|
|
$returnedExpr = $ifInnerNode->expr;
|
|
if (!$this->valueResolver->isTrueOrFalse($returnedExpr)) {
|
|
return \true;
|
|
}
|
|
$nextNode = $if->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::NEXT_NODE);
|
|
if (!$nextNode instanceof \PhpParser\Node\Stmt\Return_) {
|
|
return \true;
|
|
}
|
|
if ($nextNode->expr === null) {
|
|
return \true;
|
|
}
|
|
// negate + negate → skip for now
|
|
if (!$this->valueResolver->isFalse($returnedExpr)) {
|
|
return !$this->valueResolver->isTrueOrFalse($nextNode->expr);
|
|
}
|
|
$condString = $this->print($if->cond);
|
|
if (\strpos($condString, '!=') === \false) {
|
|
return !$this->valueResolver->isTrueOrFalse($nextNode->expr);
|
|
}
|
|
return \true;
|
|
}
|
|
private function processReturnTrue(\PhpParser\Node\Stmt\If_ $if, \PhpParser\Node\Stmt\Return_ $nextReturnNode) : \PhpParser\Node\Stmt\Return_
|
|
{
|
|
if ($if->cond instanceof \PhpParser\Node\Expr\BooleanNot && $nextReturnNode->expr !== null && $this->valueResolver->isTrue($nextReturnNode->expr)) {
|
|
return new \PhpParser\Node\Stmt\Return_($this->exprBoolCaster->boolCastOrNullCompareIfNeeded($if->cond->expr));
|
|
}
|
|
return new \PhpParser\Node\Stmt\Return_($this->exprBoolCaster->boolCastOrNullCompareIfNeeded($if->cond));
|
|
}
|
|
private function processReturnFalse(\PhpParser\Node\Stmt\If_ $if, \PhpParser\Node\Stmt\Return_ $nextReturnNode) : ?\PhpParser\Node\Stmt\Return_
|
|
{
|
|
if ($if->cond instanceof \PhpParser\Node\Expr\BinaryOp\Identical) {
|
|
$notIdentical = new \PhpParser\Node\Expr\BinaryOp\NotIdentical($if->cond->left, $if->cond->right);
|
|
return new \PhpParser\Node\Stmt\Return_($this->exprBoolCaster->boolCastOrNullCompareIfNeeded($notIdentical));
|
|
}
|
|
if ($nextReturnNode->expr === null) {
|
|
return null;
|
|
}
|
|
if (!$this->valueResolver->isTrue($nextReturnNode->expr)) {
|
|
return null;
|
|
}
|
|
if ($if->cond instanceof \PhpParser\Node\Expr\BooleanNot) {
|
|
return new \PhpParser\Node\Stmt\Return_($this->exprBoolCaster->boolCastOrNullCompareIfNeeded($if->cond->expr));
|
|
}
|
|
return new \PhpParser\Node\Stmt\Return_($this->exprBoolCaster->boolCastOrNullCompareIfNeeded(new \PhpParser\Node\Expr\BooleanNot($if->cond)));
|
|
}
|
|
/**
|
|
* Matches: "else if"
|
|
*/
|
|
private function isElseSeparatedThenIf(\PhpParser\Node\Stmt\If_ $if) : bool
|
|
{
|
|
if ($if->else === null) {
|
|
return \false;
|
|
}
|
|
if (\count($if->else->stmts) !== 1) {
|
|
return \false;
|
|
}
|
|
$onlyStmt = $if->else->stmts[0];
|
|
return $onlyStmt instanceof \PhpParser\Node\Stmt\If_;
|
|
}
|
|
private function isIfWithSingleReturnExpr(\PhpParser\Node\Stmt\If_ $if) : bool
|
|
{
|
|
if (\count($if->stmts) !== 1) {
|
|
return \false;
|
|
}
|
|
if ($if->elseifs !== []) {
|
|
return \false;
|
|
}
|
|
$ifInnerNode = $if->stmts[0];
|
|
if (!$ifInnerNode instanceof \PhpParser\Node\Stmt\Return_) {
|
|
return \false;
|
|
}
|
|
// return must have value
|
|
return $ifInnerNode->expr !== null;
|
|
}
|
|
}
|