Skip to content

Commit 3a3f880

Browse files
calebdwcalebdw
committed
feat: create rector to add names to boolean and null arguments
1 parent 68156b9 commit 3a3f880

10 files changed

Lines changed: 336 additions & 0 deletions

File tree

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

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

‎rules-tests/CodeQuality/Rector/CallLike/NameBooleanOrNullArgumentRector/Fixture/name_following_arguments.php.inc‎

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\CodeQuality\Rector\CallLike\NameBooleanOrNullArgumentRector\Fixture;
4+
5+
json_decode($json, true, 512, JSON_THROW_ON_ERROR);
6+
7+
?>
8+
-----
9+
<?php
10+
11+
namespace Rector\Tests\CodeQuality\Rector\CallLike\NameBooleanOrNullArgumentRector\Fixture;
12+
13+
json_decode($json, associative: true, depth: 512, flags: JSON_THROW_ON_ERROR);
14+
15+
?>

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?php
2+
3+
namespace Rector\Tests\CodeQuality\Rector\CallLike\NameBooleanOrNullArgumentRector\Fixture;
4+
5+
in_array($value, $array, strict: true);

‎rules-tests/CodeQuality/Rector/CallLike/NameBooleanOrNullArgumentRector/Fixture/skip_first_class_callable.php.inc‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?php
2+
3+
namespace Rector\Tests\CodeQuality\Rector\CallLike\NameBooleanOrNullArgumentRector\Fixture;
4+
5+
in_array(...);

‎rules-tests/CodeQuality/Rector/CallLike/NameBooleanOrNullArgumentRector/Fixture/skip_unpack.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\NameBooleanOrNullArgumentRector\Fixture;
4+
5+
use Rector\Tests\CodeQuality\Rector\CallLike\NameBooleanOrNullArgumentRector\Source\Service;
6+
7+
function (array $rest): void
8+
{
9+
Service::create('value', true, ...$rest);
10+
};

