Skip to content

Commit bff5e12

Browse files
o0ho0h
committed
Update AssertSameWithCountRule for assertSameSize
Expanded the AssertSameWithCountRule in PHPUnit rules to handle additional scenarios. Now the rule checks if both sides of the assertSame are counts, and suggests assertSameSize instead when necessary. The modification enhances the rule's applicability and accuracy.
1 parent f93aec7 commit bff5e12

File tree

4 files changed

+136
-24
lines changed

4 files changed

+136
-24
lines changed

‎rules.neon‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ rules:
66
- PHPStan\Rules\PHPUnit\ShouldCallParentMethodsRule
77

88
services:
9+
- class: PHPStan\Rules\PHPUnit\AssertSameWithCountRule
910
- class: PHPStan\Rules\PHPUnit\ClassCoversExistsRule
1011
- class: PHPStan\Rules\PHPUnit\ClassMethodCoversExistsRule
1112
-
@@ -17,6 +18,8 @@ services:
1718
- class: PHPStan\Rules\PHPUnit\NoMissingSpaceInMethodAnnotationRule
1819

1920
conditionalTags:
21+
PHPStan\Rules\PHPUnit\AssertSameWithCountRule:
22+
phpstan.rules.rule: %featureToggles.bleedingEdge%
2023
PHPStan\Rules\PHPUnit\ClassCoversExistsRule:
2124
phpstan.rules.rule: %featureToggles.bleedingEdge%
2225
PHPStan\Rules\PHPUnit\ClassMethodCoversExistsRule:

‎src/Rules/PHPUnit/AssertSameWithCountRule.php‎

Lines changed: 83 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
use Countable;
66
use PhpParser\Node;
7+
use PhpParser\Node\Expr\MethodCall;
78
use PhpParser\NodeAbstract;
89
use PHPStan\Analyser\Scope;
910
use PHPStan\Rules\Rule;
@@ -17,6 +18,14 @@
1718
class AssertSameWithCountRule implements Rule
1819
{
1920

21+
/** @var bool */
22+
private $bleedingEdge;
23+
24+
public function __construct(bool $bleedingEdge)
25+
{
26+
$this->bleedingEdge = $bleedingEdge;
27+
}
28+
2029
public function getNodeType(): string
2130
{
2231
return NodeAbstract::class;
@@ -37,36 +46,89 @@ public function processNode(Node $node, Scope $scope): array
3746

3847
$right = $node->getArgs()[1]->value;
3948

40-
if (
41-
$right instanceof Node\Expr\FuncCall
42-
&& $right->name instanceof Node\Name
43-
&& $right->name->toLowerString() === 'count'
44-
) {
45-
return [
46-
RuleErrorBuilder::message('You should use assertCount($expectedCount, $variable) instead of assertSame($expectedCount, count($variable)).')
47-
->identifier('phpunit.assertCount')
48-
->build(),
49-
];
49+
$rightIsCountFuncCall = $this->isCountFuncCall($right);
50+
$rightIsCountMethodCall = $this->isCountMethodCall($right) && $this->argIsCountable($right, $scope);
51+
if (!($rightIsCountFuncCall || $rightIsCountMethodCall)) {
52+
return [];
5053
}
5154

52-
if (
53-
$right instanceof Node\Expr\MethodCall
54-
&& $right->name instanceof Node\Identifier
55-
&& $right->name->toLowerString() === 'count'
56-
&& count($right->getArgs()) === 0
57-
) {
58-
$type = $scope->getType($right->var);
55+
$leftIsCountFuncCall = $leftIsCountMethodCall = false;
56+
if ($this->bleedingEdge) {
57+
$left = $node->getArgs()[0]->value;
58+
$leftIsCountFuncCall = $this->isCountFuncCall($left);
59+
$leftIsCountMethodCall = $this->isCountMethodCall($left) && $this->argIsCountable($left, $scope);
60+
}
5961

60-
if ((new ObjectType(Countable::class))->isSuperTypeOf($type)->yes()) {
62+
if ($rightIsCountFuncCall) {
63+
if ($leftIsCountFuncCall) {
6164
return [
62-
RuleErrorBuilder::message('You should use assertCount($expectedCount, $variable) instead of assertSame($expectedCount, $variable->count()).')
63-
->identifier('phpunit.assertCount')
65+
RuleErrorBuilder::message('You should use assertSameSize($expected, $variable) instead of assertSame(count($expected), count($variable)).')
66+
->identifier('phpunit.assertSameSize')
67+
->build(),
68+
];
69+
} elseif ($leftIsCountMethodCall) {
70+
return [
71+
RuleErrorBuilder::message('You should use assertSameSize($expected, $variable) instead of assertSame($expected->count(), count($variable)).')
72+
->identifier('phpunit.assertSameSize')
6473
->build(),
6574
];
6675
}
76+
77+
return [
78+
RuleErrorBuilder::message('You should use assertCount($expectedCount, $variable) instead of assertSame($expectedCount, count($variable)).')
79+
->identifier('phpunit.assertCount')
80+
->build(),
81+
];
82+
}
83+
84+
if ($leftIsCountFuncCall) {
85+
return [
86+
RuleErrorBuilder::message('You should use assertSameSize($expected, $variable) instead of assertSame(count($expected), $variable->count()).')
87+
->identifier('phpunit.assertSameSize')
88+
->build(),
89+
];
90+
} elseif ($leftIsCountMethodCall) {
91+
return [
92+
RuleErrorBuilder::message('You should use assertSameSize($expected, $variable) instead of assertSame($expected->count(), $variable->count()).')
93+
->identifier('phpunit.assertSameSize')
94+
->build(),
95+
];
6796
}
6897

69-
return [];
98+
return [
99+
RuleErrorBuilder::message('You should use assertCount($expectedCount, $variable) instead of assertSame($expectedCount, $variable->count()).')
100+
->identifier('phpunit.assertCount')
101+
->build(),
102+
];
103+
}
104+
105+
/**
106+
* @phpstan-assert-if-true Node\Expr\FuncCall $expr
107+
*/
108+
private function isCountFuncCall(Node\Expr $expr): bool
109+
{
110+
return $expr instanceof Node\Expr\FuncCall
111+
&& $expr->name instanceof Node\Name
112+
&& $expr->name->toLowerString() === 'count';
113+
}
114+
115+
/**
116+
* @phpstan-assert-if-true Node\Expr\MethodCall $expr
117+
*/
118+
private function isCountMethodCall(Node\Expr $expr): bool
119+
{
120+
return $expr instanceof Node\Expr\MethodCall
121+
&& $expr->name instanceof Node\Identifier
122+
&& $expr->name->toLowerString() === 'count'
123+
&& count($expr->getArgs()) === 0;
124+
}
125+
126+
private function argIsCountable(MethodCall $methodCall, Scope $scope): bool
127+
{
128+
$type = $scope->getType($methodCall->var);
129+
$countableType = new ObjectType(Countable::class);
130+
131+
return $countableType->isSuperTypeOf($type)->yes();
70132
}
71133

72134
}

‎tests/Rules/PHPUnit/AssertSameWithCountRuleTest.php‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ class AssertSameWithCountRuleTest extends RuleTestCase
1313

1414
protected function getRule(): Rule
1515
{
16-
return new AssertSameWithCountRule();
16+
return new AssertSameWithCountRule(true);
1717
}
1818

1919
public function testRule(): void
@@ -23,13 +23,29 @@ public function testRule(): void
2323
'You should use assertCount($expectedCount, $variable) instead of assertSame($expectedCount, count($variable)).',
2424
10,
2525
],
26+
[
27+
'You should use assertSameSize($expected, $variable) instead of assertSame(count($expected), count($variable)).',
28+
15,
29+
],
30+
[
31+
'You should use assertSameSize($expected, $variable) instead of assertSame($expected->count(), count($variable)).',
32+
23,
33+
],
2634
[
2735
'You should use assertCount($expectedCount, $variable) instead of assertSame($expectedCount, count($variable)).',
28-
22,
36+
35,
2937
],
3038
[
3139
'You should use assertCount($expectedCount, $variable) instead of assertSame($expectedCount, $variable->count()).',
32-
30,
40+
43,
41+
],
42+
[
43+
'You should use assertSameSize($expected, $variable) instead of assertSame(count($expected), $variable->count()).',
44+
51,
45+
],
46+
[
47+
'You should use assertSameSize($expected, $variable) instead of assertSame($expected->count(), $variable->count()).',
48+
61,
3349
],
3450
]);
3551
}

