Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions phpstan.neon
Original file line number Diff line number Diff line change
Expand Up @@ -379,3 +379,5 @@ parameters:
-
message: '#Property Rector\\PhpParser\\NodeTraverser\\AbstractImmutableNodeTraverser\:\:\$visitors \(list<PhpParser\\NodeVisitor>\) does not accept array<int\|string, PhpParser\\NodeVisitor>#'
path: src/PhpParser/NodeTraverser/AbstractImmutableNodeTraverser.php

- '#Method Rector\\Bridge\\PhpParser\\NodeClassFinder\:\:find\(\) should return array<class\-string<PhpParser\\Node>> but returns array<class\-string>#'
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?php

namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodParameterRector\Fixture;

class RemoveOnCallerViaSelf
{
private static function just_a_test(
string $foo,
array $bar,
$used_parameter
): void {
\external::whatever($foo, $used_parameter);
}

public static function trigger(): void
{
self::just_a_test('hello', [], 'test');
}
}

?>
4 changes: 4 additions & 0 deletions rules/CodeQuality/Rector/If_/SimplifyIfReturnBoolRector.php
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,10 @@ public function refactor(Node $node): ?Node
continue;
}

if ($key === 0) {
continue;
}

$previousStmt = $node->stmts[$key - 1] ?? null;
if (! $previousStmt instanceof If_) {
continue;
Expand Down
49 changes: 49 additions & 0 deletions src/Bridge/PhpParser/NodeClassFinder.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<?php

declare(strict_types=1);

namespace Rector\Bridge\PhpParser;

use PhpParser\Node;
use Nette\Loaders\RobotLoader;
use PHPStan\Node\AnonymousClassNode;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use ReflectionClass;

final class NodeClassFinder
{
/**
* @return array<class-string<Node>>
*/
public static function find(): array
{
$robotLoader = new RobotLoader();
$robotLoader->acceptFiles = ['*.php'];

$phpParserNodeDirectory = __DIR__ . '/../../../vendor/nikic/php-parser/lib/PhpParser/Node/';
$robotLoader->addDirectory($phpParserNodeDirectory);

$robotLoader->setTempDirectory(sys_get_temp_dir() . '/node-classes');
$robotLoader->refresh();

/** @var array<class-string> $nodeClasses */
$nodeClasses = array_keys($robotLoader->getIndexedClasses());

$instantiableNodeClasses = array_filter($nodeClasses, function (string $nodeClass): bool {
$reflectionClass = new ReflectionClass($nodeClass);
if ($reflectionClass->isAbstract()) {
return false;
}

return ! $reflectionClass->isInterface();
});

// this is needed, as PHPStan replaces the Class_ node of anonymous class completely
// @see https://github.com/phpstan/phpstan-src/blob/2.1.x/src/Parser/AnonymousClassVisitor.php
$specialPHPStanNodes = [AnonymousClassNode::class];

$specialRectorNodes = [FileWithoutNamespace::class];

return array_merge($instantiableNodeClasses, $specialPHPStanNodes, $specialRectorNodes);
}
}
8 changes: 6 additions & 2 deletions src/Configuration/ConfigurationRuleFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,11 @@ public function filter(array $rectors): array

$onlyRule = $this->configuration->getOnlyRule();
if ($onlyRule !== null) {
return $this->filterOnlyRule($rectors, $onlyRule);
foreach ($rectors as $rector) {
if ($rector instanceof $onlyRule) {
return [$rector];
}
}
}

return $rectors;
Expand All @@ -46,7 +50,7 @@ public function filterOnlyRule(array $rectors, string $onlyRule): array
$activeRectors = [];
foreach ($rectors as $rector) {
if ($rector instanceof $onlyRule) {
$activeRectors[] = $rector;
return [$rector];
}
}

Expand Down
33 changes: 19 additions & 14 deletions src/PhpParser/NodeTraverser/RectorNodeTraverser.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace Rector\PhpParser\NodeTraverser;

use Rector\Bridge\PhpParser\NodeClassFinder;
use PhpParser\Node;
use PhpParser\Node\Stmt;
use PhpParser\NodeVisitor;
Expand Down Expand Up @@ -63,22 +64,12 @@ public function refreshPhpRectors(array $rectors): void
*/
public function getVisitorsForNode(Node $node): array
{
$nodeClass = $node::class;

if (! isset($this->visitorsPerNodeClass[$nodeClass])) {
$this->visitorsPerNodeClass[$nodeClass] = [];
/** @var RectorInterface $visitor */
foreach ($this->visitors as $visitor) {
foreach ($visitor->getNodeTypes() as $nodeType) {
if (is_a($nodeClass, $nodeType, true)) {
$this->visitorsPerNodeClass[$nodeClass][] = $visitor;
continue 2;
}
}
}
// only in tests
if ($this->areNodeVisitorsPrepared === false) {
$this->prepareNodeVisitors();
}

return $this->visitorsPerNodeClass[$nodeClass];
return $this->visitorsPerNodeClass[$node::class] ?? [];
}

/**
Expand All @@ -94,9 +85,23 @@ private function prepareNodeVisitors(): void

// filer out by version
$this->visitors = $this->phpVersionedFilter->filter($this->rectors);

// filter by configuration
$this->visitors = $this->configurationRuleFilter->filter($this->visitors);

// 1. get all node non-interface, non-abstract classes
// 2. iterate through them
/** @var RectorInterface $visitor */
foreach ($this->visitors as $visitor) {
foreach (NodeClassFinder::find() as $nodeClass) {
foreach ($visitor->getNodeTypes() as $matchingNodeType) {
if (is_a($nodeClass, $matchingNodeType, true)) {
$this->visitorsPerNodeClass[$nodeClass][] = $visitor;
}
}
}
}

$this->areNodeVisitorsPrepared = true;
}
}
7 changes: 6 additions & 1 deletion src/Rector/AbstractRector.php
Original file line number Diff line number Diff line change
Expand Up @@ -191,14 +191,19 @@ final public function enterNode(Node $node): int|Node|null