‎rules-tests/CodeQuality/Rector/CallLike/NameBooleanOrNullArgumentRector/NameBooleanOrNullArgumentRectorTest.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\NameBooleanOrNullArgumentRector;
6+
7+
use Iterator;
8+
use PHPUnit\Framework\Attributes\DataProvider;
9+
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
10+
11+
final class NameBooleanOrNullArgumentRectorTest 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/NameBooleanOrNullArgumentRector/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\NameBooleanOrNullArgumentRector\Source;
6+
7+
final class Service
8+
{
9+
public function __construct(string $value, bool $strict, ?string $fallback)
10+
{
11+
}
12+
13+
public function configure(string $value, bool $strict, ?string $fallback): void
14+
{
15+
}
16+
17+
public static function create(string $value, bool $strict, ?string $fallback): self
18+
{
19+
return new self($value, $strict, $fallback);
20+
}
21+
}

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

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

Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\CodeQuality\Rector\CallLike;
6+
7+
use PhpParser\Node;
8+
use PhpParser\Node\Arg;
9+
use PhpParser\Node\Expr;
10+
use PhpParser\Node\Expr\CallLike;
11+
use PhpParser\Node\Identifier;
12+
use PHPStan\Reflection\FunctionReflection;
13+
use PHPStan\Reflection\MethodReflection;
14+
use PHPStan\Reflection\ParameterReflection;
15+
use Rector\NodeTypeResolver\PHPStan\ParametersAcceptorSelectorVariantsWrapper;
16+
use Rector\PhpParser\Node\Value\ValueResolver;
17+
use Rector\PHPStan\ScopeFetcher;
18+
use Rector\Rector\AbstractRector;
19+
use Rector\Reflection\ReflectionResolver;
20+
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
21+
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
22+
23+
/**
24+
* @see \Rector\Tests\CodeQuality\Rector\CallLike\NameBooleanOrNullArgumentRector\NameBooleanOrNullArgumentRectorTest
25+
*/
26+
final class NameBooleanOrNullArgumentRector extends AbstractRector
27+
{
28+
public function __construct(
29+
private readonly ReflectionResolver $reflectionResolver,
30+
private readonly ValueResolver $valueResolver,
31+
) {
32+
}
33+
34+
public function getRuleDefinition(): RuleDefinition
35+
{
36+
return new RuleDefinition(
37+
'Add parameter names to boolean and null arguments to make call sites clearer.',
38+
[
39+
new CodeSample(
40+
<<<'CODE_SAMPLE'
41+
in_array($value, $array, true);
42+
CODE_SAMPLE
43+
,
44+
<<<'CODE_SAMPLE'
45+
in_array($value, $array, strict: true);
46+
CODE_SAMPLE
47+
),
48+
]
49+
);
50+
}
51+
52+
/**
53+
* @return array<class-string<Node>>
54+
*/
55+
public function getNodeTypes(): array
56+
{
57+
return [CallLike::class];
58+
}
59+
60+
/**
61+
* @param CallLike $node
62+
*/
63+
public function refactor(Node $node): ?Node
64+
{
65+
if ($this->shouldSkip($node)) {
66+
return null;
67+
}
68+
69+
$reflection = $this->reflectionResolver->resolveFunctionLikeReflectionFromCall($node);
70+
if (! $reflection instanceof FunctionReflection && ! $reflection instanceof MethodReflection) {
71+
return null;
72+
}
73+
74+
$scope = ScopeFetcher::fetch($node);
75+
$args = $node->getArgs();
76+
$parameters = ParametersAcceptorSelectorVariantsWrapper::select($reflection, $node, $scope)
77+
->getParameters();
78+
79+
$position = $this->resolveFirstPositionToName($args, $parameters);
80+
if ($position === null) {
81+
return null;
82+
}
83+
84+
$wasChanged = false;
85+
for ($i = $position; $i < count($args); ++$i) {
86+
$arg = $args[$i];
87+
if ($arg->name instanceof Identifier) {
88+
continue;
89+
}
90+
91+
$parameterReflection = $this->resolveParameterReflection($arg, $i, $parameters);
92+
if (! $parameterReflection instanceof ParameterReflection) {
93+
return null;
94+
}
95+
96+
$arg->name = new Identifier($parameterReflection->getName());
97+
$wasChanged = true;
98+
}
99+
100+
if (! $wasChanged) {
101+
return null;
102+
}
103+
104+
return $node;
105+
}
106+
107+
private function shouldSkip(CallLike $callLike): bool
108+
{
109+
if ($callLike->isFirstClassCallable()) {
110+
return true;
111+
}
112+
113+
$args = $callLike->getArgs();
114+
if ($args === []) {
115+
return true;
116+
}
117+
118+
foreach ($args as $arg) {
119+
if ($arg->unpack) {
120+
return true;
121+
}
122+
}
123+
124+
return false;
125+
}
126+
127+
/**
128+
* @param Arg[] $args
129+
* @param ParameterReflection[] $parameters
130+
*/
131+
private function resolveFirstPositionToName(array $args, array $parameters): ?int
132+
{
133+
foreach ($args as $position => $arg) {
134+
if ($arg->name instanceof Identifier) {
135+
continue;
136+
}
137+
138+
if (! $this->isBooleanOrNull($arg->value)) {
139+
continue;
140+
}
141+
142+
if ($this->canNameArgsFromPosition($args, $parameters, $position)) {
143+
return $position;
144+
}
145+
}
146+
147+
return null;
148+
}
149+
150+
/**
151+
* @param Arg[] $args
152+
* @param ParameterReflection[] $parameters
153+
*/
154+
private function canNameArgsFromPosition(array $args, array $parameters, int $position): bool
155+
{
156+
$count = count($args);
157+
for ($i = $position; $i < $count; ++$i) {
158+
$arg = $args[$i];
159+
if ($arg->name instanceof Identifier) {
160+
continue;
161+
}
162+
163+
$parameterReflection = $this->resolveParameterReflection($arg, $i, $parameters);
164+
if (! $parameterReflection instanceof ParameterReflection) {
165+
return false;
166+
}
167+
168+
if ($parameterReflection->isVariadic()) {
169+
return false;
170+
}
171+
}
172+
173+
return true;
174+
}
175+
176+
/**
177+
* @param ParameterReflection[] $parameters
178+
*/
179+
private function resolveParameterReflection(Arg $arg, int $position, array $parameters): ?ParameterReflection
180+
{
181+
if ($arg->name instanceof Identifier) {
182+
foreach ($parameters as $parameter) {
183+
if ($parameter->getName() === $arg->name->toString()) {
184+
return $parameter;
185+
}
186+
}
187+
188+
return null;
189+
}
190+
191+
$parameter = $parameters[$position] ?? null;
192+
if ($parameter instanceof ParameterReflection) {
193+
return $parameter;
194+
}
195+
196+
$lastParameter = end($parameters);
197+
if ($lastParameter instanceof ParameterReflection && $lastParameter->isVariadic()) {
198+
return $lastParameter;
199+
}
200+
201+
return null;
202+
}
203+
204+
private function isBooleanOrNull(Expr $expr): bool
205+
{
206+
return $this->valueResolver->isTrueOrFalse($expr) || $this->valueResolver->isNull($expr);
207+
}
208+
}

‎src/Config/Level/CodeQualityLevel.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
use Rector\CodeQuality\Rector\BooleanNot\ReplaceMultipleBooleanNotRector;
1414
use Rector\CodeQuality\Rector\BooleanNot\SimplifyDeMorganBinaryRector;
1515
use Rector\CodeQuality\Rector\BooleanOr\RepeatedOrEqualToInArrayRector;
16+
use Rector\CodeQuality\Rector\CallLike\NameBooleanOrNullArgumentRector;
1617
use Rector\CodeQuality\Rector\Catch_\ThrowWithPreviousExceptionRector;
1718
use Rector\CodeQuality\Rector\Class_\CompleteDynamicPropertiesRector;
1819
use Rector\CodeQuality\Rector\Class_\ConvertStaticToSelfRector;
@@ -185,6 +186,7 @@ final class CodeQualityLevel
185186
SortAttributeNamedArgsRector::class,
186187
RemoveReadonlyPropertyVisibilityOnReadonlyClassRector::class,
187188
SafeDeclareStrictTypesRector::class,
189+
NameBooleanOrNullArgumentRector::class,
188190
];
189191

190192
/**

0 commit comments

Comments
 (0)