Add support for PHP 8.1 native enums (#56)

yann-eugone · web-flow · commit a864c76ea5e4 · 2023-08-18T11:56:04.000+02:00
* Add support for PHP 8.1 native enums

* Add integration test for PHP 8.1 native enums

* Updated testing matrix

* Clean integration tests

* Fixed coverage

* Changed PHP default version for tests

* Fixed coverage

---------

Co-authored-by: Yann Eugoné &lt;yeugone@prestaconcept.net&gt;
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -14,22 +14,30 @@ jobs:
     strategy:
       matrix:
         include:
-          - php-version: 7.1
-            symfony-version: 4.4.*
-          - php-version: 8.1
-            symfony-version: 4.4.*
-          - php-version: 7.2
-            symfony-version: 5.2.*
-          - php-version: 7.2
-            symfony-version: 5.3.*
-          - php-version: 7.2
-            symfony-version: 5.4.*
-          - php-version: 8.1
-            symfony-version: 5.4.*
-          - php-version: 8.0
-            symfony-version: 6.0.*
-          - php-version: 8.1
-            symfony-version: 6.0.*
+          - php-version: '7.1'
+            symfony-version: '4.4.*'
+
+          - php-version: '7.4'
+            symfony-version: '4.4.*'
+          - php-version: '7.4'
+            symfony-version: '5.4.*'
+
+          - php-version: '8.0'
+            symfony-version: '4.4.*'
+          - php-version: '8.0'
+            symfony-version: '5.4.*'
+          - php-version: '8.0'
+            symfony-version: '6.0.*'
+
+          - php-version: '8.1'
+            symfony-version: '5.4.*'
+          - php-version: '8.1'
+            symfony-version: '6.3.*'
+
+          - php-version: '8.2'
+            symfony-version: '5.4.*'
+          - php-version: '8.2'
+            symfony-version: '6.3.*'
 
     steps:
       - name: "Checkout"
@@ -59,11 +67,6 @@ jobs:
     name: "Code coverage"
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        include:
-          - php-version: 8.1
-
     steps:
       - name: "Checkout"
         uses: actions/checkout@v2
@@ -72,7 +75,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           coverage: xdebug
-          php-version: ${{ matrix.php-version }}
+          php-version: '8.2'
 
       - name: "Install dependencies with composer"
         run: composer update --no-interaction --no-progress
@@ -90,11 +93,6 @@ jobs:
     name: "Checkstyle"
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        include:
-          - php-version: 8.1
-
     steps:
       - name: "Checkout"
         uses: actions/checkout@v2
@@ -103,7 +101,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           coverage: xdebug
-          php-version: ${{ matrix.php-version }}
+          php-version: '8.2'
 
       - name: "Install dependencies with composer"
         run: composer update --no-interaction --no-progress
diff --git a/src/Exception/LogicException.php b/src/Exception/LogicException.php
@@ -38,4 +38,12 @@ public static function invalidMyClabsEnumClass(string $enum): self
             $enum
         ));
     }
+
+    public static function invalidUnitEnum(string $enum): self
+    {
+        return new self(sprintf(
+            'Enum class must be valid PHP enum. Got "%s".',
+            $enum
+        ));
+    }
 }
