Skip to content

Commit 9ce6ab6

Browse files
TomasVotrubaTomasVotruba
committed
[tdd] Add AddParamArrayDocblockBasedOnArrayMapRector
1 parent fe7432b commit 9ce6ab6

9 files changed

Lines changed: 352 additions & 1 deletion

File tree

‎rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddParamArrayDocblockBasedOnArrayMapRector/AddParamArrayDocblockBasedOnArrayMapRectorTest.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\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockBasedOnArrayMapRector;
6+
7+
use Iterator;
8+
use PHPUnit\Framework\Attributes\DataProvider;
9+
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
10+
11+
final class AddParamArrayDocblockBasedOnArrayMapRectorTest 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/TypeDeclarationDocblocks/Rector/ClassMethod/AddParamArrayDocblockBasedOnArrayMapRector/Fixture/override_mixed_type.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\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockBasedOnArrayMapRector\Fixture;
4+
5+
final class OverrideMixedType
6+
{
7+
/**
8+
* @param mixed[] $items
9+
*/
10+
public function run(array $items): void
11+
{
12+
array_map(fn (string $item) => trim($item), $items);
13+
}
14+
}
15+
16+
?>
17+
-----
18+
<?php
19+
20+
namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockBasedOnArrayMapRector\Fixture;
21+
22+
final class OverrideMixedType
23+
{
24+
/**
25+
* @param string[] $items
26+
*/
27+
public function run(array $items): void
28+
{
29+
array_map(fn (string $item) => trim($item), $items);
30+
}
31+
}
32+
33+
?>

‎rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddParamArrayDocblockBasedOnArrayMapRector/Fixture/skip_better_existing_type.php.inc‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?php
2+
3+
namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockBasedOnArrayMapRector\Fixture;
4+
5+
final class SkipBetterExistingType
6+
{
7+
/**
8+
* @param array<string|\Stringable> $items
9+
*/
10+
public function run(array $items): void
11+
{
12+
array_map(fn (string $item) => trim($item), $items);
13+
}
14+
}

‎rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/AddParamArrayDocblockBasedOnArrayMapRector/Fixture/some_class.php.inc‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<?php
2+
3+
namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockBasedOnArrayMapRector\Fixture;
4+
5+
final class SomeClass
6+
{
7+
public function run(array $items): void
8+
{
9+
array_map(fn (string $item) => trim($item), $items);
10+
}
11+
}
12+
13+
?>
14+
-----
15+
<?php
16+
17+
namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockBasedOnArrayMapRector\Fixture;
18+
19+
final class SomeClass
20+
{
21+
/**
22+
* @param string[] $items
23+
*/
24+
public function run(array $items): void
25+
{
26+
array_map(fn (string $item) => trim($item), $items);
27+
}
28+
}
29+
30+
?>

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

‎rules/TypeDeclarationDocblocks/NodeFinder/ArrayMapClosureExprFinder.php‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\TypeDeclarationDocblocks\NodeFinder;
6+
7+
use PhpParser\Node\Expr\ArrowFunction;
8+
use PhpParser\Node\Expr\Closure;
9+
use PhpParser\Node\Expr\FuncCall;
10+
use PhpParser\Node\Expr\Variable;
11+
use PhpParser\Node\Stmt\ClassMethod;
12+
use PhpParser\Node\Stmt\Function_;
13+
use Rector\NodeNameResolver\NodeNameResolver;
14+
use Rector\PhpParser\Node\BetterNodeFinder;
15+
16+
final readonly class ArrayMapClosureExprFinder
17+
{
18+
public function __construct(
19+
private BetterNodeFinder $betterNodeFinder,
20+
private NodeNameResolver $nodeNameResolver,
21+
) {
22+
}
23+
24+
/**
25+
* @return array<Closure|ArrowFunction>
26+
*/
27+
public function findByVariableName(ClassMethod|Function_ $functionLike, string $variableName): array
28+
{
29+
if ($functionLike->stmts === null) {
30+
return [];
31+
}
32+
33+
/** @var FuncCall[] $funcCalls */
34+
$funcCalls = $this->betterNodeFinder->findInstancesOfScoped($functionLike->stmts, FuncCall::class);
35+
36+
$arrayMapClosures = [];
37+
38+
foreach ($funcCalls as $funcCall) {
39+
if ($funcCall->isFirstClassCallable()) {
40+
continue;
41+
}
42+
43+
if (! $this->nodeNameResolver->isName($funcCall, 'array_map')) {
44+
continue;
45+
}
46+
47+
$secondArg = $funcCall->getArgs()[1];
48+
if (! $secondArg->value instanceof Variable) {
49+
continue;
50+
}
51+
52+
if (! $this->nodeNameResolver->isName($secondArg->value, $variableName)) {
53+
continue;
54+
}
55+
56+
$firstArg = $funcCall->getArgs()[0];
57+
if (! $firstArg->value instanceof Closure && ! $firstArg->value instanceof ArrowFunction) {
58+
continue;
59+
}
60+
61+
$arrayMapClosures[] = $firstArg->value;
62+
}
63+
64+
return $arrayMapClosures;
65+
}
66+
}

