Integration myclabs/php-enum (#46)

* Add integration with myclabs/php-enum

* Added documentation about integration with myclabs/php-enum

Author: yann-eugone

README.md

@@ -184,6 +184,7 @@ See examples from [test suite](tests/Fixtures) & associated [tests](tests/EnumsF
 
 - Creating [enums](docs/creating-enum.md)
 - Creating [translated enums](docs/creating-translated-enum.md)
+- Integration with [myclabs/php-enum](docs/myclabs-enum-integration.md)
 - Migrating [from standard Symfony](docs/migrating-from-symfony-standard.md)
 - Integration with [SonataAdminBundle](docs/sonata-admin-integration.md)
 

composer.json

@@ -15,16 +15,17 @@
     },
     "require-dev": {
         "doctrine/annotations": "^1.3",
+        "myclabs/php-enum": "^1.8",
         "phpspec/prophecy-phpunit": "^2.0",
         "phpunit/phpunit": "^9.4",
         "squizlabs/php_codesniffer": "^3.5",
         "symfony/form": "^4.4|^5.0",
-        "symfony/framework-bundle": "^4.4|^5.0",
         "symfony/twig-bundle": "^4.4|^5.0",
         "symfony/validator": "^4.4|^5.0",
         "twig/twig": "^2.0|^3.0"
     },
     "suggest": {
+        "myclabs/php-enum": "Integrate with enum object",
         "symfony/framework-bundle": "Integrate with Symfony Framework",
         "symfony/form": "Add enum form type",
         "symfony/validator": "Add enum validation",

docs/myclabs-enum-integration.md

@@ -0,0 +1,72 @@
+# myclabs/php-enum integration
+
+Let say that you already has such enum, from [myclabs/php-enum](https://github.com/myclabs/php-enum).
+
+```php
+<?php
+
+declare(strict_types=1);
+
+namespace App\Model;
+
+use MyCLabs\Enum\Enum;
+
+/**
+ * @method static self NEW
+ * @method static self VALIDATED
+ * @method static self DISABLED
+ */
+class MemberStatus extends Enum
+{
+    private const NEW = 'new';
+    private const VALIDATED = 'validated';
+    private const DISABLED = 'disabled';
+}
+```
+
+## Standard enum
+
+If you want to integrate with the bundle, you just have to declare an enum for that class.
+
+```php
+<?php
+
+declare(strict_types=1);
+
+namespace App\Enum;
+
+use App\Model\MemberStatus;
+use Yokai\EnumBundle\MyCLabsEnum;
+
+class StatusEnum extends MyCLabsEnum
+{
+    public function __construct()
+    {
+        parent::__construct(MemberStatus::class);
+    }
+}
+```
+
+## Translated enum
+
+Or if you want to translate enum constant labels.
+
+```php
+<?php
+
+declare(strict_types=1);
+
+namespace App\Enum;
+
+use App\Model\MemberStatus;
+use Symfony\Contracts\Translation\TranslatorInterface;
+use Yokai\EnumBundle\MyCLabsTranslatedEnum;
+
+class StatusEnum extends MyCLabsTranslatedEnum
+{
+    public function __construct(TranslatorInterface $translator)
+    {
+        parent::__construct(MemberStatus::class, $translator, 'status.%s');
+    }
+}
+```

src/Exception/LogicException.php

@@ -30,4 +30,12 @@ public static function alreadyRegistered(string $name): self
             $name
         ));
     }
+
+    public static function invalidMyClabsEnumClass(string $enum): self
+    {
+        return new self(sprintf(
+            'Enum class must be valid "myclabs/php-enum" enum class. Got "%s".',
+            $enum
+        ));
+    }
 }

src/MyCLabsEnum.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\EnumBundle;
+
+use MyCLabs\Enum\Enum as ActualMyCLabsEnum;
+use Yokai\EnumBundle\Exception\LogicException;
+
+/**
+ * @author Yann Eugoné <[email protected]>
+ */
+class MyCLabsEnum extends Enum
+{
+    /**
+     * @param string      $enum
+     * @param string|null $name
+     */
+    public function __construct(string $enum, string $name = null)
+    {
+        if (!\is_a($enum, ActualMyCLabsEnum::class, true)) {
+            throw LogicException::invalidMyClabsEnumClass($enum);
+        }
+
+        if ($name === null && static::class === __CLASS__) {
+            $name = $enum;
+        }
+
+        parent::__construct($enum::values(), $name);
+    }
+}

