From 58fc5eae9c42f3d49494da8d353303b33e8962e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20M=C3=B6ller?= Date: Sun, 30 Jan 2022 17:00:21 +0100 Subject: [PATCH] Fix: Rename class --- CHANGELOG.md | 2 ++ README.md | 4 ++-- psalm-baseline.xml | 16 ++++++++-------- .../{Formatter.php => DefaultFormatter.php} | 2 +- ...ormatterTest.php => DefaultFormatterTest.php} | 6 +++--- 5 files changed, 16 insertions(+), 14 deletions(-) rename src/Format/{Formatter.php => DefaultFormatter.php} (95%) rename test/Unit/Format/{FormatterTest.php => DefaultFormatterTest.php} (94%) diff --git a/CHANGELOG.md b/CHANGELOG.md index de9e70b3..aec1d44d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,7 @@ For a full diff see [`2.2.0...3.0.0`][2.2.0...3.0.0]. - Renamed `Exception\ExceptionInterface` to `Exception\Exception` ([#667]), by [@dependabot] - Removed `Exception` suffix from all exceptions ([#668]), by [@dependabot] - Renamed `NormalizerInterface` to `Normalizer` ([#669]), by [@dependabot] +- Renamed `Format\Formatter` to `Format\DefaultFormatter` ([#672]), by [@dependabot] ## [`2.2.0`][2.2.0] @@ -493,6 +494,7 @@ For a full diff see [`5d8b3e2...0.1.0`][5d8b3e2...0.1.0]. [#667]: https://github.com/ergebnis/json-normalizer/pull/667 [#668]: https://github.com/ergebnis/json-normalizer/pull/668 [#669]: https://github.com/ergebnis/json-normalizer/pull/669 +[#672]: https://github.com/ergebnis/json-normalizer/pull/672 [@BackEndTea]: https://github.com/BackEndTea [@dependabot]: https://github.com/dependabot diff --git a/README.md b/README.md index ff040ade..b5c1bc24 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ $json = Normalizer\Json::fromEncoded($encoded); /* @var Normalizer\Normalizer $composedNormalizer */ $normalizer = new Normalizer\AutoFormatNormalizer( $composedNormalizer, - new Normalizer\Format\Formatter(new Printer\Printer()) + new Normalizer\Format\DefaultFormatter(new Printer\Printer()) ); $normalized = $normalizer->normalize($json); @@ -184,7 +184,7 @@ $json = Normalizer\Json::fromEncoded($encoded); $normalizer = new Normalizer\FixedFormatNormalizer( $composedNormalizer, $format, - new Normalizer\Format\Formatter(new Printer\Printer()) + new Normalizer\Format\DefaultFormatter(new Printer\Printer()) ); $normalized = $normalizer->normalize($json); diff --git a/psalm-baseline.xml b/psalm-baseline.xml index 981e80d9..38f2b922 100644 --- a/psalm-baseline.xml +++ b/psalm-baseline.xml @@ -63,14 +63,7 @@ $value - - - \Generator<array<string>> - \Generator<array<string>> - \Generator<array<string>> - - - + $newLineString @@ -78,6 +71,13 @@ $newLineString + + + \Generator<array<string>> + \Generator<array<string>> + \Generator<array<string>> + + $style diff --git a/src/Format/Formatter.php b/src/Format/DefaultFormatter.php similarity index 95% rename from src/Format/Formatter.php rename to src/Format/DefaultFormatter.php index 64deb5c9..f4400a28 100644 --- a/src/Format/Formatter.php +++ b/src/Format/DefaultFormatter.php @@ -16,7 +16,7 @@ use Ergebnis\Json\Normalizer\Json; use Ergebnis\Json\Printer; -final class Formatter implements FormatterInterface +final class DefaultFormatter implements FormatterInterface { private Printer\PrinterInterface $printer; diff --git a/test/Unit/Format/FormatterTest.php b/test/Unit/Format/DefaultFormatterTest.php similarity index 94% rename from test/Unit/Format/FormatterTest.php rename to test/Unit/Format/DefaultFormatterTest.php index cc72ea08..d5728c7b 100644 --- a/test/Unit/Format/FormatterTest.php +++ b/test/Unit/Format/DefaultFormatterTest.php @@ -22,7 +22,7 @@ /** * @internal * - * @covers \Ergebnis\Json\Normalizer\Format\Formatter + * @covers \Ergebnis\Json\Normalizer\Format\DefaultFormatter * * @uses \Ergebnis\Json\Normalizer\Format\Format * @uses \Ergebnis\Json\Normalizer\Format\Indent @@ -30,7 +30,7 @@ * @uses \Ergebnis\Json\Normalizer\Format\NewLine * @uses \Ergebnis\Json\Normalizer\Json */ -final class FormatterTest extends Framework\TestCase +final class DefaultFormatterTest extends Framework\TestCase { use Test\Util\Helper; @@ -92,7 +92,7 @@ public function testFormatEncodesWithJsonEncodeOptionsIndentsAndPossiblySuffixes ) ->willReturn($printedWithIndentAndNewLine); - $formatter = new Format\Formatter($printer); + $formatter = new Format\DefaultFormatter($printer); $formatted = $formatter->format( $json,