Support Symfony 5.4 (#204)

Author: fre5h

.github/workflows/ci.yaml

@@ -41,7 +41,7 @@ jobs:
       - name: 'Setup PHP'
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.0
+          php-version: 8.1
           ini-values: memory_limit=-1
           coverage: none
           tools: composer:v2
@@ -66,7 +66,7 @@ jobs:
       - name: 'Setup PHP'
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.0
+          php-version: 8.1
           ini-values: memory_limit=-1
           coverage: none
           tools: composer:v2
@@ -86,14 +86,11 @@ jobs:
       fail-fast: false
       matrix:
         php-version:
-          - '7.3'
           - '7.4'
           - '8.0'
+          - '8.1'
         symfony-version:
-          - '5.0'
-          - '5.1'
-          - '5.2'
-          - '5.3'
+          - '5.4'
     steps:
       - name: 'Checkout Code'
         uses: actions/checkout@v2
@@ -128,7 +125,7 @@ jobs:
       - name: 'Setup PHP'
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 7.4
+          php-version: 8.1
           ini-values: memory_limit=-1
           coverage: pcov
           tools: composer:v2

Command/EnumDropCommentCommand.php

@@ -39,22 +39,19 @@ final class EnumDropCommentCommand extends Command
     /** @var string */
     protected static $defaultDescription = 'Drop comment in DB for the column of registered ENUM type';
 
-    /** @var ManagerRegistry */
-    private $registry;
-
-    /** @var EntityManagerInterface */
-    private $em;
+    private ManagerRegistry $registry;
+    private EntityManagerInterface $em;
 
     /** @var string[] */
-    private $registeredEnumTypes = [];
+    private array $registeredEnumTypes = [];
 
     /** @var string|mixed */
     private $enumType;
 
     /**
-     * @param ManagerRegistry $registry
-     * @param mixed[]         $registeredTypes
-     * @param string|null     $name
+     * @param ManagerRegistry                      $registry
+     * @param array<string, array<string, string>> $registeredTypes
+     * @param string|null                          $name
      *
      * @throws EnumTypeIsRegisteredButClassDoesNotExistException
      */
@@ -193,10 +190,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             }
         } catch (\Throwable $e) {
             $io->error($e->getMessage());
+            $code = $e->getCode();
 
-            return $e->getCode();
+            return \is_int($code) ? $code : self::FAILURE;
         }
 
-        return 0;
+        return self::SUCCESS;
     }
 }

DBAL/Types/AbstractEnumType.php

@@ -13,7 +13,7 @@
 namespace Fresh\DoctrineEnumBundle\DBAL\Types;
 
 use Doctrine\DBAL\Platforms\AbstractPlatform;
-use Doctrine\DBAL\Platforms\MySqlPlatform;
+use Doctrine\DBAL\Platforms\MySQLPlatform;
 use Doctrine\DBAL\Platforms\PostgreSQL100Platform;
 use Doctrine\DBAL\Platforms\PostgreSQL94Platform;
 use Doctrine\DBAL\Platforms\SqlitePlatform;
