Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/normalizer.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,13 @@ final class Profile
public array $explicitMeta;
}
```
:::note
Only the keys with a normalizer are converted. All other keys, including keys
that are not part of the shape, are kept as they are, so they must already hold
values that your storage can handle. A `null` value is passed to the normalizer
of its key, like for any other property.
:::

## DateTimeImmutable

With the `DateTimeImmutableNormalizer` you can convert `DateTimeImmutable`
Expand Down
17 changes: 7 additions & 10 deletions src/Normalizer/ArrayShapeNormalizer.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
use Symfony\Component\TypeInfo\Type\ArrayShapeType;
use Symfony\Component\TypeInfo\Type\NullableType;

use function array_key_exists;
use function is_array;

#[Attribute(Attribute::TARGET_PROPERTY)]
Expand All @@ -36,17 +37,15 @@ public function normalize(mixed $value, array $context): array|null
throw InvalidArgument::withWrongType('array|null', $value);
}

$result = [];

foreach ($this->normalizerMap as $field => $normalizer) {
if (!isset($value[$field])) {
if (!array_key_exists($field, $value)) {
continue;
}

$result[$field] = $normalizer->normalize($value[$field], $context);
$value[$field] = $normalizer->normalize($value[$field], $context);
}

return $result;
return $value;
}

/**
Expand All @@ -64,17 +63,15 @@ public function denormalize(mixed $value, array $context): array|null
throw InvalidArgument::withWrongType('array|null', $value);
}

$result = [];

foreach ($this->normalizerMap as $field => $normalizer) {
if (!isset($value[$field])) {
if (!array_key_exists($field, $value)) {
continue;
}

$result[$field] = $normalizer->denormalize($value[$field], $context);
$value[$field] = $normalizer->denormalize($value[$field], $context);
}

return $result;
return $value;
}

public function setHydrator(Hydrator $hydrator): void
Expand Down
16 changes: 16 additions & 0 deletions tests/Unit/Fixture/InferNormalizerWithArrayShapeDto.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?php

declare(strict_types=1);

namespace Patchlevel\Hydrator\Tests\Unit\Fixture;

use DateTimeImmutable;

final class InferNormalizerWithArrayShapeDto
{
/** @param array{height: int, nickname: string|null, skills: list<Skill>, status: Status|null, createdAt: DateTimeImmutable} $profile */
public function __construct(
public array $profile,
) {
}
}
66 changes: 66 additions & 0 deletions tests/Unit/Normalizer/ArrayShapeNormalizerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,72 @@ public function denormalize(mixed $value, array $context): int
$this->assertEquals(['foo' => 1], $normalizer->denormalize(['foo' => '1'], []));
}

public function testNormalizeKeepsKeysWithoutNormalizer(): void
{
$innerNormalizer = $this->createMock(Normalizer::class);
$innerNormalizer->expects($this->once())->method('normalize')->with(1, [])->willReturn('1');

$normalizer = new ArrayShapeNormalizer(['foo' => $innerNormalizer]);

$this->assertSame(
['height' => 180, 'foo' => '1', 'note' => null, 'unknown' => ['x']],
$normalizer->normalize(['height' => 180, 'foo' => 1, 'note' => null, 'unknown' => ['x']], []),
);
}

public function testDenormalizeKeepsKeysWithoutNormalizer(): void
{
$innerNormalizer = $this->createMock(Normalizer::class);
$innerNormalizer->expects($this->once())->method('denormalize')->with('1', [])->willReturn(1);

$normalizer = new ArrayShapeNormalizer(['foo' => $innerNormalizer]);

$this->assertSame(
['height' => 180, 'foo' => 1, 'note' => null, 'unknown' => ['x']],
$normalizer->denormalize(['height' => 180, 'foo' => '1', 'note' => null, 'unknown' => ['x']], []),
);
}

public function testNormalizePassesNullToInnerNormalizer(): void
{
$innerNormalizer = $this->createMock(Normalizer::class);
$innerNormalizer->expects($this->once())->method('normalize')->with(null, [])->willReturn(null);

$normalizer = new ArrayShapeNormalizer(['foo' => $innerNormalizer]);

$this->assertSame(['foo' => null], $normalizer->normalize(['foo' => null], []));
}

public function testDenormalizePassesNullToInnerNormalizer(): void
{
$innerNormalizer = $this->createMock(Normalizer::class);
$innerNormalizer->expects($this->once())->method('denormalize')->with(null, [])->willReturn(null);

$normalizer = new ArrayShapeNormalizer(['foo' => $innerNormalizer]);

$this->assertSame(['foo' => null], $normalizer->denormalize(['foo' => null], []));
}

public function testNormalizeSkipsMissingKeys(): void
{
$innerNormalizer = $this->createMock(Normalizer::class);
$innerNormalizer->expects($this->never())->method('normalize');

$normalizer = new ArrayShapeNormalizer(['foo' => $innerNormalizer]);

$this->assertSame(['bar' => 1], $normalizer->normalize(['bar' => 1], []));
}

public function testDenormalizeSkipsMissingKeys(): void
{
$innerNormalizer = $this->createMock(Normalizer::class);
$innerNormalizer->expects($this->never())->method('denormalize');

$normalizer = new ArrayShapeNormalizer(['foo' => $innerNormalizer]);

$this->assertSame(['bar' => 1], $normalizer->denormalize(['bar' => 1], []));
}

public function testNormalizePassesContextToInnerNormalizer(): void
{
$context = ['key' => 'value'];
Expand Down
25 changes: 25 additions & 0 deletions tests/Unit/StackHydratorTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
use Patchlevel\Hydrator\Tests\Unit\Fixture\DummyMiddleware;
use Patchlevel\Hydrator\Tests\Unit\Fixture\Email;
use Patchlevel\Hydrator\Tests\Unit\Fixture\InferNormalizerDto;
use Patchlevel\Hydrator\Tests\Unit\Fixture\InferNormalizerWithArrayShapeDto;
use Patchlevel\Hydrator\Tests\Unit\Fixture\InferNormalizerWithIterablesDto;
use Patchlevel\Hydrator\Tests\Unit\Fixture\InferNormalizerWithNullableDto;
use Patchlevel\Hydrator\Tests\Unit\Fixture\LazyProfileCreated;
Expand Down Expand Up @@ -557,6 +558,30 @@ public function testHydrateWithInferNormalizerWitIterables(): void
self::assertEquals($expected, $event);
}

public function testRoundTripWithArrayShape(): void
{
$object = new InferNormalizerWithArrayShapeDto([
'height' => 180,
'nickname' => null,
'skills' => [new Skill('php'), new Skill('go')],
'status' => null,
'createdAt' => new DateTimeImmutable('2015-02-13 22:34:32+01:00'),
]);

$data = [
'profile' => [
'height' => 180,
'nickname' => null,
'skills' => [['name' => 'php'], ['name' => 'go']],
'status' => null,
'createdAt' => '2015-02-13T22:34:32+01:00',
],
];

self::assertSame($data, $this->hydrator->extract($object));
self::assertEquals($object, $this->hydrator->hydrate(InferNormalizerWithArrayShapeDto::class, $data));
}

public function testHydrateWithClassNormalizer(): void
{
$object = $this->hydrator->hydrate(
Expand Down
Loading