Skip to content

Commit 4928b72

Browse files
TomasVotrubaTomasVotruba
committed
[tdd] Add AddParamArrayDocblockBasedOnArrayMapRector
1 parent fe7432b commit 4928b72

7 files changed

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

‎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)