‎rules/TypeDeclarationDocblocks/Rector/ClassMethod/AddParamArrayDocblockBasedOnArrayMapRector.php‎

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\TypeDeclarationDocblocks\Rector\ClassMethod;
6+
7+
use PhpParser\Node;
8+
use PhpParser\Node\Identifier;
9+
use PhpParser\Node\Param;
10+
use PhpParser\Node\Stmt\ClassMethod;
11+
use PhpParser\Node\Stmt\Function_;
12+
use PHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode;
13+
use PHPStan\Type\ArrayType;
14+
use PHPStan\Type\MixedType;
15+
use PHPStan\Type\Type;
16+
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
17+
use Rector\Comments\NodeDocBlock\DocBlockUpdater;
18+
use Rector\Rector\AbstractRector;
19+
use Rector\StaticTypeMapper\StaticTypeMapper;
20+
use Rector\TypeDeclarationDocblocks\NodeFinder\ArrayMapClosureExprFinder;
21+
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
22+
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
23+
24+
/**
25+
* @see \Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockBasedOnArrayMapRector\AddParamArrayDocblockBasedOnArrayMapRectorTest
26+
*/
27+
final class AddParamArrayDocblockBasedOnArrayMapRector extends AbstractRector
28+
{
29+
public function __construct(
30+
private readonly ArrayMapClosureExprFinder $arrayMapClosureExprFinder,
31+
private readonly StaticTypeMapper $staticTypeMapper,
32+
private readonly PhpDocInfoFactory $phpDocInfoFactory,
33+
private readonly DocBlockUpdater $docBlockUpdater,
34+
) {
35+
36+
}
37+
38+
public function getRuleDefinition(): RuleDefinition
39+
{
40+
return new RuleDefinition('Add @param array docblock if array_map is used on the parameter', [
41+
new CodeSample(
42+
<<<'CODE_SAMPLE'
43+
final class SomeClass
44+
{
45+
public function run(array $names): void
46+
{
47+
$names = array_map(fn(string $name) => trim($name), $names);
48+
}
49+
}
50+
CODE_SAMPLE
51+
,
52+
<<<'CODE_SAMPLE'
53+
final class SomeClass
54+
{
55+
/**
56+
* @param string[] $names
57+
*/
58+
public function run(array $names): void
59+
{
60+
$names = array_map(fn(string $name) => trim($name), $names);
61+
}
62+
}
63+
CODE_SAMPLE
64+
),
65+
]);
66+
}
67+
68+
/**
69+
* @return array<class-string<Node>>
70+
*/
71+
public function getNodeTypes(): array
72+
{
73+
return [ClassMethod::class, Function_::class];
74+
}
75+
76+
/**
77+
* @param ClassMethod|Function_ $node
78+
*/
79+
public function refactor(Node $node): ?Node
80+
{
81+
if ($node->getParams() === []) {
82+
return null;
83+
}
84+
85+
$hasChanged = false;
86+
$functionPhpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
87+
88+
foreach ($node->params as $param) {
89+
// handle only arrays
90+
if (! $this->isArrayParam($param)) {
91+
continue;
92+
}
93+
94+
$paramName = $this->getName($param);
95+
96+
$arrayMapClosures = $this->arrayMapClosureExprFinder->findByVariableName($node, $paramName);
97+
if ($arrayMapClosures === []) {
98+
continue;
99+
}
100+
101+
foreach ($arrayMapClosures as $arrayMapClosure) {
102+
$params = $arrayMapClosure->getParams();
103+
if ($params === []) {
104+
continue;
105+
}
106+
107+
$firstParam = $params[0];
108+
$paramTypeNode = $firstParam->type;
109+
if ($paramTypeNode === null) {
110+
continue;
111+
}
112+
113+
$paramType = $this->staticTypeMapper->mapPhpParserNodePHPStanType($paramTypeNode);
114+
$arrayParamType = new ArrayType(new MixedType(), $paramType);
115+
116+
$paramDocTypeNode = $this->staticTypeMapper->mapPHPStanTypeToPHPStanPhpDocTypeNode($arrayParamType);
117+
118+
$currentParamType = $functionPhpDocInfo->getParamType($paramName);
119+
120+
// has useful param type already?
121+
if (! $currentParamType instanceof MixedType && ! $this->isMixedArrayType($currentParamType)) {
122+
continue;
123+
}
124+
125+
$paramTagValueNode = new ParamTagValueNode(
126+
$paramDocTypeNode,
127+
$param->variadic,
128+
'$' . $paramName,
129+
'',
130+
$param->byRef
131+
);
132+
$functionPhpDocInfo->addTagValueNode($paramTagValueNode);
133+
134+
$hasChanged = true;
135+
}
136+
137+
}
138+
139+
if (! $hasChanged) {
140+
return null;
141+
}
142+
143+
$this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
144+
145+
return $node;
146+
}
147+
148+
private function isArrayParam(Param $param): bool
149+
{
150+
if (! $param->type instanceof Identifier) {
151+
return false;
152+
}
153+
154+
return $this->isName($param->type, 'array');
155+
}
156+
157+
private function isMixedArrayType(Type $type): bool
158+
{
159+
if (! $type instanceof ArrayType) {
160+
return false;
161+
}
162+
163+
if (! $type->getItemType() instanceof MixedType) {
164+
return false;
165+
}
166+
167+
return $type->getKeyType() instanceof MixedType;
168+
}
169+
}

