Skip to content

Commit 749a175

Browse files
calebdwcalebdw
authored
feat: Add AddNameToNullArgumentRector (#8000)
1 parent ee9e4d5 commit 749a175

9 files changed

Lines changed: 355 additions & 147 deletions

File tree

‎rules-tests/CodeQuality/Rector/CallLike/AddNameToNullArgumentRector/AddNameToNullArgumentRectorTest.php‎

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\CodeQuality\Rector\CallLike\AddNameToNullArgumentRector;
6+
7+
use Iterator;
8+
use PHPUnit\Framework\Attributes\DataProvider;
9+
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
10+
11+
final class AddNameToNullArgumentRectorTest 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+
}

‎rules-tests/CodeQuality/Rector/CallLike/AddNameToNullArgumentRector/Fixture/fixture.php.inc‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?php
2+
3+
namespace Rector\Tests\CodeQuality\Rector\CallLike\AddNameToNullArgumentRector\Fixture;
4+
5+
use Rector\Tests\CodeQuality\Rector\CallLike\AddNameToNullArgumentRector\Source\Service;
6+
7+
function (Service $service, string $value): void
8+
{
9+
$service->configure($value, null);
10+
Service::create($value, null);
11+
new Service($value, null);
12+
};
13+
14+
?>
15+
-----
16+
<?php
17+
18+
namespace Rector\Tests\CodeQuality\Rector\CallLike\AddNameToNullArgumentRector\Fixture;
19+
20+
use Rector\Tests\CodeQuality\Rector\CallLike\AddNameToNullArgumentRector\Source\Service;
21+
22+
function (Service $service, string $value): void
23+
{
24+
$service->configure($value, default: null);
25+
Service::create($value, default: null);
26+
new Service($value, default: null);
27+
};
28+
29+
?>

‎rules-tests/CodeQuality/Rector/CallLike/AddNameToNullArgumentRector/Fixture/skip_already_named.php.inc‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?php
2+
3+
namespace Rector\Tests\CodeQuality\Rector\CallLike\AddNameToNullArgumentRector\Fixture;
4+
5+
use Rector\Tests\CodeQuality\Rector\CallLike\AddNameToNullArgumentRector\Source\Service;
6+
7+
function (Service $service, string $value): void
8+
{
9+
$service->configure($value, default: null);
10+
};

‎rules-tests/CodeQuality/Rector/CallLike/AddNameToNullArgumentRector/Fixture/skip_no_null.php.inc‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?php
2+
3+
namespace Rector\Tests\CodeQuality\Rector\CallLike\AddNameToNullArgumentRector\Fixture;
4+
5+
use Rector\Tests\CodeQuality\Rector\CallLike\AddNameToNullArgumentRector\Source\Service;
6+
7+
function (Service $service, string $value): void
8+
{
9+
$service->configure($value, 'some_value');
10+
};

‎rules-tests/CodeQuality/Rector/CallLike/AddNameToNullArgumentRector/Source/Service.php‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Tests\CodeQuality\Rector\CallLike\AddNameToNullArgumentRector\Source;
6+
7+
final class Service
8+
{
9+
public function __construct(string $value, ?string $default, ?string $fallback = null)
10+
{
11+
}
12+
13+
public function configure(string $value, ?string $default, ?string $fallback = null): void
14+
{
15+
}
16+
17+
public static function create(string $value, ?string $default, ?string $fallback = null): self
18+
{
19+
return new self($value, $default, $fallback);
20+
}
21+
}

‎rules-tests/CodeQuality/Rector/CallLike/AddNameToNullArgumentRector/config/configured_rule.php‎

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\CodeQuality\Rector\CallLike\AddNameToNullArgumentRector;
6+
use Rector\Config\RectorConfig;
7+
8+
return RectorConfig::configure()
9+
->withRules([AddNameToNullArgumentRector::class]);

‎rules/CodeQuality/Rector/CallLike/AddNameToBooleanArgumentRector.php‎

Lines changed: 6 additions & 147 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,10 @@
55
namespace Rector\CodeQuality\Rector\CallLike;
66

