Skip to content

Commit

Permalink
Merge pull request #669 from ergebnis/fix/suffix
Browse files Browse the repository at this point in the history
Fix: Rename interface
  • Loading branch information
localheinz committed Jan 30, 2022
2 parents 08d6b1b + f37031b commit 7960dfa
Show file tree
Hide file tree
Showing 23 changed files with 51 additions and 49 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Expand Up @@ -17,6 +17,7 @@ For a full diff see [`2.2.0...3.0.0`][2.2.0...3.0.0].
- Required `ergebnis/json-schema-validator:^3.0.0` ([#666]), by [@dependabot]
- Renamed `Exception\ExceptionInterface` to `Exception\Exception` ([#667]), by [@dependabot]
- Removed `Exception` suffix from all exceptions ([#668]), by [@dependabot]
- Renamed `NormalizerInterface` to `Nornmalizer` ([#669]), by [@dependabot]

## [`2.2.0`][2.2.0]

Expand Down Expand Up @@ -491,6 +492,7 @@ For a full diff see [`5d8b3e2...0.1.0`][5d8b3e2...0.1.0].
[#666]: https://github.com/ergebnis/json-normalizer/pull/666
[#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

[@BackEndTea]: https://github.com/BackEndTea
[@dependabot]: https://github.com/dependabot
Expand Down
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -60,7 +60,7 @@ JSON;

$json = Normalizer\Json::fromEncoded($encoded);

/* @var Normalizer\NormalizerInterface $composedNormalizer */
/* @var Normalizer\Normalizer $composedNormalizer */
$normalizer = new Normalizer\AutoFormatNormalizer(
$composedNormalizer,
new Normalizer\Format\Formatter(new Printer\Printer())
Expand Down Expand Up @@ -179,7 +179,7 @@ JSON;

$json = Normalizer\Json::fromEncoded($encoded);

/* @var Normalizer\NormalizerInterface $composedNormalizer */
/* @var Normalizer\Normalizer $composedNormalizer */
/* @var Normalizer\Format\Format $format */
$normalizer = new Normalizer\FixedFormatNormalizer(
$composedNormalizer,
Expand Down
4 changes: 2 additions & 2 deletions psalm-baseline.xml
Expand Up @@ -154,8 +154,8 @@
</file>
<file src="test/Unit/Vendor/Composer/ComposerJsonNormalizerTest.php">
<MixedInferredReturnType occurrences="2">
<code>NormalizerInterface</code>
<code>NormalizerInterface[]</code>
<code>Normalizer</code>
<code>Normalizer[]</code>
</MixedInferredReturnType>
<MixedReturnStatement occurrences="2">
<code>$property-&gt;getValue($normalizer)</code>
Expand Down
6 changes: 3 additions & 3 deletions src/AutoFormatNormalizer.php
Expand Up @@ -13,13 +13,13 @@

namespace Ergebnis\Json\Normalizer;

final class AutoFormatNormalizer implements NormalizerInterface
final class AutoFormatNormalizer implements Normalizer
{
private NormalizerInterface $normalizer;
private Normalizer $normalizer;
private Format\FormatterInterface $formatter;

public function __construct(
NormalizerInterface $normalizer,
Normalizer $normalizer,
Format\FormatterInterface $formatter
) {
$this->normalizer = $normalizer;
Expand Down
2 changes: 1 addition & 1 deletion src/CallableNormalizer.php
Expand Up @@ -13,7 +13,7 @@

namespace Ergebnis\Json\Normalizer;

final class CallableNormalizer implements NormalizerInterface
final class CallableNormalizer implements Normalizer
{
/**
* @var callable
Expand Down
12 changes: 6 additions & 6 deletions src/ChainNormalizer.php
Expand Up @@ -13,17 +13,17 @@

namespace Ergebnis\Json\Normalizer;

final class ChainNormalizer implements NormalizerInterface
final class ChainNormalizer implements Normalizer
{
/**
* @phpstan-var list<NormalizerInterface>
* @psalm-var list<NormalizerInterface>
* @phpstan-var list<Normalizer>
* @psalm-var list<Normalizer>
*
* @var array<int, NormalizerInterface>
* @var array<int, Normalizer>
*/
private array $normalizers;

public function __construct(NormalizerInterface ...$normalizers)
public function __construct(Normalizer ...$normalizers)
{
$this->normalizers = \array_values($normalizers);
}
Expand All @@ -32,7 +32,7 @@ public function normalize(Json $json): Json
{
return \array_reduce(
$this->normalizers,
static function (Json $json, NormalizerInterface $normalizer): Json {
static function (Json $json, Normalizer $normalizer): Json {
return $normalizer->normalize($json);
},
$json,
Expand Down
6 changes: 3 additions & 3 deletions src/FixedFormatNormalizer.php
Expand Up @@ -13,14 +13,14 @@

namespace Ergebnis\Json\Normalizer;

final class FixedFormatNormalizer implements NormalizerInterface
final class FixedFormatNormalizer implements Normalizer
{
private NormalizerInterface $normalizer;
private Normalizer $normalizer;
private Format\Format $format;
private Format\FormatterInterface $formatter;

public function __construct(
NormalizerInterface $normalizer,
Normalizer $normalizer,
Format\Format $format,
Format\FormatterInterface $formatter
) {
Expand Down
2 changes: 1 addition & 1 deletion src/IndentNormalizer.php
Expand Up @@ -15,7 +15,7 @@

use Ergebnis\Json\Printer;

final class IndentNormalizer implements NormalizerInterface
final class IndentNormalizer implements Normalizer
{
private Format\Indent $indent;
private Printer\PrinterInterface $printer;
Expand Down
2 changes: 1 addition & 1 deletion src/JsonEncodeNormalizer.php
Expand Up @@ -13,7 +13,7 @@

namespace Ergebnis\Json\Normalizer;

final class JsonEncodeNormalizer implements NormalizerInterface
final class JsonEncodeNormalizer implements Normalizer
{
private Format\JsonEncodeOptions $jsonEncodeOptions;

Expand Down
2 changes: 1 addition & 1 deletion src/NormalizerInterface.php → src/Normalizer.php
Expand Up @@ -13,7 +13,7 @@

namespace Ergebnis\Json\Normalizer;

interface NormalizerInterface
interface Normalizer
{
/**
* @throws Exception\SchemaUriCouldNotBeResolved
Expand Down
2 changes: 1 addition & 1 deletion src/SchemaNormalizer.php
Expand Up @@ -21,7 +21,7 @@
use JsonSchema\Exception\UriResolverException;
use JsonSchema\SchemaStorage;

final class SchemaNormalizer implements NormalizerInterface
final class SchemaNormalizer implements Normalizer
{
private string $schemaUri;
private SchemaStorage $schemaStorage;
Expand Down
4 changes: 2 additions & 2 deletions src/Vendor/Composer/BinNormalizer.php
Expand Up @@ -14,9 +14,9 @@
namespace Ergebnis\Json\Normalizer\Vendor\Composer;

use Ergebnis\Json\Normalizer\Json;
use Ergebnis\Json\Normalizer\NormalizerInterface;
use Ergebnis\Json\Normalizer\Normalizer;

final class BinNormalizer implements NormalizerInterface
final class BinNormalizer implements Normalizer
{
public function normalize(Json $json): Json
{
Expand Down
4 changes: 2 additions & 2 deletions src/Vendor/Composer/ComposerJsonNormalizer.php
Expand Up @@ -17,9 +17,9 @@
use Ergebnis\Json\SchemaValidator;
use JsonSchema\SchemaStorage;

final class ComposerJsonNormalizer implements Normalizer\NormalizerInterface
final class ComposerJsonNormalizer implements Normalizer\Normalizer
{
private Normalizer\NormalizerInterface $normalizer;
private Normalizer\Normalizer $normalizer;

public function __construct(string $schemaUri)
{
Expand Down
4 changes: 2 additions & 2 deletions src/Vendor/Composer/ConfigHashNormalizer.php
Expand Up @@ -14,9 +14,9 @@
namespace Ergebnis\Json\Normalizer\Vendor\Composer;

use Ergebnis\Json\Normalizer\Json;
use Ergebnis\Json\Normalizer\NormalizerInterface;
use Ergebnis\Json\Normalizer\Normalizer;

final class ConfigHashNormalizer implements NormalizerInterface
final class ConfigHashNormalizer implements Normalizer
{
private const PROPERTIES_THAT_SHOULD_BE_SORTED = [
'config',
Expand Down
4 changes: 2 additions & 2 deletions src/Vendor/Composer/PackageHashNormalizer.php
Expand Up @@ -14,9 +14,9 @@
namespace Ergebnis\Json\Normalizer\Vendor\Composer;

use Ergebnis\Json\Normalizer\Json;
use Ergebnis\Json\Normalizer\NormalizerInterface;
use Ergebnis\Json\Normalizer\Normalizer;

final class PackageHashNormalizer implements NormalizerInterface
final class PackageHashNormalizer implements Normalizer
{
/**
* @see https://github.com/composer/composer/blob/2.0.11/src/Composer/Repository/PlatformRepository.php#L33
Expand Down
4 changes: 2 additions & 2 deletions src/Vendor/Composer/VersionConstraintNormalizer.php
Expand Up @@ -14,9 +14,9 @@
namespace Ergebnis\Json\Normalizer\Vendor\Composer;

use Ergebnis\Json\Normalizer\Json;
use Ergebnis\Json\Normalizer\NormalizerInterface;
use Ergebnis\Json\Normalizer\Normalizer;

final class VersionConstraintNormalizer implements NormalizerInterface
final class VersionConstraintNormalizer implements Normalizer
{
private const PROPERTIES_THAT_SHOULD_BE_NORMALIZED = [
'conflict',
Expand Down
2 changes: 1 addition & 1 deletion src/WithFinalNewLineNormalizer.php
Expand Up @@ -13,7 +13,7 @@

namespace Ergebnis\Json\Normalizer;

final class WithFinalNewLineNormalizer implements NormalizerInterface
final class WithFinalNewLineNormalizer implements Normalizer
{
public function normalize(Json $json): Json
{
Expand Down
2 changes: 1 addition & 1 deletion src/WithoutFinalNewLineNormalizer.php
Expand Up @@ -13,7 +13,7 @@

namespace Ergebnis\Json\Normalizer;

final class WithoutFinalNewLineNormalizer implements NormalizerInterface
final class WithoutFinalNewLineNormalizer implements Normalizer
{
public function normalize(Json $json): Json
{
Expand Down
4 changes: 2 additions & 2 deletions test/Unit/AutoFormatNormalizerTest.php
Expand Up @@ -16,7 +16,7 @@
use Ergebnis\Json\Normalizer\AutoFormatNormalizer;
use Ergebnis\Json\Normalizer\Format;
use Ergebnis\Json\Normalizer\Json;
use Ergebnis\Json\Normalizer\NormalizerInterface;
use Ergebnis\Json\Normalizer\Normalizer;

/**
* @internal
Expand Down Expand Up @@ -57,7 +57,7 @@ public function testNormalizeNormalizesAndFormatsUsingJsonFormat(): void
JSON
);

$composedNormalizer = $this->createMock(NormalizerInterface::class);
$composedNormalizer = $this->createMock(Normalizer::class);

$composedNormalizer
->expects(self::once())
Expand Down
6 changes: 3 additions & 3 deletions test/Unit/ChainNormalizerTest.php
Expand Up @@ -15,7 +15,7 @@

use Ergebnis\Json\Normalizer\ChainNormalizer;
use Ergebnis\Json\Normalizer\Json;
use Ergebnis\Json\Normalizer\NormalizerInterface;
use Ergebnis\Json\Normalizer\Normalizer;

/**
* @internal
Expand Down Expand Up @@ -48,14 +48,14 @@ public function testNormalizePassesJsonThroughNormalizers(): void

$last = \end($results);

$normalizers = \array_map(function ($result) use ($json): NormalizerInterface {
$normalizers = \array_map(function ($result) use ($json): Normalizer {
static $previous = null;

if (null === $previous) {
$previous = $json;
}

$normalizer = $this->createMock(NormalizerInterface::class);
$normalizer = $this->createMock(Normalizer::class);

$normalizer
->expects(self::once())
Expand Down
4 changes: 2 additions & 2 deletions test/Unit/FixedFormatNormalizerTest.php
Expand Up @@ -16,7 +16,7 @@
use Ergebnis\Json\Normalizer\FixedFormatNormalizer;
use Ergebnis\Json\Normalizer\Format;
use Ergebnis\Json\Normalizer\Json;
use Ergebnis\Json\Normalizer\NormalizerInterface;
use Ergebnis\Json\Normalizer\Normalizer;

/**
* @internal
Expand Down Expand Up @@ -66,7 +66,7 @@ public function testNormalizeNormalizesAndFormatsUsingFormat(): void
JSON
);

$composedNormalizer = $this->createMock(NormalizerInterface::class);
$composedNormalizer = $this->createMock(Normalizer::class);

$composedNormalizer
->expects(self::once())
Expand Down
4 changes: 2 additions & 2 deletions test/Unit/Vendor/Composer/AbstractComposerTestCase.php
Expand Up @@ -14,7 +14,7 @@
namespace Ergebnis\Json\Normalizer\Test\Unit\Vendor\Composer;

use Ergebnis\Json\Normalizer\Json;
use Ergebnis\Json\Normalizer\NormalizerInterface;
use Ergebnis\Json\Normalizer\Normalizer;
use Ergebnis\Json\Normalizer\Test;

/**
Expand All @@ -34,7 +34,7 @@ final public function testNormalizeDoesNotModifyWhenJsonDecodedIsNotAnObject(str

$reflection = new \ReflectionClass($className);

/** @var NormalizerInterface $normalizer */
/** @var Normalizer $normalizer */
$normalizer = $reflection->newInstanceWithoutConstructor();

$normalized = $normalizer->normalize($json);
Expand Down
14 changes: 7 additions & 7 deletions test/Unit/Vendor/Composer/ComposerJsonNormalizerTest.php
Expand Up @@ -15,7 +15,7 @@

use Ergebnis\Json\Normalizer\ChainNormalizer;
use Ergebnis\Json\Normalizer\Json;
use Ergebnis\Json\Normalizer\NormalizerInterface;
use Ergebnis\Json\Normalizer\Normalizer;
use Ergebnis\Json\Normalizer\SchemaNormalizer;
use Ergebnis\Json\Normalizer\Vendor;

Expand Down Expand Up @@ -220,7 +220,7 @@ public function testNormalizeNormalizes(): void
*/
private static function assertComposesNormalizer(
string $className,
NormalizerInterface $normalizer
Normalizer $normalizer
): void {
$attributeName = 'normalizer';

Expand All @@ -244,7 +244,7 @@ private static function assertComposesNormalizer(
*/
private static function assertComposesNormalizers(
array $classNames,
NormalizerInterface $normalizer
Normalizer $normalizer
): void {
$attributeName = 'normalizers';

Expand All @@ -266,7 +266,7 @@ private static function assertComposesNormalizers(
);
}

private static function composedNormalizer(NormalizerInterface $normalizer): NormalizerInterface
private static function composedNormalizer(Normalizer $normalizer): Normalizer
{
$reflection = new \ReflectionObject($normalizer);

Expand All @@ -278,11 +278,11 @@ private static function composedNormalizer(NormalizerInterface $normalizer): Nor
}

/**
* @throws \ReflectionException
*@throws \ReflectionException
*
* @return NormalizerInterface[]
* @return Normalizer[]
*/
private static function composedNormalizers(NormalizerInterface $normalizer): array
private static function composedNormalizers(Normalizer $normalizer): array
{
$reflection = new \ReflectionObject($normalizer);

Expand Down

0 comments on commit 7960dfa

Please sign in to comment.