[DeadCode] Handle bool var if cond return true next return bool var on RemoveDuplicatedIfReturnRector (#1136)

Co-authored-by: GitHub Action <action@github.com>
This commit is contained in:
Abdul Malik Ikhsan 2021-11-03 15:41:32 +07:00 committed by GitHub
parent c86a6eaccb
commit 37ade3fd6b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 119 additions and 12 deletions

View File

@ -0,0 +1,31 @@
<?php
namespace Rector\Tests\DeadCode\Rector\FunctionLike\RemoveDuplicatedIfReturnRector\Fixture;
class BoolVarIfCondReturnTrueNextReturnBoolVar
{
public function run(bool $value)
{
if ($value) {
return true;
}
return $value;
}
}
?>
-----
<?php
namespace Rector\Tests\DeadCode\Rector\FunctionLike\RemoveDuplicatedIfReturnRector\Fixture;
class BoolVarIfCondReturnTrueNextReturnBoolVar
{
public function run(bool $value)
{
return $value;
}
}
?>

View File

@ -0,0 +1,15 @@
<?php
namespace Rector\Tests\DeadCode\Rector\FunctionLike\RemoveDuplicatedIfReturnRector\Fixture;
class SkipNegationIfCondReturnReturnTrueNextReturnCond
{
public function run(bool $value)
{
if (! $value) {
return true;
}
return $value;
}
}

View File

@ -0,0 +1,15 @@
<?php
namespace Rector\Tests\DeadCode\Rector\FunctionLike\RemoveDuplicatedIfReturnRector\Fixture;
class SkipNonBoolIfCond
{
public function run(stdClass $value)
{
if ($value) {
return true;
}
return $value;
}
}

View File

@ -5,17 +5,22 @@ declare(strict_types=1);
namespace Rector\DeadCode\Rector\FunctionLike;
use PhpParser\Node;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\PropertyFetch;
use PhpParser\Node\Expr\StaticPropertyFetch;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\FunctionLike;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\If_;
use PhpParser\Node\Stmt\Return_;
use PhpParser\NodeTraverser;
use PHPStan\Type\BooleanType;
use Rector\Core\NodeAnalyzer\PropertyFetchAnalyzer;
use Rector\Core\NodeManipulator\IfManipulator;
use Rector\Core\PhpParser\Comparing\NodeComparator;
use Rector\Core\Rector\AbstractRector;
use Rector\DeadCode\NodeCollector\ModifiedVariableNamesCollector;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
@ -96,8 +101,15 @@ CODE_SAMPLE
}
foreach ($ifWithOnlyReturnsByHash as $ifWithOnlyReturns) {
// keep first one
array_shift($ifWithOnlyReturns);
$isBool = $this->isBoolVarIfCondReturnTrueNextReturnBoolVar($ifWithOnlyReturns);
if (! $isBool && count($ifWithOnlyReturns) < 2) {
continue;
}
if (! $isBool) {
// keep first one
array_shift($ifWithOnlyReturns);
}
foreach ($ifWithOnlyReturns as $ifWithOnlyReturn) {
$this->removeNode($ifWithOnlyReturn);
@ -107,6 +119,49 @@ CODE_SAMPLE
return $node;
}
/**
* @param If_[] $ifWithOnlyReturns
*/
private function isBoolVarIfCondReturnTrueNextReturnBoolVar(array $ifWithOnlyReturns): bool
{
if (count($ifWithOnlyReturns) > 1) {
return false;
}
/** @var Expr $cond */
$cond = $ifWithOnlyReturns[0]->cond;
if (! in_array($cond::class, [Variable::class, PropertyFetch::class, StaticPropertyFetch::class], true)) {
return false;
}
$type = $this->nodeTypeResolver->getType($cond);
if (! $type instanceof BooleanType) {
return false;
}
$next = $ifWithOnlyReturns[0]->getAttribute(AttributeKey::NEXT_NODE);
if (! $next instanceof Return_) {
return false;
}
$expr = $next->expr;
if (! $expr instanceof Expr) {
return false;
}
if (! $this->nodeComparator->areNodesEqual($expr, $cond)) {
return false;
}
/** @var Return_ $returnStmt */
$returnStmt = $ifWithOnlyReturns[0]->stmts[0];
if (! $returnStmt->expr instanceof Expr) {
return false;
}
return $this->valueResolver->isValue($returnStmt->expr, true);
}
/**
* @return If_[][]
*/
@ -142,7 +197,7 @@ CODE_SAMPLE
$ifWithOnlyReturnsByHash[$hash][] = $stmt;
}
return $this->filterOutSingleItemStmts($ifWithOnlyReturnsByHash);
return $ifWithOnlyReturnsByHash;
}
/**
@ -174,13 +229,4 @@ CODE_SAMPLE
return $containsVariableNames;
}
/**
* @param array<string, If_[]> $ifWithOnlyReturnsByHash
* @return array<string, If_[]>
*/
private function filterOutSingleItemStmts(array $ifWithOnlyReturnsByHash): array
{
return array_filter($ifWithOnlyReturnsByHash, fn (array $stmts): bool => count($stmts) >= 2);
}
}