mirror of
https://github.com/rectorphp/rector.git
synced 2024-06-01 08:50:50 +00:00
397 lines
12 KiB
PHP
397 lines
12 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Rector\Core\Rector;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Arg;
|
|
use PhpParser\Node\Expr;
|
|
use PhpParser\Node\Stmt;
|
|
use PhpParser\Node\Stmt\Expression;
|
|
use PhpParser\NodeTraverser;
|
|
use PhpParser\NodeVisitor\ParentConnectingVisitor;
|
|
use PhpParser\NodeVisitorAbstract;
|
|
use PHPStan\Type\ObjectType;
|
|
use PHPStan\Type\Type;
|
|
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
|
|
use Rector\ChangesReporting\ValueObject\RectorWithLineChange;
|
|
use Rector\Core\Configuration\CurrentNodeProvider;
|
|
use Rector\Core\Contract\Rector\PhpRectorInterface;
|
|
use Rector\Core\Exception\ShouldNotHappenException;
|
|
use Rector\Core\Exclusion\ExclusionManager;
|
|
use Rector\Core\Logging\CurrentRectorProvider;
|
|
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\ProcessAnalyzer\RectifiedAnalyzer;
|
|
use Rector\Core\Provider\CurrentFileProvider;
|
|
use Rector\Core\ValueObject\Application\File;
|
|
use Rector\Core\ValueObject\RectifiedNode;
|
|
use Rector\NodeNameResolver\NodeNameResolver;
|
|
use Rector\NodeRemoval\NodeRemover;
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
|
use Rector\NodeTypeResolver\NodeTypeResolver;
|
|
use Rector\PostRector\Collector\NodesToAddCollector;
|
|
use Rector\PostRector\Collector\NodesToRemoveCollector;
|
|
use Rector\StaticTypeMapper\StaticTypeMapper;
|
|
use Symfony\Contracts\Service\Attribute\Required;
|
|
use Symplify\Astral\NodeTraverser\SimpleCallableNodeTraverser;
|
|
use Symplify\Skipper\Skipper\Skipper;
|
|
|
|
abstract class AbstractRector extends NodeVisitorAbstract implements PhpRectorInterface
|
|
{
|
|
/**
|
|
* @var string[]
|
|
*/
|
|
private const ATTRIBUTES_TO_MIRROR = [
|
|
AttributeKey::SCOPE,
|
|
AttributeKey::RESOLVED_NAME,
|
|
AttributeKey::PARENT_NODE,
|
|
];
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
private const MESSAGE = <<<CODE_SAMPLE
|
|
Array of nodes must not be empty, ensure "%s->refactor()" returns non-empty array for Nodes.
|
|
|
|
You can also either return null for no change:
|
|
|
|
return null;
|
|
|
|
or remove the Node if not needed via
|
|
|
|
\$this->removeNode(\$node);
|
|
return \$node;
|
|
CODE_SAMPLE;
|
|
|
|
protected NodeNameResolver $nodeNameResolver;
|
|
|
|
protected NodeTypeResolver $nodeTypeResolver;
|
|
|
|
protected StaticTypeMapper $staticTypeMapper;
|
|
|
|
protected PhpDocInfoFactory $phpDocInfoFactory;
|
|
|
|
protected NodeFactory $nodeFactory;
|
|
|
|
protected ValueResolver $valueResolver;
|
|
|
|
protected BetterNodeFinder $betterNodeFinder;
|
|
|
|
protected NodeRemover $nodeRemover;
|
|
|
|
protected NodeComparator $nodeComparator;
|
|
|
|
protected NodesToRemoveCollector $nodesToRemoveCollector;
|
|
|
|
protected File $file;
|
|
|
|
protected NodesToAddCollector $nodesToAddCollector;
|
|
|
|
private SimpleCallableNodeTraverser $simpleCallableNodeTraverser;
|
|
|
|
private ExclusionManager $exclusionManager;
|
|
|
|
private CurrentRectorProvider $currentRectorProvider;
|
|
|
|
private CurrentNodeProvider $currentNodeProvider;
|
|
|
|
private Skipper $skipper;
|
|
|
|
private CurrentFileProvider $currentFileProvider;
|
|
|
|
/**
|
|
* @var array<string, Node[]|Node>
|
|
*/
|
|
private array $nodesToReturn = [];
|
|
|
|
private RectifiedAnalyzer $rectifiedAnalyzer;
|
|
|
|
private CreatedByRuleDecorator $createdByRuleDecorator;
|
|
|
|
#[Required]
|
|
public function autowire(
|
|
NodesToRemoveCollector $nodesToRemoveCollector,
|
|
NodesToAddCollector $nodesToAddCollector,
|
|
NodeRemover $nodeRemover,
|
|
NodeNameResolver $nodeNameResolver,
|
|
NodeTypeResolver $nodeTypeResolver,
|
|
SimpleCallableNodeTraverser $simpleCallableNodeTraverser,
|
|
NodeFactory $nodeFactory,
|
|
PhpDocInfoFactory $phpDocInfoFactory,
|
|
ExclusionManager $exclusionManager,
|
|
StaticTypeMapper $staticTypeMapper,
|
|
CurrentRectorProvider $currentRectorProvider,
|
|
CurrentNodeProvider $currentNodeProvider,
|
|
Skipper $skipper,
|
|
ValueResolver $valueResolver,
|
|
BetterNodeFinder $betterNodeFinder,
|
|
NodeComparator $nodeComparator,
|
|
CurrentFileProvider $currentFileProvider,
|
|
RectifiedAnalyzer $rectifiedAnalyzer,
|
|
CreatedByRuleDecorator $createdByRuleDecorator
|
|
): void {
|
|
$this->nodesToRemoveCollector = $nodesToRemoveCollector;
|
|
$this->nodesToAddCollector = $nodesToAddCollector;
|
|
$this->nodeRemover = $nodeRemover;
|
|
$this->nodeNameResolver = $nodeNameResolver;
|
|
$this->nodeTypeResolver = $nodeTypeResolver;
|
|
$this->simpleCallableNodeTraverser = $simpleCallableNodeTraverser;
|
|
$this->nodeFactory = $nodeFactory;
|
|
$this->phpDocInfoFactory = $phpDocInfoFactory;
|
|
$this->exclusionManager = $exclusionManager;
|
|
$this->staticTypeMapper = $staticTypeMapper;
|
|
$this->currentRectorProvider = $currentRectorProvider;
|
|
$this->currentNodeProvider = $currentNodeProvider;
|
|
$this->skipper = $skipper;
|
|
$this->valueResolver = $valueResolver;
|
|
$this->betterNodeFinder = $betterNodeFinder;
|
|
$this->nodeComparator = $nodeComparator;
|
|
$this->currentFileProvider = $currentFileProvider;
|
|
$this->rectifiedAnalyzer = $rectifiedAnalyzer;
|
|
$this->createdByRuleDecorator = $createdByRuleDecorator;
|
|
}
|
|
|
|
/**
|
|
* @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 Node|null
|
|
*/
|
|
final public function enterNode(Node $node)
|
|
{
|
|
$nodeClass = $node::class;
|
|
if (! $this->isMatchingNodeType($nodeClass)) {
|
|
return null;
|
|
}
|
|
|
|
if ($this->shouldSkipCurrentNode($node)) {
|
|
return null;
|
|
}
|
|
|
|
/** @var Node $originalNode */
|
|
$originalNode = $node->getAttribute(AttributeKey::ORIGINAL_NODE) ?? clone $node;
|
|
$createdByRule = $originalNode->getAttribute(AttributeKey::CREATED_BY_RULE) ?? [];
|
|
|
|
if (in_array(static::class, $createdByRule, true)) {
|
|
return null;
|
|
}
|
|
|
|
$this->currentRectorProvider->changeCurrentRector($this);
|
|
// for PHP doc info factory and change notifier
|
|
$this->currentNodeProvider->setNode($node);
|
|
|
|
$originalAttributes = $node->getAttributes();
|
|
|
|
$node = $this->refactor($node);
|
|
|
|
// nothing to change → continue
|
|
if ($node === null) {
|
|
return null;
|
|
}
|
|
|
|
if ($node === []) {
|
|
throw new ShouldNotHappenException(sprintf(self::MESSAGE, static::class));
|
|
}
|
|
|
|
/** @var Node[]|Node $node */
|
|
$this->createdByRuleDecorator->decorate($node, $originalNode, static::class);
|
|
|
|
/** @var Node $originalNode */
|
|
$rectorWithLineChange = new RectorWithLineChange($this::class, $originalNode->getLine());
|
|
$this->file->addRectorClassWithLine($rectorWithLineChange);
|
|
|
|
/** @var Node $originalNode */
|
|
if (is_array($node)) {
|
|
$originalNodeHash = spl_object_hash($originalNode);
|
|
$this->nodesToReturn[$originalNodeHash] = $node;
|
|
|
|
$firstNodeKey = array_key_first($node);
|
|
$this->mirrorComments($node[$firstNodeKey], $originalNode);
|
|
|
|
// will be replaced in leaveNode() the original node must be passed
|
|
return $originalNode;
|
|
}
|
|
|
|
// update parents relations - must run before connectParentNodes()
|
|
/** @var Node $node */
|
|
$this->mirrorAttributes($originalAttributes, $node);
|
|
$this->connectParentNodes($node);
|
|
|
|
// is equals node type? return node early
|
|
if ($originalNode::class === $node::class) {
|
|
return $node;
|
|
}
|
|
|
|
// search "infinite recursion" in https://github.com/nikic/PHP-Parser/blob/master/doc/component/Walking_the_AST.markdown
|
|
$originalNodeHash = spl_object_hash($originalNode);
|
|
|
|
if ($originalNode instanceof Stmt && $node instanceof Expr) {
|
|
$node = new Expression($node);
|
|
}
|
|
|
|
$this->nodesToReturn[$originalNodeHash] = $node;
|
|
|
|
return $node;
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
public function leaveNode(Node $node)
|
|
{
|
|
$objectHash = spl_object_hash($node);
|
|
|
|
// update parents relations!!!
|
|
return $this->nodesToReturn[$objectHash] ?? $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 $node): (Node|null|int) $callable
|
|
*/
|
|
protected function traverseNodesWithCallable(Node | array $nodes, callable $callable): void
|
|
{
|
|
$this->simpleCallableNodeTraverser->traverseNodesWithCallable($nodes, $callable);
|
|
}
|
|
|
|
protected function mirrorComments(Node $newNode, Node $oldNode): void
|
|
{
|
|
$newNode->setAttribute(AttributeKey::PHP_DOC_INFO, $oldNode->getAttribute(AttributeKey::PHP_DOC_INFO));
|
|
$newNode->setAttribute(AttributeKey::COMMENTS, $oldNode->getAttribute(AttributeKey::COMMENTS));
|
|
}
|
|
|
|
/**
|
|
* @param Arg[] $currentArgs
|
|
* @param Arg[] $appendingArgs
|
|
* @return Arg[]
|
|
*/
|
|
protected function appendArgs(array $currentArgs, array $appendingArgs): array
|
|
{
|
|
foreach ($appendingArgs as $appendingArg) {
|
|
$currentArgs[] = new Arg($appendingArg->value);
|
|
}
|
|
|
|
return $currentArgs;
|
|
}
|
|
|
|
protected function unwrapExpression(Stmt $stmt): Expr | Stmt
|
|
{
|
|
if ($stmt instanceof Expression) {
|
|
return $stmt->expr;
|
|
}
|
|
|
|
return $stmt;
|
|
}
|
|
|
|
protected function removeNode(Node $node): void
|
|
{
|
|
$this->nodeRemover->removeNode($node);
|
|
}
|
|
|
|
/**
|
|
* @param class-string<Node> $nodeClass
|
|
*/
|
|
private function isMatchingNodeType(string $nodeClass): bool
|
|
{
|
|
foreach ($this->getNodeTypes() as $nodeType) {
|
|
if (is_a($nodeClass, $nodeType, true)) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
private function shouldSkipCurrentNode(Node $node): bool
|
|
{
|
|
if ($this->nodesToRemoveCollector->isNodeRemoved($node)) {
|
|
return true;
|
|
}
|
|
|
|
if ($this->exclusionManager->isNodeSkippedByRector($node, $this)) {
|
|
return true;
|
|
}
|
|
|
|
$smartFileInfo = $this->file->getSmartFileInfo();
|
|
if ($this->skipper->shouldSkipElementAndFileInfo($this, $smartFileInfo)) {
|
|
return true;
|
|
}
|
|
|
|
$rectifiedNode = $this->rectifiedAnalyzer->verify($this, $node, $this->file);
|
|
return $rectifiedNode instanceof RectifiedNode;
|
|
}
|
|
|
|
/**
|
|
* @param array<string, mixed> $originalAttributes
|
|
*/
|
|
private function mirrorAttributes(array $originalAttributes, Node $newNode): void
|
|
{
|
|
foreach ($originalAttributes as $attributeName => $oldAttributeValue) {
|
|
if (! in_array($attributeName, self::ATTRIBUTES_TO_MIRROR, true)) {
|
|
continue;
|
|
}
|
|
|
|
$newNode->setAttribute($attributeName, $oldAttributeValue);
|
|
}
|
|
}
|
|
|
|
private function connectParentNodes(Node $node): void
|
|
{
|
|
$nodeTraverser = new NodeTraverser();
|
|
$nodeTraverser->addVisitor(new ParentConnectingVisitor());
|
|
$nodeTraverser->traverse([$node]);
|
|
}
|
|
}
|