Skip to content

Commit a864c76

Browse files
yann-eugoneyann-eugone
authored
Add support for PHP 8.1 native enums (#56)
* 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é <yeugone@prestaconcept.net>
1 parent e051412 commit a864c76

21 files changed

+484
-96
lines changed

‎.github/workflows/tests.yml‎

Lines changed: 26 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,30 @@ jobs:
1414
strategy:
1515
matrix:
1616
include:
17-
- php-version: 7.1
18-
symfony-version: 4.4.*
19-
- php-version: 8.1
20-
symfony-version: 4.4.*
21-
- php-version: 7.2
22-
symfony-version: 5.2.*
23-
- php-version: 7.2
24-
symfony-version: 5.3.*
25-
- php-version: 7.2
26-
symfony-version: 5.4.*
27-
- php-version: 8.1
28-
symfony-version: 5.4.*
29-
- php-version: 8.0
30-
symfony-version: 6.0.*
31-
- php-version: 8.1
32-
symfony-version: 6.0.*
17+
- php-version: '7.1'
18+
symfony-version: '4.4.*'
19+
20+
- php-version: '7.4'
21+
symfony-version: '4.4.*'
22+
- php-version: '7.4'
23+
symfony-version: '5.4.*'
24+
25+
- php-version: '8.0'
26+
symfony-version: '4.4.*'
27+
- php-version: '8.0'
28+
symfony-version: '5.4.*'
29+
- php-version: '8.0'
30+
symfony-version: '6.0.*'
31+
32+
- php-version: '8.1'
33+
symfony-version: '5.4.*'
34+
- php-version: '8.1'
35+
symfony-version: '6.3.*'
36+
37+
- php-version: '8.2'
38+
symfony-version: '5.4.*'
39+
- php-version: '8.2'
40+
symfony-version: '6.3.*'
3341

3442
steps:
3543
- name: "Checkout"
@@ -59,11 +67,6 @@ jobs:
5967
name: "Code coverage"
6068
runs-on: ubuntu-latest
6169

62-
strategy:
63-
matrix:
64-
include:
65-
- php-version: 8.1
66-
6770
steps:
6871
- name: "Checkout"
6972
uses: actions/checkout@v2
@@ -72,7 +75,7 @@ jobs:
7275
uses: shivammathur/setup-php@v2
7376
with:
7477
coverage: xdebug
75-
php-version: ${{ matrix.php-version }}
78+
php-version: '8.2'
7679

7780
- name: "Install dependencies with composer"
7881
run: composer update --no-interaction --no-progress
@@ -90,11 +93,6 @@ jobs:
9093
name: "Checkstyle"
9194
runs-on: ubuntu-latest
9295

93-
strategy:
94-
matrix:
95-
include:
96-
- php-version: 8.1
97-
9896
steps:
9997
- name: "Checkout"
10098
uses: actions/checkout@v2
@@ -103,7 +101,7 @@ jobs:
103101
uses: shivammathur/setup-php@v2
104102
with:
105103
coverage: xdebug
106-
php-version: ${{ matrix.php-version }}
104+
php-version: '8.2'
107105

108106
- name: "Install dependencies with composer"
109107
run: composer update --no-interaction --no-progress

‎src/Exception/LogicException.php‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,12 @@ public static function invalidMyClabsEnumClass(string $enum): self
3838
$enum
3939
));
4040
}
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+
}
4149
}

‎src/NativeEnum.php‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Yokai\EnumBundle;
6+
7+
use UnitEnum;
8+
use Yokai\EnumBundle\Exception\LogicException;
9+
10+
/**
11+
* @author Yann Eugoné <eugone.yann@gmail.com>
12+
*/
13+
class NativeEnum extends Enum
14+
{
15+
/**
16+
* @param string $enum
17+
* @param string|null $name
18+
*/
19+
public function __construct(string $enum, string $name = null)
20+
{
21+
if (!\is_a($enum, UnitEnum::class, true)) {
22+
throw LogicException::invalidUnitEnum($enum);
23+
}
24+
25+
if ($name === null && static::class === __CLASS__) {
26+
$name = $enum;
27+
}
28+
29+
$choices = [];
30+
foreach ($enum::cases() as $case) {
31+
$choices[$case->name] = $case;
32+
}
33+
34+
parent::__construct($choices, $name);
35+
}
36+
}

