Skip to content

Commit 8d22ced

Browse files
authored
[dead-code] Add RemoveUnusedVariableUseRector (#7430)
1 parent 3b17178 commit 8d22ced

File tree

6 files changed

+178
-0
lines changed

6 files changed

+178
-0
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?php
2+
3+
namespace Rector\Tests\DeadCode\Rector\Closure\RemoveUnusedClosureVariableUseRector\Fixture;
4+
5+
class Fixture
6+
{
7+
public function run($value)
8+
{
9+
return function () use ($value) {
10+
return 'value';
11+
};
12+
}
13+
}
14+
15+
?>
16+
-----
17+
<?php
18+
19+
namespace Rector\Tests\DeadCode\Rector\Closure\RemoveUnusedClosureVariableUseRector\Fixture;
20+
21+
class Fixture
22+
{
23+
public function run($value)
24+
{
25+
return function () {
26+
return 'value';
27+
};
28+
}
29+
}
30+
31+
?>
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<?php
2+
3+
namespace Rector\Tests\DeadCode\Rector\Closure\RemoveUnusedClosureVariableUseRector\Fixture;
4+
5+
final class SkipUsedVariable
6+
{
7+
public function run($value)
8+
{
9+
return function () use ($value) {
10+
$result = $value + 100;
11+
12+
return $result;
13+
};
14+
}
15+
}
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Tests\DeadCode\Rector\Closure\RemoveUnusedClosureVariableUseRector;
6+
7+
use Iterator;
8+
use PHPUnit\Framework\Attributes\DataProvider;
9+
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
10+
11+
final class RemoveUnusedClosureVariableUseRectorTest extends AbstractRectorTestCase
12+
{
13+
#[DataProvider('provideData')]
14+
public function test(string $filePath): void
15+
{
16+
$this->doTestFile($filePath);
17+
}
18+
19+
public static function provideData(): Iterator
20+
{
21+
return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
22+
}
23+
24+
public function provideConfigFilePath(): string
25+
{
26+
return __DIR__ . '/config/configured_rule.php';
27+
}
28+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use Rector\Config\RectorConfig;
6+
use Rector\DeadCode\Rector\Concat\RemoveUnusedClosureVariableUseRector;
7+
8+
return RectorConfig::configure()
9+
->withRules([RemoveUnusedClosureVariableUseRector::class]);
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\DeadCode\Rector\Concat;
6+
7+
use PhpParser\Node;
8+
use PhpParser\Node\Expr\Closure;
9+
use Rector\PhpParser\Node\BetterNodeFinder;
10+
use Rector\Rector\AbstractRector;
11+
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
12+
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
13+
14+
/**
15+
* @see \Rector\Tests\DeadCode\Rector\Closure\RemoveUnusedClosureVariableUseRector\RemoveUnusedClosureVariableUseRectorTest
16+
*/
17+
final class RemoveUnusedClosureVariableUseRector extends AbstractRector
18+
{
19+
public function __construct(
20+
private readonly BetterNodeFinder $betterNodeFinder
21+
) {
22+
}
23+
24+
public function getRuleDefinition(): RuleDefinition
25+
{
26+
return new RuleDefinition('Remove unused variable in use() of closure', [
27+
new CodeSample(
28+
<<<'CODE_SAMPLE'
29+
$var = 1;
30+
31+
$closure = function() use ($var) {
32+
echo 'Hello World';
33+
};
34+
35+
CODE_SAMPLE
36+
37+
,
38+
<<<'CODE_SAMPLE'
39+
$var = 1;
40+
$closure = function() {
41+
echo 'Hello World';
42+
};
43+
44+
CODE_SAMPLE
45+
),
46+
47+
]);
48+
}
49+
50+
/**
51+
* @return array<class-string<Node>>
52+
*/
53+
public function getNodeTypes(): array
54+
{
55+
return [Closure::class];
56+
}
57+
58+
/**
59+
* @param Closure $node
60+
*/
61+
public function refactor(Node $node): ?Node
62+
{
63+
if ($node->uses === []) {
64+
return null;
65+
}
66+
67+
$hasChanged = false;
68+
69+
foreach ($node->uses as $key => $useVariable) {
70+
$useVariableName = $this->getName($useVariable->var);
71+
if (! is_string($useVariableName)) {
72+
continue;
73+
}
74+
75+
$isUseUsed = (bool) $this->betterNodeFinder->findVariableOfName($node->stmts, $useVariableName);
76+
if ($isUseUsed) {
77+
continue;
78+
}
79+
80+
unset($node->uses[$key]);
81+
$hasChanged = true;
82+
83+
}
84+
85+
if ($hasChanged) {
86+
// reset keys, to keep as expected
87+
$node->uses = array_values($node->uses);
88+
return $node;
89+
}
90+
91+
return null;
92+
}
93+
}

src/Config/Level/DeadCodeLevel.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
use Rector\DeadCode\Rector\ClassMethod\RemoveUselessReturnExprInConstructRector;
2828
use Rector\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector;
2929
use Rector\DeadCode\Rector\Concat\RemoveConcatAutocastRector;
30+
use Rector\DeadCode\Rector\Concat\RemoveUnusedClosureVariableUseRector;
3031
use Rector\DeadCode\Rector\ConstFetch\RemovePhpVersionIdCheckRector;
3132
use Rector\DeadCode\Rector\Expression\RemoveDeadStmtRector;
3233
use Rector\DeadCode\Rector\Expression\SimplifyMirrorAssignRector;
@@ -115,6 +116,7 @@ final class DeadCodeLevel
115116
ReduceAlwaysFalseIfOrRector::class,
116117
RemoveUnusedPrivateClassConstantRector::class,
117118
RemoveUnusedPrivatePropertyRector::class,
119+
RemoveUnusedClosureVariableUseRector::class,
118120

119121
RemoveDuplicatedCaseInSwitchRector::class,
120122
RemoveDeadInstanceOfRector::class,

0 commit comments

Comments
 (0)