-
-
Notifications
You must be signed in to change notification settings - Fork 23
/
NoReturnSetterMethodRule.php
137 lines (115 loc) · 3.35 KB
/
NoReturnSetterMethodRule.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
<?php
declare(strict_types=1);
namespace Symplify\PHPStanRules\Rules;
use Nette\Utils\Strings;
use PhpParser\Node;
use PhpParser\Node\Expr\Yield_;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\NodeTraverser;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\ClassReflection;
use PHPStan\Rules\Rule;
use Symplify\PHPStanRules\NodeFinder\TypeAwareNodeFinder;
use Symplify\PHPStanRules\NodeVisitor\HasScopedReturnNodeVisitor;
use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Symplify\PHPStanRules\Tests\Rules\NoReturnSetterMethodRule\NoReturnSetterMethodRuleTest
*/
final class NoReturnSetterMethodRule implements Rule, DocumentedRuleInterface
{
/**
* @var string
*/
public const ERROR_MESSAGE = 'Setter method cannot return anything, only set value';
/**
* @var string
* @see https://regex101.com/r/IIvg8L/1
*/
private const SETTER_START_REGEX = '#^set[A-Z]#';
public function __construct(
private readonly TypeAwareNodeFinder $typeAwareNodeFinder
) {
}
/**
* @return class-string<Node>
*/
public function getNodeType(): string
{
return ClassMethod::class;
}
/**
* @param ClassMethod $node
* @return string[]
*/
public function processNode(Node $node, Scope $scope): array
{
// possibly some important logic
if ($node->attrGroups !== []) {
return [];
}
if (! $this->isInsideClassReflection($scope)) {
return [];
}
$classMethodName = $node->name->toString();
if ($classMethodName === 'setUp') {
return [];
}
if (! Strings::match($classMethodName, self::SETTER_START_REGEX)) {
return [];
}
if (! $this->hasReturnReturnFunctionLike($node)) {
return [];
}
return [self::ERROR_MESSAGE];
}
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition(self::ERROR_MESSAGE, [
new CodeSample(
<<<'CODE_SAMPLE'
final class SomeClass
{
private $name;
public function setName(string $name): int
{
return 1000;
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
final class SomeClass
{
private $name;
public function setName(string $name): void
{
$this->name = $name;
}
}
CODE_SAMPLE
),
]);
}
private function hasReturnReturnFunctionLike(ClassMethod $classMethod): bool
{
$hasScopedReturnNodeVisitor = new HasScopedReturnNodeVisitor();
$nodeTraverser = new NodeTraverser();
$nodeTraverser->addVisitor($hasScopedReturnNodeVisitor);
$nodeTraverser->traverse([$classMethod]);
if ($hasScopedReturnNodeVisitor->hasReturn()) {
return true;
}
$yield = $this->typeAwareNodeFinder->findFirstInstanceOf($classMethod, Yield_::class);
return $yield instanceof Yield_;
}
private function isInsideClassReflection(Scope $scope): bool
{
$classReflection = $scope->getClassReflection();
if (! $classReflection instanceof ClassReflection) {
return false;
}
return $classReflection->isClass();
}
}