[TASK] Add getArrayRepresentation() to Renderable (#1447)

JakeQZ · web-flow · commit b74a00045edb · 2025-12-31T13:31:57.000+01:00
This method will make it easier to test the parsing independently of the rendering. Placeholder implementations are currently all stubs that will throw an exception, confirmed by tests. They can be implemented as and when required, with the tests updated. Part of #1440.
diff --git a/src/CSSList/CSSList.php b/src/CSSList/CSSList.php
@@ -435,6 +435,16 @@ public function getContents(): array
         return $this->contents;
     }
 
+    /**
+     * @internal
+     *
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     */
+    public function getArrayRepresentation(): array
+    {
+        throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
+    }
+
     /**
      * @param list<Selector> $selectors1
      * @param list<Selector> $selectors2
diff --git a/src/Comment/Comment.php b/src/Comment/Comment.php
@@ -46,4 +46,14 @@ public function render(OutputFormat $outputFormat): string
     {
         return '/*' . $this->commentText . '*/';
     }
+
+    /**
+     * @internal
+     *
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     */
+    public function getArrayRepresentation(): array
+    {
+        throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
+    }
 }
diff --git a/src/Property/CSSNamespace.php b/src/Property/CSSNamespace.php
@@ -94,4 +94,14 @@ public function atRuleArgs(): array
         }
         return $result;
     }
+
+    /**
+     * @internal
+     *
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     */
+    public function getArrayRepresentation(): array
+    {
+        throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
+    }
 }
diff --git a/src/Property/Charset.php b/src/Property/Charset.php
@@ -71,4 +71,14 @@ public function atRuleArgs(): CSSString
     {
         return $this->charset;
     }
+
+    /**
+     * @internal
+     *
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     */
+    public function getArrayRepresentation(): array
+    {
+        throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
+    }
 }
diff --git a/src/Property/Import.php b/src/Property/Import.php
@@ -82,4 +82,14 @@ public function getMediaQuery(): ?string
     {
         return $this->mediaQuery;
     }
+
+    /**
+     * @internal
+     *
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     */
+    public function getArrayRepresentation(): array
+    {
+        throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
+    }
 }
diff --git a/src/Property/Selector.php b/src/Property/Selector.php
@@ -95,4 +95,14 @@ public function render(OutputFormat $outputFormat): string
     {
         return $this->getSelector();
     }
+
+    /**
+     * @internal
+     *
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     */
+    public function getArrayRepresentation(): array
+    {
+        throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
+    }
 }
diff --git a/src/Renderable.php b/src/Renderable.php
@@ -7,4 +7,11 @@
 interface Renderable
 {
     public function render(OutputFormat $outputFormat): string;
+
+    /**
+     * @internal
+     *
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     */
+    public function getArrayRepresentation(): array;
 }
diff --git a/src/Rule/Rule.php b/src/Rule/Rule.php
@@ -197,4 +197,14 @@ public function render(OutputFormat $outputFormat): string
         $result .= ';';
         return $result;
     }
+
+    /**
+     * @internal
+     *
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     */
+    public function getArrayRepresentation(): array
+    {
+        throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
+    }
 }
diff --git a/src/RuleSet/DeclarationBlock.php b/src/RuleSet/DeclarationBlock.php
@@ -273,6 +273,16 @@ public function render(OutputFormat $outputFormat): string
         return $result;
     }
 
+    /**
+     * @internal
+     *
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     */
+    public function getArrayRepresentation(): array
+    {
+        throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
+    }
+
     /**
      * @param list<Comment> $comments
      *
diff --git a/src/RuleSet/RuleSet.php b/src/RuleSet/RuleSet.php
@@ -331,6 +331,16 @@ protected function renderRules(OutputFormat $outputFormat): string
         return $formatter->removeLastSemicolon($result);
     }
 
+    /**
+     * @internal
+     *
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     */
+    public function getArrayRepresentation(): array
+    {
+        throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
+    }
+
     /**
      * @return int negative if `$first` is before `$second`; zero if they have the same position; positive otherwise
      *
diff --git a/src/Value/Value.php b/src/Value/Value.php
@@ -181,6 +181,16 @@ public static function parsePrimitiveValue(ParserState $parserState)
         return $value;
     }
 
+    /**
+     * @internal
+     *
+     * @return array<string, bool|int|float|string|list<array<string, mixed>>>
+     */
+    public function getArrayRepresentation(): array
+    {
+        throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
+    }
+
     /**
      * @throws UnexpectedEOFException
      * @throws UnexpectedTokenException
diff --git a/tests/Unit/CSSList/CSSListTest.php b/tests/Unit/CSSList/CSSListTest.php
@@ -380,4 +380,16 @@ public function parseListAtRootLevelSkipsErroneousClosingBraceAndParsesFollowing
 
         self::assertSame($followingContent, $subject->render(new OutputFormat()));
     }
+
+    /**
+     * @test
+     */
+    public function getArrayRepresentationThrowsException(): void
+    {
+        $this->expectException(\BadMethodCallException::class);
+
+        $subject = new ConcreteCSSList();
+
+        $subject->getArrayRepresentation();
+    }
 }