/**
* 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
* see "infinite recursion" in https://github.com/nikic/PHP-Parser/blob/master/doc/component/Walking_the_AST.markdown
*/
final public function leaveNode(Node $node): array|int|Node|null
{
if ($node->hasAttribute(AttributeKey::ORIGINAL_NODE)) {
return null;
}

// perf: hash node only if there is some object to be removed or replaced by array
if ($this->toBeRemovedNodeId === null && $this->nodesToReturn === []) {
return null;
}

$objectId = spl_object_id($node);
if ($this->toBeRemovedNodeId === $objectId) {
$this->toBeRemovedNodeId = null;
Expand Down
46 changes: 14 additions & 32 deletions tests/PhpParser/NodeTraverser/RectorNodeTraverserTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -39,57 +39,39 @@ protected function setUp(): void
public function testGetVisitorsForNodeWhenNoVisitorsAvailable(): void
{
$class = new Class_('test');
$visitorsForNode = $this->rectorNodeTraverser->getVisitorsForNode($class);

$visitors = $this->rectorNodeTraverser->getVisitorsForNode($class);

$this->assertSame([], $visitors);
$this->assertSame([], $visitorsForNode);
}

public function testGetVisitorsForNodeWhenNoVisitorsMatch(): void
{
$class = new Class_('test');
$this->rectorNodeTraverser->addVisitor($this->ruleUsingFunctionRector);

$visitors = $this->rectorNodeTraverser->getVisitorsForNode($class);
$this->rectorNodeTraverser->refreshPhpRectors([$this->ruleUsingFunctionRector]);

$this->assertSame([], $visitors);
$visitorsForNode = $this->rectorNodeTraverser->getVisitorsForNode($class);
$this->assertSame([], $visitorsForNode);
}

public function testGetVisitorsForNodeWhenSomeVisitorsMatch(): void
{
$class = new Class_('test');
$this->rectorNodeTraverser->addVisitor($this->ruleUsingFunctionRector);
$this->rectorNodeTraverser->addVisitor($this->ruleUsingClassRector);

$visitors = $this->rectorNodeTraverser->getVisitorsForNode($class);
$this->rectorNodeTraverser->refreshPhpRectors([new RuleUsingFunctionRector(), new RuleUsingClassRector()]);

$this->assertEquals([$this->ruleUsingClassRector], $visitors);
$visitorsForNode = $this->rectorNodeTraverser->getVisitorsForNode($class);
$this->assertEquals([$this->ruleUsingClassRector], $visitorsForNode);
}

public function testGetVisitorsForNodeWhenAllVisitorsMatch(): void
{
$class = new Class_('test');
$this->rectorNodeTraverser->addVisitor($this->ruleUsingClassRector);
$this->rectorNodeTraverser->addVisitor($this->ruleUsingClassLikeRector);

$visitors = $this->rectorNodeTraverser->getVisitorsForNode($class);

$this->assertEquals([$this->ruleUsingClassRector, $this->ruleUsingClassLikeRector], $visitors);
}

public function testGetVisitorsForNodeUsesCachedValue(): void
{
$class = new Class_('test');
$this->rectorNodeTraverser->addVisitor($this->ruleUsingClassRector);
$this->rectorNodeTraverser->addVisitor($this->ruleUsingClassLikeRector);

$visitors = $this->rectorNodeTraverser->getVisitorsForNode($class);

$this->assertEquals([$this->ruleUsingClassRector, $this->ruleUsingClassLikeRector], $visitors);

$this->rectorNodeTraverser->removeVisitor($this->ruleUsingClassRector);
$visitors = $this->rectorNodeTraverser->getVisitorsForNode($class);
$this->rectorNodeTraverser->refreshPhpRectors([
$this->ruleUsingClassRector,
$this->ruleUsingClassLikeRector,
]);

$this->assertEquals([$this->ruleUsingClassRector, $this->ruleUsingClassLikeRector], $visitors);
$visitorsForNode = $this->rectorNodeTraverser->getVisitorsForNode($class);
$this->assertEquals([$this->ruleUsingClassRector, $this->ruleUsingClassLikeRector], $visitorsForNode);
}
}
Loading