‎tests/Rules/PHPUnit/data/assert-same-count.php‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,19 @@ public function testAssertSameWithCount()
1010
$this->assertSame(5, count([1, 2, 3]));
1111
}
1212

13+
public function testAssertSameWithCountExpectedWithCount()
14+
{
15+
$this->assertSame(count([10, 20]), count([1, 2, 3]));
16+
}
17+
18+
public function testAssertSameWithCountExpectedMethodWithCountMethod()
19+
{
20+
$foo = new \stdClass();
21+
$foo->bar = new Bar ();
22+
23+
$this->assertSame($foo->bar->count(), count([1, 2, 3]));
24+
}
25+
1326
public function testAssertSameWithCountMethodIsOK()
1427
{
1528
$foo = new \stdClass();
@@ -30,6 +43,24 @@ public function testAssertSameWithCountMethodForCountableVariableIsNotOK()
3043
$this->assertSame(5, $foo->bar->count());
3144
}
3245

46+
public function testAssertSameWithCountExpectedWithCountMethodForCountableVariableIsNot()
47+
{
48+
$foo = new \stdClass();
49+
$foo->bar = new Bar ();
50+
51+
$this->assertSame(count([10, 20]), $foo->bar->count());
52+
}
53+
54+
public function testAssertSameWithCountExpectedMethodWithCountMethodForCountableVariableIsNot()
55+
{
56+
$foo = new \stdClass();
57+
$foo->bar = new Bar ();
58+
$foo2 = new \stdClass();
59+
$foo2->bar = new Bar ();
60+
61+
$this->assertSame($foo2->bar->count(), $foo->bar->count());
62+
}
63+
3364
}
3465

3566
class Bar implements \Countable {

0 commit comments

Comments
 (0)