[TASK] Implement getArrayRepresentation() for Size

And also in the abstract base class `Value`, with exception-throwing
implementations added for all other descendent classes.

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/Size.php

@@ -202,4 +202,19 @@ public function render(OutputFormat $outputFormat): string
 
         return preg_replace(["/$decimalPoint/", '/^(-?)0\\./'], ['.', '$1.'], $size) . ($this->unit ?? '');
     }
+
+    /**
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     *
+     * @internal
+     */
+    public function getArrayRepresentation(): array
+    {
+        $result = parent::getArrayRepresentation();
+
+        $result['number'] = $this->size;
+        $result['unit'] = $this->unit;
+
+        return $result;
+    }
 }

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,14 @@ public function render(OutputFormat $outputFormat): string
             $this->components
         );
     }
+
+    /**
+     * @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 . '`');
+    }
 }

tests/Unit/ArrayRepresentationClassProviderTest.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sabberworm\CSS\Tests\Unit;
+
+use PHPUnit\Framework\TestCase;
+use Sabberworm\CSS\Tests\Unit\Fixtures\ConcreteArrayRepresentationClassProvider;
+
+/**
+ * @covers \Sabberworm\CSS\ArrayRepresentationClassProvider
+ */
+final class ArrayRepresentationClassProviderTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function getArrayRepresentationIncludesClassName(): void
+    {
+        $subject = new ConcreteArrayRepresentationClassProvider();
+
+        $result = $subject->getArrayRepresentation();
+
+        self::assertArrayHasKey('class', $result);
+        self::assertSame('ConcreteArrayRepresentationClassProvider', $result['class']);
+    }
+}

tests/Unit/Fixtures/ConcreteArrayRepresentationClassProvider.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sabberworm\CSS\Tests\Unit\Fixtures;
+
+use Sabberworm\CSS\ArrayRepresentationClassProvider;
+use Sabberworm\CSS\OutputFormat;
+use Sabberworm\CSS\Renderable;
+
+final class ConcreteArrayRepresentationClassProvider implements Renderable
+{
+    use ArrayRepresentationClassProvider;
+
+    /**
+     * @return never
+     */
+    public function render(OutputFormat $outputFormat): string
+    {
+        throw new \BadMethodCallException('Nothing to see here :/', 1767308395);
+    }
+}

tests/Unit/Value/SizeTest.php

@@ -102,12 +102,39 @@ public function parsesUnit(string $unit): void
     /**
      * @test
      */
-    public function getArrayRepresentationThrowsException(): void
+    public function getArrayRepresentationIncludesClassName(): void
     {
-        $this->expectException(\BadMethodCallException::class);
+        $subject = new Size(1);
+
+        $result = $subject->getArrayRepresentation();
 
+        self::assertArrayHasKey('class', $result);
+        self::assertSame('Size', $result['class']);
+    }
+
+    /**
+     * @test
+     */
+    public function getArrayRepresentationIncludesNumber(): void
+    {
         $subject = new Size(1);
 
-        $subject->getArrayRepresentation();
+        $result = $subject->getArrayRepresentation();
+
+        self::assertArrayHasKey('number', $result);
+        self::assertSame(1.0, $result['number']);
+    }
+
+    /**
+     * @test
+     */
+    public function getArrayRepresentationIncludesUnit(): void
+    {
+        $subject = new Size(1, 'px');
+
+        $result = $subject->getArrayRepresentation();
+
+        self::assertArrayHasKey('unit', $result);
+        self::assertSame('px', $result['unit']);
     }
 }

tests/Unit/Value/ValueTest.php

@@ -145,12 +145,13 @@ public function parsesArithmeticWithMalformedOperandsInFunctions(string $leftOpe
     /**
      * @test
      */
-    public function getArrayRepresentationThrowsException(): void
+    public function getArrayRepresentationIncludesClassName(): void
     {
-        $this->expectException(\BadMethodCallException::class);
-
         $subject = new ConcreteValue();
 
-        $subject->getArrayRepresentation();
+        $result = $subject->getArrayRepresentation();
+
+        self::assertArrayHasKey('class', $result);
+        self::assertSame('ConcreteValue', $result['class']);
     }
 }