Support Uuid list column

Author: compositephp

phpunit.xml

@@ -1,14 +1,22 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.1/phpunit.xsd" bootstrap="vendor/autoload.php"
-         executionOrder="depends,defects" beStrictAboutOutputDuringTests="true" failOnRisky="true" failOnWarning="true"
-         colors="true" cacheDirectory=".phpunit.cache" requireCoverageMetadata="false"
-         displayDetailsOnTestsThatTriggerDeprecations="true"
-         displayDetailsOnTestsThatTriggerErrors="true"
-         displayDetailsOnTestsThatTriggerNotices="true"
-         displayDetailsOnTestsThatTriggerWarnings="true"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         backupGlobals="false"
+         colors="true"
+         processIsolation="false"
+         stopOnFailure="false"
+         stopOnError="false"
+         stderr="true"
+         cacheDirectory="runtime/.phpunit.cache"
+         backupStaticProperties="false"
+         beStrictAboutOutputDuringTests="true"
          displayDetailsOnPhpunitDeprecations="true"
-         beStrictAboutCoverageMetadata="true">
+         failOnPhpunitDeprecation="true"
+         failOnDeprecation="true"
+         failOnRisky="true"
+         failOnWarning="true"
+>
     <testsuites>
         <testsuite name="default">
             <directory>tests</directory>

src/ColumnBuilder.php

@@ -98,11 +98,15 @@ private static function getPropertyConfig(string $propertyTypeName, array $prope
         $subType = null;
 
         if ($columnClass === Columns\ArrayColumn::class && isset($propertyAttributes[Attributes\ListOf::class])) {
-            $columnClass = Columns\EntityListColumn::class;
             /** @var Attributes\ListOf $listOfAttribute */
             $listOfAttribute = $propertyAttributes[Attributes\ListOf::class];
             $type = $listOfAttribute->class;
             $subType = $listOfAttribute->keyColumn;
+            if ($type === UuidInterface::class) {
+                $columnClass = Columns\UuidListColumn::class;
+            } else {
+                $columnClass = Columns\EntityListColumn::class;
+            }
         } elseif (!$columnClass && class_exists($propertyTypeName)) {
             if (is_subclass_of($propertyTypeName, AbstractEntity::class)) {
                 $columnClass = Columns\EntityColumn::class;

src/Columns/UuidListColumn.php

@@ -0,0 +1,45 @@
+<?php declare(strict_types=1);
+
+namespace Composite\Entity\Columns;
+
+use Composite\Entity\Exceptions\EntityException;
+use Ramsey\Uuid;
+
+class UuidListColumn extends AbstractColumn
+{
+    /**
+     * @return array<Uuid\UuidInterface>
+     * @throws EntityException
+     */
+    public function cast(mixed $dbValue): array
+    {
+        if (is_array($dbValue)) {
+            foreach ($dbValue as $key => $value) {
+                if (is_string($value)) {
+                    $dbValue[$key] = Uuid\Uuid::fromString($value);
+                }
+            }
+            return $dbValue;
+        }
+        try {
+            return array_map(
+                fn ($value) => Uuid\Uuid::fromString((string)$value),
+                (array)\json_decode(strval($dbValue), true, 512, JSON_THROW_ON_ERROR)
+            );
+        } catch (\Exception $e) {
+            throw new EntityException($e->getMessage(), $e);
+        }
+    }
+
+    /**
+     * @throws EntityException
+     */
+    public function uncast(mixed $entityValue): string
+    {
+        try {
+            return \json_encode($entityValue, JSON_THROW_ON_ERROR);
+        } catch (\JsonException $e) {
+            throw new EntityException($e->getMessage(), $e);
+        }
+    }
+}

tests/Columns/UuidListColumnTest.php

@@ -0,0 +1,88 @@
+<?php declare(strict_types=1);
+
+namespace Composite\Entity\Tests\Columns;
+
+use Composite\Entity\AbstractEntity;
+use Composite\Entity\Attributes\ListOf;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Ramsey\Uuid\Uuid;
+use Ramsey\Uuid\UuidInterface;
+
+final class UuidListColumnTest extends \PHPUnit\Framework\TestCase
+{
+    public static function cast_dataProvider(): array
+    {
+        $str = '6ba7b810-9dad-11d1-80b4-00c04fd430c8';
+        $uuid = Uuid::fromString($str);
+        return [
+            [
+                'value' => [],
+                'expected' => [],
+            ],
+            [
+                'value' => "[\"{$str}\"]",
+                'expected' => [$uuid],
+            ],
+            [
+                'value' => [$uuid],
+                'expected' => [$uuid],
+            ],
+            [
+                'value' => [$str],
+                'expected' => [$uuid],
+            ],
+            [
+                'value' => 'invalid_uuid',
+                'expected' => [],
+            ],
+        ];
+    }
+
+    #[DataProvider('cast_dataProvider')]
+    public function test_cast(mixed $value, array $expected): void
+    {
+        $class = new class extends AbstractEntity {
+            public function __construct(
+                #[ListOf(UuidInterface::class)]
+                public array $column = [],
+            ) {}
+        };
+        $entity = $class::fromArray(['column' => $value]);
+        $this->assertEquals($expected, $entity->column);
+    }
+
+    public static function uncast_dataProvider(): array
+    {
+        $str = '6ba7b810-9dad-11d1-80b4-00c04fd430c8';
+        $uuid = Uuid::fromString($str);
+        return [
+            [
+                'value' => [],
+                'expected' => '[]',
+            ],
+            [
+                'value' => [$uuid],
+                'expected' => "[\"{$str}\"]",
+            ],
+
+        ];
+    }
+
+    #[DataProvider('uncast_dataProvider')]
+    public function test_uncast(array $value, mixed $expected): void
+    {
+        $entity = new class($value) extends AbstractEntity {
+            public function __construct(
+                #[ListOf(UuidInterface::class)]
+                public array $column,
+            ) {}
+        };
+        $actual = $entity->toArray()['column'];
+        $this->assertEquals($expected, $actual);
+
+        $newEntity = $entity::fromArray(['column' => $actual]);
+        $newActual = $newEntity->toArray()['column'];
+        $this->assertEquals($entity->column, $newEntity->column);
+        $this->assertEquals($expected, $newActual);
+    }
+}