mirror of
https://github.com/rectorphp/rector.git
synced 2024-06-02 17:30:50 +00:00
68e1f45251
4d01db5c10
[DX] Improve direct return of Stmt arrays in Rector rules, remove NodesToAddCollector from AbstractRector (#2623)
126 lines
4.1 KiB
PHP
126 lines
4.1 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\DowngradePhp80\Rector\New_;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Expr;
|
|
use PhpParser\Node\Expr\ArrayDimFetch;
|
|
use PhpParser\Node\Expr\Assign;
|
|
use PhpParser\Node\Expr\AssignOp;
|
|
use PhpParser\Node\Expr\AssignRef;
|
|
use PhpParser\Node\Expr\Instanceof_;
|
|
use PhpParser\Node\Expr\New_;
|
|
use PhpParser\Node\Expr\PropertyFetch;
|
|
use PhpParser\Node\Expr\StaticPropertyFetch;
|
|
use PhpParser\Node\Expr\Variable;
|
|
use Rector\Core\PhpParser\Node\NamedVariableFactory;
|
|
use Rector\Core\Rector\AbstractRector;
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
|
use Rector\PostRector\Collector\NodesToAddCollector;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
/**
|
|
* @changelog https://wiki.php.net/rfc/variable_syntax_tweaks#arbitrary_expression_support_for_new_and_instanceof
|
|
*
|
|
* @see \Rector\Tests\DowngradePhp80\Rector\New_\DowngradeArbitraryExpressionsSupportRector\DowngradeArbitraryExpressionsSupportRectorTest
|
|
*/
|
|
final class DowngradeArbitraryExpressionsSupportRector extends AbstractRector
|
|
{
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Core\PhpParser\Node\NamedVariableFactory
|
|
*/
|
|
private $namedVariableFactory;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\PostRector\Collector\NodesToAddCollector
|
|
*/
|
|
private $nodesToAddCollector;
|
|
public function __construct(NamedVariableFactory $namedVariableFactory, NodesToAddCollector $nodesToAddCollector)
|
|
{
|
|
$this->namedVariableFactory = $namedVariableFactory;
|
|
$this->nodesToAddCollector = $nodesToAddCollector;
|
|
}
|
|
public function getRuleDefinition() : RuleDefinition
|
|
{
|
|
return new RuleDefinition('Replace arbitrary expressions used with new or instanceof.', [new CodeSample(<<<'CODE_SAMPLE'
|
|
function getObjectClassName() {
|
|
return stdClass::class;
|
|
}
|
|
|
|
$object = new (getObjectClassName());
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
function getObjectClassName() {
|
|
return stdClass::class;
|
|
}
|
|
|
|
$className = getObjectClassName();
|
|
$object = new $className();
|
|
CODE_SAMPLE
|
|
)]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [Instanceof_::class, New_::class];
|
|
}
|
|
/**
|
|
* @param Instanceof_|New_ $node
|
|
*/
|
|
public function refactor(Node $node) : ?Node
|
|
{
|
|
if (!$node->class instanceof Expr) {
|
|
return null;
|
|
}
|
|
$isAllowed = $this->isAllowed($node->class);
|
|
$toSkip = $isAllowed && $this->isBetweenParentheses($node);
|
|
if ($toSkip) {
|
|
return null;
|
|
}
|
|
// mandatory to remove parentheses
|
|
$node->setAttribute(AttributeKey::ORIGINAL_NODE, null);
|
|
if ($isAllowed) {
|
|
return $node;
|
|
}
|
|
if ($this->isAssign($node->class)) {
|
|
/** @var Assign|AssignRef|AssignOp $assign */
|
|
$assign = $node->class;
|
|
$variable = $assign->var;
|
|
} else {
|
|
$variable = $this->namedVariableFactory->createVariable($node, 'className');
|
|
$assign = new Assign($variable, $node->class);
|
|
}
|
|
$this->nodesToAddCollector->addNodeBeforeNode($assign, $node);
|
|
$node->class = $variable;
|
|
return $node;
|
|
}
|
|
private function isAllowed(Expr $expr) : bool
|
|
{
|
|
return $expr instanceof Variable || $expr instanceof ArrayDimFetch || $expr instanceof PropertyFetch || $expr instanceof StaticPropertyFetch;
|
|
}
|
|
private function isAssign(Expr $expr) : bool
|
|
{
|
|
return $expr instanceof Assign || $expr instanceof AssignRef || $expr instanceof AssignOp;
|
|
}
|
|
private function isBetweenParentheses(Node $node) : bool
|
|
{
|
|
$oldTokens = $this->file->getOldTokens();
|
|
$previousTokenPos = $node->getStartTokenPos() - 1;
|
|
while ($previousTokenPos >= 0) {
|
|
$token = $oldTokens[$previousTokenPos] ?? null;
|
|
--$previousTokenPos;
|
|
if (!isset($token[0])) {
|
|
return $token === '(';
|
|
}
|
|
if (!\in_array($token[0], [\T_COMMENT, \T_WHITESPACE], \true)) {
|
|
return $token === '(';
|
|
}
|
|
}
|
|
return \false;
|
|
}
|
|
}
|