diff --git a/tests/Unit/Comment/CommentTest.php b/tests/Unit/Comment/CommentTest.php
@@ -77,4 +77,16 @@ public function getLineNumberReturnsLineNumberProvidedToConstructor(): void
 
         self::assertSame($lineNumber, $subject->getLineNumber());
     }
+
+    /**
+     * @test
+     */
+    public function getArrayRepresentationThrowsException(): void
+    {
+        $this->expectException(\BadMethodCallException::class);
+
+        $subject = new Comment();
+
+        $subject->getArrayRepresentation();
+    }
 }
diff --git a/tests/Unit/Property/CSSNamespaceTest.php b/tests/Unit/Property/CSSNamespaceTest.php
@@ -31,4 +31,14 @@ public function implementsCSSListItem(): void
     {
         self::assertInstanceOf(CSSListItem::class, $this->subject);
     }
+
+    /**
+     * @test
+     */
+    public function getArrayRepresentationThrowsException(): void
+    {
+        $this->expectException(\BadMethodCallException::class);
+
+        $this->subject->getArrayRepresentation();
+    }
 }
diff --git a/tests/Unit/Property/CharsetTest.php b/tests/Unit/Property/CharsetTest.php
@@ -31,4 +31,14 @@ public function implementsCSSListItem(): void
     {
         self::assertInstanceOf(CSSListItem::class, $this->subject);
     }
+
+    /**
+     * @test
+     */
+    public function getArrayRepresentationThrowsException(): void
+    {
+        $this->expectException(\BadMethodCallException::class);
+
+        $this->subject->getArrayRepresentation();
+    }
 }
diff --git a/tests/Unit/Property/ImportTest.php b/tests/Unit/Property/ImportTest.php
@@ -32,4 +32,14 @@ public function implementsCSSListItem(): void
     {
         self::assertInstanceOf(CSSListItem::class, $this->subject);
     }
+
+    /**
+     * @test
+     */
+    public function getArrayRepresentationThrowsException(): void
+    {
+        $this->expectException(\BadMethodCallException::class);
+
+        $this->subject->getArrayRepresentation();
+    }
 }
diff --git a/tests/Unit/Property/SelectorTest.php b/tests/Unit/Property/SelectorTest.php
@@ -188,4 +188,16 @@ public function doesNotCleanupSpacesWithinAttributeSelector(): void
 
         self::assertSame('a[title="extra  space"]', $subject->getSelector());
     }
+
+    /**
+     * @test
+     */
+    public function getArrayRepresentationThrowsException(): void
+    {
+        $this->expectException(\BadMethodCallException::class);
+
+        $subject = new Selector('a');
+
+        $subject->getArrayRepresentation();
+    }
 }
diff --git a/tests/Unit/Rule/RuleTest.php b/tests/Unit/Rule/RuleTest.php
@@ -70,4 +70,16 @@ static function ($component): string {
 
         self::assertSame($expectedTypeClassnames, $actualClassnames);
     }
+
+    /**
+     * @test
+     */
+    public function getArrayRepresentationThrowsException(): void
+    {
+        $this->expectException(\BadMethodCallException::class);
+
+        $subject = new Rule('todo');
+
+        $subject->getArrayRepresentation();
+    }
 }
diff --git a/tests/Unit/RuleSet/DeclarationBlockTest.php b/tests/Unit/RuleSet/DeclarationBlockTest.php
@@ -535,6 +535,16 @@ public function setSelectorsThrowsExceptionWithInvalidSelector(string $selector)
         $subject->setSelectors($selector);
     }
 
+    /**
+     * @test
+     */
+    public function getArrayRepresentationThrowsException(): void
+    {
+        $this->expectException(\BadMethodCallException::class);
+
+        $this->subject->getArrayRepresentation();
+    }
+
     /**
      * @return list<string>
      */
diff --git a/tests/Unit/RuleSet/RuleSetTest.php b/tests/Unit/RuleSet/RuleSetTest.php
@@ -79,4 +79,14 @@ public function getLineNumberReturnsLineNumberPassedToConstructor(?int $lineNumb
 
         self::assertSame($lineNumber, $result);
     }
