Skip to content

Commit

Permalink
Updated Rector to commit 4399f28
Browse files Browse the repository at this point in the history
rectorphp/rector-src@4399f28 [Core] Apply CREATED_BY_RULE attribute as array collection of applied Rector rule (#1600)
  • Loading branch information
TomasVotruba committed Dec 31, 2021
1 parent b1cba49 commit fd3e742
Show file tree
Hide file tree
Showing 13 changed files with 93 additions and 57 deletions.
4 changes: 2 additions & 2 deletions rules/DeadCode/NodeAnalyzer/ExprUsedInNextNodeAnalyzer.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public function isUsed(\PhpParser\Node\Expr $expr) : bool
}
private function hasIfChangedByRemoveAlwaysElseRector(\PhpParser\Node\Stmt\If_ $if) : bool
{
$createdByRule = $if->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::CREATED_BY_RULE);
return $createdByRule === \Rector\EarlyReturn\Rector\If_\RemoveAlwaysElseRector::class;
$createdByRule = $if->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::CREATED_BY_RULE) ?? [];
return \in_array(\Rector\EarlyReturn\Rector\If_\RemoveAlwaysElseRector::class, $createdByRule, \true);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -82,23 +82,21 @@ public function refactor(\PhpParser\Node $node)
if (!isset($args[1])) {
return null;
}
$createdByRule = $node->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::CREATED_BY_RULE);
if ($createdByRule === self::class) {
$createdByRule = $node->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::CREATED_BY_RULE) ?? [];
if (\in_array(self::class, $createdByRule, \true)) {
return null;
}
// direct null check ConstFetch
if ($args[1]->value instanceof \PhpParser\Node\Expr\ConstFetch && $this->valueResolver->isNull($args[1]->value)) {
$args = [$args[0]];
$node->args = $args;
$node->setAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::CREATED_BY_RULE, self::class);
return $node;
}
if ($this->shouldSkipSecondArg($args[1]->value)) {
return null;
}
$node->args[1] = new \PhpParser\Node\Arg($this->createNewArgFirstTernary($args));
$node->args[2] = new \PhpParser\Node\Arg($this->createNewArgSecondTernary($args));
$node->setAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::CREATED_BY_RULE, self::class);
return $node;
}
private function shouldSkipSecondArg(\PhpParser\Node\Expr $expr) : bool
Expand Down
3 changes: 0 additions & 3 deletions rules/EarlyReturn/Rector/If_/RemoveAlwaysElseRector.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
use PhpParser\Node\Stmt\Return_;
use PhpParser\Node\Stmt\Throw_;
use Rector\Core\Rector\AbstractRector;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
Expand Down Expand Up @@ -70,7 +69,6 @@ public function refactor(\PhpParser\Node $node) : ?\PhpParser\Node
$originalNode = clone $node;
$if = new \PhpParser\Node\Stmt\If_($node->cond);
$if->stmts = $node->stmts;
$node->setAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::CREATED_BY_RULE, self::class);
$this->nodesToAddCollector->addNodeBeforeNode($if, $node);
$this->mirrorComments($if, $node);
/** @var ElseIf_ $firstElseIf */
Expand All @@ -91,7 +89,6 @@ public function refactor(\PhpParser\Node $node) : ?\PhpParser\Node
if ($node->else !== null) {
$this->nodesToAddCollector->addNodesAfterNode($node->else->stmts, $node);
$node->else = null;
$node->setAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::CREATED_BY_RULE, self::class);
return $node;
}
return null;
Expand Down
4 changes: 2 additions & 2 deletions src/Application/VersionResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ final class VersionResolver
/**
* @var string
*/
public const PACKAGE_VERSION = '311ffc6ec3270cef54b3e243cf042d247195b6ac';
public const PACKAGE_VERSION = '4399f28ee1aeec1bfe4446a97d741cee60c5eaf5';
/**
* @var string
*/
public const RELEASE_DATE = '2021-12-31 15:52:50';
public const RELEASE_DATE = '2021-12-31 11:23:19';
public static function resolvePackageVersion() : string
{
$process = new \RectorPrefix20211231\Symfony\Component\Process\Process(['git', 'log', '--pretty="%H"', '-n1', 'HEAD'], __DIR__);
Expand Down
16 changes: 16 additions & 0 deletions src/NodeDecorator/CreatedByRuleDecorator.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?php

declare (strict_types=1);
namespace Rector\Core\NodeDecorator;

use PhpParser\Node;
use Rector\NodeTypeResolver\Node\AttributeKey;
final class CreatedByRuleDecorator
{
public function decorate(\PhpParser\Node $node, string $rectorClass) : void
{
$mergeCreatedByRule = \array_merge($node->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::CREATED_BY_RULE) ?? [], [$rectorClass]);
$mergeCreatedByRule = \array_unique($mergeCreatedByRule);
$node->setAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::CREATED_BY_RULE, $mergeCreatedByRule);
}
}
12 changes: 9 additions & 3 deletions src/PhpParser/NodeVisitor/CreatedByRuleNodeVisitor.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,27 @@

