Merge pull request #589 from ergebnis/fix/to-string

Fix: Disallow implicit cast to `string`
ergebnis · Dec 29, 2021 · c387938 · c387938
2 parents 9a3dc55 + 6115688
commit c387938
Show file tree

Hide file tree

Showing 12 changed files with 40 additions and 38 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ For a full diff see [`1.0.3...main`][1.0.3...main].
 
 - Dropped support for PHP 7.2 ([#564]), by [@dependabot]
 - Dropped support for PHP 7.3 ([#573]), by [@dependabot]
+- Renamed `Format::__toString()`, `Indent::__toString()`, and `Json::__toString()` to `Format::toString()`, `Indent::toString()`, and `Json::toString()`, requiring consumers to explicitly invoke methods instead of allowing to cast to `string` ([#589]), by [@dependabot]
 
 ### Fixed
 
@@ -423,6 +424,7 @@ For a full diff see [`5d8b3e2...0.1.0`][5d8b3e2...0.1.0].
 [#517]: https://github.com/ergebnis/json-normalizer/pull/517
 [#564]: https://github.com/ergebnis/json-normalizer/pull/564
 [#573]: https://github.com/ergebnis/json-normalizer/pull/573
+[#589]: https://github.com/ergebnis/json-normalizer/pull/589
 
 [@BackEndTea]: https://github.com/BackEndTea
 [@dependabot]: https://github.com/dependabot

diff --git a/src/Format/Formatter.php b/src/Format/Formatter.php
@@ -37,14 +37,14 @@ public function format(
 
         $printed = $this->printer->print(
             $encoded,
-            (string) $format->indent(),
-            (string) $format->newLine(),
+            $format->indent()->toString(),
+            $format->newLine()->toString(),
         );
 
         if (!$format->hasFinalNewLine()) {
             return Json::fromEncoded($printed);
         }
 
-        return Json::fromEncoded($printed . $format->newLine());
+        return Json::fromEncoded($printed . $format->newLine()->toString());
     }
 }
diff --git a/src/Format/Indent.php b/src/Format/Indent.php
@@ -29,11 +29,6 @@ private function __construct(string $string)
         $this->string = $string;
     }
 
-    public function __toString(): string
-    {
-        return $this->string;
-    }
-
     /**
      * @throws Exception\InvalidIndentStringException
      */
@@ -89,4 +84,9 @@ public static function fromJson(Json $json): self
             'space',
         );
     }
+
+    public function toString(): string
+    {
+        return $this->string;
+    }
 }
diff --git a/src/Format/NewLine.php b/src/Format/NewLine.php
@@ -25,11 +25,6 @@ private function __construct(string $string)
         $this->string = $string;
     }
 
-    public function __toString(): string
-    {
-        return $this->string;
-    }
-
     /**
      * @throws Exception\InvalidNewLineStringException
      */
@@ -50,4 +45,9 @@ public static function fromJson(Json $json): self
 
         return self::fromString(\PHP_EOL);
     }
+
+    public function toString(): string
+    {
+        return $this->string;
+    }
 }
diff --git a/src/IndentNormalizer.php b/src/IndentNormalizer.php
@@ -32,7 +32,7 @@ public function normalize(Json $json): Json
     {
         $withIndent = $this->printer->print(
             $json->encoded(),
-            $this->indent->__toString(),
+            $this->indent->toString(),
         );
 
         return Json::fromEncoded($withIndent);

diff --git a/src/Json.php b/src/Json.php
@@ -31,14 +31,6 @@ private function __construct(
         $this->decoded = $decoded;
     }
 
-    /**
-     * Returns the original JSON value.
-     */
-    public function __toString(): string
-    {
-        return $this->encoded;
-    }
-
     /**
      * @throws Exception\InvalidJsonEncodedException
      */
@@ -88,4 +80,12 @@ public function format(): Format\Format
 
         return $this->format;
     }
+
+    /**
+     * Returns the original JSON value.
+     */
+    public function toString(): string
+    {
+        return $this->encoded;
+    }
 }
diff --git a/test/Unit/Format/FormatTest.php b/test/Unit/Format/FormatTest.php
@@ -129,7 +129,7 @@ public function testFromJsonReturnsFormatWithDefaultIndentIfJsonIsWithoutIndent(
 
         $format = Format\Format::fromJson($json);
 
-        self::assertSame('    ', $format->indent()->__toString());
+        self::assertSame('    ', $format->indent()->toString());
     }
 
     /**

diff --git a/test/Unit/Format/FormatterTest.php b/test/Unit/Format/FormatterTest.php
@@ -87,8 +87,8 @@ public function testFormatEncodesWithJsonEncodeOptionsIndentsAndPossiblySuffixes
             ->method('print')
             ->with(
                 self::identicalTo($encodedWithJsonEncodeOptions),
-                self::identicalTo($format->indent()->__toString()),
-                self::identicalTo($format->newLine()->__toString()),
+                self::identicalTo($format->indent()->toString()),
+                self::identicalTo($format->newLine()->toString()),
             )
             ->willReturn($printedWithIndentAndNewLine);
 

diff --git a/test/Unit/Format/IndentTest.php b/test/Unit/Format/IndentTest.php
@@ -101,7 +101,7 @@ public function testFromSizeAndStyleReturnsIndent(int $size, string $style, stri
             $style,
         );
 
-        self::assertSame($string, $indent->__toString());
+        self::assertSame($string, $indent->toString());
     }
 
     /**
@@ -160,7 +160,7 @@ public function testFromStringReturnsIndent(string $string): void
     {
         $indent = Format\Indent::fromString($string);
 
-        self::assertSame($string, $indent->__toString());
+        self::assertSame($string, $indent->toString());
     }
 
     /**
@@ -202,7 +202,7 @@ public function testFromJsonReturnsIndentSniffedFromArray(string $actualIndent,
 
         $indent = Format\Indent::fromJson($json);
 
-        self::assertSame($sniffedIndent, $indent->__toString());
+        self::assertSame($sniffedIndent, $indent->toString());
     }
 
     /**
@@ -225,7 +225,7 @@ public function testFromJsonReturnsIndentSniffedFromObject(string $actualIndent,
 
         $indent = Format\Indent::fromJson($json);
 
-        self::assertSame($sniffedIndent, $indent->__toString());
+        self::assertSame($sniffedIndent, $indent->toString());
     }
 
     /**
@@ -298,7 +298,7 @@ public function testFromJsonReturnsIndentWithDefaultsWhenIndentCouldNotBeSniffed
             4,
         );
 
-        self::assertSame($default, $indent->__toString());
+        self::assertSame($default, $indent->toString());
     }
 
     /**

diff --git a/test/Unit/Format/NewLineTest.php b/test/Unit/Format/NewLineTest.php
@@ -68,7 +68,7 @@ public function testFromStringReturnsNewLine(string $string): void
     {
         $newLine = Format\NewLine::fromString($string);
 
-        self::assertSame($string, $newLine->__toString());
+        self::assertSame($string, $newLine->toString());
     }
 
     /**
@@ -97,7 +97,7 @@ public function testFromJsonReturnsFormatWithDefaultNewLineIfNoneFound(): void
 
         $newLine = Format\NewLine::fromJson($json);
 
-        self::assertSame(\PHP_EOL, $newLine->__toString());
+        self::assertSame(\PHP_EOL, $newLine->toString());
     }
 
     /**
@@ -113,7 +113,7 @@ public function testFromFormatReturnsFormatWithNewLineSniffedFromArray(string $n
 
         $newLine = Format\NewLine::fromJson($json);
 
-        self::assertSame($newLineString, $newLine->__toString());
+        self::assertSame($newLineString, $newLine->toString());
     }
 
     /**
@@ -129,7 +129,7 @@ public function testFromFormatReturnsFormatWithNewLineNewLineSniffedFromObject(s
 
         $newLine = Format\NewLine::fromJson($json);
 
-        self::assertSame($newLineString, $newLine->__toString());
+        self::assertSame($newLineString, $newLine->toString());
     }
 
     /**

diff --git a/test/Unit/IndentNormalizerTest.php b/test/Unit/IndentNormalizerTest.php
@@ -54,7 +54,7 @@ public function testNormalizeUsesPrinterToNormalizeJsonWithIndent(): void
             ->method('print')
             ->with(
                 self::identicalTo($json->encoded()),
-                self::identicalTo($indent->__toString()),
+                self::identicalTo($indent->toString()),
             )
             ->willReturn($indented);
 

diff --git a/test/Unit/JsonTest.php b/test/Unit/JsonTest.php
@@ -50,15 +50,15 @@ public function testFromEncodedReturnsJson(string $encoded): void
     {
         $json = Json::fromEncoded($encoded);
 
-        self::assertSame($encoded, $json->__toString());
+        self::assertSame($encoded, $json->toString());
         self::assertSame($encoded, $json->encoded());
         self::assertSame($encoded, \json_encode($json->decoded()));
 
         $format = Format\Format::fromJson($json);
 
         self::assertSame($format->jsonEncodeOptions()->value(), $json->format()->jsonEncodeOptions()->value());
-        self::assertSame($format->indent()->__toString(), $json->format()->indent()->__toString());
-        self::assertSame($format->newLine()->__toString(), $json->format()->newLine()->__toString());
+        self::assertSame($format->indent()->toString(), $json->format()->indent()->toString());
+        self::assertSame($format->newLine()->toString(), $json->format()->newLine()->toString());
         self::assertSame($format->hasFinalNewLine(), $json->format()->hasFinalNewLine());
     }