77
use PhpParser\Node;
8-
use PhpParser\Node\Arg;
98
use PhpParser\Node\Expr\CallLike;
10-
use PhpParser\Node\Identifier;
11-
use PHPStan\Reflection\FunctionReflection;
12-
use PHPStan\Reflection\MethodReflection;
13-
use PHPStan\Reflection\ParameterReflection;
14-
use Rector\NodeTypeResolver\PHPStan\ParametersAcceptorSelectorVariantsWrapper;
9+
use Rector\NodeAnalyzer\CallLikeArgumentNameAdder;
1510
use Rector\PhpParser\Node\Value\ValueResolver;
16-
use Rector\PHPStan\ScopeFetcher;
1711
use Rector\Rector\AbstractRector;
18-
use Rector\Reflection\ReflectionResolver;
1912
use Rector\ValueObject\PhpVersionFeature;
2013
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
2114
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
@@ -27,7 +20,7 @@
2720
final class AddNameToBooleanArgumentRector extends AbstractRector implements MinPhpVersionInterface
2821
{
2922
public function __construct(
30-
private readonly ReflectionResolver $reflectionResolver,
23+
private readonly CallLikeArgumentNameAdder $callLikeArgumentNameAdder,
3124
private readonly ValueResolver $valueResolver,
3225
) {
3326
}
@@ -63,148 +56,14 @@ public function getNodeTypes(): array
6356
*/
6457
public function refactor(Node $node): ?Node
6558
{
66-
if ($this->shouldSkip($node)) {
67-
return null;
68-
}
69-
70-
$reflection = $this->reflectionResolver->resolveFunctionLikeReflectionFromCall($node);
71-
if (! $reflection instanceof FunctionReflection && ! $reflection instanceof MethodReflection) {
72-
return null;
73-
}
74-
75-
$scope = ScopeFetcher::fetch($node);
76-
$args = $node->getArgs();
77-
$parameters = ParametersAcceptorSelectorVariantsWrapper::select($reflection, $node, $scope)
78-
->getParameters();
79-
80-
$position = $this->resolveFirstPositionToName($args, $parameters);
81-
if ($position === null) {
82-
return null;
83-
}
84-
85-
$wasChanged = false;
86-
$counter = count($args);
87-
for ($i = $position; $i < $counter; ++$i) {
88-
$arg = $args[$i];
89-
if ($arg->name instanceof Identifier) {
90-
continue;
91-
}
92-
93-
$parameterReflection = $this->resolveParameterReflection($arg, $i, $parameters);
94-
if (! $parameterReflection instanceof ParameterReflection) {
95-
return null;
96-
}
97-
98-
$arg->name = new Identifier($parameterReflection->getName());
99-
$wasChanged = true;
100-
}
101-
102-
if (! $wasChanged) {
103-
return null;
104-
}
105-
106-
return $node;
59+
return $this->callLikeArgumentNameAdder->addNamesToArgs(
60+
$node,
61+
fn ($expr): bool => $this->valueResolver->isTrueOrFalse($expr),
62+
);
10763
}
10864

10965
public function provideMinPhpVersion(): int
11066
{
11167
return PhpVersionFeature::NAMED_ARGUMENTS;
11268
}
113-
114-
private function shouldSkip(CallLike $callLike): bool
115-
{
116-
if ($callLike->isFirstClassCallable()) {
117-
return true;
118-
}
119-
120-
$args = $callLike->getArgs();
121-
if ($args === []) {
122-
return true;
123-
}
124-
125-
foreach ($args as $arg) {
126-
if ($arg->unpack) {
127-
return true;
128-
}
129-
}
130-
131-
return false;
132-
}
133-
134-
/**
135-
* @param Arg[] $args
136-
* @param ParameterReflection[] $parameters
137-
*/
138-
private function resolveFirstPositionToName(array $args, array $parameters): ?int
139-
{
140-
foreach ($args as $position => $arg) {
141-
if ($arg->name instanceof Identifier) {
142-
continue;
143-
}
144-
145-
if (! $this->valueResolver->isTrueOrFalse($arg->value)) {
146-
continue;
147-
}
148-
149-
if ($this->canNameArgsFromPosition($args, $parameters, $position)) {
150-
return $position;
151-
}
152-
}
153-
154-
return null;
155-
}
156-
157-
/**
158-
* @param Arg[] $args
159-
* @param ParameterReflection[] $parameters
160-
*/
161-
private function canNameArgsFromPosition(array $args, array $parameters, int $position): bool
162-
{
163-
$count = count($args);
164-
for ($i = $position; $i < $count; ++$i) {
165-
$arg = $args[$i];
166-
if ($arg->name instanceof Identifier) {
167-
continue;
168-
}
169-
170-
$parameterReflection = $this->resolveParameterReflection($arg, $i, $parameters);
171-
if (! $parameterReflection instanceof ParameterReflection) {
172-
return false;
173-
}
174-
175-
if ($parameterReflection->isVariadic()) {
176-
return false;
177-
}
178-
}
179-
180-
return true;
181-
}
182-
183-
/**
184-
* @param ParameterReflection[] $parameters
185-
*/
186-
private function resolveParameterReflection(Arg $arg, int $position, array $parameters): ?ParameterReflection
187-
{
188-
if ($arg->name instanceof Identifier) {
189-
foreach ($parameters as $parameter) {
190-
if ($parameter->getName() === $arg->name->toString()) {
191-
return $parameter;
192-
}
193-
}
194-
195-
return null;
196-
}
197-
198-
$parameter = $parameters[$position] ?? null;
199-
if ($parameter instanceof ParameterReflection) {
200-
return $parameter;
201-
}
202-
203-
$lastParameter = end($parameters);
204-
if ($lastParameter instanceof ParameterReflection && $lastParameter->isVariadic()) {
205-
return $lastParameter;
206-
}
207-
208-
return null;
209-
}
21069
}

