[DoctrineBridge] Ulid and Uuid as Doctrine Types

symfony · nicolas-grekas · Sep 3, 2020 · Jul 27, 2020 · Sep 3, 2020 · f44fa34098ad5a3432950a3d8a67a01a2bf8221f
commit f44fa34098ad5a3432950a3d8a67a01a2bf8221f
diff --git a/src/Symfony/Bridge/Doctrine/CHANGELOG.md b/src/Symfony/Bridge/Doctrine/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+5.2.0
+-----
+
+ * added support for symfony/uid as `UlidType`, `UuidType`, `UlidBinaryType` and `UuidBinaryType` as Doctrine types
+ * added `UlidGenerator`, `UUidV1Generator`, `UuidV4Generator` and `UuidV6Generator`
+
 5.0.0
 -----
 

diff --git a/src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/RegisterUidTypePass.php b/src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/RegisterUidTypePass.php
@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Doctrine\DependencyInjection\CompilerPass;
+
+use Symfony\Bridge\Doctrine\Types\UlidType;
+use Symfony\Bridge\Doctrine\Types\UuidType;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\Uid\AbstractUid;
+
+final class RegisterUidTypePass implements CompilerPassInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container)
+    {
+        if (!class_exists(AbstractUid::class)) {
+            return;
+        }
+
+        $typeDefinition = $container->getParameter('doctrine.dbal.connection_factory.types');
+
+        if (!isset($typeDefinition['uuid'])) {
+            $typeDefinition['uuid'] = ['class' => UuidType::class];
+        }
+
+        if (!isset($typeDefinition['ulid'])) {
+            $typeDefinition['ulid'] = ['class' => UlidType::class];
+        }
+
+        $container->setParameter('doctrine.dbal.connection_factory.types', $typeDefinition);
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/Id/UlidGenerator.php b/src/Symfony/Bridge/Doctrine/Id/UlidGenerator.php
@@ -0,0 +1,24 @@
+<?php
+
+/*
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Doctrine\Types;
+
+use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\Id\AbstractIdGenerator;
+use Symfony\Component\Uid\Ulid;
+
+final class UlidGenerator extends AbstractIdGenerator
+{
+    public function generate(EntityManager $em, $entity): Ulid
+    {
+        return new Ulid();
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/Id/UuidV1Generator.php b/src/Symfony/Bridge/Doctrine/Id/UuidV1Generator.php
@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Doctrine\Types;
+
+use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\Id\AbstractIdGenerator;
+use Symfony\Component\Uid\UuidV1;
+
+final class UuidV1Generator extends AbstractIdGenerator
+{
+    public function generate(EntityManager $em, $entity): UuidV1
+    {
+        return new UuidV1();
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/Id/UuidV4Generator.php b/src/Symfony/Bridge/Doctrine/Id/UuidV4Generator.php
@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Doctrine\Types;
+
+use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\Id\AbstractIdGenerator;
+use Symfony\Component\Uid\UuidV4;
+
+final class UuidV4Generator extends AbstractIdGenerator
+{
+    public function generate(EntityManager $em, $entity): UuidV4
+    {
+        return new UuidV4();
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/Id/UuidV6Generator.php b/src/Symfony/Bridge/Doctrine/Id/UuidV6Generator.php
@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Doctrine\Types;
+
+use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\Id\AbstractIdGenerator;
+use Symfony\Component\Uid\UuidV6;
+
+final class UuidV6Generator extends AbstractIdGenerator
+{
+    public function generate(EntityManager $em, $entity): UuidV6
+    {
+        return new UuidV6();
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Types/UlidBinaryTypeTest.php b/src/Symfony/Bridge/Doctrine/Tests/Types/UlidBinaryTypeTest.php
@@ -0,0 +1,119 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Doctrine\Tests\Types;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\ConversionException;
+use Doctrine\DBAL\Types\Type;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\Doctrine\Types\UlidBinaryType;
+use Symfony\Component\Uid\Ulid;
+
+class UlidBinaryTypeTest extends TestCase
+{
+    private const DUMMY_ULID = '01EEDQEK6ZAZE93J8KG5B4MBJC';
+
+    private $platform;
+
+    /** @var UlidBinaryType */
+    private $type;
+
+    public static function setUpBeforeClass(): void
+    {
+        Type::addType('ulid_binary', UlidBinaryType::class);
+    }
+
+    protected function setUp(): void
+    {
+        $this->platform = $this->createMock(AbstractPlatform::class);
+        $this->platform
+            ->method('getBinaryTypeDeclarationSQL')
+            ->willReturn('DUMMYBINARY(16)');
+
+        $this->type = Type::getType('ulid_binary');
+    }
+
+    public function testUlidConvertsToDatabaseValue()
+    {
+        $uuid = Ulid::fromString(self::DUMMY_ULID);
+
+        $expected = $uuid->toBinary();
+        $actual = $this->type->convertToDatabaseValue($uuid, $this->platform);
+
+        $this->assertEquals($expected, $actual);
+    }
+
+    public function testStringUlidConvertsToDatabaseValue()
+    {
+        $expected = Ulid::fromString(self::DUMMY_ULID)->toBinary();
+        $actual = $this->type->convertToDatabaseValue(self::DUMMY_ULID, $this->platform);
+
+        $this->assertEquals($expected, $actual);
+    }
+
+    public function testInvalidUlidConversionForDatabaseValue()
+    {
+        $this->expectException(ConversionException::class);
+
+        $this->type->convertToDatabaseValue('abcdefg', $this->platform);
+    }
+
+    public function testNotSupportedTypeConversionForDatabaseValue()
+    {
+        $this->assertNull($this->type->convertToDatabaseValue(new \stdClass(), $this->platform));
+    }
+
+    public function testNullConversionForDatabaseValue()
+    {
+        $this->assertNull($this->type->convertToDatabaseValue(null, $this->platform));
+    }
+
+    public function testUlidConvertsToPHPValue()
+    {
+        $uuid = $this->type->convertToPHPValue(self::DUMMY_ULID, $this->platform);
+
+        $this->assertEquals(self::DUMMY_ULID, $uuid->__toString());
+    }
+
+    public function testInvalidUlidConversionForPHPValue()
+    {
+        $this->expectException(ConversionException::class);
+
+        $this->type->convertToPHPValue('abcdefg', $this->platform);
+    }
+
+    public function testNullConversionForPHPValue()
+    {
+        $this->assertNull($this->type->convertToPHPValue(null, $this->platform));
+    }
+
+    public function testReturnValueIfUlidForPHPValue()
+    {
+        $uuid = new Ulid();
+        $this->assertSame($uuid, $this->type->convertToPHPValue($uuid, $this->platform));
+    }
+
+    public function testGetName()
+    {
+        $this->assertEquals('ulid_binary', $this->type->getName());
+    }
+
+    public function testGetGuidTypeDeclarationSQL()
+    {
+        $this->assertEquals('DUMMYBINARY(16)', $this->type->getSqlDeclaration(['length' => 36], $this->platform));
+    }
+
+    public function testRequiresSQLCommentHint()
+    {
+        $this->assertTrue($this->type->requiresSQLCommentHint($this->platform));
+    }
+}