-
-
Notifications
You must be signed in to change notification settings - Fork 23
/
ForbiddenNestedCallInAssertMethodCallRule.php
111 lines (94 loc) · 2.7 KB
/
ForbiddenNestedCallInAssertMethodCallRule.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
<?php
declare(strict_types=1);
namespace Symplify\PHPStanRules\Rules;
use PhpParser\Node;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Identifier;
use PhpParser\NodeFinder;
use PHPStan\Analyser\Scope;
use PHPStan\Rules\Rule;
use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Symplify\PHPStanRules\Tests\Rules\ForbiddenNestedCallInAssertMethodCallRule\ForbiddenNestedCallInAssertMethodCallRuleTest
*/
final class ForbiddenNestedCallInAssertMethodCallRule implements Rule, DocumentedRuleInterface
{
/**
* @var string
*/
public const ERROR_MESSAGE = 'Decouple method call in assert to standalone line to make test core more readable';
public function __construct(
private readonly NodeFinder $nodeFinder
) {
}
/**
* @return class-string<Node>
*/
public function getNodeType(): string
{
return MethodCall::class;
}
/**
* @param MethodCall $node
* @return string[]
*/
public function processNode(Node $node, Scope $scope): array
{
if (! $node->name instanceof Identifier) {
return [];
}
$methodName = $node->name->toString();
if ($this->shouldSkipMethodName($methodName, $node)) {
return [];
}
$argMethodCall = $this->nodeFinder->findFirstInstanceOf($node->getArgs()[1], MethodCall::class);
if (! $argMethodCall instanceof MethodCall) {
return [];
}
if ($argMethodCall->getArgs() === []) {
return [];
}
return [self::ERROR_MESSAGE];
}
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition(self::ERROR_MESSAGE, [
new CodeSample(
<<<'CODE_SAMPLE'
use PHPUnit\Framework\TestCase;
final class SomeClass extends TestCase
{
public function test()
{
$this->assertSame('oooo', $this->someMethodCall());
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
use PHPUnit\Framework\TestCase;
final class SomeClass extends TestCase
{
public function test()
{
$result = $this->someMethodCall();
$this->assertSame('oooo', $result);
}
}
CODE_SAMPLE
),
]);
}
private function shouldSkipMethodName(string $methodName, MethodCall $methodCall): bool
{
if (! \str_starts_with($methodName, 'assert')) {
return true;
}
if (in_array($methodName, ['assertTrue', 'assertFalse'], true)) {
return true;
}
return count($methodCall->getArgs()) <= 1;
}
}