mirror of
https://github.com/archtechx/enums.git
synced 2025-12-12 06:44:04 +00:00
df3681965c
* Add .idea folder to .gitignore * Remove useless concatenation * Add phpunit cache directory to .gitignore * Use iterable type instead of unnecessary checks * Remove unnecessary null coalescing If the return value is `null`, it will return `null` anyway. If the method doesn't exist, it will throw an `Error` because of the undefined method. * Add typehint * Merge meta properties in one go instead of in a loop * Simplify control flow * Use non-deprecated phpstan configuration value * Add missing types * Fix style with php-cs-fixer * Add tests that satisfy the ArrayIterator branch * Use is() for comparison in in() * from(int|string), tryFrom(int|string) --------- Co-authored-by: Samuel Štancl <samuel@archte.ch>
73 lines
2.8 KiB
PHP
73 lines
2.8 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
test('pure enums can have metadata on cases', function () {
|
|
expect(Role::ADMIN->color())->toBe('indigo');
|
|
expect(Role::GUEST->color())->toBe('gray');
|
|
|
|
expect(Role::ADMIN->description())->toBe('Administrator');
|
|
expect(Role::GUEST->description())->toBe('Read-only guest');
|
|
|
|
expect(Role::ADMIN->help())->toBe('Help: Administrators can manage the entire account');
|
|
expect(Role::GUEST->help())->toBe('Help: Guest users can only view the existing records');
|
|
});
|
|
|
|
test('backed enums can have metadata on cases', function () {
|
|
expect(Status::DONE->color())->toBe('green');
|
|
expect(Status::PENDING->color())->toBe('orange');
|
|
|
|
expect(Status::PENDING->description())->toBe('Incomplete task');
|
|
expect(Status::DONE->description())->toBe('Completed task');
|
|
});
|
|
|
|
test('meta properties must be enabled on the enum to be usable on cases', function () {
|
|
expect(Role::ADMIN->help())->not()->toBeNull(); // enabled
|
|
expect(Status::DONE->help())->toBeNull(); // not enabled
|
|
});
|
|
|
|
test('meta properties can transform arguments', function () {
|
|
expect(
|
|
Instructions::make('Administrators can manage the entire account')->value
|
|
)->toStartWith('Help: ');
|
|
});
|
|
|
|
test('meta properties can customize the method name using a method', function () {
|
|
expect(Desc::method())->toBe('description');
|
|
expect(Status::DONE->desc())->toBeNull();
|
|
expect(Status::DONE->description())->not()->toBeNull();
|
|
});
|
|
|
|
test('meta properties can customize the method name using a property', function () {
|
|
expect(Instructions::method())->toBe('help');
|
|
expect(Role::ADMIN->instructions())->toBeNull();
|
|
expect(Role::ADMIN->help())->not()->toBeNull();
|
|
});
|
|
|
|
test('enums can be instantiated from metadata', function () {
|
|
expect(Role::fromMeta(Color::make('indigo')))->toBe(Role::ADMIN);
|
|
expect(Role::fromMeta(Color::make('gray')))->toBe(Role::GUEST);
|
|
|
|
expect(Status::fromMeta(Desc::make('Incomplete task')))->toBe(Status::PENDING);
|
|
expect(Status::fromMeta(Desc::make('Completed task')))->toBe(Status::DONE);
|
|
});
|
|
|
|
test('enums can be instantiated from metadata using tryFromMeta')
|
|
->expect(Role::tryFromMeta(Color::make('indigo')))
|
|
->toBe(Role::ADMIN);
|
|
|
|
test('fromMeta throws an exception when the enum cannot be instantiated', function () {
|
|
Role::fromMeta(Color::make('foobar'));
|
|
})->throws(ValueError::class, 'Enum Role does not have a case with a meta property "Color" of value "foobar"');
|
|
|
|
test('tryFromMeta silently fails when the enum cannot be instantiated')
|
|
->expect(Role::tryFromMeta(Color::make('foobar')))
|
|
->toBeNull();
|
|
|
|
test('metadata properties return null if missing on the case')
|
|
->expect(RoleWithoutAttribute::ADMIN->desc())
|
|
->toBeNull();
|
|
|
|
test('metadata can have default values')
|
|
->expect(ReferenceType::INACTIVE_TYPE->isActive())
|
|
->toBeFalse();
|