allow to extend infer normalizerer with custom guesser

patchlevel · Jul 8, 2024 · c1aeeea · c1aeeea
1 parent ab7500a
commit c1aeeea
Show file tree

Hide file tree

Showing 6 changed files with 187 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -111,6 +111,9 @@ final class DTO
 }
 ```
 
+> [!TIP]
+> You do not need to specify the DateTimeImmutableNormalizer, as the Hydrator can guess it from the type definition.
+
 You can also define the format. Either describe it yourself as a string or use one of the existing constants.
 The default is `DateTimeImmutable::ATOM`.
 
@@ -141,6 +144,9 @@ final class DTO
 }
 ```
 
+> [!TIP]
+> You do not need to specify the DateTimeNormalizer, as the Hydrator can guess it from the type definition.
+
 You can also specify the format here. The default is `DateTime::ATOM`.
 
 ```php
@@ -170,6 +176,9 @@ final class DTO
 }
 ```
 
+> [!TIP]
+> You do not need to specify the DateTimeZoneNormalizer, as the Hydrator can guess it from the type definition.
+
 #### Enum
 
 Backed enums can also be normalized.
@@ -185,6 +194,9 @@ final class DTO
 }
 ```
 
+> [!TIP]
+> You do not need to specify the EnumNormalizer, as the Hydrator can guess it from the type definition.
+
 #### Object
 
 If you have a complex object that you want to normalize, you can use the `ObjectNormalizer`.
@@ -325,11 +337,10 @@ final class DTO
 }
 ```
 
-### Infer Normalizer
+### Guess Normalizer
 
 We also integrated a process where the normalizer gets inferred by type. This means you don't need to define the 
-normalizer in for the properties or on class level. Right now this is only possible for Normalizer defined by our 
-library. There are exceptions though, the `ObjectNormalizer` and the `ArrayNormalizer`.
+normalizer in for the properties or on class level. 
 
 These Normalizer can be inferred:
 
@@ -338,6 +349,43 @@ These Normalizer can be inferred:
 * `DateTimeZoneNormalizer` 
 * `EnumNormalizer` 
 
+You can also create your own guesser:
+
+```php
+use Patchlevel\Hydrator\Guesser\Guesser;
+use Patchlevel\Hydrator\Normalizer\Normalizer;
+
+final class MyGuesser implements Guesser
+{
+    /** @param class-string $className */ 
+    public function guess(string $className): Normalizer|null
+    {
+        if ($className === Name::class) {
+            return new NameNormalizer();
+        }
+
+        return null;
+    }
+}
+```
+
+After that you can use the guesser in the hydrator.
+
+```php
+use Patchlevel\Hydrator\Guesser\BuiltInGuesser;
+use Patchlevel\Hydrator\Metadata\AttributeMetadataFactory;
+use Patchlevel\Hydrator\MetadataHydrator;
+
+$hydrator = new MetadataHydrator(
+    new AttributeMetadataFactory([
+        new MyGuesser(),
+        new BuiltInGuesser()
+    ])
+);
+```
+
+> [!WARNING]
+> Do not forget to add the built-in guesser.
 
 ### Normalized Name
 
