[Live] support (de)hydrating Enum's

Author: kbond

src/LiveComponent/src/LiveComponentHydrator.php

@@ -166,12 +166,15 @@ public function hydrate(object $component, array $data, string $componentName):
             }
 
             $value = $dehydratedValue;
+            $type = $property->getType() instanceof \ReflectionNamedType ? $property->getType() : null;
 
             if ($method = $liveProp->hydrateMethod()) {
                 // TODO: Error checking
                 $value = $component->$method($dehydratedValue);
-            } elseif ($property->getType() instanceof \ReflectionNamedType && !$property->getType()->isBuiltin()) {
-                $value = $this->normalizer->denormalize($value, $property->getType()->getName(), 'json', [self::LIVE_CONTEXT => true]);
+            } elseif (!$value && $type && $type->allowsNull()) {
+                $value = null;
+            } elseif ($value && $type && !$type->isBuiltin()) {
+                $value = $this->normalizer->denormalize($value, $type->getName(), 'json', [self::LIVE_CONTEXT => true]);
             }
 
             foreach ($liveProp->exposed() as $exposedProperty) {

src/LiveComponent/tests/Fixtures/Component/WithEnums.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Symfony\UX\LiveComponent\Tests\Fixtures\Component;
+
+use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
+use Symfony\UX\LiveComponent\Attribute\LiveProp;
+use Symfony\UX\LiveComponent\DefaultActionTrait;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Enum\Priority;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Enum\Status;
+
+#[AsLiveComponent('with_enum')]
+final class WithEnums
+{
+    use DefaultActionTrait;
+
+    #[LiveProp(writable: true)]
+    public ?Priority $priority = null;
+
+    #[LiveProp(writable: true)]
+    public ?Status $status = null;
+}

src/LiveComponent/tests/Fixtures/Enum/Priority.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Symfony\UX\LiveComponent\Tests\Fixtures\Enum;
+
+enum Priority: int
+{
+    case HIGH = 10;
+    case LOW = 1;
+}

src/LiveComponent/tests/Fixtures/Enum/Status.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Symfony\UX\LiveComponent\Tests\Fixtures\Enum;
+
+enum Status: string
+{
+    case PENDING = 'pending';
+    case ACTIVE = 'active';
+}

src/LiveComponent/tests/Integration/LiveComponentHydratorTest.php

@@ -17,6 +17,8 @@
 use Symfony\UX\LiveComponent\Tests\Fixtures\Component\Component3;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Component\ComponentWithArrayProp;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Entity\Entity1;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Enum\Priority;
+use Symfony\UX\LiveComponent\Tests\Fixtures\Enum\Status;
 use Symfony\UX\LiveComponent\Tests\LiveComponentTestHelper;
 use Zenstruck\Foundry\Test\Factories;
 use Zenstruck\Foundry\Test\ResetDatabase;
@@ -279,4 +281,72 @@ public function testCanDehydrateAndHydrateComponentsWithEmptyAttributes(): void
 
         $this->assertSame([], $mounted->getAttributes()->all());
     }
+
+    /**
+     * @requires PHP >= 8.1
+     */
+    public function testCanHydrateEnums(): void
+    {
+        $mounted = $this->mountComponent('with_enum', ['priority' => Priority::HIGH, 'status' => Status::ACTIVE]);
+
+        $dehydrated = $this->dehydrateComponent($mounted);
+
+        $this->assertSame(10, $dehydrated['priority']);
+        $this->assertSame('active', $dehydrated['status']);
+
+        $mounted = $this->hydrateComponent($this->getComponent('with_enum'), $dehydrated, $mounted->getName());
+
+        $this->assertSame(Priority::HIGH, $mounted->getComponent()->priority);
+        $this->assertSame(Status::ACTIVE, $mounted->getComponent()->status);
+
+        $dehydrated['priority'] = Priority::LOW->value;
+        $dehydrated['status'] = Status::PENDING->value;
+
+        $mounted = $this->hydrateComponent($this->getComponent('with_enum'), $dehydrated, $mounted->getName());
+
+        $this->assertSame(Priority::LOW, $mounted->getComponent()->priority);
+        $this->assertSame(Status::PENDING, $mounted->getComponent()->status);
+    }
+
+    /**
+     * @requires PHP >= 8.1
+     */
+    public function testCanHydrateEnumsThatAreNull(): void
+    {
+        $mounted = $this->mountComponent('with_enum');
+
+        $dehydrated = $this->dehydrateComponent($mounted);
+
+        $this->assertNull($dehydrated['priority']);
+        $this->assertNull($dehydrated['status']);
+
+        $mounted = $this->hydrateComponent($this->getComponent('with_enum'), $dehydrated, $mounted->getName());
+
+        $this->assertNull($mounted->getComponent()->priority);
+        $this->assertNull($mounted->getComponent()->status);
+
+        $dehydrated['priority'] = Priority::LOW->value;
+        $dehydrated['status'] = Status::PENDING->value;
+
+        $mounted = $this->hydrateComponent($this->getComponent('with_enum'), $dehydrated, $mounted->getName());
+
+        $this->assertSame(Priority::LOW, $mounted->getComponent()->priority);
+        $this->assertSame(Status::PENDING, $mounted->getComponent()->status);
+
+        $dehydrated['priority'] = null;
+        $dehydrated['status'] = null;
+
+        $mounted = $this->hydrateComponent($this->getComponent('with_enum'), $dehydrated, $mounted->getName());
+
+        $this->assertNull($mounted->getComponent()->priority);
+        $this->assertNull($mounted->getComponent()->status);
+
+        $dehydrated['priority'] = '';
+        $dehydrated['status'] = '';
+
+        $mounted = $this->hydrateComponent($this->getComponent('with_enum'), $dehydrated, $mounted->getName());
+
+        $this->assertNull($mounted->getComponent()->priority);
+        $this->assertNull($mounted->getComponent()->status);
+    }
 }