src/MyCLabsTranslatedEnum.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\EnumBundle;
+
+use MyCLabs\Enum\Enum as ActualMyCLabsEnum;
+use Symfony\Contracts\Translation\TranslatorInterface;
+use Yokai\EnumBundle\Exception\LogicException;
+
+/**
+ * @author Yann Eugoné <[email protected]>
+ */
+class MyCLabsTranslatedEnum extends TranslatedEnum
+{
+    /**
+     * @param string              $enum
+     * @param TranslatorInterface $translator
+     * @param string              $transPattern
+     * @param string              $transDomain
+     * @param string|null         $name
+     */
+    public function __construct(
+        string $enum,
+        TranslatorInterface $translator,
+        string $transPattern,
+        string $transDomain = 'messages',
+        string $name = null
+    ) {
+        if (!\is_a($enum, ActualMyCLabsEnum::class, true)) {
+            throw LogicException::invalidMyClabsEnumClass($enum);
+        }
+
+        if ($name === null && static::class === __CLASS__) {
+            $name = $enum;
+        }
+
+        parent::__construct($enum::values(), $translator, $transPattern, $transDomain, $name);
+    }
+}

tests/EnumsFromFixturesTest.php

@@ -7,7 +7,11 @@
 use Generator;
 use PHPUnit\Framework\TestCase;
 use Yokai\EnumBundle\EnumInterface;
+use Yokai\EnumBundle\Tests\Fixtures\Action;
+use Yokai\EnumBundle\Tests\Fixtures\ActionEnum;
 use Yokai\EnumBundle\Tests\Fixtures\StateEnum;
+use Yokai\EnumBundle\Tests\Fixtures\Status;
+use Yokai\EnumBundle\Tests\Fixtures\StatusEnum;
 use Yokai\EnumBundle\Tests\Fixtures\SubscriptionEnum;
 use Yokai\EnumBundle\Tests\Fixtures\TypeEnum;
 use Yokai\EnumBundle\Tests\Fixtures\Vehicle;
@@ -27,21 +31,36 @@ class EnumsFromFixturesTest extends TestCase
     public function testEnum(EnumInterface $enum, string $name, array $choices): void
     {
         self::assertSame($name, $enum->getName());
-        self::assertSame($choices, $enum->getChoices());
-        self::assertSame(\array_values($choices), $enum->getValues());
+        self::assertEquals($choices, $enum->getChoices());
+        self::assertEquals(\array_values($choices), $enum->getValues());
         foreach ($choices as $label => $value) {
             self::assertSame($label, $enum->getLabel($value));
         }
     }
 
     public function enums(): Generator
     {
+        yield ActionEnum::class . ' : myclabs/php-enum translated enum' => [
+            new ActionEnum(new Translator([
+                'action.VIEW' => 'Voir',
+                'action.EDIT' => 'Modifier',
+            ])),
+            ActionEnum::class,
+            ['Voir' => Action::VIEW(), 'Modifier' => Action::EDIT()]
+        ];
+
         yield StateEnum::class . ' : direct interface implementation' => [
             new StateEnum(),
             StateEnum::class,
             ['New' => 'new', 'Validated' => 'validated', 'Disabled' => 'disabled']
         ];
 
+        yield StatusEnum::class . ' : myclabs/php-enum enum' => [
+            new StatusEnum(),
+            StatusEnum::class,
+            ['SUCCESS' => Status::SUCCESS(), 'ERROR' => Status::ERROR()]
+        ];
+
         yield SubscriptionEnum::class . ' : translated enum with keyword name' => [
             new SubscriptionEnum(new Translator([
                 'choice.subscription.none' => 'Aucune',

tests/Fixtures/Action.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\EnumBundle\Tests\Fixtures;
+
+use MyCLabs\Enum\Enum;
+
+/**
+ * Enum from "myclabs/php-enum".
+ *
+ * @method static self VIEW
+ * @method static self EDIT
+ *
+ * @author Yann Eugoné <[email protected]>
+ */
+class Action extends Enum
+{
+    private const VIEW = 'view';
+    private const EDIT = 'edit';
+}

tests/Fixtures/ActionEnum.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\EnumBundle\Tests\Fixtures;
+
+use Symfony\Contracts\Translation\TranslatorInterface;
+use Yokai\EnumBundle\MyCLabsTranslatedEnum;
+
+/**
+ * @author Yann Eugoné <[email protected]>
+ */
+class ActionEnum extends MyCLabsTranslatedEnum
+{
+    public function __construct(TranslatorInterface $translator)
+    {
+        parent::__construct(Action::class, $translator, 'action.%s');
+    }
+}

tests/Fixtures/Status.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\EnumBundle\Tests\Fixtures;
+
+use MyCLabs\Enum\Enum;
+
+/**
+ * Enum from "myclabs/php-enum".
+ *
+ * @method static self SUCCESS
+ * @method static self ERROR
+ *
+ * @author Yann Eugoné <[email protected]>
+ */
+class Status extends Enum
+{
+    private const SUCCESS = 0;
+    private const ERROR = 1;
+}