Refactor to utilize namespace so classes are just called Enum

Author: ekvedaras

src/Enum.php src/BaseEnum.phpsrc/Enum.php renamed to src/BaseEnum.php

@@ -12,7 +12,7 @@
  * Class EnumArray
  * @package EKvedaras\PHPEnum
  */
-abstract class Enum implements JsonSerializable
+abstract class BaseEnum implements JsonSerializable
 {
     /** @var iterable|iterable[] */
     public static $cache;

src/IlluminateCollectionEnum.php src/Illuminate/Collection/Enum.phpsrc/IlluminateCollectionEnum.php renamed to src/Illuminate/Collection/Enum.php

@@ -1,15 +1,17 @@
 <?php
 
-namespace EKvedaras\PHPEnum;
+namespace EKvedaras\PHPEnum\Illuminate\Collection;
 
+use EKvedaras\PHPEnum\BaseEnum;
+use EKvedaras\PHPEnum\Storage\ArrayAccessibleStorage;
 use Illuminate\Support\Collection;
 
 /**
- * Class IlluminateCollectionEnum
- * @package EKvedaras\PHPEnum
+ * Class Enum
+ * @package EKvedaras\PHPEnum\Illuminate\Collection
  * @method static Collection|static[] enum()
  */
-abstract class IlluminateCollectionEnum extends Enum
+abstract class Enum extends BaseEnum
 {
     use ArrayAccessibleStorage;
 

src/ArrayEnum.php src/PHPArray/Enum.phpsrc/ArrayEnum.php renamed to src/PHPArray/Enum.php

@@ -1,12 +1,15 @@
 <?php
 
-namespace EKvedaras\PHPEnum;
+namespace EKvedaras\PHPEnum\PHPArray;
+
+use EKvedaras\PHPEnum\BaseEnum;
+use EKvedaras\PHPEnum\Storage\ArrayAccessibleStorage;
 
 /**
- * Class ArrayEnum
- * @package EKvedaras\PHPEnum
+ * Class Enum
+ * @package EKvedaras\PHPEnum\PHPArray
  */
-abstract class ArrayEnum extends Enum
+abstract class Enum extends BaseEnum
 {
     use ArrayAccessibleStorage;
 

src/ArrayAccessibleStorage.php src/Storage/ArrayAccessibleStorage.phpsrc/ArrayAccessibleStorage.php renamed to src/Storage/ArrayAccessibleStorage.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace EKvedaras\PHPEnum;
+namespace EKvedaras\PHPEnum\Storage;
 
 /**
  * Trait ArrayAccessibleStorage

tests/EnumTest.php tests/BaseEnumTest.phptests/EnumTest.php renamed to tests/BaseEnumTest.php

@@ -2,7 +2,7 @@
 
 namespace Tests;
 
-use EKvedaras\PHPEnum\Enum;
+use EKvedaras\PHPEnum\BaseEnum;
 use OutOfBoundsException;
 use PHPUnit\Framework\TestCase;
 use RuntimeException;
@@ -14,7 +14,7 @@
  * Class EnumTest
  * @package Tests
  */
-class EnumTest extends TestCase
+class BaseEnumTest extends TestCase
 {
     public const PAYMENT_STATUS_PENDING   = 'pending';
     public const PAYMENT_STATUS_COMPLETED = 'completed';
@@ -52,7 +52,7 @@ public function enums(): array
     /**
      * @test
      * @dataProvider enums
-     * @param Enum|PaymentStatusOptions|string $enum
+     * @param BaseEnum|PaymentStatusOptions|string $enum
      */
     public function it_fetches_enum_list(string $enum)
     {
@@ -69,7 +69,7 @@ public function it_fetches_enum_list(string $enum)
     /**
      * @test
      * @dataProvider enums
-     * @param Enum|PaymentStatusOptions|string $enum
+     * @param BaseEnum|PaymentStatusOptions|string $enum
      */
     public function it_fetches_option_list(string $enum)
     {
@@ -89,7 +89,7 @@ public function it_fetches_option_list(string $enum)
     /**
      * @test
      * @dataProvider enums
-     * @param Enum|PaymentStatusOptions|string $enum
+     * @param BaseEnum|PaymentStatusOptions|string $enum
      */
     public function it_fetches_enum_as_json(string $enum)
     {
@@ -100,7 +100,7 @@ public function it_fetches_enum_as_json(string $enum)
     /**
      * @test
      * @dataProvider enums
-     * @param Enum|PaymentStatusOptions|string $enum
+     * @param BaseEnum|PaymentStatusOptions|string $enum
      */
     public function it_fetches_options_as_json(string $enum)
     {
@@ -111,7 +111,7 @@ public function it_fetches_options_as_json(string $enum)
     /**
      * @test
      * @dataProvider enums
-     * @param Enum|PaymentStatusOptions|string $enum
+     * @param BaseEnum|PaymentStatusOptions|string $enum
      */
     public function it_retrieves_from_id_and_returns_correct_values(string $enum)
     {
@@ -128,7 +128,7 @@ public function it_retrieves_from_id_and_returns_correct_values(string $enum)
     /**
      * @test
      * @dataProvider enums
-     * @param Enum|PaymentStatusOptions|string $enum
+     * @param BaseEnum|PaymentStatusOptions|string $enum
      */
     public function it_retrieves_from_meta_and_returns_correct_values(string $enum)
     {
@@ -146,7 +146,7 @@ public function it_retrieves_from_meta_and_returns_correct_values(string $enum)
      * @test
      * @runInSeparateProcess
      * @dataProvider enums
-     * @param Enum|PaymentStatusOptions|string $enum
+     * @param BaseEnum|PaymentStatusOptions|string $enum
      */
     public function it_retrieves_by_calling_a_method_and_returns_correct_values(string $enum)
     {
@@ -163,7 +163,7 @@ public function it_retrieves_by_calling_a_method_and_returns_correct_values(stri
     /**
      * @test
      * @dataProvider enums
-     * @param Enum|PaymentStatusOptions|string $enum
+     * @param BaseEnum|PaymentStatusOptions|string $enum
      */
     public function it_creates_only_one_instance_of_each_option(string $enum)
     {
@@ -179,7 +179,7 @@ public function it_creates_only_one_instance_of_each_option(string $enum)
     /**
      * @test
      * @dataProvider enums
-     * @param Enum|PaymentStatusOptions|string $enum
+     * @param BaseEnum|PaymentStatusOptions|string $enum
      */
     public function it_cannot_be_serialized(string $enum)
     {
@@ -193,7 +193,7 @@ public function it_cannot_be_serialized(string $enum)
     /**
      * @test
      * @dataProvider enums
-     * @param Enum|PaymentStatusOptions|string $enum
+     * @param BaseEnum|PaymentStatusOptions|string $enum
      */
     public function it_throws_an_exception_for_unknown_id(string $enum)
     {
@@ -208,7 +208,7 @@ public function it_throws_an_exception_for_unknown_id(string $enum)
     /**
      * @test
      * @dataProvider enums
-     * @param Enum|PaymentStatusOptions|string $enum
+     * @param BaseEnum|PaymentStatusOptions|string $enum
      */
     public function it_throws_an_exception_for_unknown_meta(string $enum)
     {
@@ -223,7 +223,7 @@ public function it_throws_an_exception_for_unknown_meta(string $enum)
     /**
      * @test
      * @dataProvider enums
-     * @param Enum|PaymentStatusOptions|string $enum
+     * @param BaseEnum|PaymentStatusOptions|string $enum
      */
     public function it_casts_to_string_as_id(string $enum)
     {
@@ -235,7 +235,7 @@ public function it_casts_to_string_as_id(string $enum)
     /**
      * @test
      * @dataProvider enums
-     * @param Enum|PaymentStatusOptions|string $enum
+     * @param BaseEnum|PaymentStatusOptions|string $enum
      */
     public function it_can_be_json_serialized(string $enum)
     {
@@ -254,7 +254,7 @@ public function it_can_be_json_serialized(string $enum)
     /**
      * @test
      * @dataProvider enums
-     * @param Enum|PaymentStatusOptions|string $enum
+     * @param BaseEnum|PaymentStatusOptions|string $enum
      */
     public function it_can_set_state(string $enum)
     {

tests/Enums/PaymentStatusArrayEnum.php

@@ -2,13 +2,13 @@
 
 namespace Tests\Enums;
 
-use EKvedaras\PHPEnum\ArrayEnum;
+use EKvedaras\PHPEnum\PHPArray\Enum;
 
 /**
  * Class PaymentStatusArrayEnum
  * @package Tests\Enums
  */
-class PaymentStatusArrayEnum extends ArrayEnum
+class PaymentStatusArrayEnum extends Enum
 {
     use PaymentStatusOptions;
 }

tests/Enums/PaymentStatusIlluminateCollectionEnum.php

@@ -2,13 +2,13 @@
 
 namespace Tests\Enums;
 
-use EKvedaras\PHPEnum\IlluminateCollectionEnum;
+use EKvedaras\PHPEnum\Illuminate\Collection\Enum;
 
 /**
  * Class PaymentStatusCollectionEnum
  * @package Tests\Enums
  */
-class PaymentStatusIlluminateCollectionEnum extends IlluminateCollectionEnum
+class PaymentStatusIlluminateCollectionEnum extends Enum
 {
     use PaymentStatusOptions;
 }

tests/Enums/PaymentStatusOptions.php

@@ -2,7 +2,7 @@
 
 namespace Tests\Enums;
 
-use Tests\EnumTest;
+use Tests\BaseEnumTest;
 
 /**
  * Trait PaymentStatusOptions
@@ -16,9 +16,9 @@ trait PaymentStatusOptions
     final public static function pending(): self
     {
         return static::get(
-            EnumTest::PAYMENT_STATUS_IDS[EnumTest::PAYMENT_STATUS_PENDING],
-            EnumTest::PAYMENT_STATUS_NAMES[EnumTest::PAYMENT_STATUS_PENDING],
-            EnumTest::PAYMENT_STATUS_META[EnumTest::PAYMENT_STATUS_PENDING]
+            BaseEnumTest::PAYMENT_STATUS_IDS[BaseEnumTest::PAYMENT_STATUS_PENDING],
+            BaseEnumTest::PAYMENT_STATUS_NAMES[BaseEnumTest::PAYMENT_STATUS_PENDING],
+            BaseEnumTest::PAYMENT_STATUS_META[BaseEnumTest::PAYMENT_STATUS_PENDING]
         );
     }
 
@@ -28,9 +28,9 @@ final public static function pending(): self
     final public static function completed(): self
     {
         return static::get(
-            EnumTest::PAYMENT_STATUS_IDS[EnumTest::PAYMENT_STATUS_COMPLETED],
-            EnumTest::PAYMENT_STATUS_NAMES[EnumTest::PAYMENT_STATUS_COMPLETED],
-            EnumTest::PAYMENT_STATUS_META[EnumTest::PAYMENT_STATUS_COMPLETED]
+            BaseEnumTest::PAYMENT_STATUS_IDS[BaseEnumTest::PAYMENT_STATUS_COMPLETED],
+            BaseEnumTest::PAYMENT_STATUS_NAMES[BaseEnumTest::PAYMENT_STATUS_COMPLETED],
+            BaseEnumTest::PAYMENT_STATUS_META[BaseEnumTest::PAYMENT_STATUS_COMPLETED]
         );
     }
 
@@ -40,9 +40,9 @@ final public static function completed(): self
     final public static function failed(): self
     {
         return static::get(
-            EnumTest::PAYMENT_STATUS_IDS[EnumTest::PAYMENT_STATUS_FAILED],
-            EnumTest::PAYMENT_STATUS_NAMES[EnumTest::PAYMENT_STATUS_FAILED],
-            EnumTest::PAYMENT_STATUS_META[EnumTest::PAYMENT_STATUS_FAILED]
+            BaseEnumTest::PAYMENT_STATUS_IDS[BaseEnumTest::PAYMENT_STATUS_FAILED],
+            BaseEnumTest::PAYMENT_STATUS_NAMES[BaseEnumTest::PAYMENT_STATUS_FAILED],
+            BaseEnumTest::PAYMENT_STATUS_META[BaseEnumTest::PAYMENT_STATUS_FAILED]
         );
     }
 

tests/IlluminateCollectionEnumTest.php tests/Illuminate/Collection/EnumTest.phptests/IlluminateCollectionEnumTest.php renamed to tests/Illuminate/Collection/EnumTest.php

@@ -1,16 +1,17 @@
 <?php
 
-namespace Tests;
+namespace Tests\Illuminate\Collection;
 
 use Illuminate\Support\Collection;
 use PHPUnit\Framework\TestCase;
+use Tests\BaseEnumTest;
 use Tests\Enums\PaymentStatusIlluminateCollectionEnum;
 
 /**
- * Class IlluminateCollectionEnumTest
- * @package Tests
+ * Class EnumTest
+ * @package Tests\Illuminate\Collection
  */
-class IlluminateCollectionEnumTest extends TestCase
+class EnumTest extends TestCase
 {
     /** @test */
     public function it_returns_illuminate_collection_storage()
@@ -23,6 +24,6 @@ public function it_returns_illuminate_collection_storage()
     /** @test */
     public function it_fetches_keys()
     {
-        $this->assertEquals(array_values(EnumTest::PAYMENT_STATUS_IDS), PaymentStatusIlluminateCollectionEnum::keys()->toArray());
+        $this->assertEquals(array_values(BaseEnumTest::PAYMENT_STATUS_IDS), PaymentStatusIlluminateCollectionEnum::keys()->toArray());
     }
 }

tests/ArrayEnumTest.php tests/PHPArray/EnumTest.phptests/ArrayEnumTest.php renamed to tests/PHPArray/EnumTest.php

@@ -1,15 +1,15 @@
 <?php
 
-namespace Tests;
+namespace Tests\PHPArray;
 
 use PHPUnit\Framework\TestCase;
 use Tests\Enums\PaymentStatusArrayEnum;
 
 /**
- * Class ArrayEnumTest
- * @package Tests
+ * Class EnumTest
+ * @package Tests\PHPArray
  */
-class ArrayEnumTest extends TestCase
+class EnumTest extends TestCase
 {
     /** @test */
     public function it_returns_array_storage()