Add voku/arrayy Arrayy implementation

Author: ekvedaras

CHANGELOG-1.x.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.0] - 2020-09-07
+### Added
+- `voku/arrayy` `Arrayy` implementation
+
+### Updated
+- Rename `ArrayAccessibleStorage` to `GenericArrayAccessibleStorage`
+- Extract common methods to `GenericArrayAccessibleObjectStorage`
+
 ## [1.1.1] - 2020-09-02
 ### Fixed
 - There was an issue when calling `Enum::option1()` and then calling `Enum::from('option2')`, `option2` was not registered.
@@ -26,7 +34,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Array and illuminate collection implementations
 
-[Unreleased]:  https://github.com/ekvedaras/php-enum/compare/v1.1.1...HEAD
+[Unreleased]:  https://github.com/ekvedaras/php-enum/compare/v1.2.0...HEAD
+[1.2.0]:  https://github.com/ekvedaras/php-enum/compare/v1.1.1...v1.2.0
 [1.1.1]:  https://github.com/ekvedaras/php-enum/compare/v1.1.0...v1.1.1
 [1.1.0]:  https://github.com/ekvedaras/php-enum/compare/v1.0.1...v1.1.0
 [1.0.1]:  https://github.com/ekvedaras/php-enum/compare/v1.0.0...v1.0.1

README.md

