[TASK] Remove __toString()

oliverklee · oliverklee · commit 49f54ced3488 · 2025-03-02T15:08:11.000+01:00
Part of #998.
diff --git a/src/CSSList/AtRuleBlockList.php b/src/CSSList/AtRuleBlockList.php
@@ -42,14 +42,6 @@ public function atRuleArgs(): string
         return $this->arguments;
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     public function render(OutputFormat $outputFormat): string
     {
         $result = $outputFormat->comments($this);
diff --git a/src/CSSList/CSSList.php b/src/CSSList/CSSList.php
@@ -402,14 +402,6 @@ public function removeDeclarationBlockBySelector($selectors, $removeAll = false)
         }
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     /**
      * @return string
      */
diff --git a/src/CSSList/KeyFrame.php b/src/CSSList/KeyFrame.php
@@ -51,14 +51,6 @@ public function getAnimationName()
         return $this->animationName;
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     public function render(OutputFormat $outputFormat): string
     {
         $result = $outputFormat->comments($this);
diff --git a/src/Comment/Comment.php b/src/Comment/Comment.php
@@ -50,14 +50,6 @@ public function setComment(string $commentText): void
         $this->commentText = $commentText;
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     public function render(OutputFormat $outputFormat): string
     {
         return '/*' . $this->commentText . '*/';
diff --git a/src/Property/CSSNamespace.php b/src/Property/CSSNamespace.php
@@ -54,14 +54,6 @@ public function getLineNo(): int
         return $this->lineNumber;
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     public function render(OutputFormat $outputFormat): string
     {
         return '@namespace ' . ($this->prefix === null ? '' : $this->prefix . ' ')
diff --git a/src/Property/Charset.php b/src/Property/Charset.php
@@ -71,14 +71,6 @@ public function getCharset()
         return $this->charset->getString();
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     public function render(OutputFormat $outputFormat): string
     {
         return "{$outputFormat->comments($this)}@charset {$this->charset->render($outputFormat)};";
diff --git a/src/Property/Import.php b/src/Property/Import.php
@@ -72,14 +72,6 @@ public function getLocation()
         return $this->location;
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     public function render(OutputFormat $outputFormat): string
     {
         return $outputFormat->comments($this) . '@import ' . $this->location->render($outputFormat)
diff --git a/src/Property/Selector.php b/src/Property/Selector.php
@@ -109,14 +109,6 @@ public function setSelector(string $selector): void
         $this->specificity = null;
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->getSelector();
-    }
-
     /**
      * @return int<0, max>
      */
diff --git a/src/Renderable.php b/src/Renderable.php
@@ -6,10 +6,5 @@
 
 interface Renderable
 {
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string;
-
     public function render(OutputFormat $outputFormat): string;
 }
diff --git a/src/Rule/Rule.php b/src/Rule/Rule.php
@@ -260,14 +260,6 @@ public function getIsImportant()
         return $this->isImportant;
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     public function render(OutputFormat $outputFormat): string
     {
         $result = "{$outputFormat->comments($this)}{$this->rule}:{$outputFormat->spaceAfterRuleName()}";
diff --git a/src/RuleSet/AtRuleSet.php b/src/RuleSet/AtRuleSet.php
@@ -53,14 +53,6 @@ public function atRuleArgs()
         return $this->arguments;
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     public function render(OutputFormat $outputFormat): string
     {
         $result = $outputFormat->comments($this);
diff --git a/src/RuleSet/DeclarationBlock.php b/src/RuleSet/DeclarationBlock.php
@@ -140,16 +140,6 @@ public function getSelectors()
         return $this->selectors;
     }
 
-    /**
-     * @throws OutputException
-     *
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     /**
      * @throws OutputException
      */
diff --git a/src/RuleSet/RuleSet.php b/src/RuleSet/RuleSet.php
@@ -255,14 +255,6 @@ public function removeRule($searchPattern): void
         }
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     /**
      * @return string
      */
diff --git a/src/Value/CSSFunction.php b/src/Value/CSSFunction.php
@@ -105,14 +105,6 @@ public function getArguments()
         return $this->aComponents;
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     public function render(OutputFormat $outputFormat): string
     {
         $aArguments = parent::render($outputFormat);
diff --git a/src/Value/CSSString.php b/src/Value/CSSString.php
@@ -90,14 +90,6 @@ public function getString()
         return $this->string;
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     public function render(OutputFormat $outputFormat): string
     {
         $string = \addslashes($this->string);
diff --git a/src/Value/Color.php b/src/Value/Color.php
@@ -224,14 +224,6 @@ public function getColorDescription()
         return $this->getName();
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     public function render(OutputFormat $outputFormat): string
     {
         if ($this->shouldRenderAsHex($outputFormat)) {
diff --git a/src/Value/LineName.php b/src/Value/LineName.php
@@ -49,14 +49,6 @@ public static function parse(ParserState $parserState): LineName
         return new LineName($aNames, $parserState->currentLine());
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     public function render(OutputFormat $outputFormat): string
     {
         return '[' . parent::render(OutputFormat::createCompact()) . ']';
diff --git a/src/Value/Size.php b/src/Value/Size.php
@@ -210,14 +210,6 @@ public function isRelative(): bool
         return false;
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     public function render(OutputFormat $outputFormat): string
     {
         $l = \localeconv();
diff --git a/src/Value/URL.php b/src/Value/URL.php
@@ -76,14 +76,6 @@ public function getURL()
         return $this->oURL;
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     public function render(OutputFormat $outputFormat): string
     {
         return "url({$this->oURL->render($outputFormat)})";
diff --git a/src/Value/ValueList.php b/src/Value/ValueList.php
@@ -83,14 +83,6 @@ public function setListSeparator($sSeparator): void
         $this->sSeparator = $sSeparator;
     }
 
-    /**
-     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
-     */
-    public function __toString(): string
-    {
-        return $this->render(new OutputFormat());
-    }
-
     public function render(OutputFormat $outputFormat): string
     {
         return $outputFormat->implode(
diff --git a/tests/FunctionalDeprecated/.gitkeep b/tests/FunctionalDeprecated/.gitkeep
diff --git a/tests/FunctionalDeprecated/Comment/CommentTest.php b/tests/FunctionalDeprecated/Comment/CommentTest.php
diff --git a/tests/ParserTest.php b/tests/ParserTest.php
@@ -193,7 +193,7 @@ public function unicodeParsing(): void
                 continue;
             }
             $contentRules = $ruleSet->getRules('content');
-            $firstContentRuleAsString = $contentRules[0]->getValue()->__toString();
+            $firstContentRuleAsString = $contentRules[0]->getValue()->render(OutputFormat::create());
             if ($selector === '.test-1') {
                 self::assertSame('" "', $firstContentRuleAsString);
             }
diff --git a/tests/Unit/Value/ColorTest.php b/tests/Unit/Value/ColorTest.php
@@ -5,6 +5,7 @@
 namespace Sabberworm\CSS\Tests\Unit\Value;
 
 use PHPUnit\Framework\TestCase;
+use Sabberworm\CSS\OutputFormat;
 use Sabberworm\CSS\Parsing\ParserState;
 use Sabberworm\CSS\Parsing\SourceException;
 use Sabberworm\CSS\Settings;
@@ -346,7 +347,7 @@ public function parsesAndRendersValidColor(string $color, string $expectedRender
     {
         $subject = Color::parse(new ParserState($color, Settings::create()));
 
-        $renderedResult = (string) $subject;
+        $renderedResult = $subject->render(OutputFormat::create());
 
         self::assertSame($expectedRendering, $renderedResult);
     }

Original file line number	Diff line number	Diff line change
`@@ -42,14 +42,6 @@ public function atRuleArgs(): string`
`42`	`42`	`return $this->arguments;`
`43`	`43`	`}`
`44`	`44`
`45`		`- /**`
`46`		- * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`47`		`- */`
`48`		`- public function __toString(): string`
`49`		`- {`
`50`		`- return $this->render(new OutputFormat());`
`51`		`- }`
`52`		`-`
`53`	`45`	`public function render(OutputFormat $outputFormat): string`
`54`	`46`	`{`
`55`	`47`	`$result = $outputFormat->comments($this);`
Original file line number	Diff line number	Diff line change
`@@ -402,14 +402,6 @@ public function removeDeclarationBlockBySelector($selectors, $removeAll = false)`
`402`	`402`	`}`
`403`	`403`	`}`
`404`	`404`
`405`		`- /**`
`406`		- * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`407`		`- */`
`408`		`- public function __toString(): string`
`409`		`- {`
`410`		`- return $this->render(new OutputFormat());`
`411`		`- }`
`412`		`-`
`413`	`405`	`/**`
`414`	`406`	`* @return string`
`415`	`407`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -51,14 +51,6 @@ public function getAnimationName()`
`51`	`51`	`return $this->animationName;`
`52`	`52`	`}`
`53`	`53`
`54`		`- /**`
`55`		- * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`56`		`- */`
`57`		`- public function __toString(): string`
`58`		`- {`
`59`		`- return $this->render(new OutputFormat());`
`60`		`- }`
`61`		`-`
`62`	`54`	`public function render(OutputFormat $outputFormat): string`
`63`	`55`	`{`
`64`	`56`	`$result = $outputFormat->comments($this);`
Original file line number	Diff line number	Diff line change
`@@ -50,14 +50,6 @@ public function setComment(string $commentText): void`
`50`	`50`	`$this->commentText = $commentText;`
`51`	`51`	`}`
`52`	`52`
`53`		`- /**`
`54`		- * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`55`		`- */`
`56`		`- public function __toString(): string`
`57`		`- {`
`58`		`- return $this->render(new OutputFormat());`
`59`		`- }`
`60`		`-`
`61`	`53`	`public function render(OutputFormat $outputFormat): string`
`62`	`54`	`{`
`63`	`55`	`return '/' . $this->commentText . '/';`
Original file line number	Diff line number	Diff line change
`@@ -54,14 +54,6 @@ public function getLineNo(): int`
`54`	`54`	`return $this->lineNumber;`
`55`	`55`	`}`
`56`	`56`
`57`		`- /**`
`58`		- * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`59`		`- */`
`60`		`- public function __toString(): string`
`61`		`- {`
`62`		`- return $this->render(new OutputFormat());`
`63`		`- }`
`64`		`-`
`65`	`57`	`public function render(OutputFormat $outputFormat): string`
`66`	`58`	`{`
`67`	`59`	`return '@namespace ' . ($this->prefix === null ? '' : $this->prefix . ' ')`
Original file line number	Diff line number	Diff line change
`@@ -71,14 +71,6 @@ public function getCharset()`
`71`	`71`	`return $this->charset->getString();`
`72`	`72`	`}`
`73`	`73`
`74`		`- /**`
`75`		- * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`76`		`- */`
`77`		`- public function __toString(): string`
`78`		`- {`
`79`		`- return $this->render(new OutputFormat());`
`80`		`- }`
`81`		`-`
`82`	`74`	`public function render(OutputFormat $outputFormat): string`
`83`	`75`	`{`
`84`	`76`	`return "{$outputFormat->comments($this)}@charset {$this->charset->render($outputFormat)};";`
Original file line number	Diff line number	Diff line change
`@@ -72,14 +72,6 @@ public function getLocation()`
`72`	`72`	`return $this->location;`
`73`	`73`	`}`
`74`	`74`
`75`		`- /**`
`76`		- * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`77`		`- */`
`78`		`- public function __toString(): string`
`79`		`- {`
`80`		`- return $this->render(new OutputFormat());`
`81`		`- }`
`82`		`-`
`83`	`75`	`public function render(OutputFormat $outputFormat): string`
`84`	`76`	`{`
`85`	`77`	`return $outputFormat->comments($this) . '@import ' . $this->location->render($outputFormat)`
Original file line number	Diff line number	Diff line change
`@@ -6,10 +6,5 @@`
`6`	`6`
`7`	`7`	`interface Renderable`
`8`	`8`	`{`
`9`		`- /**`
`10`		- * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`11`		`- */`
`12`		`- public function __toString(): string;`
`13`		`-`
`14`	`9`	`public function render(OutputFormat $outputFormat): string;`
`15`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -260,14 +260,6 @@ public function getIsImportant()`
`260`	`260`	`return $this->isImportant;`
`261`	`261`	`}`
`262`	`262`
`263`		`- /**`
`264`		- * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`265`		`- */`
`266`		`- public function __toString(): string`
`267`		`- {`
`268`		`- return $this->render(new OutputFormat());`
`269`		`- }`
`270`		`-`
`271`	`263`	`public function render(OutputFormat $outputFormat): string`
`272`	`264`	`{`
`273`	`265`	`$result = "{$outputFormat->comments($this)}{$this->rule}:{$outputFormat->spaceAfterRuleName()}";`