ValuesTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Tests\KeyValueStorage\Internal;
 
use ILIAS\KeyValueStorage\Exception\InvalidStoredValueException;
use ILIAS\KeyValueStorage\Internal\Values;
use ILIAS\Tests\KeyValueStorage\RefineryHelper;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
 
class ValuesTest extends TestCase
{
    use RefineryHelper;
 
    private Values $values;
 
    protected function setUp(): void
    {
        $this->values = new Values($this->refinery());
    }
 
    #[DataProvider('roundTrippableValues')]
    public function testValuesSurviveARoundTrip(mixed $value): void
    {
        $this->assertSame($value, $this->values->decode($this->values->encode($value)));
    }
 
    public static function roundTrippableValues(): array
    {
        return [
            'null' => [null],
            'true' => [true],
            'false' => [false],
            'int' => [42],
            'float' => [1.5],
            'string' => ['title'],
            'empty string' => [''],
            'list' => [['a', 'b']],
            'map' => [['sort' => 'title', 'direction' => 'asc']],
            'nested' => [['filter' => ['status' => ['open', 'closed'], 'limit' => 10]]],
            'empty array' => [[]],
        ];
    }
 
    public function testJsonSerializableIsStoredAsItsJsonForm(): void
    {
        $value = new class () implements \JsonSerializable {
            public function jsonSerialize(): array
            {
                return ['a' => 1];
            }
        };
 
        $this->assertSame('{"a":1}', $this->values->encode($value));
        $this->assertSame(['a' => 1], $this->values->decode($this->values->encode($value)));
    }
 
    public function testAJsonSerializableMayReturnAScalar(): void
    {
        $value = new class () implements \JsonSerializable {
            public function jsonSerialize(): string
            {
                return 'title';
            }
        };
 
        $this->assertSame('title', $this->values->decode($this->values->encode($value)));
    }
 
    public function testAJsonSerializableInsideAnArrayIsAccepted(): void
    {
        $inner = new class () implements \JsonSerializable {
            public function jsonSerialize(): array
            {
                return ['a' => 1];
            }
        };
 
        $this->assertSame(
            ['wrapped' => ['a' => 1]],
            $this->values->decode($this->values->encode(['wrapped' => $inner]))
        );
    }
 
    public function testAJsonSerializableReturningSomethingUnstorableIsRejected(): void
    {
        $value = new class () implements \JsonSerializable {
            public function jsonSerialize(): array
            {
                return ['bad' => new \stdClass()];
            }
        };
 
        $this->expectException(\InvalidArgumentException::class);
 
        $this->values->encode($value);
    }
 
    #[DataProvider('unstorableValues')]
    public function testUnstorableValuesAreRejected(mixed $value): void
    {
        $this->expectException(\InvalidArgumentException::class);
 
        $this->values->encode($value);
    }
 
    public static function unstorableValues(): array
    {
        return [
            'plain object' => [new \stdClass()],
            'object in array' => [['a' => new \stdClass()]],
            'closure' => [static fn() => null],
            'not a number' => [NAN],
        ];
    }
 
    public function testStoredGarbageIsReported(): void
    {
        $this->expectException(InvalidStoredValueException::class);
 
        $this->values->decode('{not json');
    }
}