@@ -390,6 +390,14 @@ class Payment
 }
 ```
 
+### Don't mix implementations
+
+Enum instances cache is stored in a static variable. Choose one implementation for your project
+and stick to it, otherwise you may unexpectedly get errors because types don't match.
+
+You may create your own project enum class and extend your chosen implementation, so if it ever needs to be
+changed it can be done in one place only (if storage APIs match).
+
 ## Related packages
 
 * [ekvedaras/laravel-enum](https://packagist.org/packages/ekvedaras/laravel-enum)

composer.json

@@ -33,11 +33,13 @@
     },
     "require-dev": {
         "illuminate/support": "^6|^7",
-        "phpunit/phpunit": "^8.5.8"
+        "phpunit/phpunit": "^8.5.8",
+        "voku/arrayy": "^7.0"
     },
     "suggest": {
-        "illuminate/collections": "*",
-        "illuminate/support": "*"
+        "illuminate/collections": "Required for \\EKvedaras\\PHPEnum\\Illuminate\\Collection\\Enum implementation. Provides standalone Laravel collections",
+        "illuminate/support": "Required for \\EKvedaras\\PHPEnum\\Illuminate\\Collection\\Enum implementation. Use if illuminate/collections can't be installed due to version contstraints",
+        "voku/arrayy": "Required for \\EKvedaras\\PHPEnum\\Arrayy\\Enum implementation"
     },
     "scripts": {
         "test": "phpunit",

src/Arrayy/Enum.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace EKvedaras\PHPEnum\Arrayy;
+
+use Arrayy\Arrayy;
+use EKvedaras\PHPEnum\BaseEnum;
+use EKvedaras\PHPEnum\Storage\GenericArrayAccessibleObjectStorage;
+
+/**
+ * Class Enum
+ * @package EKvedaras\PHPEnum\Arrayy
+ * @method static Arrayy|static[] enum()
+ * @method static Arrayy|string[] options()
+ * @method static Arrayy|int[]|string[] keys()
+ */
+class Enum extends BaseEnum
+{
+    use GenericArrayAccessibleObjectStorage;
+
+    /**
+     * @inheritDoc
+     */
+    protected static function getNewStorage()
+    {
+        return new Arrayy();
+    }
+}

src/Illuminate/Collection/Enum.php

@@ -3,17 +3,19 @@
 namespace EKvedaras\PHPEnum\Illuminate\Collection;
 
 use EKvedaras\PHPEnum\BaseEnum;
-use EKvedaras\PHPEnum\Storage\ArrayAccessibleStorage;
+use EKvedaras\PHPEnum\Storage\GenericArrayAccessibleObjectStorage;
 use Illuminate\Support\Collection;
 
 /**
  * Class Enum
  * @package EKvedaras\PHPEnum\Illuminate\Collection
  * @method static Collection|static[] enum()
+ * @method static Collection|string[] options()
+ * @method static Collection|int[]|string[] keys()
  */
 abstract class Enum extends BaseEnum
 {
-    use ArrayAccessibleStorage;
+    use GenericArrayAccessibleObjectStorage;
 
     /**
      * @return Collection
@@ -22,30 +24,4 @@ protected static function getNewStorage()
     {
         return new Collection();
     }
-
-    /**
-     * @return Collection|string[]
-     */
-    public static function options()
-    {
-        return static::enum()->map(function (self $enum) {
-            return $enum->name();
-        });
-    }
-
-    /**
-     * @return Collection|int[]|string[]
-     */
-    public static function keys()
-    {
-        return static::enum()->keys();
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public static function keyString(string $glue = ',')
-    {
-        return static::keys()->implode($glue);
-    }
 }

src/PHPArray/Enum.php

@@ -3,15 +3,15 @@
 namespace EKvedaras\PHPEnum\PHPArray;
 
 use EKvedaras\PHPEnum\BaseEnum;
-use EKvedaras\PHPEnum\Storage\ArrayAccessibleStorage;
+use EKvedaras\PHPEnum\Storage\GenericArrayAccessibleStorage;
 
 /**
  * Class Enum
  * @package EKvedaras\PHPEnum\PHPArray
  */
 abstract class Enum extends BaseEnum
 {
-    use ArrayAccessibleStorage;
+    use GenericArrayAccessibleStorage;
 
     /**
      * @inheritDoc

src/Storage/GenericArrayAccessibleObjectStorage.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace EKvedaras\PHPEnum\Storage;
+
+/**
+ * Trait GenericArrayAccessibleObjectStorage
+ * @package EKvedaras\PHPEnum\Storage
+ */
+trait GenericArrayAccessibleObjectStorage
+{
+    use GenericArrayAccessibleStorage;
+
+    /**
+     * @return string[]
+     */
+    public static function options()
+    {
+        return static::enum()->map(function (self $enum) {
+            return $enum->name();
+        });
+    }
+
+    /**
+     * @return int[]|string[]
+     */
+    public static function keys()
+    {
+        return static::enum()->keys();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public static function keyString(string $glue = ',')
+    {
+        return static::keys()->implode($glue);
+    }
+}

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

@@ -3,10 +3,10 @@
 namespace EKvedaras\PHPEnum\Storage;
 
 /**
- * Trait ArrayAccessibleStorage
- * @package EKvedaras\PHPEnum
+ * Trait GenericArrayAccessibleStorage
+ * @package EKvedaras\PHPEnum\Storage
  */
-trait ArrayAccessibleStorage
+trait GenericArrayAccessibleStorage
 {
     /**
      * @inheritDoc

tests/Arrayy/EnumTest.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Tests\Arrayy;
+
+use Arrayy\Arrayy;
+use Tests\BaseEnumTest;
+use Tests\Enums\PaymentStatusArrayyEnum;
+use Tests\TestCase;
+
+/**
+ * Class EnumTest
+ * @package Tests\Arrayy
+ */
+class EnumTest extends TestCase
+{
+    /** @test */
+    public function it_returns_arrayy_storage()
+    {
+        $this->assertInstanceOf(Arrayy::class, PaymentStatusArrayyEnum::enum());
+        $this->assertInstanceOf(Arrayy::class, PaymentStatusArrayyEnum::options());
+        $this->assertInstanceOf(Arrayy::class, PaymentStatusArrayyEnum::keys());
+    }
+
+    /** @test */
+    public function it_fetches_keys()
+    {
+        $this->assertEquals(array_values(BaseEnumTest::PAYMENT_STATUS_IDS), PaymentStatusArrayyEnum::keys()->toArray());
+    }
+}

tests/BaseEnumTest.php

@@ -4,9 +4,9 @@
 
 use EKvedaras\PHPEnum\BaseEnum;
 use OutOfBoundsException;
-use PHPUnit\Framework\TestCase;
 use RuntimeException;
 use Tests\Enums\PaymentStatusArrayEnum;
+use Tests\Enums\PaymentStatusArrayyEnum;
 use Tests\Enums\PaymentStatusIlluminateCollectionEnum;
 use Tests\Enums\PaymentStatusOptions;
 
@@ -46,6 +46,7 @@ public function enums(): array
         return [
             'array-storage'      => [PaymentStatusArrayEnum::class],
             'collection-storage' => [PaymentStatusIlluminateCollectionEnum::class],
+            'arrayy'             => [PaymentStatusArrayyEnum::class],
         ];
     }
 

tests/Enums/PaymentStatusArrayyEnum.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Tests\Enums;
+
+use EKvedaras\PHPEnum\Arrayy\Enum;
+
+/**
+ * Class PaymentStatusArrayyEnum
+ * @package Tests\Enums
+ */
+class PaymentStatusArrayyEnum extends Enum
+{
+    use PaymentStatusOptions;
+}

tests/Enums/PaymentStatusOptions.php

@@ -53,4 +53,9 @@ public static function notPartOfEnumStatic()
     public function notPartOfEnum()
     {
     }
+
+    public static function clearCache()
+    {
+        static::$cache = null;
+    }
 }

tests/Illuminate/Collection/EnumTest.php

@@ -3,9 +3,9 @@
 namespace Tests\Illuminate\Collection;
 
 use Illuminate\Support\Collection;
-use PHPUnit\Framework\TestCase;
 use Tests\BaseEnumTest;
 use Tests\Enums\PaymentStatusIlluminateCollectionEnum;
+use Tests\TestCase;
 
 /**
  * Class EnumTest

tests/PHPArray/EnumTest.php

@@ -2,8 +2,8 @@
 
 namespace Tests\PHPArray;
 
-use PHPUnit\Framework\TestCase;
 use Tests\Enums\PaymentStatusArrayEnum;
+use Tests\TestCase;
 
 /**
  * Class EnumTest

tests/TestCase.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Tests;
+
+use PHPUnit\Framework\TestCase as BaseTestCase;
+use Tests\Enums\PaymentStatusArrayEnum;
+
+/**
+ * Class TestCase
+ * @package Tests
+ */
+class TestCase extends BaseTestCase
+{
+    public static function setUpBeforeClass(): void
+    {
+        PaymentStatusArrayEnum::clearCache();
+    }
+}