diff --git a/src/NativeEnum.php b/src/NativeEnum.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\EnumBundle;
+
+use UnitEnum;
+use Yokai\EnumBundle\Exception\LogicException;
+
+/**
+ * @author Yann Eugoné <eugone.yann@gmail.com>
+ */
+class NativeEnum extends Enum
+{
+    /**
+     * @param string      $enum
+     * @param string|null $name
+     */
+    public function __construct(string $enum, string $name = null)
+    {
+        if (!\is_a($enum, UnitEnum::class, true)) {
+            throw LogicException::invalidUnitEnum($enum);
+        }
+
+        if ($name === null && static::class === __CLASS__) {
+            $name = $enum;
+        }
+
+        $choices = [];
+        foreach ($enum::cases() as $case) {
+            $choices[$case->name] = $case;
+        }
+
+        parent::__construct($choices, $name);
+    }
+}
diff --git a/src/NativeTranslatedEnum.php b/src/NativeTranslatedEnum.php
@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\EnumBundle;
+
+use UnitEnum;
+use Symfony\Contracts\Translation\TranslatorInterface;
+use Yokai\EnumBundle\Exception\LogicException;
+
+/**
+ * @author Yann Eugoné <eugone.yann@gmail.com>
+ */
+class NativeTranslatedEnum 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, UnitEnum::class, true)) {
+            throw LogicException::invalidUnitEnum($enum);
+        }
+
+        if ($name === null && static::class === __CLASS__) {
+            $name = $enum;
+        }
+
+        $values = [];
+        foreach ($enum::cases() as $case) {
+            $values[$case->name] = $case;
+        }
+
+        parent::__construct($values, $translator, $transPattern, $transDomain, $name);
+    }
+}
diff --git a/tests/Integration/config/services-8.0.yaml b/tests/Integration/config/services-8.0.yaml
@@ -0,0 +1,8 @@
+services:
+    _defaults:
+        autowire: true
+        autoconfigure: true
+
+    Yokai\EnumBundle\Tests\Integration\App\Enum\PullRequestLabelEnum: ~
+    Yokai\EnumBundle\Tests\Integration\App\Enum\PullRequestMyCLabsStatusEnum: ~
+    Yokai\EnumBundle\Tests\Integration\App\Form\PullRequestType: ~
diff --git a/tests/Integration/config/services-8.1.yaml b/tests/Integration/config/services-8.1.yaml
@@ -0,0 +1,8 @@
+services:
+    _defaults:
+        autowire: true
+        autoconfigure: true
+
+    Yokai\EnumBundle\Tests\Integration\App\Enum\PullRequestLabelEnum: ~
+    Yokai\EnumBundle\Tests\Integration\App\Enum\PullRequestNativeStatusEnum: ~
+    Yokai\EnumBundle\Tests\Integration\App\Form\PullRequestType: ~
diff --git a/tests/Integration/config/services.yaml b/tests/Integration/config/services.yaml
diff --git a/tests/Integration/src/Enum/PullRequestMyCLabsStatusEnum.php b/tests/Integration/src/Enum/PullRequestMyCLabsStatusEnum.php
@@ -6,15 +6,15 @@
 
 use Symfony\Contracts\Translation\TranslatorInterface;
 use Yokai\EnumBundle\MyCLabsTranslatedEnum;
-use Yokai\EnumBundle\Tests\Integration\App\Model\Status;
+use Yokai\EnumBundle\Tests\Integration\App\Model\MyCLabsStatus;
 
 /**
  * @author Yann Eugoné <eugone.yann@gmail.com>
  */
-final class PullRequestStatusEnum extends MyCLabsTranslatedEnum
+final class PullRequestMyCLabsStatusEnum extends MyCLabsTranslatedEnum
 {
     public function __construct(TranslatorInterface $translator)
     {
-        parent::__construct(Status::class, $translator, 'pull_request.status.%s');
+        parent::__construct(MyCLabsStatus::class, $translator, 'pull_request.status.%s');
     }
 }
diff --git a/tests/Integration/src/Enum/PullRequestNativeStatusEnum.php b/tests/Integration/src/Enum/PullRequestNativeStatusEnum.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\EnumBundle\Tests\Integration\App\Enum;
+
+use Symfony\Contracts\Translation\TranslatorInterface;
+use Yokai\EnumBundle\NativeTranslatedEnum;
+use Yokai\EnumBundle\Tests\Integration\App\Model\NativeStatus;
+
+/**
+ * @author Yann Eugoné <eugone.yann@gmail.com>
+ */
+final class PullRequestNativeStatusEnum extends NativeTranslatedEnum
+{
+    public function __construct(TranslatorInterface $translator)
+    {
+        parent::__construct(NativeStatus::class, $translator, 'pull_request.status.%s');
+    }
+}
diff --git a/tests/Integration/src/Kernel.php b/tests/Integration/src/Kernel.php
@@ -36,7 +36,11 @@ public function registerContainerConfiguration(LoaderInterface $loader): void
             $loader->load(__DIR__ . '/../config/packages/annotations.yaml');
         }
 
