Skip to content

Make the ordering assertions reject operands PHP can only compare by coercion #366

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

Open
lenamonj wants to merge 1 commit into
base: master
Choose a base branch
from
+36 −5
Open

Make the ordering assertions reject operands PHP can only compare by coercion #366

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
28 changes: 23 additions & 5 deletions src/Assert.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1114,7 +1114,7 @@ public static function notSame(mixed $value, mixed $expect, string|callable $mes
*/
public static function greaterThan(mixed $value, mixed $limit, string|callable $message = ''): mixed
{
if ($value <= $limit) {
if (!static::comparable($value, $limit) || $value <= $limit) {
$message = self::resolveMessage($message);
static::reportInvalidArgument(\sprintf(
$message ?: 'Expected a value greater than %2$s. Got: %s',
Expand All @@ -1135,7 +1135,7 @@ public static function greaterThan(mixed $value, mixed $limit, string|callable $
*/
public static function greaterThanEq(mixed $value, mixed $limit, string|callable $message = ''): mixed
{
if ($value < $limit) {
if (!static::comparable($value, $limit) || $value < $limit) {
$message = self::resolveMessage($message);
static::reportInvalidArgument(\sprintf(
$message ?: 'Expected a value greater than or equal to %2$s. Got: %s',
Expand All @@ -1156,7 +1156,7 @@ public static function greaterThanEq(mixed $value, mixed $limit, string|callable
*/
public static function lessThan(mixed $value, mixed $limit, string|callable $message = ''): mixed
{
if ($value >= $limit) {
if (!static::comparable($value, $limit) || $value >= $limit) {
$message = self::resolveMessage($message);
static::reportInvalidArgument(\sprintf(
$message ?: 'Expected a value less than %2$s. Got: %s',
Expand All @@ -1177,7 +1177,7 @@ public static function lessThan(mixed $value, mixed $limit, string|callable $mes
*/
public static function lessThanEq(mixed $value, mixed $limit, string|callable $message = ''): mixed
{
if ($value > $limit) {
if (!static::comparable($value, $limit) || $value > $limit) {
$message = self::resolveMessage($message);
static::reportInvalidArgument(\sprintf(
$message ?: 'Expected a value less than or equal to %2$s. Got: %s',
Expand All @@ -1200,7 +1200,7 @@ public static function lessThanEq(mixed $value, mixed $limit, string|callable $m
*/
public static function range(mixed $value, mixed $min, mixed $max, string|callable $message = ''): mixed
{
if ($value < $min || $value > $max) {
if (!static::comparable($value, $min) || !static::comparable($value, $max) || $value < $min || $value > $max) {
$message = self::resolveMessage($message);
static::reportInvalidArgument(\sprintf(
$message ?: 'Expected a value between %2$s and %3$s. Got: %s',
Expand Down Expand Up @@ -2614,6 +2614,24 @@ protected static function resolveMessage(string|callable $message): string
return \is_callable($message) ? $message() : $message;
}

/**
* Whether two operands can be ordered against one another without coercion.
*
* PHP's relational operators answer for every pair: an object compares as 1, an array
* outranks any scalar, null and bool are compared as bool. The ordering assertions ask
* this first, so such a pair is reported as a failed assertion instead of a passed one.
*
* @psalm-pure
*/
protected static function comparable(mixed $value, mixed $other): bool
{
return (\is_numeric($value) && \is_numeric($other))
|| (\is_string($value) && \is_string($other))
|| (\is_bool($value) && \is_bool($other))
|| (\is_array($value) && \is_array($other))
|| (\is_object($value) && \is_object($other));
}

private function __construct()
{
}
Expand Down
13 changes: 13 additions & 0 deletions tests/AssertTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,19 @@ public static function getTests(): array
['range', [2, 1, 2], true],
['range', [0, 1, 2], false],
['range', [3, 1, 2], false],
['greaterThan', [new stdClass(), 10], false],
['greaterThan', [[1, 2], 10], false],
['greaterThan', ['abc', 10], false],
['greaterThanEq', [null, 10], false],
['lessThan', [new stdClass(), 10], false],
['lessThan', [false, 10], false],
['range', [new stdClass(), 1, 10], false],
['range', [5, 1, 'x'], false],
['lessThan', ['5', 10], true],
['lessThan', ['abc', 'abd'], true],
['lessThan', [[1], [1, 2]], true],
['greaterThan', [true, false], true],
['lessThan', [new DateTimeImmutable('2020-01-01'), new DateTimeImmutable('2021-01-01')], true],
['oneOf', [1, [1, 2, 3]], true],
['oneOf', [1, ['1', '2', '3']], false],
['notOneOf', [1, [1, 2, 3]], false],
Expand Down