1
0
Fork 0
mirror of https://github.com/archtechx/enums.git synced 2025-12-12 14:34:05 +00:00

#4 Added From trait

This adds the `from()` and `tryFrom()` methods to pure enums, and the `fromName()` and `tryFromName()` methods for all enum types.
This commit is contained in:
Samuel Levy 2022-03-13 16:09:32 +10:00
parent 20fa78c2b1
commit a063814396
4 changed files with 188 additions and 1 deletions

View file

@ -11,6 +11,7 @@
|
*/
use ArchTech\Enums\From;
use ArchTech\Enums\InvokableCases;
use ArchTech\Enums\Names;
use ArchTech\Enums\Options;
@ -51,8 +52,16 @@ function something()
enum Status: int
{
use InvokableCases, Options, Names, Values;
use InvokableCases, Options, Names, Values, From;
case PENDING = 0;
case DONE = 1;
}
enum Role
{
use InvokableCases, Options, Names, Values, From;
case ADMIN;
case GUEST;
}

65
tests/Pest/FromTest.php Normal file
View file

@ -0,0 +1,65 @@
<?php
it('does not override the default BackedEnum from method')
->expect(Status::from(0))
->toBe(Status::PENDING);
it('does not override the default BackedEnum from method with errors', function () {
Status::from(2);
})->throws(\ValueError::class, '2 is not a valid backing value for enum "Status"');
it('does not override the default BackedEnum tryFrom method')
->expect(Status::tryFrom(1))
->toBe(Status::DONE);
it('does not override the default BackedEnum tryFrom method with errors')
->expect(Status::tryFrom(2))
->toBe(null);
it('can select a case by index with from() for pure enums')
->expect(Role::from(0))
->toBe(Role::ADMIN);
it('throws a value error when selecting a non-existent case by index with from() for pure enums', function () {
Role::from(2);
})->throws(\ValueError::class, '2 is not a valid unit for enum "Role"');
it('can select a case by index with tryFrom() for pure enums')
->expect(Role::tryFrom(1))
->toBe(Role::GUEST);
it('can returns null when selecting a non-existent case by index with tryFrom() for pure enums')
->expect(Role::tryFrom(2))
->toBe(null);
it('can select a case by name with fromName() for pure enums')
->expect(Role::fromName('ADMIN'))
->toBe(Role::ADMIN);
it('throws a value error when selecting a non-existent case by name with fromName() for pure enums', function () {
Role::fromName('NOTHING');
})->throws(\ValueError::class, '"NOTHING" is not a valid name for enum "Role"');
it('can select a case by name with tryFromName() for pure enums')
->expect(Role::tryFromName('GUEST'))
->toBe(Role::GUEST);
it('returns null when selecting a non-existent case by name with tryFromName() for pure enums')
->expect(Role::tryFromName('NOTHING'))
->toBe(null);
it('can select a case by name with fromName() for backed enums')
->expect(Status::fromName('PENDING'))
->toBe(Status::PENDING);
it('throws a value error when selecting a non-existent case by name with fromName() for backed enums', function () {
Status::fromName('NOTHING');
})->throws(\ValueError::class, '"NOTHING" is not a valid name for enum "Status"');
it('can select a case by name with tryFromName() for backed enums')
->expect(Status::tryFromName('DONE'))
->toBe(Status::DONE);
it('returns null when selecting a non-existent case by name with tryFromName() for backed enums')
->expect(Status::tryFromName('NOTHING'))
->toBe(null);