Merge pull request #616 from ergebnis/fix/format

localheinz · web-flow · commit a8203cb133c8 · 2021-12-29T13:26:11.000+01:00
Fix: Do not compose `Format` into `Json`
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,7 @@ For a full diff see [`1.0.3...main`][1.0.3...main].
 - Started using the `SchemaValidator` provided by `ergebnis/json-schema-validator` ([#595]), by [@localheinz]
 - Renamed `Format\JsonEncodeOptions::value()` to `Format\JsonEncodeOptions::toInt()` ([#603]), by [@localheinz]
 - Extracted `Format\Format::create()` as named constructor and reduced visibility of `__construct`  to `private` ([#608]), by [@localheinz]
+- Stopped composing `Format\Format` into `Json` ([#616]), by [@localheinz]
 
 ### Fixed
 
@@ -438,6 +439,7 @@ For a full diff see [`5d8b3e2...0.1.0`][5d8b3e2...0.1.0].
 [#597]: https://github.com/ergebnis/json-normalizer/pull/597
 [#603]: https://github.com/ergebnis/json-normalizer/pull/603
 [#608]: https://github.com/ergebnis/json-normalizer/pull/608
+[#616]: https://github.com/ergebnis/json-normalizer/pull/616
 
 [@BackEndTea]: https://github.com/BackEndTea
 [@dependabot]: https://github.com/dependabot
diff --git a/src/AutoFormatNormalizer.php b/src/AutoFormatNormalizer.php
@@ -28,9 +28,11 @@ public function __construct(
 
     public function normalize(Json $json): Json
     {
+        $format = Format\Format::fromJson($json);
+
         return $this->formatter->format(
             $this->normalizer->normalize($json),
-            $json->format(),
+            $format,
         );
     }
 }
diff --git a/src/Json.php b/src/Json.php
@@ -24,15 +24,13 @@ final class Json
      * @var null|array<mixed>|bool|float|int|\stdClass|string
      */
     private $decoded;
-    private Format\Format $format;
 
     private function __construct(
         string $encoded,
         $decoded
     ) {
         $this->encoded = $encoded;
         $this->decoded = $decoded;
-        $this->format = Format\Format::fromJson($this);
     }
 
     /**
@@ -75,14 +73,6 @@ public function encoded(): string
         return $this->encoded;
     }
 
-    /**
-     * Returns the format of the original JSON value.
-     */
-    public function format(): Format\Format
-    {
-        return $this->format;
-    }
-
     /**
      * Returns the original JSON value.
      */
diff --git a/test/Unit/AutoFormatNormalizerTest.php b/test/Unit/AutoFormatNormalizerTest.php
@@ -72,7 +72,7 @@ public function testNormalizeNormalizesAndFormatsUsingJsonFormat(): void
             ->method('format')
             ->with(
                 self::identicalTo($normalized),
-                self::identicalTo($json->format()),
+                self::equalTo(Format\Format::fromJson($json)),
             )
             ->willReturn($formatted);
 
diff --git a/test/Unit/CallableNormalizerTest.php b/test/Unit/CallableNormalizerTest.php
@@ -21,10 +21,6 @@
  *
  * @covers \Ergebnis\Json\Normalizer\CallableNormalizer
  *
- * @uses \Ergebnis\Json\Normalizer\Format\Format
- * @uses \Ergebnis\Json\Normalizer\Format\Indent
- * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions
- * @uses \Ergebnis\Json\Normalizer\Format\NewLine
  * @uses \Ergebnis\Json\Normalizer\Json
  */
 final class CallableNormalizerTest extends AbstractNormalizerTestCase
diff --git a/test/Unit/ChainNormalizerTest.php b/test/Unit/ChainNormalizerTest.php
@@ -22,10 +22,6 @@
  *
  * @covers \Ergebnis\Json\Normalizer\ChainNormalizer
  *
- * @uses \Ergebnis\Json\Normalizer\Format\Format
- * @uses \Ergebnis\Json\Normalizer\Format\Indent
- * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions
- * @uses \Ergebnis\Json\Normalizer\Format\NewLine
  * @uses \Ergebnis\Json\Normalizer\Json
  */
 final class ChainNormalizerTest extends AbstractNormalizerTestCase
diff --git a/test/Unit/FinalNewLineNormalizerTest.php b/test/Unit/FinalNewLineNormalizerTest.php
@@ -21,10 +21,6 @@
  *
  * @covers \Ergebnis\Json\Normalizer\FinalNewLineNormalizer
  *
- * @uses \Ergebnis\Json\Normalizer\Format\Format
- * @uses \Ergebnis\Json\Normalizer\Format\Indent
- * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions
- * @uses \Ergebnis\Json\Normalizer\Format\NewLine
  * @uses \Ergebnis\Json\Normalizer\Json
  */
 final class FinalNewLineNormalizerTest extends AbstractNormalizerTestCase
diff --git a/test/Unit/Format/IndentTest.php b/test/Unit/Format/IndentTest.php
@@ -27,9 +27,6 @@
  * @uses \Ergebnis\Json\Normalizer\Exception\InvalidIndentSizeException
  * @uses \Ergebnis\Json\Normalizer\Exception\InvalidIndentStringException
  * @uses \Ergebnis\Json\Normalizer\Exception\InvalidIndentStyleException
- * @uses \Ergebnis\Json\Normalizer\Format\Format
- * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions
- * @uses \Ergebnis\Json\Normalizer\Format\NewLine
  * @uses \Ergebnis\Json\Normalizer\Json
  */
 final class IndentTest extends Framework\TestCase
diff --git a/test/Unit/Format/JsonEncodeOptionsTest.php b/test/Unit/Format/JsonEncodeOptionsTest.php
@@ -25,10 +25,6 @@
  * @covers \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions
  *
  * @uses \Ergebnis\Json\Normalizer\Exception\InvalidJsonEncodeOptionsException
- * @uses \Ergebnis\Json\Normalizer\Format\Format
- * @uses \Ergebnis\Json\Normalizer\Format\Indent
- * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions
- * @uses \Ergebnis\Json\Normalizer\Format\NewLine
  * @uses \Ergebnis\Json\Normalizer\Json
  */
 final class JsonEncodeOptionsTest extends Framework\TestCase
diff --git a/test/Unit/Format/NewLineTest.php b/test/Unit/Format/NewLineTest.php
@@ -24,10 +24,6 @@
  * @covers \Ergebnis\Json\Normalizer\Format\NewLine
  *
  * @uses \Ergebnis\Json\Normalizer\Exception\InvalidNewLineStringException
- * @uses \Ergebnis\Json\Normalizer\Format\Format
- * @uses \Ergebnis\Json\Normalizer\Format\Indent
- * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions
- * @uses \Ergebnis\Json\Normalizer\Format\NewLine
  * @uses \Ergebnis\Json\Normalizer\Json
  */
 final class NewLineTest extends Framework\TestCase
diff --git a/test/Unit/IndentNormalizerTest.php b/test/Unit/IndentNormalizerTest.php
@@ -23,10 +23,7 @@
  *
  * @covers \Ergebnis\Json\Normalizer\IndentNormalizer
  *
- * @uses \Ergebnis\Json\Normalizer\Format\Format
  * @uses \Ergebnis\Json\Normalizer\Format\Indent
- * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions
- * @uses \Ergebnis\Json\Normalizer\Format\NewLine
  * @uses \Ergebnis\Json\Normalizer\Json
  */
 final class IndentNormalizerTest extends AbstractNormalizerTestCase
diff --git a/test/Unit/JsonEncodeNormalizerTest.php b/test/Unit/JsonEncodeNormalizerTest.php
@@ -22,10 +22,7 @@
  *
  * @covers \Ergebnis\Json\Normalizer\JsonEncodeNormalizer
  *
- * @uses \Ergebnis\Json\Normalizer\Format\Format
- * @uses \Ergebnis\Json\Normalizer\Format\Indent
  * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions
- * @uses \Ergebnis\Json\Normalizer\Format\NewLine
  * @uses \Ergebnis\Json\Normalizer\Json
  */
 final class JsonEncodeNormalizerTest extends AbstractNormalizerTestCase
diff --git a/test/Unit/JsonTest.php b/test/Unit/JsonTest.php
@@ -14,7 +14,6 @@
 namespace Ergebnis\Json\Normalizer\Test\Unit;
 
 use Ergebnis\Json\Normalizer\Exception;
-use Ergebnis\Json\Normalizer\Format;
 use Ergebnis\Json\Normalizer\Json;
 use Ergebnis\Json\Normalizer\Test;
 use PHPUnit\Framework;
@@ -25,10 +24,6 @@
  * @covers \Ergebnis\Json\Normalizer\Json
  *
  * @uses \Ergebnis\Json\Normalizer\Exception\InvalidJsonEncodedException
- * @uses \Ergebnis\Json\Normalizer\Format\Format
- * @uses \Ergebnis\Json\Normalizer\Format\Indent
- * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions
- * @uses \Ergebnis\Json\Normalizer\Format\NewLine
  */
 final class JsonTest extends Framework\TestCase
 {
@@ -53,10 +48,6 @@ public function testFromEncodedReturnsJson(string $encoded): void
         self::assertSame($encoded, $json->toString());
         self::assertSame($encoded, $json->encoded());
         self::assertSame($encoded, \json_encode($json->decoded()));
-
-        $format = Format\Format::fromJson($json);
-
-        self::assertEquals($format, $json->format());
     }
 
     /**
diff --git a/test/Unit/NoFinalNewLineNormalizerTest.php b/test/Unit/NoFinalNewLineNormalizerTest.php
@@ -21,10 +21,6 @@
  *
  * @covers \Ergebnis\Json\Normalizer\NoFinalNewLineNormalizer
  *
- * @uses \Ergebnis\Json\Normalizer\Format\Format
- * @uses \Ergebnis\Json\Normalizer\Format\Indent
- * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions
- * @uses \Ergebnis\Json\Normalizer\Format\NewLine
  * @uses \Ergebnis\Json\Normalizer\Json
  */
 final class NoFinalNewLineNormalizerTest extends AbstractNormalizerTestCase
diff --git a/test/Unit/SchemaNormalizerTest.php b/test/Unit/SchemaNormalizerTest.php
@@ -34,10 +34,6 @@
  * @uses \Ergebnis\Json\Normalizer\Exception\SchemaUriCouldNotBeResolvedException
  * @uses \Ergebnis\Json\Normalizer\Exception\SchemaUriReferencesDocumentWithInvalidMediaTypeException
  * @uses \Ergebnis\Json\Normalizer\Exception\SchemaUriReferencesInvalidJsonDocumentException
- * @uses \Ergebnis\Json\Normalizer\Format\Format
- * @uses \Ergebnis\Json\Normalizer\Format\Indent
- * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions
- * @uses \Ergebnis\Json\Normalizer\Format\NewLine
  * @uses \Ergebnis\Json\Normalizer\Json
  */
 final class SchemaNormalizerTest extends AbstractNormalizerTestCase
diff --git a/test/Unit/Vendor/Composer/BinNormalizerTest.php b/test/Unit/Vendor/Composer/BinNormalizerTest.php
@@ -21,10 +21,6 @@
  *
  * @covers \Ergebnis\Json\Normalizer\Vendor\Composer\BinNormalizer
  *
- * @uses \Ergebnis\Json\Normalizer\Format\Format
- * @uses \Ergebnis\Json\Normalizer\Format\Indent
- * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions
- * @uses \Ergebnis\Json\Normalizer\Format\NewLine
  * @uses \Ergebnis\Json\Normalizer\Json
  */
 final class BinNormalizerTest extends AbstractComposerTestCase
diff --git a/test/Unit/Vendor/Composer/ComposerJsonNormalizerTest.php b/test/Unit/Vendor/Composer/ComposerJsonNormalizerTest.php
@@ -25,10 +25,6 @@
  * @covers \Ergebnis\Json\Normalizer\Vendor\Composer\ComposerJsonNormalizer
  *
  * @uses \Ergebnis\Json\Normalizer\ChainNormalizer
- * @uses \Ergebnis\Json\Normalizer\Format\Format
- * @uses \Ergebnis\Json\Normalizer\Format\Indent
- * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions
- * @uses \Ergebnis\Json\Normalizer\Format\NewLine
  * @uses \Ergebnis\Json\Normalizer\Json
  * @uses \Ergebnis\Json\Normalizer\SchemaNormalizer
  * @uses \Ergebnis\Json\Normalizer\Vendor\Composer\BinNormalizer
diff --git a/test/Unit/Vendor/Composer/ConfigHashNormalizerTest.php b/test/Unit/Vendor/Composer/ConfigHashNormalizerTest.php
@@ -21,10 +21,6 @@
  *
  * @covers \Ergebnis\Json\Normalizer\Vendor\Composer\ConfigHashNormalizer
  *
- * @uses \Ergebnis\Json\Normalizer\Format\Format
- * @uses \Ergebnis\Json\Normalizer\Format\Indent
- * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions
- * @uses \Ergebnis\Json\Normalizer\Format\NewLine
  * @uses \Ergebnis\Json\Normalizer\Json
  */
 final class ConfigHashNormalizerTest extends AbstractComposerTestCase
diff --git a/test/Unit/Vendor/Composer/PackageHashNormalizerTest.php b/test/Unit/Vendor/Composer/PackageHashNormalizerTest.php
@@ -21,10 +21,6 @@
  *
  * @covers \Ergebnis\Json\Normalizer\Vendor\Composer\PackageHashNormalizer
  *
- * @uses \Ergebnis\Json\Normalizer\Format\Format
- * @uses \Ergebnis\Json\Normalizer\Format\Indent
- * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions
- * @uses \Ergebnis\Json\Normalizer\Format\NewLine
  * @uses \Ergebnis\Json\Normalizer\Json
  */
 final class PackageHashNormalizerTest extends AbstractComposerTestCase
diff --git a/test/Unit/Vendor/Composer/VersionConstraintNormalizerTest.php b/test/Unit/Vendor/Composer/VersionConstraintNormalizerTest.php
@@ -21,10 +21,6 @@
  *
  * @covers \Ergebnis\Json\Normalizer\Vendor\Composer\VersionConstraintNormalizer
  *
- * @uses \Ergebnis\Json\Normalizer\Format\Format
- * @uses \Ergebnis\Json\Normalizer\Format\Indent
- * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions
- * @uses \Ergebnis\Json\Normalizer\Format\NewLine
  * @uses \Ergebnis\Json\Normalizer\Json
  */
 final class VersionConstraintNormalizerTest extends AbstractComposerTestCase

Original file line number	Diff line number	Diff line change
`@@ -28,9 +28,11 @@ public function __construct(`
`28`	`28`
`29`	`29`	`public function normalize(Json $json): Json`
`30`	`30`	`{`
	`31`	`+ $format = Format\Format::fromJson($json);`
	`32`	`+`
`31`	`33`	`return $this->formatter->format(`
`32`	`34`	`$this->normalizer->normalize($json),`
`33`		`- $json->format(),`
	`35`	`+ $format,`
`34`	`36`	`);`
`35`	`37`	`}`
`36`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public function testNormalizeNormalizesAndFormatsUsingJsonFormat(): void`
`72`	`72`	`->method('format')`
`73`	`73`	`->with(`
`74`	`74`	`self::identicalTo($normalized),`
`75`		`- self::identicalTo($json->format()),`
	`75`	`+ self::equalTo(Format\Format::fromJson($json)),`
`76`	`76`	`)`
`77`	`77`	`->willReturn($formatted);`
`78`	`78`
Original file line number	Diff line number	Diff line change
`@@ -21,10 +21,6 @@`
`21`	`21`	`*`
`22`	`22`	`* @covers \Ergebnis\Json\Normalizer\CallableNormalizer`
`23`	`23`	`*`
`24`		`- * @uses \Ergebnis\Json\Normalizer\Format\Format`
`25`		`- * @uses \Ergebnis\Json\Normalizer\Format\Indent`
`26`		`- * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions`
`27`		`- * @uses \Ergebnis\Json\Normalizer\Format\NewLine`
`28`	`24`	`* @uses \Ergebnis\Json\Normalizer\Json`
`29`	`25`	`*/`
`30`	`26`	`final class CallableNormalizerTest extends AbstractNormalizerTestCase`
Original file line number	Diff line number	Diff line change
`@@ -22,10 +22,6 @@`
`22`	`22`	`*`
`23`	`23`	`* @covers \Ergebnis\Json\Normalizer\ChainNormalizer`
`24`	`24`	`*`
`25`		`- * @uses \Ergebnis\Json\Normalizer\Format\Format`
`26`		`- * @uses \Ergebnis\Json\Normalizer\Format\Indent`
`27`		`- * @uses \Ergebnis\Json\Normalizer\Format\JsonEncodeOptions`
`28`		`- * @uses \Ergebnis\Json\Normalizer\Format\NewLine`
`29`	`25`	`* @uses \Ergebnis\Json\Normalizer\Json`
`30`	`26`	`*/`
`31`	`27`	`final class ChainNormalizerTest extends AbstractNormalizerTestCase`