Skip to content

Commit be34138

Browse files
DavidBaduraDavidBadura
authored
Merge pull request #124 from patchlevel/inline-normalizer
2 parents 632b475 + d8e4829 commit be34138

File tree

6 files changed

+267
-1
lines changed

6 files changed

+267
-1
lines changed

‎README.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,42 @@ final class AnotherDto
308308
> [!WARNING]
309309
> Circular references are not supported and will result in an exception.
310310
311+
#### Inline
312+
313+
The `InlineNormalizer` allows you to define normalization and denormalization logic directly via closures.
314+
This is useful for simple value objects or when you don't want to create a separate normalizer class.
315+
316+
```php
317+
use Patchlevel\Hydrator\Normalizer\InlineNormalizer;
318+
319+
#[InlineNormalizer(
320+
normalize: static function (self $object): string {
321+
return $object->toString();
322+
},
323+
denormalize: static function (string $value): self {
324+
return new self($value);
325+
},
326+
)]
327+
final class Email
328+
{
329+
public function __construct(
330+
private string $value
331+
) {}
332+
333+
public function toString(): string
334+
{
335+
return $this->value;
336+
}
337+
}
338+
```
339+
340+
> [!NOTE]
341+
> Closures in attributes can only be used since PHP 8.5, therefore this normalizer can only be used with PHP 8.5.
342+
343+
> [!TIP]
344+
> If you want to handle `null` values within your closures, you can set the `passNull` option to `true`.
345+
> By default, `null` values are not passed to the closures and are returned as `null` directly.
346+
311347
### Custom Normalizer
312348

313349
Since we only offer normalizers for PHP native things,

‎src/Normalizer/InlineNormalizer.php‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Patchlevel\Hydrator\Normalizer;
6+
7+
use Attribute;
8+
use Closure;
9+
use TypeError;
10+
11+
#[Attribute(Attribute::TARGET_PROPERTY | Attribute::TARGET_CLASS)]
12+
final class InlineNormalizer implements Normalizer
13+
{
14+
/**
15+
* @param Closure(O): N $normalize
16+
* @param Closure(N): O $denormalize
17+
*
18+
* @template O of mixed
19+
* @template N of mixed
20+
*/
21+
public function __construct(
22+
private readonly Closure $normalize,
23+
private readonly Closure $denormalize,
24+
private readonly bool $passNull = false,
25+
) {
26+
}
27+
28+
public function normalize(mixed $value): mixed
29+
{
30+
if (!$this->passNull && $value === null) {
31+
return null;
32+
}
33+
34+
try {
35+
return ($this->normalize)($value);
36+
} catch (TypeError) {
37+
throw new InvalidType();
38+
}
39+
}
40+
41+
public function denormalize(mixed $value): mixed
42+
{
43+
if (!$this->passNull && $value === null) {
44+
return null;
45+
}
46+
47+
try {
48+
return ($this->denormalize)($value);
49+
} catch (TypeError) {
50+
throw new InvalidType();
51+
}
52+
}
53+
}

‎tests/Unit/Fixture/ProfileCreatedWithInlineNormalizer.php‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Patchlevel\Hydrator\Tests\Unit\Fixture;
6+
7+
final class ProfileCreatedWithInlineNormalizer
8+
{
9+
public function __construct(
10+
public ProfileId $profileId,
11+
public ValueObject $valueObject,
12+
) {
13+
}
14+
}

‎tests/Unit/Fixture/ValueObject.php‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Patchlevel\Hydrator\Tests\Unit\Fixture;
6+
7+
use Patchlevel\Hydrator\Normalizer\InlineNormalizer;
8+
9+
#[InlineNormalizer(
10+
normalize: static function (self $object): string {
11+
return $object->toString();
12+
},
13+
denormalize: static function (string $value): self {
14+
return self::fromString($value);
15+
},
16+
)]
17+
final class ValueObject
18+
{
19+
private function __construct(
20+
private readonly string $value,
21+
) {
22+
}
23+
24+
public function toString(): string
25+
{
26+
return $this->value;
27+
}
28+
29+
public static function fromString(string $value): self
30+
{
31+
return new self($value);
32+
}
33+
}

‎tests/Unit/MetadataHydratorTest.php‎

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,14 @@
3333
use Patchlevel\Hydrator\Tests\Unit\Fixture\NormalizerInBaseClassDefinedDto;
3434
use Patchlevel\Hydrator\Tests\Unit\Fixture\ParentDto;
3535
use Patchlevel\Hydrator\Tests\Unit\Fixture\ProfileCreated;
36+
use Patchlevel\Hydrator\Tests\Unit\Fixture\ProfileCreatedWithInlineNormalizer;
3637
use Patchlevel\Hydrator\Tests\Unit\Fixture\ProfileCreatedWithNormalizer;
3738
use Patchlevel\Hydrator\Tests\Unit\Fixture\ProfileCreatedWrapper;
3839
use Patchlevel\Hydrator\Tests\Unit\Fixture\ProfileId;
3940
use Patchlevel\Hydrator\Tests\Unit\Fixture\Skill;
4041
use Patchlevel\Hydrator\Tests\Unit\Fixture\Status;
4142
use Patchlevel\Hydrator\Tests\Unit\Fixture\StatusWithNormalizer;
43+
use Patchlevel\Hydrator\Tests\Unit\Fixture\ValueObject;
4244
use Patchlevel\Hydrator\Tests\Unit\Fixture\WrongNormalizer;
4345
use Patchlevel\Hydrator\TypeMismatch;
4446
use PHPUnit\Framework\Attributes\RequiresPhp;
@@ -114,7 +116,7 @@ public function testExtractCircularReference(): void
114116
$this->hydrator->extract($dto1);
115117
}
116118

