use native enum (#12)

ddd-by-examples · Jun 3, 2024 · 700df5b · 700df5b
1 parent 870fc52
commit 700df5b
Show file tree

Hide file tree

Showing 11 changed files with 27 additions and 121 deletions.
diff --git a/composer.json b/composer.json
@@ -13,7 +13,6 @@
         "php": "^8.2",
         "fale/isbn": "^3.1",
         "munusphp/munus": "^0.16",
-        "myclabs/php-enum": "^1.7",
         "symfony/uid": "^7.1"
     },
     "require-dev": {

diff --git a/composer.lock b/composer.lock
diff --git a/src/Catalogue/BookType.php b/src/Catalogue/BookType.php
@@ -4,18 +4,8 @@
 
 namespace Akondas\Library\Catalogue;
 
-use MyCLabs\Enum\Enum;
-
-/**
- * @extends Enum<string>
- *
- * @method static BookType restricted()
- * @method static BookType circulating()
- *
- * @psalm-immutable
- */
-final class BookType extends Enum
+enum BookType: string
 {
-    public const restricted = 'restricted';
-    public const circulating = 'circulating';
+    case RESTRICTED = 'restricted';
+    case CIRCULATING = 'circulating';
 }
diff --git a/src/Catalogue/Catalogue.php b/src/Catalogue/Catalogue.php
@@ -29,20 +29,20 @@ public function getBook(string $isbn): Option
     }
 
     /**
-     * @return TryTo<Result>
+     * @return TryTo<covariant Result>
      */
     public function addBook(string $isbn, string $title, string $author): TryTo
     {
         return TryTo::run(function () use ($isbn, $title, $author) {
             $book = Book::of($isbn, $title, $author);
             $this->database->saveBook($book);
 
-            return Result::SUCCESS();
+            return Result::SUCCESS;
         });
     }
 
     /**
-     * @return TryTo<Result>
+     * @return TryTo<covariant Result>
      */
     public function addBookInstance(string $isbn, BookType $bookType): TryTo
     {
@@ -51,8 +51,8 @@ public function addBookInstance(string $isbn, BookType $bookType): TryTo
                 ->findByIsbn(new ISBN($isbn))
                 ->map(fn (Book $book): BookInstance => BookInstance::of($book, $bookType))
                 ->map(fn (BookInstance $bookInstance): BookInstance => $this->saveAndPublishEvent($bookInstance))
-                ->map(fn (BookInstance $bookInstance): Result => Result::SUCCESS())
-                ->getOrElse(Result::REJECTION());
+                ->map(fn (BookInstance $bookInstance): Result => Result::SUCCESS)
+                ->getOrElse(Result::REJECTION); // @phpstan-ignore-line
         });
     }
 

diff --git a/src/Common/Result/Result.php b/src/Common/Result/Result.php
@@ -4,18 +4,8 @@
 
 namespace Akondas\Library\Common\Result;
 
-use MyCLabs\Enum\Enum;
-
-/**
- * @extends Enum<string>
- *
- * @psalm-immutable
- *
- * @method static Result SUCCESS()
- * @method static Result REJECTION()
- */
-class Result extends Enum
+enum Result: string
 {
-    public const SUCCESS = 'success';
-    public const REJECTION = 'rejection';
+    case SUCCESS = 'success';
+    case REJECTION = 'rejection';
 }
diff --git a/src/Lending/Book/Domain/AvailableBook.php b/src/Lending/Book/Domain/AvailableBook.php
@@ -46,6 +46,6 @@ public function libraryBranch(): LibraryBranchId
 
     public function isRestricted(): bool
     {
-        return $this->bookType->equals(BookType::restricted());
+        return $this->bookType === BookType::RESTRICTED;
     }
 }
diff --git a/src/Lending/Patron/Domain/PatronInformation.php b/src/Lending/Patron/Domain/PatronInformation.php
@@ -27,6 +27,6 @@ public function patronType(): PatronType
 
     public function isRegular(): bool
     {
-        return $this->patronType->equals(PatronType::regular());
+        return $this->patronType === PatronType::REGULAR;
     }
 }
diff --git a/src/Lending/Patron/Domain/PatronType.php b/src/Lending/Patron/Domain/PatronType.php
@@ -4,18 +4,8 @@
 
 namespace Akondas\Library\Lending\Patron\Domain;
 
-use MyCLabs\Enum\Enum;
-
-/**
- * @extends Enum<string>
- *
- * @method static PatronType regular()
- * @method static PatronType researcher()
- *
- * @psalm-immutable
- */
-final class PatronType extends Enum
+enum PatronType: string
 {
-    public const regular = 'regular';
-    public const researcher = 'researcher';
+    case REGULAR = 'regular';
+    case RESEARCHER = 'researcher';
 }
