mirror of
https://github.com/rectorphp/rector.git
synced 2024-05-31 00:10:51 +00:00
328 lines
13 KiB
PHP
328 lines
13 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\Core\Rector;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Stmt\InlineHTML;
|
|
use PhpParser\Node\Stmt\Nop;
|
|
use PhpParser\NodeTraverser;
|
|
use PhpParser\NodeVisitorAbstract;
|
|
use PHPStan\Analyser\MutatingScope;
|
|
use PHPStan\Type\ObjectType;
|
|
use PHPStan\Type\Type;
|
|
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
|
|
use Rector\ChangesReporting\ValueObject\RectorWithLineChange;
|
|
use Rector\Core\Application\ChangedNodeScopeRefresher;
|
|
use Rector\Core\Contract\Rector\RectorInterface;
|
|
use Rector\Core\Exception\ShouldNotHappenException;
|
|
use Rector\Core\NodeDecorator\CreatedByRuleDecorator;
|
|
use Rector\Core\PhpParser\Comparing\NodeComparator;
|
|
use Rector\Core\PhpParser\Node\BetterNodeFinder;
|
|
use Rector\Core\PhpParser\Node\NodeFactory;
|
|
use Rector\Core\PhpParser\Node\Value\ValueResolver;
|
|
use Rector\Core\Provider\CurrentFileProvider;
|
|
use Rector\Core\ValueObject\Application\File;
|
|
use Rector\NodeNameResolver\NodeNameResolver;
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
|
use Rector\NodeTypeResolver\NodeTypeResolver;
|
|
use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
|
|
use Rector\Skipper\Skipper\Skipper;
|
|
use Rector\StaticTypeMapper\StaticTypeMapper;
|
|
/**
|
|
* @property-read PhpDocInfoFactory $phpDocInfoFactory; @deprecated The parent AbstractRector dependency is deprecated and will be removed. Use dependency injection in your own rule instead.
|
|
*
|
|
* @property-read ValueResolver $valueResolver; @deprecated The parent AbstractRector dependency is deprecated and will be removed. Use dependency injection in your own rule instead.
|
|
*
|
|
* @property-read BetterNodeFinder $betterNodeFinder; @deprecated The parent AbstractRector dependency is deprecated and will be removed. Use dependency injection in your own rule instead.
|
|
*
|
|
* @property-read StaticTypeMapper $staticTypeMapper; @deprecated The parent AbstractRector dependency is deprecated and will be removed. Use dependency injection in your own rule instead.
|
|
*/
|
|
abstract class AbstractRector extends NodeVisitorAbstract implements RectorInterface
|
|
{
|
|
/**
|
|
* @var string
|
|
*/
|
|
private const EMPTY_NODE_ARRAY_MESSAGE = <<<CODE_SAMPLE
|
|
Array of nodes cannot be empty. Ensure "%s->refactor()" returns non-empty array for Nodes.
|
|
|
|
A) Direct return null for no change:
|
|
|
|
return null;
|
|
|
|
B) Remove the Node:
|
|
|
|
return NodeTraverser::REMOVE_NODE;
|
|
CODE_SAMPLE;
|
|
/**
|
|
* @var \Rector\NodeNameResolver\NodeNameResolver
|
|
*/
|
|
protected $nodeNameResolver;
|
|
/**
|
|
* @var \Rector\NodeTypeResolver\NodeTypeResolver
|
|
*/
|
|
protected $nodeTypeResolver;
|
|
/**
|
|
* @var \Rector\Core\PhpParser\Node\NodeFactory
|
|
*/
|
|
protected $nodeFactory;
|
|
/**
|
|
* @var \Rector\Core\PhpParser\Comparing\NodeComparator
|
|
*/
|
|
protected $nodeComparator;
|
|
/**
|
|
* @var \Rector\Core\ValueObject\Application\File
|
|
*/
|
|
protected $file;
|
|
/**
|
|
* @var \Rector\Core\Application\ChangedNodeScopeRefresher
|
|
*/
|
|
private $changedNodeScopeRefresher;
|
|
/**
|
|
* @var \Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser
|
|
*/
|
|
private $simpleCallableNodeTraverser;
|
|
/**
|
|
* @var \Rector\Skipper\Skipper\Skipper
|
|
*/
|
|
private $skipper;
|
|
/**
|
|
* @var \Rector\Core\Provider\CurrentFileProvider
|
|
*/
|
|
private $currentFileProvider;
|
|
/**
|
|
* @var array<int, Node[]>
|
|
*/
|
|
private $nodesToReturn = [];
|
|
/**
|
|
* @var \Rector\Core\NodeDecorator\CreatedByRuleDecorator
|
|
*/
|
|
private $createdByRuleDecorator;
|
|
/**
|
|
* @var int|null
|
|
*/
|
|
private $toBeRemovedNodeId;
|
|
/**
|
|
* @var array<string, object>
|
|
*/
|
|
private $deprecatedDependencies = [];
|
|
/**
|
|
* @var array<class-string, array<string, bool>>
|
|
*/
|
|
private $cachedDeprecatedDependenciesWarning = [];
|
|
/**
|
|
* Handle deprecated dependencies compatbility
|
|
* @return mixed
|
|
*/
|
|
public function __get(string $name)
|
|
{
|
|
if (!isset($this->cachedDeprecatedDependenciesWarning[static::class][$name])) {
|
|
echo \sprintf('Get %s property from AbstractRector on %s is deprecated, inject via __construct() instead', $name, static::class);
|
|
echo \PHP_EOL;
|
|
$this->cachedDeprecatedDependenciesWarning[static::class][$name] = \true;
|
|
}
|
|
return $this->deprecatedDependencies[$name] ?? null;
|
|
}
|
|
public function autowire(NodeNameResolver $nodeNameResolver, NodeTypeResolver $nodeTypeResolver, SimpleCallableNodeTraverser $simpleCallableNodeTraverser, NodeFactory $nodeFactory, PhpDocInfoFactory $phpDocInfoFactory, StaticTypeMapper $staticTypeMapper, Skipper $skipper, ValueResolver $valueResolver, BetterNodeFinder $betterNodeFinder, NodeComparator $nodeComparator, CurrentFileProvider $currentFileProvider, CreatedByRuleDecorator $createdByRuleDecorator, ChangedNodeScopeRefresher $changedNodeScopeRefresher) : void
|
|
{
|
|
$this->nodeNameResolver = $nodeNameResolver;
|
|
$this->nodeTypeResolver = $nodeTypeResolver;
|
|
$this->simpleCallableNodeTraverser = $simpleCallableNodeTraverser;
|
|
$this->nodeFactory = $nodeFactory;
|
|
$this->skipper = $skipper;
|
|
$this->nodeComparator = $nodeComparator;
|
|
$this->currentFileProvider = $currentFileProvider;
|
|
$this->createdByRuleDecorator = $createdByRuleDecorator;
|
|
$this->changedNodeScopeRefresher = $changedNodeScopeRefresher;
|
|
$this->deprecatedDependencies['phpDocInfoFactory'] = $phpDocInfoFactory;
|
|
$this->deprecatedDependencies['valueResolver'] = $valueResolver;
|
|
$this->deprecatedDependencies['betterNodeFinder'] = $betterNodeFinder;
|
|
$this->deprecatedDependencies['staticTypeMapper'] = $staticTypeMapper;
|
|
}
|
|
/**
|
|
* @return Node[]|null
|
|
*/
|
|
public function beforeTraverse(array $nodes) : ?array
|
|
{
|
|
// workaround for file around refactor()
|
|
$file = $this->currentFileProvider->getFile();
|
|
if (!$file instanceof File) {
|
|
throw new ShouldNotHappenException('File object is missing. Make sure you call $this->currentFileProvider->setFile(...) before traversing.');
|
|
}
|
|
$this->file = $file;
|
|
return parent::beforeTraverse($nodes);
|
|
}
|
|
/**
|
|
* @return int|\PhpParser\Node|null
|
|
*/
|
|
public final function enterNode(Node $node)
|
|
{
|
|
if (!$this->isMatchingNodeType($node)) {
|
|
return null;
|
|
}
|
|
$filePath = $this->file->getFilePath();
|
|
if ($this->skipper->shouldSkipCurrentNode($this, $filePath, static::class, $node)) {
|
|
return null;
|
|
}
|
|
$this->changedNodeScopeRefresher->reIndexNodeAttributes($node);
|
|
// ensure origNode pulled before refactor to avoid changed during refactor, ref https://3v4l.org/YMEGN
|
|
$originalNode = $node->getAttribute(AttributeKey::ORIGINAL_NODE) ?? $node;
|
|
$refactoredNode = $this->refactor($node);
|
|
// @see NodeTraverser::* codes, e.g. removal of node of stopping the traversing
|
|
if ($refactoredNode === NodeTraverser::REMOVE_NODE) {
|
|
$this->toBeRemovedNodeId = \spl_object_id($originalNode);
|
|
// notify this rule changing code
|
|
$rectorWithLineChange = new RectorWithLineChange(static::class, $originalNode->getLine());
|
|
$this->file->addRectorClassWithLine($rectorWithLineChange);
|
|
return $originalNode;
|
|
}
|
|
if (\is_int($refactoredNode)) {
|
|
$this->createdByRuleDecorator->decorate($node, $originalNode, static::class);
|
|
if (!\in_array($refactoredNode, [NodeTraverser::DONT_TRAVERSE_CHILDREN, NodeTraverser::DONT_TRAVERSE_CURRENT_AND_CHILDREN], \true)) {
|
|
// notify this rule changing code
|
|
$rectorWithLineChange = new RectorWithLineChange(static::class, $originalNode->getLine());
|
|
$this->file->addRectorClassWithLine($rectorWithLineChange);
|
|
return $refactoredNode;
|
|
}
|
|
$this->decorateCurrentAndChildren($node);
|
|
return null;
|
|
}
|
|
// nothing to change → continue
|
|
if ($refactoredNode === null) {
|
|
return null;
|
|
}
|
|
if ($refactoredNode === []) {
|
|
$errorMessage = \sprintf(self::EMPTY_NODE_ARRAY_MESSAGE, static::class);
|
|
throw new ShouldNotHappenException($errorMessage);
|
|
}
|
|
return $this->postRefactorProcess($originalNode, $node, $refactoredNode, $filePath);
|
|
}
|
|
/**
|
|
* Replacing nodes in leaveNode() method avoids infinite recursion
|
|
* see"infinite recursion" in https://github.com/nikic/PHP-Parser/blob/master/doc/component/Walking_the_AST.markdown
|
|
* @return mixed[]|int|\PhpParser\Node|null
|
|
*/
|
|
public function leaveNode(Node $node)
|
|
{
|
|
if ($node->hasAttribute(AttributeKey::ORIGINAL_NODE)) {
|
|
return null;
|
|
}
|
|
$objectId = \spl_object_id($node);
|
|
if ($this->toBeRemovedNodeId === $objectId) {
|
|
$this->toBeRemovedNodeId = null;
|
|
return NodeTraverser::REMOVE_NODE;
|
|
}
|
|
return $this->nodesToReturn[$objectId] ?? $node;
|
|
}
|
|
protected function isName(Node $node, string $name) : bool
|
|
{
|
|
return $this->nodeNameResolver->isName($node, $name);
|
|
}
|
|
/**
|
|
* @param string[] $names
|
|
*/
|
|
protected function isNames(Node $node, array $names) : bool
|
|
{
|
|
return $this->nodeNameResolver->isNames($node, $names);
|
|
}
|
|
protected function getName(Node $node) : ?string
|
|
{
|
|
return $this->nodeNameResolver->getName($node);
|
|
}
|
|
protected function isObjectType(Node $node, ObjectType $objectType) : bool
|
|
{
|
|
return $this->nodeTypeResolver->isObjectType($node, $objectType);
|
|
}
|
|
/**
|
|
* Use this method for getting expr|node type
|
|
*/
|
|
protected function getType(Node $node) : Type
|
|
{
|
|
return $this->nodeTypeResolver->getType($node);
|
|
}
|
|
/**
|
|
* @param Node|Node[] $nodes
|
|
* @param callable(Node): (int|Node|null|Node[]) $callable
|
|
*/
|
|
protected function traverseNodesWithCallable($nodes, callable $callable) : void
|
|
{
|
|
$this->simpleCallableNodeTraverser->traverseNodesWithCallable($nodes, $callable);
|
|
}
|
|
protected function mirrorComments(Node $newNode, Node $oldNode) : void
|
|
{
|
|
if ($this->nodeComparator->areSameNode($newNode, $oldNode)) {
|
|
return;
|
|
}
|
|
if ($oldNode instanceof InlineHTML) {
|
|
return;
|
|
}
|
|
$newNode->setAttribute(AttributeKey::PHP_DOC_INFO, $oldNode->getAttribute(AttributeKey::PHP_DOC_INFO));
|
|
if (!$newNode instanceof Nop) {
|
|
$newNode->setAttribute(AttributeKey::COMMENTS, $oldNode->getAttribute(AttributeKey::COMMENTS));
|
|
}
|
|
}
|
|
private function decorateCurrentAndChildren(Node $node) : void
|
|
{
|
|
// filter only types that
|
|
// 1. registered in getNodesTypes() method
|
|
// 2. different with current node type, as already decorated above
|
|
//
|
|
$otherTypes = \array_filter($this->getNodeTypes(), static function (string $nodeType) use($node) : bool {
|
|
return $nodeType !== \get_class($node);
|
|
});
|
|
if ($otherTypes === []) {
|
|
return;
|
|
}
|
|
$this->traverseNodesWithCallable($node, static function (Node $subNode) use($otherTypes) {
|
|
if (\in_array(\get_class($subNode), $otherTypes, \true)) {
|
|
$subNode->setAttribute(AttributeKey::SKIPPED_BY_RECTOR_RULE, static::class);
|
|
}
|
|
return null;
|
|
});
|
|
}
|
|
/**
|
|
* @param Node|Node[] $refactoredNode
|
|
*/
|
|
private function postRefactorProcess(Node $originalNode, Node $node, $refactoredNode, string $filePath) : Node
|
|
{
|
|
/** @var non-empty-array<Node>|Node $refactoredNode */
|
|
$this->createdByRuleDecorator->decorate($refactoredNode, $originalNode, static::class);
|
|
$rectorWithLineChange = new RectorWithLineChange(static::class, $originalNode->getLine());
|
|
$this->file->addRectorClassWithLine($rectorWithLineChange);
|
|
/** @var MutatingScope|null $currentScope */
|
|
$currentScope = $node->getAttribute(AttributeKey::SCOPE);
|
|
if (\is_array($refactoredNode)) {
|
|
$firstNode = \current($refactoredNode);
|
|
$this->mirrorComments($firstNode, $originalNode);
|
|
$this->refreshScopeNodes($refactoredNode, $filePath, $currentScope);
|
|
// search "infinite recursion" in https://github.com/nikic/PHP-Parser/blob/master/doc/component/Walking_the_AST.markdown
|
|
$originalNodeId = \spl_object_id($originalNode);
|
|
// will be replaced in leaveNode() the original node must be passed
|
|
$this->nodesToReturn[$originalNodeId] = $refactoredNode;
|
|
return $originalNode;
|
|
}
|
|
$this->refreshScopeNodes($refactoredNode, $filePath, $currentScope);
|
|
return $refactoredNode;
|
|
}
|
|
/**
|
|
* @param Node[]|Node $node
|
|
*/
|
|
private function refreshScopeNodes($node, string $filePath, ?MutatingScope $mutatingScope) : void
|
|
{
|
|
$nodes = $node instanceof Node ? [$node] : $node;
|
|
foreach ($nodes as $node) {
|
|
$this->changedNodeScopeRefresher->refresh($node, $filePath, $mutatingScope);
|
|
}
|
|
}
|
|
private function isMatchingNodeType(Node $node) : bool
|
|
{
|
|
$nodeClass = \get_class($node);
|
|
foreach ($this->getNodeTypes() as $nodeType) {
|
|
if (\is_a($nodeClass, $nodeType, \true)) {
|
|
return \true;
|
|
}
|
|
}
|
|
return \false;
|
|
}
|
|
}
|