2019-10-13 05:59:52 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
declare(strict_types=1);
|
2018-10-25 21:59:19 +00:00
|
|
|
|
|
|
|
namespace Rector\CodeQuality\Rector\Return_;
|
|
|
|
|
|
|
|
use PhpParser\Node;
|
|
|
|
use PhpParser\Node\Expr\Assign;
|
|
|
|
use PhpParser\Node\Expr\AssignOp;
|
|
|
|
use PhpParser\Node\Expr\Variable;
|
|
|
|
use PhpParser\Node\Stmt\Expression;
|
|
|
|
use PhpParser\Node\Stmt\Return_;
|
2020-09-01 17:56:30 +00:00
|
|
|
use PHPStan\Type\MixedType;
|
|
|
|
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
|
2020-02-06 21:48:18 +00:00
|
|
|
use Rector\Core\PhpParser\Node\AssignAndBinaryMap;
|
|
|
|
use Rector\Core\Rector\AbstractRector;
|
2019-04-13 09:20:27 +00:00
|
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
2020-11-16 17:50:38 +00:00
|
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
2018-10-25 21:59:19 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @see Based on https://github.com/slevomat/coding-standard/blob/master/SlevomatCodingStandard/Sniffs/Variables/UselessVariableSniff.php
|
2019-09-03 09:11:45 +00:00
|
|
|
* @see \Rector\CodeQuality\Tests\Rector\Return_\SimplifyUselessVariableRector\SimplifyUselessVariableRectorTest
|
2018-10-25 21:59:19 +00:00
|
|
|
*/
|
|
|
|
final class SimplifyUselessVariableRector extends AbstractRector
|
|
|
|
{
|
|
|
|
/**
|
2018-10-27 14:02:49 +00:00
|
|
|
* @var AssignAndBinaryMap
|
2018-10-25 21:59:19 +00:00
|
|
|
*/
|
2018-10-27 14:02:49 +00:00
|
|
|
private $assignAndBinaryMap;
|
2018-10-25 21:59:19 +00:00
|
|
|
|
2018-10-27 14:02:49 +00:00
|
|
|
public function __construct(AssignAndBinaryMap $assignAndBinaryMap)
|
2018-10-25 21:59:19 +00:00
|
|
|
{
|
2018-10-27 14:02:49 +00:00
|
|
|
$this->assignAndBinaryMap = $assignAndBinaryMap;
|
2018-10-25 21:59:19 +00:00
|
|
|
}
|
|
|
|
|
2020-11-16 17:50:38 +00:00
|
|
|
public function getRuleDefinition(): RuleDefinition
|
2018-10-25 21:59:19 +00:00
|
|
|
{
|
2020-11-16 17:50:38 +00:00
|
|
|
return new RuleDefinition('Removes useless variable assigns', [
|
2018-10-25 21:59:19 +00:00
|
|
|
new CodeSample(
|
2020-09-15 08:23:13 +00:00
|
|
|
<<<'CODE_SAMPLE'
|
2018-10-25 21:59:19 +00:00
|
|
|
function () {
|
|
|
|
$a = true;
|
|
|
|
return $a;
|
|
|
|
};
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2018-10-25 21:59:19 +00:00
|
|
|
,
|
2020-09-15 08:23:13 +00:00
|
|
|
<<<'CODE_SAMPLE'
|
2018-10-25 21:59:19 +00:00
|
|
|
function () {
|
|
|
|
return true;
|
|
|
|
};
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2018-10-25 21:59:19 +00:00
|
|
|
),
|
|
|
|
]);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return string[]
|
|
|
|
*/
|
|
|
|
public function getNodeTypes(): array
|
|
|
|
{
|
|
|
|
return [Return_::class];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param Return_ $node
|
|
|
|
*/
|
|
|
|
public function refactor(Node $node): ?Node
|
|
|
|
{
|
|
|
|
if ($this->shouldSkip($node)) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
2019-04-13 09:20:27 +00:00
|
|
|
$previousNode = $node->getAttribute(AttributeKey::PREVIOUS_NODE);
|
2019-01-25 00:49:26 +00:00
|
|
|
if (! $previousNode instanceof Expression) {
|
|
|
|
return null;
|
|
|
|
}
|
2018-10-25 21:59:19 +00:00
|
|
|
|
2019-01-25 00:49:26 +00:00
|
|
|
/** @var AssignOp|Assign $previousNode */
|
|
|
|
$previousNode = $previousNode->expr;
|
2018-10-25 21:59:19 +00:00
|
|
|
$previousVariableNode = $previousNode->var;
|
|
|
|
|
|
|
|
// has some comment
|
|
|
|
if ($previousVariableNode->getComments() || $previousVariableNode->getDocComment()) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($previousNode instanceof Assign) {
|
2020-09-01 17:56:30 +00:00
|
|
|
if ($this->isReturnWithVarAnnotation($node)) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
2018-10-25 21:59:19 +00:00
|
|
|
$node->expr = $previousNode->expr;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($previousNode instanceof AssignOp) {
|
2018-10-27 14:02:49 +00:00
|
|
|
$binaryClass = $this->assignAndBinaryMap->getAlternative($previousNode);
|
2018-11-07 19:39:33 +00:00
|
|
|
if ($binaryClass === null) {
|
2018-10-25 21:59:19 +00:00
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
$node->expr = new $binaryClass($previousNode->var, $previousNode->expr);
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->removeNode($previousNode);
|
|
|
|
|
|
|
|
return $node;
|
|
|
|
}
|
|
|
|
|
2020-06-29 21:19:37 +00:00
|
|
|
private function shouldSkip(Return_ $return): bool
|
2018-10-25 21:59:19 +00:00
|
|
|
{
|
2020-06-29 21:19:37 +00:00
|
|
|
if (! $return->expr instanceof Variable) {
|
2018-10-25 21:59:19 +00:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2020-06-29 21:19:37 +00:00
|
|
|
$variableNode = $return->expr;
|
2018-10-25 21:59:19 +00:00
|
|
|
|
2020-06-29 21:19:37 +00:00
|
|
|
$previousExpression = $return->getAttribute(AttributeKey::PREVIOUS_NODE);
|
2018-10-25 21:59:19 +00:00
|
|
|
if ($previousExpression === null || ! $previousExpression instanceof Expression) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
// is variable part of single assign
|
|
|
|
$previousNode = $previousExpression->expr;
|
|
|
|
if (! $previousNode instanceof AssignOp && ! $previousNode instanceof Assign) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
// is the same variable
|
2018-12-13 21:07:27 +00:00
|
|
|
if (! $this->areNodesEqual($previousNode->var, $variableNode)) {
|
|
|
|
return true;
|
|
|
|
}
|
2018-12-15 20:04:25 +00:00
|
|
|
return $this->isPreviousExpressionVisuallySimilar($previousExpression, $previousNode);
|
2018-12-13 21:07:27 +00:00
|
|
|
}
|
|
|
|
|
2020-12-20 12:50:55 +00:00
|
|
|
private function isReturnWithVarAnnotation(Return_ $return): bool
|
2020-09-01 17:56:30 +00:00
|
|
|
{
|
2020-12-20 12:50:55 +00:00
|
|
|
$phpDocInfo = $return->getAttribute(AttributeKey::PHP_DOC_INFO);
|
2020-09-01 17:56:30 +00:00
|
|
|
if (! $phpDocInfo instanceof PhpDocInfo) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
return ! $phpDocInfo->getVarType() instanceof MixedType;
|
|
|
|
}
|
|
|
|
|
2018-12-13 21:07:27 +00:00
|
|
|
/**
|
|
|
|
* @param AssignOp|Assign $previousNode
|
|
|
|
*/
|
|
|
|
private function isPreviousExpressionVisuallySimilar(Expression $previousExpression, Node $previousNode): bool
|
|
|
|
{
|
2019-10-27 16:50:26 +00:00
|
|
|
$prePreviousExpression = $previousExpression->getAttribute(AttributeKey::PREVIOUS_STATEMENT);
|
2020-12-19 15:24:53 +00:00
|
|
|
if (! $prePreviousExpression instanceof Expression) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
if (! $prePreviousExpression->expr instanceof AssignOp) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
return $this->areNodesEqual($prePreviousExpression->expr->var, $previousNode->var);
|
2018-10-25 21:59:19 +00:00
|
|
|
}
|
|
|
|
}
|