feat(twig): allow string[] for ComponentAttribute values

Author: kbond

src/TwigComponent/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## Unreleased
+
+-  Allow `string[]` for component attribute values (filter non-strings).
+
 ## 2.13.0
 
 -   [BC BREAK] Add component metadata to `PreMountEvent` and `PostMountEvent`

src/TwigComponent/src/ComponentAttributes.php

@@ -21,29 +21,24 @@
  */
 final class ComponentAttributes
 {
+    private bool $normalized = false;
+
     /**
-     * @param array<string, string|bool> $attributes
+     * @param array<string, string|bool, string[]> $attributes
      */
     public function __construct(private array $attributes)
     {
     }
 
     public function __toString(): string
     {
+        $this->ensureNormalized();
+
         return array_reduce(
             array_keys($this->attributes),
             function (string $carry, string $key) {
                 $value = $this->attributes[$key];
 
-                if (!\is_scalar($value) && null !== $value) {
-                    throw new \LogicException(sprintf('A "%s" prop was passed when creating the component. No matching "%s" property or mount() argument was found, so we attempted to use this as an HTML attribute. But, the value is not a scalar (it\'s a %s). Did you mean to pass this to your component or is there a typo on its name?', $key, $key, get_debug_type($value)));
-                }
-
-                if (null === $value) {
-                    trigger_deprecation('symfony/ux-twig-component', '2.8.0', 'Passing "null" as an attribute value is deprecated and will throw an exception in 3.0.');
-                    $value = true;
-                }
-
                 return match ($value) {
                     true => "{$carry} {$key}",
                     false => $carry,
@@ -59,7 +54,7 @@ function (string $carry, string $key) {
      */
     public function all(): array
     {
-        return $this->attributes;
+        return $this->ensureNormalized()->attributes;
     }
 
     /**
@@ -79,6 +74,8 @@ public function defaults(iterable $attributes): self
             $attributes = iterator_to_array($attributes);
         }
 
+        self::normalize($attributes);
+
         foreach ($this->attributes as $key => $value) {
             if (\in_array($key, ['class', 'data-controller', 'data-action'], true) && isset($attributes[$key])) {
                 $attributes[$key] = "{$attributes[$key]} {$value}";
@@ -157,4 +154,34 @@ public function remove($key): self
 
         return new self($attributes);
     }
+
+    private function ensureNormalized(): self
+    {
+        if ($this->normalized) {
+            return $this;
+        }
+
+        self::normalize($this->attributes);
+        $this->normalized = true;
+
+        return $this;
+    }
+
+    private static function normalize(array &$attributes): void
+    {
+        foreach ($attributes as $key => &$value) {
+            if (null === $value) {
+                trigger_deprecation('symfony/ux-twig-component', '2.8.0', 'Passing "null" as an attribute value is deprecated and will throw an exception in 3.0.');
+                $value = true;
+            }
+
+            if (\is_array($value) && array_is_list($value)) {
+                $value = implode(' ', array_filter($value, 'is_string'));
+            }
+
+            if (!\is_scalar($value)) {
+                throw new \LogicException(sprintf('A "%s" prop was passed when creating the component. No matching "%s" property or mount() argument was found, so we attempted to use this as an HTML attribute. But, the value is not a scalar (it\'s a %s). Did you mean to pass this to your component or is there a typo on its name?', $key, $key, get_debug_type($value)));
+            }
+        }
+    }
 }

src/TwigComponent/tests/Unit/ComponentAttributesTest.php

@@ -188,7 +188,24 @@ public function testNullBehaviour(): void
     {
         $attributes = new ComponentAttributes(['disabled' => null]);
 
-        $this->assertSame(['disabled' => null], $attributes->all());
+        $this->assertSame(['disabled' => true], $attributes->all());
         $this->assertSame(' disabled', (string) $attributes);
     }
+
+    public function testCannotPassNonScalarValues(): void
+    {
+        $this->expectException(\LogicException::class);
+
+        (string) new ComponentAttributes(['data-foo' => new \stdClass()]);
+    }
+
+    public function testListAttributeValues(): void
+    {
+        $attributes = new ComponentAttributes([
+            'style' => ['foo', null, false, true, new \stdClass(), 'bar'],
+        ]);
+
+        $this->assertSame(' style="foo bar"', (string) $attributes);
+        $this->assertSame(['style' => 'foo bar'], $attributes->all());
+    }
 }