10681768699

Committed 03 Sep 2024 11:08AM UTC coverage: 97.152%. Remained the same

Build # 10681768699

Build Type

push

github

Committed by

jrfnl

Commit Message

PHPUnit 11.3.1 | AssertIsList: sync error message with upstream

PHPUnit 11.3.1 improved the type information in select assertion failure messages.

For the polyfills, this only affects the `AssertIsList` polyfill.

Now the choice was between the following:
* Just update the test(s) to have a different message expectation for PHPUnit 11.3.1+.
* Update the polyfills to mirror the improvement made in PHPUnit upstream.

I've chosen to implement the latter as it makes the message significantly more informative.

This means that on PHPUnit 6.x to 9.x and 11.3.1+, the new, improved message is shown. While on PHPUnit 10.0 - 11.3.0, the "old" message is shown as, in that case, the PHPUnit native `assertIsList()` method is used without the message improvements.

Includes:
* Renaming the `assertIsListFailureDescription()` method parameter from `$other` to `$value` to be more descriptive.
* Updating the tests, including adding an extra test with an anonymous class as that has separate handling for the error message in the polyfill.

Refs:
* https://github.com/sebastianbergmann/phpunit/commit/5e8b79e52
* https://github.com/sebastianbergmann/phpunit/commit/42cfc7d59

Run Details

14 of 14 new or added lines in 1 file covered. (100.0%)

2 existing lines in 1 file now uncovered.

580 of 597 relevant lines covered (97.15%)

124.53 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.43

/src/Polyfills/AssertIsList.php

<?php

namespace Yoast\PHPUnitPolyfills\Polyfills;

use PHPUnit\Framework\Assert;
use ReflectionObject;

/**
 * Polyfill the Assert::assertIsList() method.
 *
 * Introduced in PHPUnit 10.0.0.
 *
 * @link https://github.com/sebastianbergmann/phpunit/pull/4818
 *
 * @since 2.0.0
 */
trait AssertIsList {

        /**
         * Asserts that an array is list.
         *
         * @param mixed  $array   The value to test.
         * @param string $message Optional failure message to display.
         *
         * @return void
         */
        final public static function assertIsList( $array, $message = '' ) {
                $msg = self::assertIsListFailureDescription( $array );
                if ( $message !== '' ) {
                        $msg = $message . \PHP_EOL . $msg;
                }

                if ( \is_array( $array ) === false ) {
                        if ( \method_exists( Assert::class, 'assertIsArray' ) ) {
                                static::assertIsArray( $array, $msg );
                                return;
                        }

                        static::assertInternalType( 'array', $array, $msg );
                        return;
                }

                if ( $array === [] ) {
                        static::assertSame( $array, $array, $msg );
                        return;
                }

                if ( \function_exists( 'array_is_list' ) ) {
                        // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctions.array_is_listFound -- PHP 8.1+.
                        static::assertTrue( \array_is_list( $array ), $msg );
                        return;
                }

                $expected = \range( 0, ( \count( $array ) - 1 ) );

                static::assertSame( $expected, \array_keys( $array ), $msg );
        }

        /**
         * Returns the description of the failure.
         *
         * @param mixed $value The value under test.
         *
         * @return string
         */
        private static function assertIsListFailureDescription( $value ) {
                $message = 'Failed asserting that %s is a list.';

                if ( \is_object( $value ) ) {
                        // Improved error message as per upstream since PHPUnit 11.3.1.
                        $reflector   = new ReflectionObject( $value );
                        $description = 'an instance of class ' . $reflector->getName();

                        if ( $reflector->isAnonymous() ) {
                                $name   = \str_replace( 'class@anonymous', '', $reflector->getName() );
                                $length = \strpos( $name, '$' );
                                if ( \is_int( $length ) ) {
                                        $name = \substr( $name, 0, $length );
                                }

                                $description = 'an instance of anonymous class created at ' . $name;
                        }

                        return \sprintf( $message, $description );
                }

                $type = \strtolower( \gettype( $value ) );

                switch ( $type ) {
                        case 'double':
                                $description = 'a float';
                                break;

                        case 'resource (closed)':
                                $description = 'a closed resource';
                                break;

                        case 'array':
                        case 'integer':
                                $description = 'an ' . $type;
                                break;

                        case 'boolean':
                        case 'closed resource':
                        case 'float':
                        case 'resource':
                        case 'string':
                                $description = 'a ' . $type;
                                break;

                        case 'null':
                                $description = 'null';
                                break;

                        default:
                                $description = 'a value of ' . $type;
                                break;
                }

                return \sprintf( $message, $description );
        }
}