117-
public function testExtractWithInferNormalizer2(): void
119+
public function testExtractWithInferNormalizer(): void
118120
{
119121
$result = $this->hydrator->extract(
120122
new InferNormalizerWithNullableDto(
@@ -149,6 +151,20 @@ public function testExtractWithInferNormalizerFailed(): void
149151
);
150152
}
151153

154+
#[RequiresPhp('>=8.5')]
155+
public function testExtractWithInlineNormalizer(): void
156+
{
157+
$event = new ProfileCreatedWithInlineNormalizer(
158+
ProfileId::fromString('1'),
159+
ValueObject::fromString('foo'),
160+
);
161+
162+
self::assertEquals(
163+
['profileId' => '1', 'valueObject' => 'foo'],
164+
$this->hydrator->extract($event),
165+
);
166+
}
167+
152168
public function testExtractWithHooks(): void
153169
{
154170
$data = $this->hydrator->extract(new DtoWithHooks());
@@ -238,6 +254,22 @@ public function testHydrateWithTypeMismatch(): void
238254
);
239255
}
240256

257+
#[RequiresPhp('>=8.5')]
258+
public function testHydrateWithInlineNormalizer(): void
259+
{
260+
$expected = new ProfileCreatedWithInlineNormalizer(
261+
ProfileId::fromString('1'),
262+
ValueObject::fromString('foo'),
263+
);
264+
265+
$event = $this->hydrator->hydrate(
266+
ProfileCreatedWithInlineNormalizer::class,
267+
['profileId' => '1', 'valueObject' => 'foo'],
268+
);
269+
270+
self::assertEquals($expected, $event);
271+
}
272+
241273
public function testDenormalizationFailure(): void
242274
{
243275
$this->expectException(DenormalizationFailure::class);

‎tests/Unit/Normalizer/InlineNormalizerTest.php‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Patchlevel\Hydrator\Tests\Unit\Normalizer;
6+
7+
use Patchlevel\Hydrator\Normalizer\InlineNormalizer;
8+
use Patchlevel\Hydrator\Normalizer\InvalidType;
9+
use PHPUnit\Framework\TestCase;
10+
11+
final class InlineNormalizerTest extends TestCase
12+
{
13+
public function testNormalizeWithValue(): void
14+
{
15+
$normalizer = new InlineNormalizer(
16+
static fn (int $value): string => (string)$value,
17+
static fn (string $value): int => (int)$value,
18+
);
19+
20+
$this->assertEquals('123', $normalizer->normalize(123));
21+
}
22+
23+
public function testDenormalizeWithValue(): void
24+
{
25+
$normalizer = new InlineNormalizer(
26+
static fn (int $value): string => (string)$value,
27+
static fn (string $value): int => (int)$value,
28+
);
29+
30+
$this->assertEquals(123, $normalizer->denormalize('123'));
31+
}
32+
33+
public function testNormalizeWithNull(): void
34+
{
35+
$normalizer = new InlineNormalizer(
36+
static fn (mixed $value) => 'not null',
37+
static fn (mixed $value) => 'not null',
38+
);
39+
40+
$this->assertNull($normalizer->normalize(null));
41+
}
42+
43+
public function testDenormalizeWithNull(): void
44+
{
45+
$normalizer = new InlineNormalizer(
46+
static fn (mixed $value) => 'not null',
47+
static fn (mixed $value) => 'not null',
48+
);
49+
50+
$this->assertNull($normalizer->denormalize(null));
51+
}
52+
53+
public function testNormalizePassNull(): void
54+
{
55+
$normalizer = new InlineNormalizer(
56+
static fn (mixed $value) => $value === null ? 'is null' : 'is not null',
57+
static fn (mixed $value) => $value,
58+
true,
59+
);
60+
61+
$this->assertEquals('is null', $normalizer->normalize(null));
62+
}
63+
64+
public function testDenormalizePassNull(): void
65+
{
66+
$normalizer = new InlineNormalizer(
67+
static fn (mixed $value) => $value,
68+
static fn (mixed $value) => $value === null ? 'is null' : 'is not null',
69+
true,
70+
);
71+
72+
$this->assertEquals('is null', $normalizer->denormalize(null));
73+
}
74+
75+
public function testNormalizeInvalidType(): void
76+
{
77+
$this->expectException(InvalidType::class);
78+
79+
$normalizer = new InlineNormalizer(
80+
static fn (string $value) => $value,
81+
static fn (mixed $value) => $value,
82+
);
83+
84+
$normalizer->normalize(123);
85+
}
86+
87+
public function testDenormalizeInvalidType(): void
88+
{
89+
$this->expectException(InvalidType::class);
90+
91+
$normalizer = new InlineNormalizer(
92+
static fn (mixed $value) => $value,
93+
static fn (string $value) => $value,
94+
);
95+
96+
$normalizer->denormalize(123);
97+
}
98+
}

0 commit comments

Comments
 (0)