diff --git a/tests/Fixture/BookFixture.php b/tests/Fixture/BookFixture.php
@@ -12,12 +12,12 @@
 
 function restrictedBook(): AvailableBook
 {
-    return new AvailableBook(anyBookId(), BookType::restricted(), anyBranch(), Version::zero());
+    return new AvailableBook(anyBookId(), BookType::RESTRICTED, anyBranch(), Version::zero());
 }
 
 function circulatingBook(): AvailableBook
 {
-    return new AvailableBook(anyBookId(), BookType::circulating(), anyBranch(), Version::zero());
+    return new AvailableBook(anyBookId(), BookType::CIRCULATING, anyBranch(), Version::zero());
 }
 
 function anyBookId(): BookId

diff --git a/tests/Fixture/PatronFixture.php b/tests/Fixture/PatronFixture.php
@@ -21,7 +21,7 @@
 function regularPatron(): Patron
 {
     return new Patron(
-        new PatronInformation(anyPatronId(), PatronType::regular()),
+        new PatronInformation(anyPatronId(), PatronType::REGULAR),
         GenericList::of(
             new OnlyResearcherPatronsCanPlaceOpenEndedHolds(),
             new OnlyResearcherPatronsCanHoldRestrictedBooks()
@@ -33,7 +33,7 @@ function regularPatron(): Patron
 function regularPatronWithHolds(int $numberOfHolds): Patron
 {
     return new Patron(
-        new PatronInformation(anyPatronId(), PatronType::regular()),
+        new PatronInformation(anyPatronId(), PatronType::REGULAR),
         GenericList::of(
             new OnlyResearcherPatronsCanPlaceOpenEndedHolds(),
             new OnlyResearcherPatronsCanHoldRestrictedBooks(),
@@ -45,13 +45,13 @@ function regularPatronWithHolds(int $numberOfHolds): Patron
 
 function researcherPatronWithPolicy(PatronId $patronId, PlacingOnHoldPolicy $placingOnHoldPolicy): Patron
 {
-    return patronWithPolicy($patronId, PatronType::researcher(), $placingOnHoldPolicy);
+    return patronWithPolicy($patronId, PatronType::RESEARCHER, $placingOnHoldPolicy);
 }
 
 function researcherPatronWithHolds(int $numberOfHolds): Patron
 {
     return new Patron(
-        new PatronInformation(anyPatronId(), PatronType::researcher()),
+        new PatronInformation(anyPatronId(), PatronType::RESEARCHER),
         GenericList::of(
             new RegularPatronMaximumNumberOfHoldsPolicy()
         ),

diff --git a/tests/Unit/Catalogue/CatalogueTest.php b/tests/Unit/Catalogue/CatalogueTest.php
@@ -47,7 +47,7 @@ public function testPutBookToCatalogue(): void
         $result = $this->catalogue->addBook(DDD_ISBN_STR, 'Domain Driven Design', 'Eric Evans');
         // then
         self::assertTrue($result->isSuccess());
-        self::assertEquals(Result::SUCCESS(), $result->get());
+        self::assertSame(Result::SUCCESS, $result->get());
     }
 
     public function testPutNewBookInstanceToCatalogue(): void
@@ -60,10 +60,10 @@ public function testPutNewBookInstanceToCatalogue(): void
             ->method('publish')
             ->with(self::isInstanceOf(BookInstanceAddedToCatalogue::class));
         // when
-        $result = $this->catalogue->addBookInstance(DDD_ISBN_STR, BookType::restricted());
+        $result = $this->catalogue->addBookInstance(DDD_ISBN_STR, BookType::RESTRICTED);
         // then
         self::assertTrue($result->isSuccess());
-        self::assertEquals(Result::SUCCESS(), $result->get());
+        self::assertSame(Result::SUCCESS, $result->get());
     }
 
     public function testItFailsOnAddingBookWhenDatabaseFails(): void
@@ -85,7 +85,7 @@ public function testItFailsOnAddingBookInstanceWhenDatabaseFails(): void
             ->expects(self::never())
             ->method('publish');
         // when
-        $result = $this->catalogue->addBookInstance(DDD_ISBN_STR, BookType::restricted());
+        $result = $this->catalogue->addBookInstance(DDD_ISBN_STR, BookType::RESTRICTED);
         // then
         self::assertTrue($result->isFailure());
     }