‎rules/CodeQuality/Rector/CallLike/AddNameToNullArgumentRector.php‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\CodeQuality\Rector\CallLike;
6+
7+
use PhpParser\Node;
8+
use PhpParser\Node\Expr\CallLike;
9+
use Rector\NodeAnalyzer\CallLikeArgumentNameAdder;
10+
use Rector\PhpParser\Node\Value\ValueResolver;
11+
use Rector\Rector\AbstractRector;
12+
use Rector\ValueObject\PhpVersionFeature;
13+
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
14+
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
15+
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
16+
17+
/**
18+
* @see \Rector\Tests\CodeQuality\Rector\CallLike\AddNameToNullArgumentRector\AddNameToNullArgumentRectorTest
19+
*/
20+
final class AddNameToNullArgumentRector extends AbstractRector implements MinPhpVersionInterface
21+
{
22+
public function __construct(
23+
private readonly CallLikeArgumentNameAdder $callLikeArgumentNameAdder,
24+
private readonly ValueResolver $valueResolver,
25+
) {
26+
}
27+
28+
public function getRuleDefinition(): RuleDefinition
29+
{
30+
return new RuleDefinition(
31+
'Add parameter names to null arguments.',
32+
[
33+
new CodeSample(
34+
<<<'CODE_SAMPLE'
35+
some_function($value, null);
36+
CODE_SAMPLE
37+
,
38+
<<<'CODE_SAMPLE'
39+
some_function($value, default: null);
40+
CODE_SAMPLE
41+
),
42+
]
43+
);
44+
}
45+
46+
/**
47+
* @return array<class-string<Node>>
48+
*/
49+
public function getNodeTypes(): array
50+
{
51+
return [CallLike::class];
52+
}
53+
54+
/**
55+
* @param CallLike $node
56+
*/
57+
public function refactor(Node $node): ?Node
58+
{
59+
return $this->callLikeArgumentNameAdder->addNamesToArgs(
60+
$node,
61+
fn ($expr): bool => $this->valueResolver->isNull($expr),
62+
);
63+
}
64+
65+
public function provideMinPhpVersion(): int
66+
{
67+
return PhpVersionFeature::NAMED_ARGUMENTS;
68+
}
69+
}

0 commit comments

Comments
 (0)