Yiisoft\Yii\Debug\Tests\Unit\DumperTest

Complexity

Total Complexity

5

Size/Duplication

Total Lines	301
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	testAsJson()	0	4	1
A	asJsonObjectMapDataProvider()	0	22	1
A	testAsJsonObjectsMap()	0	4	1
B	jsonDataProvider()	0	236	1
A	assertEqualsWithoutLE()	0	5	1

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Debug\Tests\Unit;

use PHPUnit\Framework\TestCase;
use stdClass;
use Yiisoft\Yii\Debug as D;
use Yiisoft\Yii\Debug\Dumper;

final class DumperTest extends TestCase
{
    /**
     * @dataProvider asJsonObjectMapDataProvider
     *
     * @param string $expectedResult
     *
     * @group JOM
     */
    public function testAsJsonObjectsMap(mixed $var, $expectedResult): void
    {
        $exportResult = Dumper::create($var)->asJsonObjectsMap();
        $this->assertEquals($expectedResult, $exportResult);
    }

    public function asJsonObjectMapDataProvider(): array
    {
        $user = new stdClass();
        $user->id = 1;
        $objectId = spl_object_id($user);

        $decoratedUser = clone $user;
        $decoratedUser->name = 'Name';
        $decoratedUser->originalUser = $user;
        $decoratedObjectId = spl_object_id($decoratedUser);

        return [
            [
                $user,
                <<<S
                [{"stdClass#{$objectId}":{"public \$id":1}}]
                S,
            ],
            [
                $decoratedUser,
                <<<S
                [{"stdClass#{$decoratedObjectId}":{"public \$id":1,"public \$name":"Name","public \$originalUser":"object@stdClass#{$objectId}"}},{"stdClass#{$objectId}":{"public \$id":1}}]
                S,
            ],
        ];
    }

    /**
     * @dataProvider jsonDataProvider()
     */
    public function testAsJson($variable, string $result): void
    {
        $output = Dumper::create($variable)->asJson();
        $this->assertEqualsWithoutLE($result, $output);
    }

