NativeEnumCastTest.php

<?php declare(strict_types=1);

namespace BenSampo\Enum\Tests;

use BenSampo\Enum\Exceptions\InvalidEnumMemberException;
use BenSampo\Enum\Tests\Enums\UserType;
use BenSampo\Enum\Tests\Enums\UserTypeCustomCast;
use BenSampo\Enum\Tests\Models\NativeCastModel;
use PHPUnit\Framework\TestCase;

final class NativeEnumCastTest extends TestCase
{
    public function testCanSetModelValueUsingEnumInstance(): void
    {
        $model = new NativeCastModel();
        $model->user_type = UserType::Moderator();

        $this->assertEquals(UserType::Moderator(), $model->user_type);
    }

    public function testCanSetModelValueUsingEnumValue(): void
    {
        $model = new NativeCastModel();
        // @phpstan-ignore-next-line loose typing
        $model->user_type = UserType::Moderator;

        $this->assertEquals(UserType::Moderator(), $model->user_type);
    }

    public function testCannotSetModelValueUsingInvalidEnumValue(): void
    {
        $model = new NativeCastModel();

        $this->expectException(InvalidEnumMemberException::class);
        // @phpstan-ignore-next-line intentionally wrong
        $model->user_type = 5;
    }

    public function testGettingModelValueReturnsEnumInstance(): void
    {
        $model = new NativeCastModel();
        // @phpstan-ignore-next-line loose typing
        $model->user_type = UserType::Moderator;

        // @phpstan-ignore-next-line casts change the set property
        $this->assertInstanceOf(UserType::class, $model->user_type);
    }

    public function testCanGetAndSetNullOnEnumCastable(): void
    {
        $model = new NativeCastModel();
        $model->user_type = null;

        $this->assertNull($model->user_type);
    }

    public function testCanHandleStringIntFromDatabase(): void
    {
        $model = new NativeCastModel();

        $reflection = new \ReflectionProperty(NativeCastModel::class, 'attributes');
        $reflection->setAccessible(true);
        $reflection->setValue($model, ['user_type' => '1']);

        $this->assertInstanceOf(UserType::class, $model->user_type);
    }

    public function testThatModelWithEnumCanBeCastToArray(): void
    {
        $model = new NativeCastModel();
        $model->user_type = UserType::Moderator();

        $this->assertSame(['user_type' => 1], $model->toArray());
    }

    public function testCanUseCustomCasting(): void
    {
        $model = new NativeCastModel();

        $reflection = new \ReflectionProperty(NativeCastModel::class, 'attributes');
        $reflection->setAccessible(true);
        $reflection->setValue($model, ['user_type_custom' => 'type-3']);

        $this->assertInstanceOf(UserTypeCustomCast::class, $model->user_type_custom);
        $this->assertEquals(UserTypeCustomCast::SuperAdministrator(), $model->user_type_custom);

        $model->user_type_custom = UserTypeCustomCast::Administrator();

        $this->assertSame('type-0', $reflection->getValue($model)['user_type_custom']);
    }

    public function testCanBailCustomCasting(): void
    {
        $model = new NativeCastModel();

        $reflection = new \ReflectionProperty(NativeCastModel::class, 'attributes');
        $reflection->setAccessible(true);
        $reflection->setValue($model, ['user_type_custom' => '']);

        $this->assertNull($model->user_type_custom);
    }
}