use PhpParser\Node;
use PhpParser\NodeVisitorAbstract;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\Core\NodeDecorator\CreatedByRuleDecorator;
final class CreatedByRuleNodeVisitor extends \PhpParser\NodeVisitorAbstract
{
/**
* @readonly
* @var \Rector\Core\NodeDecorator\CreatedByRuleDecorator
*/
private $createdByRuleDecorator;
/**
* @readonly
* @var string
*/
private $rectorClass;
public function __construct(string $rectorClass)
public function __construct(\Rector\Core\NodeDecorator\CreatedByRuleDecorator $createdByRuleDecorator, string $rectorClass)
{
$this->createdByRuleDecorator = $createdByRuleDecorator;
$this->rectorClass = $rectorClass;
}
public function enterNode(\PhpParser\Node $node)
{
$node->setAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::CREATED_BY_RULE, $this->rectorClass);
$this->createdByRuleDecorator->decorate($node, $this->rectorClass);
return $node;
}
}
54 changes: 32 additions & 22 deletions src/Rector/AbstractRector.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
use Rector\Core\Exclusion\ExclusionManager;
use Rector\Core\Logging\CurrentRectorProvider;
use Rector\Core\NodeAnalyzer\ChangedNodeAnalyzer;
use Rector\Core\NodeDecorator\CreatedByRuleDecorator;
use Rector\Core\Php\PhpVersionProvider;
use Rector\Core\PhpParser\Comparing\NodeComparator;
use Rector\Core\PhpParser\Node\BetterNodeFinder;
Expand Down Expand Up @@ -170,10 +171,14 @@ abstract class AbstractRector extends \PhpParser\NodeVisitorAbstract implements
* @var \Rector\Core\ProcessAnalyzer\RectifiedAnalyzer
*/
private $rectifiedAnalyzer;
/**
* @var \Rector\Core\NodeDecorator\CreatedByRuleDecorator
*/
private $createdByRuleDecorator;
/**
* @required
*/
public function autowire(\Rector\PostRector\Collector\NodesToRemoveCollector $nodesToRemoveCollector, \Rector\PostRector\Collector\NodesToAddCollector $nodesToAddCollector, \Rector\NodeRemoval\NodeRemover $nodeRemover, \Rector\Core\Application\FileSystem\RemovedAndAddedFilesCollector $removedAndAddedFilesCollector, \Rector\Core\PhpParser\Printer\BetterStandardPrinter $betterStandardPrinter, \Rector\NodeNameResolver\NodeNameResolver $nodeNameResolver, \Rector\NodeTypeResolver\NodeTypeResolver $nodeTypeResolver, \RectorPrefix20211231\Symplify\Astral\NodeTraverser\SimpleCallableNodeTraverser $simpleCallableNodeTraverser, \Rector\Core\PhpParser\Node\NodeFactory $nodeFactory, \Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory $phpDocInfoFactory, \RectorPrefix20211231\Symfony\Component\Console\Style\SymfonyStyle $symfonyStyle, \Rector\Core\Php\PhpVersionProvider $phpVersionProvider, \Rector\Core\Exclusion\ExclusionManager $exclusionManager, \Rector\StaticTypeMapper\StaticTypeMapper $staticTypeMapper, \RectorPrefix20211231\Symplify\PackageBuilder\Parameter\ParameterProvider $parameterProvider, \Rector\Core\Logging\CurrentRectorProvider $currentRectorProvider, \Rector\Core\Configuration\CurrentNodeProvider $currentNodeProvider, \RectorPrefix20211231\Symplify\Skipper\Skipper\Skipper $skipper, \Rector\Core\PhpParser\Node\Value\ValueResolver $valueResolver, \Rector\Core\PhpParser\Node\BetterNodeFinder $betterNodeFinder, \Rector\Core\PhpParser\Comparing\NodeComparator $nodeComparator, \Rector\Core\Provider\CurrentFileProvider $currentFileProvider, \Rector\Core\NodeAnalyzer\ChangedNodeAnalyzer $changedNodeAnalyzer, \Rector\Core\Validation\InfiniteLoopValidator $infiniteLoopValidator, \Rector\Core\ProcessAnalyzer\RectifiedAnalyzer $rectifiedAnalyzer) : void
public function autowire(\Rector\PostRector\Collector\NodesToRemoveCollector $nodesToRemoveCollector, \Rector\PostRector\Collector\NodesToAddCollector $nodesToAddCollector, \Rector\NodeRemoval\NodeRemover $nodeRemover, \Rector\Core\Application\FileSystem\RemovedAndAddedFilesCollector $removedAndAddedFilesCollector, \Rector\Core\PhpParser\Printer\BetterStandardPrinter $betterStandardPrinter, \Rector\NodeNameResolver\NodeNameResolver $nodeNameResolver, \Rector\NodeTypeResolver\NodeTypeResolver $nodeTypeResolver, \RectorPrefix20211231\Symplify\Astral\NodeTraverser\SimpleCallableNodeTraverser $simpleCallableNodeTraverser, \Rector\Core\PhpParser\Node\NodeFactory $nodeFactory, \Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory $phpDocInfoFactory, \RectorPrefix20211231\Symfony\Component\Console\Style\SymfonyStyle $symfonyStyle, \Rector\Core\Php\PhpVersionProvider $phpVersionProvider, \Rector\Core\Exclusion\ExclusionManager $exclusionManager, \Rector\StaticTypeMapper\StaticTypeMapper $staticTypeMapper, \RectorPrefix20211231\Symplify\PackageBuilder\Parameter\ParameterProvider $parameterProvider, \Rector\Core\Logging\CurrentRectorProvider $currentRectorProvider, \Rector\Core\Configuration\CurrentNodeProvider $currentNodeProvider, \RectorPrefix20211231\Symplify\Skipper\Skipper\Skipper $skipper, \Rector\Core\PhpParser\Node\Value\ValueResolver $valueResolver, \Rector\Core\PhpParser\Node\BetterNodeFinder $betterNodeFinder, \Rector\Core\PhpParser\Comparing\NodeComparator $nodeComparator, \Rector\Core\Provider\CurrentFileProvider $currentFileProvider, \Rector\Core\NodeAnalyzer\ChangedNodeAnalyzer $changedNodeAnalyzer, \Rector\Core\Validation\InfiniteLoopValidator $infiniteLoopValidator, \Rector\Core\ProcessAnalyzer\RectifiedAnalyzer $rectifiedAnalyzer, \Rector\Core\NodeDecorator\CreatedByRuleDecorator $createdByRuleDecorator) : void
{
$this->nodesToRemoveCollector = $nodesToRemoveCollector;
$this->nodesToAddCollector = $nodesToAddCollector;
Expand All @@ -200,6 +205,7 @@ public function autowire(\Rector\PostRector\Collector\NodesToRemoveCollector $no
$this->changedNodeAnalyzer = $changedNodeAnalyzer;
$this->infiniteLoopValidator = $infiniteLoopValidator;
$this->rectifiedAnalyzer = $rectifiedAnalyzer;
$this->createdByRuleDecorator = $createdByRuleDecorator;
}
/**
* @return Node[]|null
Expand Down Expand Up @@ -235,7 +241,12 @@ public final function enterNode(\PhpParser\Node $node)
$originalAttributes = $node->getAttributes();
$originalNode = $node->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::ORIGINAL_NODE) ?? clone $node;
$node = $this->refactor($node);
// nothing to change → continue
if ($node === null) {
return null;
}
if (\is_array($node)) {
$this->createdByRuleDecorator->decorate($originalNode, static::class);
$originalNodeHash = \spl_object_hash($originalNode);
$this->nodesToReturn[$originalNodeHash] = $node;
if ($node !== []) {
Expand All @@ -246,29 +257,28 @@ public final function enterNode(\PhpParser\Node $node)
// will be replaced in leaveNode() the original node must be passed
return $originalNode;
}
// nothing to change → continue
if (!$node instanceof \PhpParser\Node) {
return null;
// not changed, return node early
if (!$this->changedNodeAnalyzer->hasNodeChanged($originalNode, $node)) {
return $node;
}
// changed!
if ($this->changedNodeAnalyzer->hasNodeChanged($originalNode, $node)) {
$rectorWithLineChange = new \Rector\ChangesReporting\ValueObject\RectorWithLineChange(\get_class($this), $originalNode->getLine());
$this->file->addRectorClassWithLine($rectorWithLineChange);
// update parents relations - must run before connectParentNodes()
$this->mirrorAttributes($originalAttributes, $node);
$this->connectParentNodes($node);
// is different node type? do not traverse children to avoid looping
if (\get_class($originalNode) !== \get_class($node)) {
$this->infiniteLoopValidator->process($node, $originalNode, static::class);
// 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 \PhpParser\Node\Stmt && $node instanceof \PhpParser\Node\Expr) {
$node = new \PhpParser\Node\Stmt\Expression($node);
}
$this->nodesToReturn[$originalNodeHash] = $node;
return $node;
}
$this->createdByRuleDecorator->decorate($node, static::class);
$rectorWithLineChange = new \Rector\ChangesReporting\ValueObject\RectorWithLineChange(\get_class($this), $originalNode->getLine());
$this->file->addRectorClassWithLine($rectorWithLineChange);
// update parents relations - must run before connectParentNodes()
$this->mirrorAttributes($originalAttributes, $node);
$this->connectParentNodes($node);
// is equals node type? return node early
if (\get_class($originalNode) === \get_class($node)) {
return $node;
}
// is different node type? do not traverse children to avoid looping
$this->infiniteLoopValidator->process($node, $originalNode, static::class);
// 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 \PhpParser\Node\Stmt && $node instanceof \PhpParser\Node\Expr) {
$node = new \PhpParser\Node\Stmt\Expression($node);
}
$this->nodesToReturn[$originalNodeHash] = $node;
return $node;
}
/**
Expand Down
15 changes: 11 additions & 4 deletions src/Validation/InfiniteLoopValidator.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use PhpParser\NodeTraverser;
use Rector\Core\Contract\Rector\RectorInterface;
use Rector\Core\Exception\NodeTraverser\InfiniteLoopTraversingException;
use Rector\Core\NodeDecorator\CreatedByRuleDecorator;
use Rector\Core\PhpParser\Node\BetterNodeFinder;
use Rector\Core\PhpParser\NodeVisitor\CreatedByRuleNodeVisitor;
use Rector\DowngradePhp74\Rector\ArrowFunction\ArrowFunctionToAnonymousFunctionRector;
Expand All @@ -24,9 +25,15 @@ final class InfiniteLoopValidator
* @var \Rector\Core\PhpParser\Node\BetterNodeFinder
*/
private $betterNodeFinder;
public function __construct(\Rector\Core\PhpParser\Node\BetterNodeFinder $betterNodeFinder)
/**
* @readonly
* @var \Rector\Core\NodeDecorator\CreatedByRuleDecorator
*/
private $createdByRuleDecorator;
public function __construct(\Rector\Core\PhpParser\Node\BetterNodeFinder $betterNodeFinder, \Rector\Core\NodeDecorator\CreatedByRuleDecorator $createdByRuleDecorator)
{
$this->betterNodeFinder = $betterNodeFinder;
$this->createdByRuleDecorator = $createdByRuleDecorator;
}
/**
* @param class-string<RectorInterface> $rectorClass
Expand All @@ -36,9 +43,9 @@ public function process(\PhpParser\Node $node, \PhpParser\Node $originalNode, st
if (\in_array($rectorClass, self::ALLOWED_INFINITE_RECTOR_CLASSES, \true)) {
return;
}
$createdByRule = $originalNode->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::CREATED_BY_RULE);
$createdByRule = $originalNode->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::CREATED_BY_RULE) ?? [];
// special case
if ($createdByRule === $rectorClass) {
if (\in_array($rectorClass, $createdByRule, \true)) {
// does it contain the same node type as input?
$originalNodeClass = \get_class($originalNode);
$hasNestedOriginalNodeType = $this->betterNodeFinder->findInstanceOf($node, $originalNodeClass);
Expand All @@ -54,7 +61,7 @@ public function process(\PhpParser\Node $node, \PhpParser\Node $originalNode, st
private function decorateNode(\PhpParser\Node $node, string $rectorClass) : void
{
$nodeTraverser = new \PhpParser\NodeTraverser();
$createdByRuleNodeVisitor = new \Rector\Core\PhpParser\NodeVisitor\CreatedByRuleNodeVisitor($rectorClass);
$createdByRuleNodeVisitor = new \Rector\Core\PhpParser\NodeVisitor\CreatedByRuleNodeVisitor($this->createdByRuleDecorator, $rectorClass);
$nodeTraverser->addVisitor($createdByRuleNodeVisitor);
$nodeTraverser->traverse([$node]);
}
Expand Down
2 changes: 1 addition & 1 deletion vendor/autoload.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

require_once __DIR__ . '/composer/autoload_real.php';

return ComposerAutoloaderInit7f0a65a2c8923817a71d3b6fea426d18::getLoader();
return ComposerAutoloaderInite97b4cfe3136a985b3f861761a5bbc76::getLoader();
1 change: 1 addition & 0 deletions vendor/composer/autoload_classmap.php
Original file line number Diff line number Diff line change
Expand Up @@ -1696,6 +1696,7 @@
'Rector\\Core\\NodeAnalyzer\\PropertyPresenceChecker' => $baseDir . '/src/NodeAnalyzer/PropertyPresenceChecker.php',
'Rector\\Core\\NodeAnalyzer\\VariableAnalyzer' => $baseDir . '/src/NodeAnalyzer/VariableAnalyzer.php',
'Rector\\Core\\NodeAnalyzer\\VariadicAnalyzer' => $baseDir . '/src/NodeAnalyzer/VariadicAnalyzer.php',
'Rector\\Core\\NodeDecorator\\CreatedByRuleDecorator' => $baseDir . '/src/NodeDecorator/CreatedByRuleDecorator.php',
'Rector\\Core\\NodeDecorator\\NamespacedNameDecorator' => $baseDir . '/src/NodeDecorator/NamespacedNameDecorator.php',
'Rector\\Core\\NodeDecorator\\PropertyTypeDecorator' => $baseDir . '/src/NodeDecorator/PropertyTypeDecorator.php',
'Rector\\Core\\NodeManipulator\\ArrayDestructVariableFilter' => $baseDir . '/src/NodeManipulator/ArrayDestructVariableFilter.php',
Expand Down
Loading

0 comments on commit fd3e742

Please sign in to comment.