@@ -35,40 +35,37 @@
  */
 abstract class AbstractEnumType extends Type
 {
-    /** @var string */
-    protected $name = '';
+    protected string $name = '';
 
     /**
      * @var array<TValue, TReadable> Array of ENUM Values, where ENUM values are keys and their readable versions are values
      *
      * @static
      */
-    protected static $choices = [];
+    protected static array $choices = [];
 
     /**
-     * {@inheritdoc}
+     * @param TValue           $value
+     * @param AbstractPlatform $platform
      *
      * @throws InvalidArgumentException
      *
-     * @return TValue|null
+     * @return TValue|int|string
      */
     public function convertToDatabaseValue($value, AbstractPlatform $platform)
     {
-        if (null === $value) {
-            return null;
-        }
-
-        if (!isset(static::$choices[$value])) {
+        if (null !== $value && !isset(static::$choices[$value])) {
             throw new InvalidArgumentException(\sprintf('Invalid value "%s" for ENUM "%s".', $value, $this->getName()));
         }
 
         return $value;
     }
 
     /**
-     * {@inheritdoc}
+     * @param TValue           $value
+     * @param AbstractPlatform $platform
      *
-     * @return TValue|null
+     * @return TValue
      */
     public function convertToPHPValue($value, AbstractPlatform $platform)
     {
@@ -89,8 +86,8 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
     /**
      * Gets the SQL declaration snippet for a field of this type.
      *
-     * @param mixed[]          $fieldDeclaration The field declaration
-     * @param AbstractPlatform $platform         The currently used database platform
+     * @param array<string, string> $fieldDeclaration The field declaration
+     * @param AbstractPlatform      $platform         The currently used database platform
      *
      * @return string
      */
@@ -99,7 +96,8 @@ public function getSqlDeclaration(array $fieldDeclaration, AbstractPlatform $pla
         $values = \implode(
             ', ',
             \array_map(
-                static function (string $value) {
+                /** @var TValue $value */
+                static function ($value) {
                     return "'{$value}'";
                 },
                 static::getValues()
@@ -174,14 +172,20 @@ public static function getValues(): array
      *
      * @static
      *
+     * @throws InvalidArgumentException
+     *
      * @return TValue
      */
     public static function getRandomValue()
     {
         $values = self::getValues();
-        $randomKey = \random_int(0, \count($values) - 1);
 
-        return $values[$randomKey];
+        $count = \count($values);
+        if (0 === $count) {
+            throw new InvalidArgumentException('There is no value in Enum type');
+        }
+
+        return $values[\random_int(0, $count - 1)];
     }
 
     /**
@@ -261,7 +265,7 @@ public static function getDefaultValue()
      */
     public function getMappedDatabaseTypes(AbstractPlatform $platform): array
     {
-        if ($platform instanceof MySqlPlatform) {
+        if ($platform instanceof MySQLPlatform) {
             return \array_merge(parent::getMappedDatabaseTypes($platform), ['enum']);
         }
 

DBAL/Types/DayOfWeekFullNameType.php

@@ -38,7 +38,7 @@ final class DayOfWeekFullNameType extends AbstractEnumType
     /**
      * {@inheritdoc}
      */
-    protected static $choices = [
+    protected static array $choices = [
         self::MONDAY => 'Monday',
         self::TUESDAY => 'Tuesday',
         self::WEDNESDAY => 'Wednesday',

DBAL/Types/DayOfWeekShortNameType.php

@@ -38,7 +38,7 @@ final class DayOfWeekShortNameType extends AbstractEnumType
     /**
      * {@inheritdoc}
      */
-    protected static $choices = [
+    protected static array $choices = [
         self::MONDAY => 'Monday',
         self::TUESDAY => 'Tuesday',
         self::WEDNESDAY => 'Wednesday',

DBAL/Types/MonthFullNameType.php

@@ -48,7 +48,7 @@ final class MonthFullNameType extends AbstractEnumType
     /**
      * {@inheritdoc}
      */
-    protected static $choices = [
+    protected static array $choices = [
         self::JANUARY => 'January',
         self::FEBRUARY => 'February',
         self::MARCH => 'March',

DBAL/Types/MonthShortNameType.php

@@ -48,7 +48,7 @@ final class MonthShortNameType extends AbstractEnumType
     /**
      * {@inheritdoc}
      */
-    protected static $choices = [
+    protected static array $choices = [
         self::JANUARY => 'January',
         self::FEBRUARY => 'February',
         self::MARCH => 'March',

DependencyInjection/Compiler/RegisterEnumTypePass.php

@@ -38,7 +38,7 @@ public function process(ContainerBuilder $container): void
         /* @see \Doctrine\Bundle\DoctrineBundle\ConnectionFactory::createConnection */
         foreach ($doctrine->getConnectionNames() as $connectionName) {
             $definition = $container->getDefinition($connectionName);
-            $mappingTypes = $definition->getArgument(3);
+            $mappingTypes = (array) $definition->getArgument(3);
             if (!isset($mappingTypes['enum']) || 'string' !== $mappingTypes['enum']) {
                 $mappingTypes['enum'] = 'string';
                 $definition->setArgument(3, $mappingTypes);

Form/EnumTypeGuesser.php

@@ -29,11 +29,11 @@
 class EnumTypeGuesser extends DoctrineOrmTypeGuesser
 {
     /** @var string[] */
-    private $registeredEnumTypes = [];
+    private array $registeredEnumTypes = [];
 
     /**
-     * @param ManagerRegistry $registry
-     * @param mixed[]         $registeredTypes
+     * @param ManagerRegistry                      $registry
+     * @param array<string, array<string, string>> $registeredTypes
      */
     public function __construct(ManagerRegistry $registry, array $registeredTypes)
     {

README.md

@@ -13,19 +13,19 @@
 
 ## Supported platforms 🧐
 
-| MySQL | SQLite | PostgreSQL | MSSQL |
-|-------|--------|------------|-------|
+| PostgreSQL | SQLite | MySQL | MSSQL |
+|------------|--------|-------|-------|
 
 ## Installation 🌱
 
-```composer req fresh/doctrine-enum-bundle='~7.3'```
+```composer req fresh/doctrine-enum-bundle='~7.4'```
 
 ##### Choose the version you need
 
-| Bundle Version (X.Y.Z) | PHP              | Symfony          | Doctrine Bundle    | Comment                   |
-|:----------------------:|:----------------:|:----------------:|:------------------:|:--------------------------|
-| `7.3.*`                | `>= 7.3.0`       | `>= 5.0`         | `>= 2.1`           | **Current version**       |
-| `6.6.*`                | `>= 7.1.3`       | `4.3, 4.4`       | `>= 2.0`           | Previous version          |
+| Bundle Version (X.Y.Z) | PHP              | Symfony          | Doctrine Bundle | Comment             |
+|:----------------------:|:----------------:|:----------------:|:---------------:|:--------------------|
+| `7.4.*`                | `>= 7.4.0`       | `5.4`            | `>= 2.5`        | **Current version** |
+| `7.3.*`                | `>= 7.3.0`       | `5.0..5.3`       | `>= 2.1`        | Previous version    |
 
 #### Check the `config/bundles.php` file
 

Resources/docs/example_of_using.md

@@ -64,7 +64,7 @@ class Player
      * @ORM\Column(name="id", type="integer")
      * @ORM\GeneratedValue(strategy="AUTO")
      */
-    protected $id;
+    private $id;
 
     /**
      * Note, that type of a field should be same as you set in Doctrine config
@@ -73,7 +73,7 @@ class Player
      * @ORM\Column(name="position", type="BasketballPositionType", nullable=false)
      * @DoctrineAssert\Enum(entity="App\DBAL\Types\BasketballPositionType")     
      */
-    protected $position;
+    private $position;
 
     public function getId()
     {
@@ -82,6 +82,8 @@ class Player
 
     public function setPosition(string $position)
     {
+        BasketballPositionType::assertValidChoice($position);
+        
         $this->position = $position;
     }
 

Tests/Command/EnumDropCommentCommandTest.php

@@ -42,17 +42,10 @@ final class EnumDropCommentCommandTest extends TestCase
     /** @var AbstractPlatform|MockObject */
     private $platform;
 
-    /** @var Command */
-    private $command;
-
-    /** @var ClassMetadataFactory */
-    private $metadataFactory;
-
-    /** @var Application */
-    private $application;
-
-    /** @var CommandTester */
-    private $commandTester;
+    private Command $command;
+    private ClassMetadataFactory $metadataFactory;
+    private Application $application;
+    private CommandTester$commandTester;
 
     protected function setUp(): void
     {