‎src/Config/Level/DeadCodeLevel.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626
use Rector\DeadCode\Rector\ClassMethod\RemoveUselessParamTagRector;
2727
use Rector\DeadCode\Rector\ClassMethod\RemoveUselessReturnExprInConstructRector;
2828
use Rector\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector;
29-
use Rector\DeadCode\Rector\Concat\RemoveConcatAutocastRector;
3029
use Rector\DeadCode\Rector\Closure\RemoveUnusedClosureVariableUseRector;
30+
use Rector\DeadCode\Rector\Concat\RemoveConcatAutocastRector;
3131
use Rector\DeadCode\Rector\ConstFetch\RemovePhpVersionIdCheckRector;
3232
use Rector\DeadCode\Rector\Expression\RemoveDeadStmtRector;
3333
use Rector\DeadCode\Rector\Expression\SimplifyMirrorAssignRector;

‎src/Config/Level/TypeDeclarationDocblocksLevel.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
use Rector\TypeDeclarationDocblocks\Rector\Class_\DocblockVarArrayFromGetterReturnRector;
1313
use Rector\TypeDeclarationDocblocks\Rector\Class_\DocblockVarArrayFromPropertyDefaultsRector;
1414
use Rector\TypeDeclarationDocblocks\Rector\Class_\DocblockVarFromParamDocblockInConstructorRector;
15+
use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockBasedOnArrayMapRector;
1516
use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDataProviderRector;
1617
use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDimFetchAccessRector;
1718
use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForArrayDimAssignedObjectRector;
@@ -37,6 +38,7 @@ final class TypeDeclarationDocblocksLevel
3738
// param
3839
AddParamArrayDocblockFromDimFetchAccessRector::class,
3940
ClassMethodArrayDocblockParamFromLocalCallsRector::class,
41+
AddParamArrayDocblockBasedOnArrayMapRector::class,
4042

4143
// return
4244
AddReturnDocblockForCommonObjectDenominatorRector::class,

0 commit comments

Comments
 (0)