bug #532 [Live] coerce falsey strings to scalar types (kbond)

This PR was merged into the 2.x branch.

Discussion
----------

[Live] coerce falsey strings to scalar types

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | yes
| Tickets       | Fix #526
| License       | MIT

I chose to allow _weird_ values to be cast to the proper type instead of throwing an exception (ie `0 === (int) 'apple'`).

Commits
-------

f122b89 [Live] coerce falsey strings to scalar types

Author: weaverryan

src/LiveComponent/src/LiveComponentHydrator.php

@@ -148,6 +148,8 @@ public function hydrate(object $component, array $data, string $componentName):
             if ($method = $liveProp->hydrateMethod()) {
                 // TODO: Error checking
                 $value = $component->$method($value);
+            } elseif (\is_string($value) && $type && \in_array($type->getName(), ['int', 'float', 'bool'], true)) {
+                $value = self::coerceScalarValue($value, $type);
             } elseif (!$value && $type && $type->allowsNull() && is_a($type->getName(), \BackedEnum::class, true) && !\in_array($value, array_map(fn (\BackedEnum $e) => $e->value, $type->getName()::cases()))) {
                 $value = null;
             } elseif (null !== $value && $type && !$type->isBuiltin()) {
@@ -189,6 +191,21 @@ public function hydrate(object $component, array $data, string $componentName):
         return new MountedComponent($componentName, $component, $attributes);
     }
 
+    private static function coerceScalarValue(string $value, \ReflectionNamedType $type): int|float|bool|null
+    {
+        $value = trim($value);
+
+        if ('' === $value && $type->allowsNull()) {
+            return null;
+        }
+
+        return match ($type->getName()) {
+            'int' => (int) $value,
+            'float' => (float) $value,
+            'bool' => (bool) $value,
+        };
+    }
+
     /**
      * Transforms a path like `post.name` into `[post][name]`.
      *

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

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\LiveComponent\Tests\Fixtures\Component;
+
+use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
+use Symfony\UX\LiveComponent\Attribute\LiveProp;
+use Symfony\UX\LiveComponent\DefaultActionTrait;
+
+#[AsLiveComponent('scalar_types')]
+final class ScalarTypes
+{
+    use DefaultActionTrait;
+
+    #[LiveProp(writable: true)]
+    public int $int = 1;
+
+    #[LiveProp(writable: true)]
+    public float $float = 1.0;
+
+    #[LiveProp(writable: true)]
+    public bool $bool = true;
+
+    #[LiveProp(writable: true)]
+    public ?int $nullableInt = 1;
+
+    #[LiveProp(writable: true)]
+    public ?float $nullableFloat = 1.0;
+
+    #[LiveProp(writable: true)]
+    public ?bool $nullableBool = true;
+}

src/LiveComponent/tests/Fixtures/templates/components/scalar_types.html.twig

@@ -382,4 +382,41 @@ public function testComponentWithNormalizableObjects(): void
         $this->assertSame('foo', $component->embeddable1->name);
         $this->assertSame('qux', $component->embeddable2->name);
     }
+
+    /**
+     * @dataProvider falseyValueProvider
+     */
+    public function testCoerceFalseyValuesForScalarTypes($prop, $value, $expected): void
+    {
+        $dehydrated = $this->dehydrateComponent($this->mountComponent('scalar_types'))->all();
+
+        $dehydrated[$prop] = $value;
+
+        $hydrated = $this->hydrateComponent($this->getComponent('scalar_types'), $dehydrated, 'scalar_types')
+            ->getComponent()
+        ;
+
+        $this->assertSame($expected, $hydrated->$prop);
+    }
+
+    public static function falseyValueProvider(): iterable
+    {
+        yield ['int', '', 0];
+        yield ['int', '   ', 0];
+        yield ['int', 'apple', 0];
+        yield ['float', '', 0.0];
+        yield ['float', '   ', 0.0];
+        yield ['float', 'apple', 0.0];
+        yield ['bool', '', false];
+        yield ['bool', '   ', false];
+
+        yield ['nullableInt', '', null];
+        yield ['nullableInt', '   ', null];
+        yield ['nullableInt', 'apple', 0];
+        yield ['nullableFloat', '', null];
+        yield ['nullableFloat', '   ', null];
+        yield ['nullableFloat', 'apple', 0.0];
+        yield ['nullableBool', '', null];
+        yield ['nullableBool', '   ', null];
+    }
 }