+
+    /**
+     * @test
+     */
+    public function getArrayRepresentationThrowsException(): void
+    {
+        $this->expectException(\BadMethodCallException::class);
+
+        $this->subject->getArrayRepresentation();
+    }
 }
diff --git a/tests/Unit/Value/ValueTest.php b/tests/Unit/Value/ValueTest.php
@@ -141,4 +141,16 @@ public function parsesArithmeticWithMalformedOperandsInFunctions(string $leftOpe
             $subject->render(OutputFormat::createCompact())
         );
     }
+
+    /**
+     * @test
+     */
+    public function getArrayRepresentationThrowsException(): void
+    {
+        $this->expectException(\BadMethodCallException::class);
+
+        $subject = new ConcreteValue();
+
+        $subject->getArrayRepresentation();
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -46,4 +46,14 @@ public function render(OutputFormat $outputFormat): string`
`46`	`46`	`{`
`47`	`47`	`return '/' . $this->commentText . '/';`
`48`	`48`	`}`
	`49`	`+`
	`50`	`+ /**`
	`51`	`+ * @internal`
	`52`	`+ *`
	`53`	`+ * @return array<string, bool\|int\|float\|string\|list<array<string, mixed>>>`
	`54`	`+ */`
	`55`	`+ public function getArrayRepresentation(): array`
	`56`	`+ {`
	`57`	+ throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
	`58`	`+ }`
`49`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -94,4 +94,14 @@ public function atRuleArgs(): array`
`94`	`94`	`}`
`95`	`95`	`return $result;`
`96`	`96`	`}`
	`97`	`+`
	`98`	`+ /**`
	`99`	`+ * @internal`
	`100`	`+ *`
	`101`	`+ * @return array<string, bool\|int\|float\|string\|list<array<string, mixed>>>`
	`102`	`+ */`
	`103`	`+ public function getArrayRepresentation(): array`
	`104`	`+ {`
	`105`	+ throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
	`106`	`+ }`
`97`	`107`	`}`
Original file line number	Diff line number	Diff line change
`@@ -71,4 +71,14 @@ public function atRuleArgs(): CSSString`
`71`	`71`	`{`
`72`	`72`	`return $this->charset;`
`73`	`73`	`}`
	`74`	`+`
	`75`	`+ /**`
	`76`	`+ * @internal`
	`77`	`+ *`
	`78`	`+ * @return array<string, bool\|int\|float\|string\|list<array<string, mixed>>>`
	`79`	`+ */`
	`80`	`+ public function getArrayRepresentation(): array`
	`81`	`+ {`
	`82`	+ throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
	`83`	`+ }`
`74`	`84`	`}`
Original file line number	Diff line number	Diff line change
`@@ -82,4 +82,14 @@ public function getMediaQuery(): ?string`
`82`	`82`	`{`
`83`	`83`	`return $this->mediaQuery;`
`84`	`84`	`}`
	`85`	`+`
	`86`	`+ /**`
	`87`	`+ * @internal`
	`88`	`+ *`
	`89`	`+ * @return array<string, bool\|int\|float\|string\|list<array<string, mixed>>>`
	`90`	`+ */`
	`91`	`+ public function getArrayRepresentation(): array`
	`92`	`+ {`
	`93`	+ throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
	`94`	`+ }`
`85`	`95`	`}`
Original file line number	Diff line number	Diff line change
`@@ -95,4 +95,14 @@ public function render(OutputFormat $outputFormat): string`
`95`	`95`	`{`
`96`	`96`	`return $this->getSelector();`
`97`	`97`	`}`
	`98`	`+`
	`99`	`+ /**`
	`100`	`+ * @internal`
	`101`	`+ *`
	`102`	`+ * @return array<string, bool\|int\|float\|string\|list<array<string, mixed>>>`
	`103`	`+ */`
	`104`	`+ public function getArrayRepresentation(): array`
	`105`	`+ {`
	`106`	+ throw new \BadMethodCallException('`getArrayRepresentation` is not yet implemented for `' . self::class . '`');
	`107`	`+ }`
`98`	`108`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,4 +7,11 @@`
`7`	`7`	`interface Renderable`
`8`	`8`	`{`
`9`	`9`	`public function render(OutputFormat $outputFormat): string;`
	`10`	`+`
	`11`	`+ /**`
	`12`	`+ * @internal`
	`13`	`+ *`
	`14`	`+ * @return array<string, bool\|int\|float\|string\|list<array<string, mixed>>>`
	`15`	`+ */`
	`16`	`+ public function getArrayRepresentation(): array;`
`10`	`17`	`}`