Add doctrine/collections integration

Author: ekvedaras

CHANGELOG-1.x.md

@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- `doctrine/collections` `ArrayCollection` implementation
+
 ### Updated
 - Change `php` requirement from `^7.2|^8` to `>=7.2`
 

README.md

@@ -12,7 +12,7 @@
 Big thanks [happy-types/enumerable-type](https://packagist.org/packages/happy-types/enumerable-type) for the original idea. Take a look if it suits your needs better.
 
 This package adds `meta` field, provides a few more methods like `options`, `keys`, `json`, etc. 
-and there are simple php array, `illuminate/collection` and `arrayy` collection implementations to choose from. 
+and there are simple php array, `illuminate/collection`, `arrayy` and `doctrine` collection implementations to choose from. 
 
 ## Benefits
 
@@ -30,6 +30,7 @@ Create enums by extending one of:
  * `EKvedaras\PHPEnum\PHPArray\Enum`
  * `EKvedaras\PHPEnum\Illuminate\Collection\Enum`
  * `EKvedaras\PHPEnum\Arrayy\Enum`
+ * `EKvedaras\PHPEnum\Doctrine\Enum`
 
 ```php
 use EKvedaras\PHPEnum\PHPArray\Enum;
@@ -401,10 +402,6 @@ changed it can be done in one place only (if storage APIs match).
 
 * [ekvedaras/laravel-enum](https://packagist.org/packages/ekvedaras/laravel-enum)
 
-## Coming soon
-
-* More implementations of collections in other frameworks
-
 ## Changelog
 
 See changes in changelog files:

composer.json

@@ -32,14 +32,16 @@
         "ext-json": "*"
     },
     "require-dev": {
+        "doctrine/collections": "^1.6",
         "illuminate/support": "^6|^7|^8",
         "phpunit/phpunit": "^8.5.8",
         "voku/arrayy": "^7.0"
     },
     "suggest": {
         "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"
+        "voku/arrayy": "Required for \\EKvedaras\\PHPEnum\\Arrayy\\Enum implementation",
+        "doctrine/collections": "Required for \\EKvedaras\\PHPEnum\\Doctrine\\Enum implementation"
     },
     "scripts": {
         "test": "phpunit",

src/Doctrine/Enum.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace EKvedaras\PHPEnum\Doctrine;
+
+use Doctrine\Common\Collections\ArrayCollection;
+use EKvedaras\PHPEnum\BaseEnum;
+use EKvedaras\PHPEnum\Storage\GenericArrayAccessibleObjectStorage;
+
+/**
+ * Class Enum
+ * @package EKvedaras\PHPEnum\Doctrine
+ * @method static ArrayCollection|static[] enum()
+ * @method static ArrayCollection|string[] options()
+ */
+class Enum extends BaseEnum
+{
+    use GenericArrayAccessibleObjectStorage;
+
+    /**
+     * @inheritDoc
+     */
+    protected static function getNewStorage()
+    {
+        return new ArrayCollection();
+    }
+
+    /**
+     * @return ArrayCollection|int[]|string[]
+     */
+    public static function keys()
+    {
+        return new ArrayCollection(static::enum()->getKeys());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public static function keyString(string $glue = ',')
+    {
+        return implode($glue, static::keys()->toArray());
+    }
+}

tests/BaseEnumTest.php

@@ -7,6 +7,7 @@
 use RuntimeException;
 use Tests\Enums\PaymentStatusArrayEnum;
 use Tests\Enums\PaymentStatusArrayyEnum;
+use Tests\Enums\PaymentStatusDoctrineEnum;
 use Tests\Enums\PaymentStatusIlluminateCollectionEnum;
 use Tests\Enums\PaymentStatusOptions;
 
@@ -47,6 +48,7 @@ public function enums(): array
             'array-storage'      => [PaymentStatusArrayEnum::class],
             'collection-storage' => [PaymentStatusIlluminateCollectionEnum::class],
             'arrayy'             => [PaymentStatusArrayyEnum::class],
+            'doctrine'           => [PaymentStatusDoctrineEnum::class],
         ];
     }
 

tests/Doctrine/EnumTest.php

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

tests/Enums/PaymentStatusDoctrineEnum.php

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