    public function jsonDataProvider(): array
    {
        $objectWithClosureInProperty = new stdClass();
        // @formatter:off
        $objectWithClosureInProperty->a = fn () => 1;
        // @formatter:on
        $objectWithClosureInPropertyId = spl_object_id($objectWithClosureInProperty);
        $objectWithClosureInPropertyClosureId = spl_object_id($objectWithClosureInProperty->a);

$objectWithClosureInProperty->a of type callable is incompatible with the type object expected by parameter $object of spl_object_id().

        $emptyObject = new stdClass();
        $emptyObjectId = spl_object_id($emptyObject);

        // @formatter:off
        $shortFunctionObject = fn () => 1;
        // @formatter:on
        $shortFunctionObjectId = spl_object_id($shortFunctionObject);

$shortFunctionObject of type callable is incompatible with the type object expected by parameter $object of spl_object_id().

        // @formatter:off
        $staticShortFunctionObject = static fn () => 1;
        // @formatter:on
        $staticShortFunctionObjectId = spl_object_id($staticShortFunctionObject);

$staticShortFunctionObject of type callable is incompatible with the type object expected by parameter $object of spl_object_id().

        // @formatter:off
        $functionObject = function () {
            return 1;
        };
        // @formatter:on
        $functionObjectId = spl_object_id($functionObject);

$functionObject of type callable is incompatible with the type object expected by parameter $object of spl_object_id().

        // @formatter:off
        $staticFunctionObject = static function () {
            return 1;
        };
        // @formatter:on
        $staticFunctionObjectId = spl_object_id($staticFunctionObject);

$staticFunctionObject of type callable is incompatible with the type object expected by parameter $object of spl_object_id().

        // @formatter:off
        $closureWithNullCollisionOperatorObject = fn () => $_ENV['var'] ?? null;
        // @formatter:on
        $closureWithNullCollisionOperatorObjectId = spl_object_id($closureWithNullCollisionOperatorObject);

$closureWithNullCollisionOperatorObject of type callable is incompatible with the type object expected by parameter $object of spl_object_id().

        // @formatter:off
        $closureWithUsualClassNameObject = fn (Dumper $date) => new \DateTimeZone('');

The parameter $date is not used and could be removed.

        // @formatter:on
        $closureWithUsualClassNameObjectId = spl_object_id($closureWithUsualClassNameObject);

$closureWithUsualClassNameObject of type callable is incompatible with the type object expected by parameter $object of spl_object_id().

        // @formatter:off
        $closureWithAliasedClassNameObject = fn (Dumper $date) => new \DateTimeZone('');

The parameter $date is not used and could be removed.

        // @formatter:on
        $closureWithAliasedClassNameObjectId = spl_object_id($closureWithAliasedClassNameObject);

$closureWithAliasedClassNameObject of type callable is incompatible with the type object expected by parameter $object of spl_object_id().

        // @formatter:off
        $closureWithAliasedNamespaceObject = fn (D\Dumper $date) => new \DateTimeZone('');

The parameter $date is not used and could be removed.

        // @formatter:on
        $closureWithAliasedNamespaceObjectId = spl_object_id($closureWithAliasedNamespaceObject);

$closureWithAliasedNamespaceObject of type callable is incompatible with the type object expected by parameter $object of spl_object_id().

        // @formatter:off
        $closureInArrayObject = fn () => new \DateTimeZone('');
        // @formatter:on
        $closureInArrayObjectId = spl_object_id($closureInArrayObject);

$closureInArrayObject of type callable is incompatible with the type object expected by parameter $object of spl_object_id().

        $fileResource = tmpfile();
        $fileResourceUri = preg_quote(stream_get_meta_data($fileResource)['uri'], '/');

        $closedFileResource = tmpfile();
        fclose($closedFileResource);
        $closedFileResourceUri = preg_quote(stream_get_meta_data($fileResource)['uri'], '/');

The assignment to $closedFileResourceUri is dead and can be removed.

        $opendirResource = opendir('/tmp');
        //$opendirResourceUri = preg_quote(stream_get_meta_data($fileResource)['uri'], '/');

        $curlResource = curl_init('https://example.com');
        $curlResourceObjectId = spl_object_id($curlResource);

It seems like $curlResource can also be of type resource; however, parameter $object of spl_object_id() does only seem to accept object, maybe add an additional type check?

        return [
            'empty object' => [
                $emptyObject,
                <<<S
                {"stdClass#{$emptyObjectId}":"{stateless object}"}
                S,
            ],
            'short function' => [
                $shortFunctionObject,
                <<<S
                {"Closure#{$shortFunctionObjectId}":"fn () => 1"}
                S,
            ],
            'short static function' => [
                $staticShortFunctionObject,
                <<<S
                {"Closure#{$staticShortFunctionObjectId}":"static fn () => 1"}
                S,
            ],
            'function' => [
                $functionObject,
                <<<S
                {"Closure#{$functionObjectId}":"function () {\\n            return 1;\\n        }"}
                S,
            ],
            'static function' => [
                $staticFunctionObject,
                <<<S
                {"Closure#{$staticFunctionObjectId}":"static function () {\\n            return 1;\\n        }"}
                S,
            ],
            'string' => [
                'Hello, Yii!',
                '"Hello, Yii!"',
            ],
            'empty string' => [
                '',
                '""',
            ],
            'null' => [
                null,
                'null',
            ],
            'integer' => [
                1,
                '1',
            ],
            'integer with separator' => [
                1_23_456,

The constant Yiisoft\Yii\Debug\Tests\Unit\1_23_456 was not found. Maybe you did not declare it correctly or list all dependencies?

                '123456',
            ],
            'boolean' => [
                true,
                'true',
            ],
            'fileResource' => [
                fopen('php://input', 'rb'),
                '{"timed_out":false,"blocked":true,"eof":false,"wrapper_type":"PHP","stream_type":"Input","mode":"rb","unread_bytes":0,"seekable":true,"uri":"php:\/\/input"}',
            ],
            'empty array' => [
                [],
                '[]',
            ],
            'array of 3 elements, automatic keys' => [
                [
                    'one',
                    'two',
                    'three',
                ],
                '["one","two","three"]',
            ],
            'array of 3 elements, custom keys' => [
                [
                    2 => 'one',
                    'two' => 'two',
                    0 => 'three',
                ],
                '{"2":"one","two":"two","0":"three"}',
            ],
            'closure in array' => [
                // @formatter:off
                [$closureInArrayObject],
                // @formatter:on
                <<<S
                [{"Closure#{$closureInArrayObjectId}":"fn () => new \\\DateTimeZone('')"}]
                S,
            ],
            'original class name' => [
                $closureWithUsualClassNameObject,
                <<<S
                {"Closure#{$closureWithUsualClassNameObjectId}":"fn (\\\Yiisoft\\\Yii\\\Debug\\\Dumper \$date) => new \\\DateTimeZone('')"}
                S,
            ],
            'class alias' => [
                $closureWithAliasedClassNameObject,
                <<<S
                {"Closure#{$closureWithAliasedClassNameObjectId}":"fn (\\\Yiisoft\\\Yii\\\Debug\\\Dumper \$date) => new \\\DateTimeZone('')"}
                S,
            ],
            'namespace alias' => [
                $closureWithAliasedNamespaceObject,
                <<<S
                {"Closure#{$closureWithAliasedNamespaceObjectId}":"fn (\\\Yiisoft\\\Yii\\\Debug\\\Dumper \$date) => new \\\DateTimeZone('')"}
                S,
            ],
            'closure with null-collision operator' => [
                $closureWithNullCollisionOperatorObject,
                <<<S
                {"Closure#{$closureWithNullCollisionOperatorObjectId}":"fn () => \$_ENV['var'] ?? null"}
                S,
            ],
            'utf8 supported' => [
                '🤣',
                '"🤣"',
            ],
            'closure in property supported' => [
                $objectWithClosureInProperty,
                <<<S
                {"stdClass#{$objectWithClosureInPropertyId}":{"public \$a":{"Closure#{$objectWithClosureInPropertyClosureId}":"fn () => 1"}}}
                S,
            ],
            'binary string' => [
                pack('H*', md5('binary string')),
                '"ɍ��^��\u00191\u0017�]�-f�"',
            ],
            'file resource' => [
                $fileResource,
                <<<S
                {"timed_out":false,"blocked":true,"eof":false,"wrapper_type":"plainfile","stream_type":"STDIO","mode":"r+b","unread_bytes":0,"seekable":true,"uri":"{$fileResourceUri}"}
                S,
            ],
            'closed file resource' => [
                $closedFileResource,
                '"{closed resource}"',
            ],
            'opendir resource' => [
                $opendirResource,
                <<<S
                {"timed_out":false,"blocked":true,"eof":false,"wrapper_type":"plainfile","stream_type":"dir","mode":"r","unread_bytes":0,"seekable":true}
                S,
            ],
            'curl resource' => [
                $curlResource,
                <<<S
                {"CurlHandle#{$curlResourceObjectId}":"{stateless object}"}
                S,
            ],
            'stdout' => [
                STDOUT,
                <<<S
                {"timed_out":false,"blocked":true,"eof":false,"wrapper_type":"PHP","stream_type":"STDIO","mode":"wb","unread_bytes":0,"seekable":false,"uri":"php:\/\/stdout"}
                S,
            ],
            'stderr' => [
                STDERR,
                <<<S
                {"timed_out":false,"blocked":true,"eof":false,"wrapper_type":"PHP","stream_type":"STDIO","mode":"wb","unread_bytes":0,"seekable":false,"uri":"php:\/\/stderr"}
                S,
            ],
            'stdin' => [
                STDIN,
                <<<S
                {"timed_out":false,"blocked":true,"eof":false,"wrapper_type":"PHP","stream_type":"STDIO","mode":"rb","unread_bytes":0,"seekable":false,"uri":"php:\/\/stdin"}
                S,
            ],
        ];
    }

    /**
     * Asserting two strings equality ignoring line endings.
     */
    protected function assertEqualsWithoutLE(string $expected, string $actual, string $message = ''): void
    {
        $expected = str_replace(["\r\n", '\r\n'], ["\n", '\n'], $expected);
        $actual = str_replace(["\r\n", '\r\n'], ["\n", '\n'], $actual);
        $this->assertEquals($expected, $actual, $message);
    }
}