-
-
Notifications
You must be signed in to change notification settings - Fork 333
/
ReturnTypeFromReturnNewRector.php
185 lines (158 loc) · 5.46 KB
/
ReturnTypeFromReturnNewRector.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<?php
declare(strict_types=1);
namespace Rector\TypeDeclaration\Rector\ClassMethod;
use PhpParser\Node;
use PhpParser\Node\Expr\ArrowFunction;
use PhpParser\Node\Expr\Closure;
use PhpParser\Node\Expr\New_;
use PhpParser\Node\Name;
use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Function_;
use PhpParser\Node\Stmt\Return_;
use PHPStan\Reflection\ClassReflection;
use PHPStan\Reflection\ReflectionProvider;
use PHPStan\Type\ObjectType;
use PHPStan\Type\StaticType;
use Rector\Core\Enum\ObjectReference;
use Rector\Core\Exception\ShouldNotHappenException;
use Rector\Core\Rector\AbstractRector;
use Rector\Core\Reflection\ReflectionResolver;
use Rector\Core\ValueObject\PhpVersionFeature;
use Rector\NodeTypeResolver\PHPStan\Type\TypeFactory;
use Rector\PHPStanStaticTypeMapper\Enum\TypeKind;
use Rector\StaticTypeMapper\ValueObject\Type\SelfStaticType;
use Rector\TypeDeclaration\NodeAnalyzer\ReturnTypeAnalyzer\StrictReturnNewAnalyzer;
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromReturnNewRector\ReturnTypeFromReturnNewRectorTest
*/
final class ReturnTypeFromReturnNewRector extends AbstractRector implements MinPhpVersionInterface
{
public function __construct(
private readonly TypeFactory $typeFactory,
private readonly ReflectionProvider $reflectionProvider,
private readonly ReflectionResolver $reflectionResolver,
private readonly StrictReturnNewAnalyzer $strictReturnNewAnalyzer
) {
}
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition('Add return type to function like with return new', [
new CodeSample(
<<<'CODE_SAMPLE'
final class SomeClass
{
public function action()
{
return new Response();
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
final class SomeClass
{
public function action(): Response
{
return new Response();
}
}
CODE_SAMPLE
),
]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes(): array
{
return [ClassMethod::class, Function_::class, Closure::class, ArrowFunction::class];
}
/**
* @param ClassMethod|Function_|ArrowFunction $node
*/
public function refactor(Node $node): ?Node
{
if ($node->returnType !== null) {
return null;
}
if (! $node instanceof ArrowFunction) {
$returnedNewClassName = $this->strictReturnNewAnalyzer->matchAlwaysReturnVariableNew($node);
if (is_string($returnedNewClassName)) {
$node->returnType = new FullyQualified($returnedNewClassName);
return $node;
}
}
return $this->refactorDirectReturnNew($node);
}
public function provideMinPhpVersion(): int
{
return PhpVersionFeature::SCALAR_TYPES;
}
private function createObjectTypeFromNew(New_ $new): ObjectType|StaticType
{
$className = $this->getName($new->class);
if ($className === null) {
throw new ShouldNotHappenException();
}
if ($className === ObjectReference::STATIC || $className === ObjectReference::SELF) {
$classReflection = $this->reflectionResolver->resolveClassReflection($new);
if (! $classReflection instanceof ClassReflection) {
throw new ShouldNotHappenException();
}
if ($className === ObjectReference::SELF) {
return new SelfStaticType($classReflection);
}
return new StaticType($classReflection);
}
$classReflection = $this->reflectionProvider->getClass($className);
return new ObjectType($className, null, $classReflection);
}
private function refactorDirectReturnNew(
ClassMethod|Function_|ArrowFunction $node
): null|ArrowFunction|Function_|ClassMethod
{
if ($node instanceof ArrowFunction) {
$returns = [new Return_($node->expr)];
} else {
/** @var Return_[] $returns */
$returns = $this->betterNodeFinder->findInstancesOfInFunctionLikeScoped($node, Return_::class);
}
if ($returns === []) {
return null;
}
$newTypes = $this->resolveReturnNewType($returns);
if ($newTypes === null) {
return null;
}
$returnType = $this->typeFactory->createMixedPassedOrUnionType($newTypes);
$returnTypeNode = $this->staticTypeMapper->mapPHPStanTypeToPhpParserNode($returnType, TypeKind::RETURN);
if (! $returnTypeNode instanceof \PhpParser\Node) {
return null;
}
$node->returnType = $returnTypeNode;
return $node;
}
/**
* @param Return_[] $returns
* @return \PHPStan\Type\Type[]|null
*/
private function resolveReturnNewType(array $returns): ?array
{
$newTypes = [];
foreach ($returns as $return) {
if (! $return->expr instanceof New_) {
return null;
}
$new = $return->expr;
if (! $new->class instanceof Name) {
return null;
}
$newTypes[] = $this->createObjectTypeFromNew($new);
}
return $newTypes;
}
}