Skip to content

Fix AssertSameWithCountRule for recursive count() #257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 11, 2025
Merged

Fix AssertSameWithCountRule for recursive count() #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 51 additions & 16 deletions src/Rules/PHPUnit/AssertSameWithCountRule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,12 @@
use PHPStan\Analyser\Scope;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleErrorBuilder;
use PHPStan\TrinaryLogic;
use PHPStan\Type\Constant\ConstantIntegerType;
use PHPStan\Type\ObjectType;
use PHPStan\Type\Type;
use function count;
use const COUNT_NORMAL;

/**
* @implements Rule<CallLike>
Expand Down Expand Up @@ -42,36 +46,67 @@ public function processNode(Node $node, Scope $scope): array
}

$right = $node->getArgs()[1]->value;
if (
$right instanceof Node\Expr\FuncCall
Copy link
Contributor Author

@staabm staabm Nov 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

extracted conditions logic into new methods, to ease implementing auto-fixable in a followup

&& $right->name instanceof Node\Name
&& $right->name->toLowerString() === 'count'
) {
if (self::isCountFunctionCall($right, $scope)) {
return [
RuleErrorBuilder::message('You should use assertCount($expectedCount, $variable) instead of assertSame($expectedCount, count($variable)).')
->identifier('phpunit.assertCount')
->build(),
];
}

if (self::isCountableMethodCall($right, $scope)) {
return [
RuleErrorBuilder::message('You should use assertCount($expectedCount, $variable) instead of assertSame($expectedCount, $variable->count()).')
->identifier('phpunit.assertCount')
->build(),
];
}

return [];
}

/**
* @phpstan-assert-if-true Node\Expr\FuncCall $expr
*/
private static function isCountFunctionCall(Node\Expr $expr, Scope $scope): bool
{
return $expr instanceof Node\Expr\FuncCall
&& $expr->name instanceof Node\Name
&& $expr->name->toLowerString() === 'count'
&& count($expr->getArgs()) >= 1
&& self::isNormalCount($expr, $scope->getType($expr->getArgs()[0]->value), $scope)->yes();
}

/**
* @phpstan-assert-if-true Node\Expr\MethodCall $expr
*/
private static function isCountableMethodCall(Node\Expr $expr, Scope $scope): bool
{
if (
$right instanceof Node\Expr\MethodCall
&& $right->name instanceof Node\Identifier
&& $right->name->toLowerString() === 'count'
&& count($right->getArgs()) === 0
$expr instanceof Node\Expr\MethodCall
&& $expr->name instanceof Node\Identifier
&& $expr->name->toLowerString() === 'count'
&& count($expr->getArgs()) === 0
) {
$type = $scope->getType($right->var);
$type = $scope->getType($expr->var);

if ((new ObjectType(Countable::class))->isSuperTypeOf($type)->yes()) {
return [
RuleErrorBuilder::message('You should use assertCount($expectedCount, $variable) instead of assertSame($expectedCount, $variable->count()).')
->identifier('phpunit.assertCount')
->build(),
];
return true;
}
}

return [];
return false;
}

private static function isNormalCount(Node\Expr\FuncCall $countFuncCall, Type $countedType, Scope $scope): TrinaryLogic
{
if (count($countFuncCall->getArgs()) === 1) {
$isNormalCount = TrinaryLogic::createYes();
} else {
$mode = $scope->getType($countFuncCall->getArgs()[1]->value);
$isNormalCount = (new ConstantIntegerType(COUNT_NORMAL))->isSuperTypeOf($mode)->result->or($countedType->getIterableValueType()->isArray()->negate());
}
return $isNormalCount;
}

}
8 changes: 8 additions & 0 deletions tests/Rules/PHPUnit/AssertSameWithCountRuleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@ public function testRule(): void
'You should use assertCount($expectedCount, $variable) instead of assertSame($expectedCount, $variable->count()).',
30,
],
[
'You should use assertCount($expectedCount, $variable) instead of assertSame($expectedCount, count($variable)).',
40,
],
[
'You should use assertCount($expectedCount, $variable) instead of assertSame($expectedCount, count($variable)).',
45,
],
]);
}

Expand Down
26 changes: 25 additions & 1 deletion tests/Rules/PHPUnit/data/assert-same-count.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,35 @@ public function testAssertSameWithCountMethodForCountableVariableIsNotOK()
$this->assertSame(5, $foo->bar->count());
}

public function testRecursiveCount($x)
{
$this->assertSame(5, count([1, 2, 3, $x], COUNT_RECURSIVE)); // OK
}

public function testNormalCount($x)
{
$this->assertSame(5, count([1, 2, 3, $x], COUNT_NORMAL));
}

public function testImplicitNormalCount($mode)
{
$this->assertSame(5, count([1, 2, 3], $mode));
}

public function testUnknownCountable($x, $mode)
{
$this->assertSame(5, count($x, $mode)); // OK
}

public function testUnknownCountMode($x, $mode)
{
$this->assertSame(5, count([1, 2, 3, $x], $mode)); // OK
}
}

class Bar implements \Countable {
public function count(): int
{
return 1;
}
};
}
Loading