[TASK] Implement getArrayRepresentation() in Value and ValueList

Also include a demo of its usage.

Part of #1440.

Author: JakeQZ

src/ArrayRepresentationClassProvider.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sabberworm\CSS;
+
+/**
+ * Provides a reusable implementation of `getArrayRepresentation()` which will populate the `class` element with the
+ * short name of the actual class.
+ * It is expected that this will be `use`d by (possibly-abstract) base classes, with extended classes calling on to the
+ * parent implementation then further populating the array.
+ * If a base class using this trait needs to further populate the array, the trait method can be `use`d `as`.
+ *
+ * @internal
+ *
+ * @phpstan-require-implements Renderable
+ */
+trait ArrayRepresentationClassProvider
+{
+    /**
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     *
+     * @internal
+     */
+    public function getArrayRepresentation(): array
+    {
+        $reflect = new \ReflectionClass($this);
+
+        return ['class' => $reflect->getShortName()];
+    }
+}

src/Value/CSSString.php

@@ -94,4 +94,14 @@ public function render(OutputFormat $outputFormat): string
         $string = \str_replace("\n", '\\A', $string);
         return $outputFormat->getStringQuotingType() . $string . $outputFormat->getStringQuotingType();
     }
+
+    /**
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     *
+     * @internal
+     */
+    public function getArrayRepresentation(): array
+    {
+        throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
+    }
 }

src/Value/CalcFunction.php

@@ -96,4 +96,14 @@ public static function parse(ParserState $parserState, bool $ignoreCase = false)
         }
         return new CalcFunction($function, $list, ',', $parserState->currentLine());
     }
+
+    /**
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     *
+     * @internal
+     */
+    public function getArrayRepresentation(): array
+    {
+        throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
+    }
 }

src/Value/Color.php

@@ -239,6 +239,16 @@ public function render(OutputFormat $outputFormat): string
         return parent::render($outputFormat);
     }
 
+    /**
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     *
+     * @internal
+     */
+    public function getArrayRepresentation(): array
+    {
+        throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
+    }
+
     private function shouldRenderAsHex(OutputFormat $outputFormat): bool
     {
         return

src/Value/LineName.php

@@ -56,4 +56,14 @@ public function render(OutputFormat $outputFormat): string
     {
         return '[' . parent::render(OutputFormat::createCompact()) . ']';
     }
+
+    /**
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     *
+     * @internal
+     */
+    public function getArrayRepresentation(): array
+    {
+        throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
+    }
 }

src/Value/URL.php

@@ -80,4 +80,14 @@ public function render(OutputFormat $outputFormat): string
     {
         return "url({$this->url->render($outputFormat)})";
     }
+
+    /**
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     *
+     * @internal
+     */
+    public function getArrayRepresentation(): array
+    {
+        throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
+    }
 }

src/Value/Value.php

@@ -4,6 +4,7 @@
 
 namespace Sabberworm\CSS\Value;
 
+use Sabberworm\CSS\ArrayRepresentationClassProvider;
 use Sabberworm\CSS\CSSElement;
 use Sabberworm\CSS\Parsing\ParserState;
 use Sabberworm\CSS\Parsing\SourceException;
@@ -21,6 +22,7 @@
 abstract class Value implements CSSElement, Positionable
 {
     use Position;
+    use ArrayRepresentationClassProvider;
 
     /**
      * @param int<1, max>|null $lineNumber
@@ -181,16 +183,6 @@ public static function parsePrimitiveValue(ParserState $parserState)
         return $value;
     }
 
-    /**
-     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
-     *
-     * @internal
-     */
-    public function getArrayRepresentation(): array
-    {
-        throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
-    }
-
     /**
      * @throws UnexpectedEOFException
      * @throws UnexpectedTokenException

src/Value/ValueList.php

@@ -93,4 +93,31 @@ public function render(OutputFormat $outputFormat): string
             $this->components
         );
     }
+
+    /**
+     * @internal
+     *
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     */
+    public function getArrayRepresentation(): array
+    {
+        $result = parent::getArrayRepresentation();
+
+        $result['components'] = \array_map(
+            /**
+             * @parm Value|string $component
+             *
+             * @return array|string
+             */
+            function ($component) {
+                if (\is_string($component)) {
+                    return $component;
+                }
+                return $component->getArrayRepresentation();
+            },
+            $this->components
+        );
+
+        return $result;
+    }
 }

tests/Unit/Value/CSSFunctionTest.php

@@ -5,24 +5,10 @@
 namespace Sabberworm\CSS\Tests\Unit\Value;
 
 use PHPUnit\Framework\TestCase;
-use Sabberworm\CSS\Value\CSSFunction;
 
 /**
  * @covers \Sabberworm\CSS\Value\CSSFunction
  * @covers \Sabberworm\CSS\Value\Value
  * @covers \Sabberworm\CSS\Value\ValueList
  */
-final class CSSFunctionTest extends TestCase
-{
-    /**
-     * @test
-     */
-    public function getArrayRepresentationThrowsException(): void
-    {
-        $this->expectException(\BadMethodCallException::class);
-
-        $subject = new CSSFunction('filter', []);
-
-        $subject->getArrayRepresentation();
-    }
-}
+final class CSSFunctionTest extends TestCase {}

tests/Unit/Value/CalcRuleValueListTest.php

@@ -56,16 +56,4 @@ public function separatorAlwaysIsComma(): void
 
         self::assertSame(',', $subject->getListSeparator());
     }
-
-    /**
-     * @test
-     */
-    public function getArrayRepresentationThrowsException(): void
-    {
-        $this->expectException(\BadMethodCallException::class);
-
-        $subject = new CalcRuleValueList();
-
-        $subject->getArrayRepresentation();
-    }
 }