Fix #282: Fix dumper

[samdark]

Q	A
Is bugfix?	✔️
New feature?	❌
Breaks BC?	❌

[samdark]

@olegbaturin would you please test it?

[samdark]

Could be that 2 is more than enough and 1 would do as well.

[olegbaturin]

1 would do as well

2 is min, because property of the root object, that is object, must be converted to the expected string

yii-debug/src/Dumper.php

Line 150 in 90bb196

if ($depth <= $level || array_key_exists($variable::class, $this->excludedClasses)) {

but this works only if dumped variable object or function, if it's an array, than it must be dumped deeper (or no?).

[samdark]

@xepozz seem to fail tests.

[olegbaturin]

/**
 * @dataProvider loopAsJsonObjectMapDataProvider
 */
public function testLoopAsJsonObjectsMap(mixed $var, int $depth, $expectedResult): void
{
    $exportResult = Dumper::create($var)->asJsonObjectsMap($depth);
    $this->assertEquals($expectedResult, $exportResult);
}

public static function loopAsJsonObjectMapDataProvider(): iterable
{
    // parent->child->parent structure
    $o1 = new \stdClass();
    $o1->id = 'o1';
    $o2 = new \stdClass();
    $o2->id = 'o2';
    $o2->o1 = $o1;
    $o1->o2 = $o2;

    // 5 is a min level to reproduce buggy dumping of parent->child->parent structure
    $head1 = self::getNested(5, $o1);
    // can't imagine the expected result
    yield 'nested loop - object' => [
        $head1,
        5,
        <<<S
        {}
        S,
    ];

    // array loop must be 1 level deeper to parse loop objects
    $head2 = self::getNested(6, [$o1, $o2]);
    // can't imagine the expected result
    yield 'nested loop - array' => [
        $head2,
        6,
        <<<S
        {}
        S,
    ];

    $head3 = new \stdClass();
    $head3->id = '1';
    $head3->lv12 = [
        'id' => 2,
        'loop' => $o1,
    ];
    // can't imagine the expected result
    yield 'nested loop to object->array' => [
        $head3,
        3,
        <<<S
        {}
        S,
    ];
}

private static function getNested(int $depth, mixed $data): object
{
    $head = $lvl = new \stdClass();
    $lvl->id = 'lvl1';

    for ($i = 2; $i <= $depth; $i++) {
        $nested = new \stdClass();
        $nested->id = 'lvl'.$i;
        $lvl->{'lvl'.$i} = $nested;
        $lvl = $nested;
    }
    $lvl->loop = $data;

    return $head;
}

[olegbaturin]

@samdark I've added some tests for dumping of loop and one test for your solution.

If you show me expected results for those cases, I can make a fix.

[olegbaturin]

@olegbaturin would you please test it?

this fixes the issue, but changes some dumped structures,

[samdark]

@xepozz need your help with expected results.

[olegbaturin]

https://github.com/olegbaturin/yii3-debug/tree/282-fix-dumper

@samdark, @xepozz check the output to /runtime/debug please, look like this is a fix. Results in the test errors will become the expected results.

[samdark]

#284

[samdark]

@olegbaturin I like your fix more.