forked from symplify/phpstan-rules
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ForbiddenNullableReturnRule.php
130 lines (114 loc) · 3.36 KB
/
ForbiddenNullableReturnRule.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
<?php
declare(strict_types=1);
namespace Symplify\PHPStanRules\Rules;
use PhpParser\Node;
use PhpParser\Node\Expr\Closure;
use PhpParser\Node\NullableType;
use PhpParser\Node\Scalar\String_;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Function_;
use PHPStan\Analyser\Scope;
use Symplify\Astral\Naming\SimpleNameResolver;
use Symplify\PHPStanRules\ParentGuard\ParentClassMethodGuard;
use Symplify\PHPStanRules\TypeAnalyzer\ForbiddenAllowedTypeAnalyzer;
use Symplify\RuleDocGenerator\Contract\ConfigurableRuleInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Symplify\PHPStanRules\Tests\Rules\ForbiddenNullableReturnRule\ForbiddenNullableReturnRuleTest
*/
final class ForbiddenNullableReturnRule extends AbstractSymplifyRule implements ConfigurableRuleInterface
{
/**
* @var string
*/
public const ERROR_MESSAGE = 'Return type "%s" cannot be nullable';
/**
* @var class-string[]
*/
private array $forbiddenTypes = [];
/**
* @var class-string[]
*/
private array $allowedTypes = [];
/**
* @param class-string[] $forbiddenTypes
* @param class-string[] $allowedTypes
*/
public function __construct(
private SimpleNameResolver $simpleNameResolver,
private ParentClassMethodGuard $parentClassMethodGuard,
private ForbiddenAllowedTypeAnalyzer $forbiddenAllowedTypeAnalyzer,
array $forbiddenTypes = [],
array $allowedTypes = []
) {
$this->forbiddenTypes = $forbiddenTypes;
$this->allowedTypes = $allowedTypes;
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes(): array
{
return [ClassMethod::class, Function_::class, Closure::class];
}
/**
* @param ClassMethod|Function_|Closure $node
* @return string[]
*/
public function process(Node $node, Scope $scope): array
{
if ($this->parentClassMethodGuard->isFunctionLikeProtected($node, $scope)) {
return [];
}
$returnType = $node->returnType;
if (! $returnType instanceof NullableType) {
return [];
}
$mainReturnType = $this->simpleNameResolver->getName($returnType->type);
if ($mainReturnType === null) {
return [];
}
if ($this->forbiddenAllowedTypeAnalyzer->shouldSkip(
$mainReturnType,
$this->forbiddenTypes,
$this->allowedTypes
)) {
return [];
}
$paramName = $this->simpleNameResolver->getName($mainReturnType);
$errorMessage = sprintf(self::ERROR_MESSAGE, $paramName);
return [$errorMessage];
}
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition(self::ERROR_MESSAGE, [
new ConfiguredCodeSample(
<<<'CODE_SAMPLE'
use PhpParser\Node;
class SomeClass
{
public function run(): ?Node
{
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
use PhpParser\Node;
class SomeClass
{
public function run(): Node
{
}
}
CODE_SAMPLE
,
[
'forbiddenTypes' => [Node::class],
'allowedTypes' => [String_::class],
]
),
]);
}
}