‎src/NativeTranslatedEnum.php‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Yokai\EnumBundle;
6+
7+
use UnitEnum;
8+
use Symfony\Contracts\Translation\TranslatorInterface;
9+
use Yokai\EnumBundle\Exception\LogicException;
10+
11+
/**
12+
* @author Yann Eugoné <eugone.yann@gmail.com>
13+
*/
14+
class NativeTranslatedEnum extends TranslatedEnum
15+
{
16+
/**
17+
* @param string $enum
18+
* @param TranslatorInterface $translator
19+
* @param string $transPattern
20+
* @param string $transDomain
21+
* @param string|null $name
22+
*/
23+
public function __construct(
24+
string $enum,
25+
TranslatorInterface $translator,
26+
string $transPattern,
27+
string $transDomain = 'messages',
28+
string $name = null
29+
) {
30+
if (!\is_a($enum, UnitEnum::class, true)) {
31+
throw LogicException::invalidUnitEnum($enum);
32+
}
33+
34+
if ($name === null && static::class === __CLASS__) {
35+
$name = $enum;
36+
}
37+
38+
$values = [];
39+
foreach ($enum::cases() as $case) {
40+
$values[$case->name] = $case;
41+
}
42+
43+
parent::__construct($values, $translator, $transPattern, $transDomain, $name);
44+
}
45+
}

‎tests/Integration/config/services-8.0.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
services:
2+
_defaults:
3+
autowire: true
4+
autoconfigure: true
5+
6+
Yokai\EnumBundle\Tests\Integration\App\Enum\PullRequestLabelEnum: ~
7+
Yokai\EnumBundle\Tests\Integration\App\Enum\PullRequestMyCLabsStatusEnum: ~
8+
Yokai\EnumBundle\Tests\Integration\App\Form\PullRequestType: ~

‎tests/Integration/config/services-8.1.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
services:
2+
_defaults:
3+
autowire: true
4+
autoconfigure: true
5+
6+
Yokai\EnumBundle\Tests\Integration\App\Enum\PullRequestLabelEnum: ~
7+
Yokai\EnumBundle\Tests\Integration\App\Enum\PullRequestNativeStatusEnum: ~
8+
Yokai\EnumBundle\Tests\Integration\App\Form\PullRequestType: ~

‎tests/Integration/config/services.yaml‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎tests/Integration/src/Enum/PullRequestStatusEnum.php‎ renamed to ‎tests/Integration/src/Enum/PullRequestMyCLabsStatusEnum.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66

77
use Symfony\Contracts\Translation\TranslatorInterface;
88
use Yokai\EnumBundle\MyCLabsTranslatedEnum;
9-
use Yokai\EnumBundle\Tests\Integration\App\Model\Status;
9+
use Yokai\EnumBundle\Tests\Integration\App\Model\MyCLabsStatus;
1010

1111
/**
1212
* @author Yann Eugoné <eugone.yann@gmail.com>
1313
*/
14-
final class PullRequestStatusEnum extends MyCLabsTranslatedEnum
14+
final class PullRequestMyCLabsStatusEnum extends MyCLabsTranslatedEnum
1515
{
1616
public function __construct(TranslatorInterface $translator)
1717
{
18-
parent::__construct(Status::class, $translator, 'pull_request.status.%s');
18+
parent::__construct(MyCLabsStatus::class, $translator, 'pull_request.status.%s');
1919
}
2020
}

‎tests/Integration/src/Enum/PullRequestNativeStatusEnum.php‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Yokai\EnumBundle\Tests\Integration\App\Enum;
6+
7+
use Symfony\Contracts\Translation\TranslatorInterface;
8+
use Yokai\EnumBundle\NativeTranslatedEnum;
9+
use Yokai\EnumBundle\Tests\Integration\App\Model\NativeStatus;
10+
11+
/**
12+
* @author Yann Eugoné <eugone.yann@gmail.com>
13+
*/
14+
final class PullRequestNativeStatusEnum extends NativeTranslatedEnum
15+
{
16+
public function __construct(TranslatorInterface $translator)
17+
{
18+
parent::__construct(NativeStatus::class, $translator, 'pull_request.status.%s');
19+
}
20+
}

‎tests/Integration/src/Kernel.php‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,11 @@ public function registerContainerConfiguration(LoaderInterface $loader): void
3636
$loader->load(__DIR__ . '/../config/packages/annotations.yaml');
3737
}
3838

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+
}
4044
}
4145

4246
/**

0 commit comments

Comments
 (0)