-        $loader->load(__DIR__ . '/../config/services.yaml');
+        if (\PHP_VERSION_ID < 80100) {
+            $loader->load(__DIR__ . '/../config/services-8.0.yaml');
+        } else {
+            $loader->load(__DIR__ . '/../config/services-8.1.yaml');
+        }
     }
 
     /**
diff --git a/tests/Integration/src/Model/MyCLabsStatus.php b/tests/Integration/src/Model/MyCLabsStatus.php
@@ -13,7 +13,7 @@
  *
  * @author Yann Eugoné <eugone.yann@gmail.com>
  */
-final class Status extends Enum
+final class MyCLabsStatus extends Enum
 {
     private const OPENED = 'opened';
     private const MERGED = 'merged';
diff --git a/tests/Integration/src/Model/NativeStatus.php b/tests/Integration/src/Model/NativeStatus.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\EnumBundle\Tests\Integration\App\Model;
+
+/**
+ * @author Yann Eugoné <eugone.yann@gmail.com>
+ */
+enum NativeStatus: string
+{
+    case OPENED = 'opened';
+    case MERGED = 'merged';
+    case CLOSED = 'closed';
+}
diff --git a/tests/Integration/src/Model/PullRequestPhp7.php b/tests/Integration/src/Model/PullRequestPhp7.php
@@ -5,18 +5,18 @@
 namespace Yokai\EnumBundle\Tests\Integration\App\Model;
 
 use Yokai\EnumBundle\Validator\Constraints\Enum;
-use Yokai\EnumBundle\Tests\Integration\App\Enum\PullRequestStatusEnum;
+use Yokai\EnumBundle\Tests\Integration\App\Enum\PullRequestMyCLabsStatusEnum;
 use Yokai\EnumBundle\Tests\Integration\App\Enum\PullRequestLabelEnum;
 
 /**
  * @author Yann Eugoné <eugone.yann@gmail.com>
  */
-final class PullRequestUsingAnnotations
+final class PullRequestPhp7
 {
     /**
-     * @var Status
+     * @var MyCLabsStatus
      *
-     * @Enum(PullRequestStatusEnum::class)
+     * @Enum(PullRequestMyCLabsStatusEnum::class)
      */
     public $status;
 
diff --git a/tests/Integration/src/Model/PullRequestPhp80.php b/tests/Integration/src/Model/PullRequestPhp80.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\EnumBundle\Tests\Integration\App\Model;
+
+use Yokai\EnumBundle\Validator\Constraints\Enum;
+use Yokai\EnumBundle\Tests\Integration\App\Enum\PullRequestMyCLabsStatusEnum;
+use Yokai\EnumBundle\Tests\Integration\App\Enum\PullRequestLabelEnum;
+
+/**
+ * @author Yann Eugoné <eugone.yann@gmail.com>
+ */
+final class PullRequestPhp80
+{
+    /**
+     * @var MyCLabsStatus
+     */
+    #[Enum(enum: PullRequestMyCLabsStatusEnum::class)]
+    public $status;
+
+    /**
+     * @var string[]
+     */
+    #[Enum(enum: PullRequestLabelEnum::class, multiple: true)]
+    public $labels;
+}
diff --git a/tests/Integration/src/Model/PullRequestPhp81.php b/tests/Integration/src/Model/PullRequestPhp81.php
@@ -5,18 +5,18 @@
 namespace Yokai\EnumBundle\Tests\Integration\App\Model;
 
 use Yokai\EnumBundle\Validator\Constraints\Enum;
-use Yokai\EnumBundle\Tests\Integration\App\Enum\PullRequestStatusEnum;
+use Yokai\EnumBundle\Tests\Integration\App\Enum\PullRequestNativeStatusEnum;
 use Yokai\EnumBundle\Tests\Integration\App\Enum\PullRequestLabelEnum;
 
 /**
  * @author Yann Eugoné <eugone.yann@gmail.com>
  */
-final class PullRequestUsingAttributes
+final class PullRequestPhp81
 {
     /**
-     * @var Status
+     * @var NativeStatus
      */
-    #[Enum(enum: PullRequestStatusEnum::class)]
+    #[Enum(enum: PullRequestNativeStatusEnum::class)]
     public $status;
 
     /**
diff --git a/tests/Integration/tests/PullRequestFormTest.php b/tests/Integration/tests/PullRequestFormTest.php
diff --git a/tests/Unit/Fixtures/HTTPMethod.php b/tests/Unit/Fixtures/HTTPMethod.php
diff --git a/tests/Unit/Fixtures/HTTPStatus.php b/tests/Unit/Fixtures/HTTPStatus.php
diff --git a/tests/Unit/Fixtures/Picture.php b/tests/Unit/Fixtures/Picture.php
diff --git a/tests/Unit/NativeEnumTest.php b/tests/Unit/NativeEnumTest.php
diff --git a/tests/Unit/NativeTranslatedEnumTest.php b/tests/Unit/NativeTranslatedEnumTest.php

Original file line number	Diff line number	Diff line change
`@@ -38,4 +38,12 @@ public static function invalidMyClabsEnumClass(string $enum): self`
`38`	`38`	`$enum`
`39`	`39`	`));`
`40`	`40`	`}`
	`41`	`+`
	`42`	`+ public static function invalidUnitEnum(string $enum): self`
	`43`	`+ {`
	`44`	`+ return new self(sprintf(`
	`45`	`+ 'Enum class must be valid PHP enum. Got "%s".',`
	`46`	`+ $enum`
	`47`	`+ ));`
	`48`	`+ }`
`41`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,15 +6,15 @@`
`6`	`6`
`7`	`7`	`use Symfony\Contracts\Translation\TranslatorInterface;`
`8`	`8`	`use Yokai\EnumBundle\MyCLabsTranslatedEnum;`
`9`		`-use Yokai\EnumBundle\Tests\Integration\App\Model\Status;`
	`9`	`+use Yokai\EnumBundle\Tests\Integration\App\Model\MyCLabsStatus;`
`10`	`10`
`11`	`11`	`/**`
`12`	`12`	`* @author Yann Eugoné <[email protected]>`
`13`	`13`	`*/`
`14`		`-final class PullRequestStatusEnum extends MyCLabsTranslatedEnum`
	`14`	`+final class PullRequestMyCLabsStatusEnum extends MyCLabsTranslatedEnum`
`15`	`15`	`{`
`16`	`16`	`public function __construct(TranslatorInterface $translator)`
`17`	`17`	`{`
`18`		`- parent::__construct(Status::class, $translator, 'pull_request.status.%s');`
	`18`	`+ parent::__construct(MyCLabsStatus::class, $translator, 'pull_request.status.%s');`
`19`	`19`	`}`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,11 @@ public function registerContainerConfiguration(LoaderInterface $loader): void`
`36`	`36`	`$loader->load(__DIR__ . '/../config/packages/annotations.yaml');`
`37`	`37`	`}`
`38`	`38`
`39`		`- $loader->load(__DIR__ . '/../config/services.yaml');`
	`39`	`+ if (\PHP_VERSION_ID < 80100) {`
	`40`	`+ $loader->load(__DIR__ . '/../config/services-8.0.yaml');`
	`41`	`+ } else {`
	`42`	`+ $loader->load(__DIR__ . '/../config/services-8.1.yaml');`
	`43`	`+ }`
`40`	`44`	`}`
`41`	`45`
`42`	`46`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`*`
`14`	`14`	`* @author Yann Eugoné <[email protected]>`
`15`	`15`	`*/`
`16`		`-final class Status extends Enum`
	`16`	`+final class MyCLabsStatus extends Enum`
`17`	`17`	`{`
`18`	`18`	`private const OPENED = 'opened';`
`19`	`19`	`private const MERGED = 'merged';`