@@ -422,7 +470,7 @@ final class DTO
 }
 ```
 
-> [!DANGER]
+> [!CAUTION]
 > You have to deal with this case in your business logic such as aggregates and subscriptions.
 
 > [!WARNING]

diff --git a/src/Guesser/BuiltInGuesser.php b/src/Guesser/BuiltInGuesser.php
@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\Hydrator\Guesser;
+
+use BackedEnum;
+use DateTime;
+use DateTimeImmutable;
+use DateTimeZone;
+use Patchlevel\Hydrator\Normalizer\DateTimeImmutableNormalizer;
+use Patchlevel\Hydrator\Normalizer\DateTimeNormalizer;
+use Patchlevel\Hydrator\Normalizer\DateTimeZoneNormalizer;
+use Patchlevel\Hydrator\Normalizer\EnumNormalizer;
+use Patchlevel\Hydrator\Normalizer\Normalizer;
+
+use function is_a;
+
+final class BuiltInGuesser implements Guesser
+{
+    /** @param class-string $className */
+    public function guess(string $className): Normalizer|null
+    {
+        $normalizer = match ($className) {
+            DateTimeImmutable::class => new DateTimeImmutableNormalizer(),
+            DateTime::class => new DateTimeNormalizer(),
+            DateTimeZone::class => new DateTimeZoneNormalizer(),
+            default => null,
+        };
+
+        if ($normalizer) {
+            return $normalizer;
+        }
+
+        if (is_a($className, BackedEnum::class, true)) {
+            return new EnumNormalizer($className);
+        }
+
+        return null;
+    }
+}
diff --git a/src/Guesser/Guesser.php b/src/Guesser/Guesser.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\Hydrator\Guesser;
+
+use Patchlevel\Hydrator\Normalizer\Normalizer;
+
+interface Guesser
+{
+    /** @param class-string $className */
+    public function guess(string $className): Normalizer|null;
+}
diff --git a/src/Metadata/AttributeMetadataFactory.php b/src/Metadata/AttributeMetadataFactory.php
@@ -4,18 +4,12 @@
 
 namespace Patchlevel\Hydrator\Metadata;
 
-use BackedEnum;
-use DateTime;
-use DateTimeImmutable;
-use DateTimeZone;
 use Patchlevel\Hydrator\Attribute\DataSubjectId;
 use Patchlevel\Hydrator\Attribute\Ignore;
 use Patchlevel\Hydrator\Attribute\NormalizedName;
 use Patchlevel\Hydrator\Attribute\PersonalData;
-use Patchlevel\Hydrator\Normalizer\DateTimeImmutableNormalizer;
-use Patchlevel\Hydrator\Normalizer\DateTimeNormalizer;
-use Patchlevel\Hydrator\Normalizer\DateTimeZoneNormalizer;
-use Patchlevel\Hydrator\Normalizer\EnumNormalizer;
+use Patchlevel\Hydrator\Guesser\BuiltInGuesser;
+use Patchlevel\Hydrator\Guesser\Guesser;
 use Patchlevel\Hydrator\Normalizer\Normalizer;
 use Patchlevel\Hydrator\Normalizer\ReflectionTypeAwareNormalizer;
 use ReflectionAttribute;
@@ -26,13 +20,20 @@
 use function array_key_exists;
 use function array_values;
 use function class_exists;
-use function is_a;
 
 final class AttributeMetadataFactory implements MetadataFactory
 {
     /** @var array<class-string, ClassMetadata> */
     private array $classMetadata = [];
 
+    /** @param iterable<Guesser> $guessers */
+    public function __construct(
+        private readonly iterable $guessers = [
+            new BuiltInGuesser(),
+        ],
+    ) {
+    }
+
     /**
      * @param class-string<T> $class
      *
@@ -172,19 +173,16 @@ private function inferNormalizer(ReflectionNamedType $type): Normalizer|null
     {
         $className = $type->getName();
 
-        $normalizer = match ($className) {
-            DateTimeImmutable::class => new DateTimeImmutableNormalizer(),
-            DateTime::class => new DateTimeNormalizer(),
-            DateTimeZone::class => new DateTimeZoneNormalizer(),
-            default => null,
-        };
-
-        if ($normalizer) {
-            return $normalizer;
+        if (!class_exists($className)) {
+            return null;
         }
 
-        if (is_a($className, BackedEnum::class, true)) {
-            return new EnumNormalizer($className);
+        foreach ($this->guessers as $guesser) {
+            $normalizer = $guesser->guess($className);
+
+            if ($normalizer !== null) {
+                return $normalizer;
+            }
         }
 
         return null;

diff --git a/tests/Unit/Guesser/BuiltInGuesserTest.php b/tests/Unit/Guesser/BuiltInGuesserTest.php
@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\Hydrator\Tests\Unit\Guesser;
+
+use DateTime;
+use DateTimeImmutable;
+use DateTimeZone;
+use Patchlevel\Hydrator\Guesser\BuiltInGuesser;
+use Patchlevel\Hydrator\Normalizer\DateTimeImmutableNormalizer;
+use Patchlevel\Hydrator\Normalizer\DateTimeNormalizer;
+use Patchlevel\Hydrator\Normalizer\DateTimeZoneNormalizer;
+use Patchlevel\Hydrator\Normalizer\EnumNormalizer;
+use Patchlevel\Hydrator\Tests\Unit\Fixture\Email;
+use Patchlevel\Hydrator\Tests\Unit\Fixture\Status;
+use PHPUnit\Framework\TestCase;
+
+final class BuiltInGuesserTest extends TestCase
+{
+    public function testNoMatch(): void
+    {
+        $guesser = new BuiltInGuesser();
+        self::assertNull($guesser->guess(Email::class));
+    }
+
+    public function testEnum(): void
+    {
+        $guesser = new BuiltInGuesser();
+        self::assertInstanceOf(
+            EnumNormalizer::class,
+            $guesser->guess(Status::class),
+        );
+    }
+
+    public function testDateTimeImmutable(): void
+    {
+        $guesser = new BuiltInGuesser();
+        self::assertInstanceOf(
+            DateTimeImmutableNormalizer::class,
+            $guesser->guess(DateTimeImmutable::class),
+        );
+    }
+
+    public function testDateTime(): void
+    {
+        $guesser = new BuiltInGuesser();
+        self::assertInstanceOf(
+            DateTimeNormalizer::class,
+            $guesser->guess(DateTime::class),
+        );
+    }
+
+    public function testDateTimeZone(): void
+    {
+        $guesser = new BuiltInGuesser();
+        self::assertInstanceOf(
+            DateTimeZoneNormalizer::class,
+            $guesser->guess(DateTimeZone::class),
+        );
+    }
+}
diff --git a/tests/Unit/MetadataHydratorTest.php b/tests/Unit/MetadataHydratorTest.php
@@ -41,7 +41,7 @@ final class MetadataHydratorTest extends TestCase
 
     public function setUp(): void
     {
-        $this->hydrator = new MetadataHydrator(new AttributeMetadataFactory());
+        $this->hydrator = new MetadataHydrator();
     }
 
     public function testExtract(): void