Merge branch '10.0'

Author: sebastianbergmann

ChangeLog-10.0.md

@@ -2,6 +2,12 @@
 
 All notable changes of the PHPUnit 10.0 release series are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles.
 
+## [10.0.12] - 2023-MM-DD
+
+### Changed
+
+* Values of other types than `array` may now be passed to `assertIsList()`
+
 ## [10.0.11] - 2023-02-20
 
 ### Fixed
@@ -210,6 +216,7 @@ All notable changes of the PHPUnit 10.0 release series are documented in this fi
 * PHP 7.3, PHP 7.4, and PHP 8.0 are no longer supported
 * `phpunit/php-code-coverage` [no longer supports PHPDBG and Xdebug 2](https://github.com/sebastianbergmann/php-code-coverage/blob/10.0.0/ChangeLog.md#1000---2023-02-03)
 
+[10.0.12]: https://github.com/sebastianbergmann/phpunit/compare/10.0.11...10.0
 [10.0.11]: https://github.com/sebastianbergmann/phpunit/compare/10.0.10...10.0.11
 [10.0.10]: https://github.com/sebastianbergmann/phpunit/compare/10.0.9...10.0.10
 [10.0.9]: https://github.com/sebastianbergmann/phpunit/compare/10.0.8...10.0.9

src/Framework/Assert.php

@@ -103,7 +103,7 @@ final public static function assertArrayNotHasKey(int|string $key, array|ArrayAc
     /**
      * @throws ExpectationFailedException
      */
-    final public static function assertIsList(array $array, string $message = ''): void
+    final public static function assertIsList(mixed $array, string $message = ''): void
     {
         static::assertThat(
             $array,
@@ -1824,9 +1824,9 @@ final public static function assertThat(mixed $value, Constraint $constraint, st
      *
      * @throws ExpectationFailedException
      */
-    final public static function assertJson(string $actualJson, string $message = ''): void
+    final public static function assertJson(string $actual, string $message = ''): void
     {
-        static::assertThat($actualJson, static::isJson(), $message);
+        static::assertThat($actual, static::isJson(), $message);
     }
 
     /**

src/Framework/Assert/Functions.php

@@ -111,7 +111,7 @@ function assertArrayNotHasKey(int|string $key, array|ArrayAccess $array, string
      *
      * @see Assert::assertIsList
      */
-    function assertIsList(array $array, string $message = ''): void
+    function assertIsList(mixed $array, string $message = ''): void
     {
         Assert::assertIsList(...func_get_args());
     }
@@ -2095,7 +2095,7 @@ function assertThat(mixed $value, Constraint $constraint, string $message = ''):
      *
      * @see Assert::assertJson
      */
-    function assertJson(string $actualJson, string $message = ''): void
+    function assertJson(string $actual, string $message = ''): void
     {
         Assert::assertJson(...func_get_args());
     }

src/Framework/Constraint/Traversable/IsList.php

@@ -10,7 +10,9 @@
 namespace PHPUnit\Framework\Constraint;
 
 use function array_is_list;
+use function gettype;
 use function is_array;
+use function strtolower;
 
 /**
  * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
@@ -22,7 +24,7 @@ final class IsList extends Constraint
      */
     public function toString(): string
     {
-        return 'is list';
+        return 'is a list';
     }
 
     /**
@@ -46,6 +48,20 @@ protected function matches(mixed $other): bool
      */
     protected function failureDescription(mixed $other): string
     {
-        return 'an array ' . $this->toString();
+        $type = strtolower(gettype($other));
+
+        if ($type === 'double') {
+            $type = 'float';
+        }
+
+        if ($type === 'resource (closed)') {
+            $type = 'closed resource';
+        }
+
+        return match ($type) {
+            'array', 'integer', 'object' => 'an ' . $type . ' ' . $this->toString(),
+            'boolean', 'float', 'null', 'resource', 'string' => 'a ' . $type . ' ' . $this->toString(),
+            default => 'a value of ' . $type . ' ' . $this->toString(),
+        };
     }
 }

tests/unit/Framework/AssertTest.php

@@ -251,6 +251,13 @@ public function testAssertIsListFailsWithStringKeys(): void
         $this->assertIsList(['string' => 0]);
     }
 
+    public function testAssertIsListFailsForTypesOtherThanArray(): void
+    {
+        $this->expectException(AssertionFailedError::class);
+
+        $this->assertIsList(null);
+    }
+
     public function testAssertArrayContainsOnlyIntegers(): void
     {
         $this->assertContainsOnly('integer', [1, 2, 3]);

tests/unit/Framework/Constraint/IsListTest.php

@@ -31,15 +31,15 @@ public function testConstraintIsNotList(): void
         $constraint = new IsList;
 
         $this->assertFalse($constraint->evaluate([1 => 1], '', true));
-        $this->assertEquals('is list', $constraint->toString());
+        $this->assertEquals('is a list', $constraint->toString());
         $this->assertCount(1, $constraint);
 
         try {
             $constraint->evaluate([1 => 1]);
         } catch (ExpectationFailedException $e) {
             $this->assertEquals(
                 <<<'EOF'
-Failed asserting that an array is list.
+Failed asserting that an array is a list.
 
 EOF
                 ,
@@ -57,15 +57,15 @@ public function testConstraintIsNotListWithFilteredArray(): void
         $constraint = new IsList;
 
         $this->assertFalse($constraint->evaluate([0 => 0, 1 => 1, 3 => 3], '', true));
-        $this->assertEquals('is list', $constraint->toString());
+        $this->assertEquals('is a list', $constraint->toString());
         $this->assertCount(1, $constraint);
 
         try {
             $constraint->evaluate([1 => 1]);
         } catch (ExpectationFailedException $e) {
             $this->assertEquals(
                 <<<'EOF'
-Failed asserting that an array is list.
+Failed asserting that an array is a list.
 
 EOF
                 ,
@@ -88,7 +88,7 @@ public function testConstraintIsNotListWithCustomMessage(): void
             $this->assertEquals(
                 <<<'EOF'
 custom message
-Failed asserting that an array is list.
+Failed asserting that an array is a list.
 
 EOF
                 ,
@@ -110,7 +110,7 @@ public function testConstraintIsNotListWhenNotArray(): void
         } catch (ExpectationFailedException $e) {
             $this->assertEquals(
                 <<<'EOF'
-Failed asserting that an array is list.
+Failed asserting that a string is a list.
 
 EOF
                 ,
@@ -131,7 +131,7 @@ public function testConstraintArrayIsNotList(): void
             $this->assertEquals(
                 <<<'EOF'
 custom message
-Failed asserting that an array is not list.
+Failed asserting that an array is not a list.
 
 EOF
                 ,