StringIdTest.php

<?php

/*
 * Copyright 2025 Cloud Creativity Limited
 *
 * Use of this source code is governed by an MIT-style
 * license that can be found in the LICENSE file or at
 * https://opensource.org/licenses/MIT.
 */

declare(strict_types=1);

namespace CloudCreativity\Modules\Tests\Unit\Toolkit\Identifiers;

use CloudCreativity\Modules\Contracts\Toolkit\Identifiers\Identifier;
use CloudCreativity\Modules\Toolkit\ContractException;
use CloudCreativity\Modules\Toolkit\Identifiers\Guid;
use CloudCreativity\Modules\Toolkit\Identifiers\IntegerId;
use CloudCreativity\Modules\Toolkit\Identifiers\StringId;
use CloudCreativity\Modules\Toolkit\Identifiers\Uuid;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;

class StringIdTest extends TestCase
{
    public function test(): void
    {
        $id = new StringId('99');

        $this->assertSame('99', $id->value);
        $this->assertSame('99', $id->context());
        $this->assertSame('99', $id->key());
        $this->assertSame('99', $id->toString());
        $this->assertSame('99', (string) $id);
        $this->assertJsonStringEqualsJsonString(
            json_encode(['id' => '99'], \JSON_THROW_ON_ERROR),
            json_encode(compact('id'), \JSON_THROW_ON_ERROR),
        );
    }

    public function testItCanBeZero(): void
    {
        $id = new StringId('0');
        $this->assertSame('0', $id->value);
    }

    public function testItMustNotBeEmpty(): void
    {
        $this->expectException(ContractException::class);
        $this->expectExceptionMessage('Identifier value must be a non-empty string.');
        new StringId('');
    }

    public function testItIsEquals(): void
    {
        $this->assertObjectEquals($id = new StringId('99'), $other = StringId::from('99'));
        $this->assertSame($id, StringId::from($id));
        $this->assertTrue($id->is($other));
        $this->assertTrue($id->any(new StringId('foo'), new StringId('bar'), null, $other));
    }

    public function testItIsNotEqual(): void
    {
        $id = new StringId('99');
        $this->assertFalse($id->equals($other = new StringId('100')));
        $this->assertFalse($id->is($other));
        $this->assertFalse($id->any(new StringId('foo'), new StringId('bar'), null, $other));
        $this->assertFalse($id->any());
    }

    /**
     * @return array<int, array<Identifier>>
     */
    public static function notStringIdProvider(): array
    {
        return [
            [new IntegerId(1)],
            [new Guid('SomeType', new StringId('1'))],
            [new Uuid(\Ramsey\Uuid\Uuid::uuid4())],
        ];
    }

    #[DataProvider('notStringIdProvider')]
    public function testIsWithOtherIdentifiers(Identifier $other): void
    {
        $id = new StringId('1');

        $this->assertFalse($id->is($other));
        $this->assertFalse($id->any($other, new StringId('foo'), null));
    }

    public function testIsWithNull(): void
    {
        $id = new StringId('1');

        $this->assertFalse($id->is(null));
    }

    #[DataProvider('notStringIdProvider')]
    public function testFromWithOtherIdentifiers(Identifier $other): void
    {
        $this->expectException(ContractException::class);
        $this->expectExceptionMessage('Unexpected identifier type, received: ' . get_debug_type($other));
        StringId::from($other);
    }
}