1	<?php
2
3	namespace Yoast\PHPUnitPolyfills\Polyfills;
4
5	use PHPUnit\Framework\Assert;
6	use ReflectionObject;
7
8	/**
9	* Polyfill the Assert::assertIsList() method.
10	*
11	* Introduced in PHPUnit 10.0.0.
12	*
13	* @link https://github.com/sebastianbergmann/phpunit/pull/4818
14	*
15	* @since 2.0.0
16	*/
17	trait AssertIsList {
18
19	/**
20	* Asserts that an array is list.
21	*
22	* @param mixed $array The value to test.
23	* @param string $message Optional failure message to display.
24	*
25	* @return void
26	*/
27	final public static function assertIsList( $array, $message = '' ) {	429✔
28	$msg = self::assertIsListFailureDescription( $array );	429✔
29	if ( $message !== '' ) {	429✔
30	$msg = $message . \PHP_EOL . $msg;	21✔
31	}
32
33	if ( \is_array( $array ) === false ) {	429✔
34	if ( \method_exists( Assert::class, 'assertIsArray' ) ) {	168✔
35	static::assertIsArray( $array, $msg );	120✔
UNCOV 36	return;	×
37	}
38
39	static::assertInternalType( 'array', $array, $msg );	48✔
UNCOV 40	return;	×
41	}
42
43	if ( $array === [] ) {	261✔
44	static::assertSame( $array, $array, $msg );	21✔
45	return;	21✔
46	}
47
48	if ( \function_exists( 'array_is_list' ) ) {	240✔
49	// phpcs:ignore PHPCompatibility.FunctionUse.NewFunctions.array_is_listFound -- PHP 8.1+.
50	static::assertTrue( \array_is_list( $array ), $msg );	36✔
51	return;	18✔
52	}
53
54	$expected = \range( 0, ( \count( $array ) - 1 ) );	204✔
55
56	static::assertSame( $expected, \array_keys( $array ), $msg );	204✔
57	}	66✔
58
59	/**
60	* Returns the description of the failure.
61	*
62	* @param mixed $value The value under test.
63	*
64	* @return string
65	*/
66	private static function assertIsListFailureDescription( $value ) {	429✔
67	$message = 'Failed asserting that %s is a list.';	429✔
68
69	if ( \is_object( $value ) ) {	429✔
70	// Improved error message as per upstream since PHPUnit 11.3.1.
71	$reflector = new ReflectionObject( $value );	42✔
72	$description = 'an instance of class ' . $reflector->getName();	42✔
73
74	if ( $reflector->isAnonymous() ) {	42✔
75	$name = \str_replace( 'class@anonymous', '', $reflector->getName() );	21✔
76	$length = \strpos( $name, '$' );	21✔
77	if ( \is_int( $length ) ) {	21✔
78	$name = \substr( $name, 0, $length );	9✔
79	}
80
81	$description = 'an instance of anonymous class created at ' . $name;	21✔
82	}
83
84	return \sprintf( $message, $description );	42✔
85	}
86
87	$type = \strtolower( \gettype( $value ) );	387✔
88
89	switch ( $type ) {	165✔
90	case 'double':	387✔
91	$description = 'a float';	21✔
92	break;	21✔
93
94	case 'resource (closed)':	366✔
95	$description = 'a closed resource';	17✔
96	break;	17✔
97
98	case 'array':	349✔
99	case 'integer':	88✔
100	$description = 'an ' . $type;	282✔
101	break;	282✔
102
103	case 'boolean':	67✔
104	case 'closed resource':	46✔
105	case 'float':	46✔
106	case 'resource':	46✔
107	case 'string':	46✔
108	$description = 'a ' . $type;	42✔
109	break;	42✔
110
111	case 'null':	25✔
112	$description = 'null';	21✔
113	break;	21✔
114
115	default:
116	$description = 'a value of ' . $type;	4✔
117	break;	4✔
118	}
119
120	return \sprintf( $message, $description );	387✔
121	}
122	}

Yoast / PHPUnit-Polyfills / 10681768699

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous