Merge pull request #29 from nutgram/apply-mutators

apply mutators to an attribute

src/Annotation/ConcreteResolver.php

@@ -7,7 +7,7 @@
 /**
  * @Annotation
  *
- * @Target({"PROPERTY"})
+ * @Target({"CLASS"})
  */
 #[Attribute(Attribute::TARGET_CLASS)]
 abstract class ConcreteResolver

src/Annotation/Mutate.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace SergiX44\Hydrator\Annotation;
+
+use Attribute;
+use InvalidArgumentException;
+use SergiX44\Hydrator\Mutator;
+
+/**
+ * @Annotation
+ *
+ * @Target({"PROPERTY"})
+ */
+#[Attribute(Attribute::TARGET_PROPERTY)]
+final class Mutate
+{
+    /**
+     * The attribute value.
+     *
+     * @var class-string<Mutator>[]
+     */
+    public array $mutators;
+
+    /**
+     * Constructor of the class.
+     *
+     * @param string ...$mutators
+     */
+    public function __construct(string ...$mutators)
+    {
+        foreach ($mutators as $mutator) {
+            if (!is_subclass_of($mutator, Mutator::class)) {
+                throw new InvalidArgumentException(sprintf('Class %s must implements %s', $mutator, Mutator::class));
+            }
+        }
+
+        $this->mutators = $mutators;
+    }
+
+    /**
+     * @param $value
+     *
+     * @return mixed
+     */
+    public function apply($value): mixed
+    {
+        foreach ($this->mutators as $mutator) {
+            $value = (new $mutator())->mutate($value);
+        }
+
+        return $value;
+    }
+}

src/Hydrator.php

@@ -18,6 +18,7 @@
 use SergiX44\Hydrator\Annotation\Alias;
 use SergiX44\Hydrator\Annotation\ArrayType;
 use SergiX44\Hydrator\Annotation\ConcreteResolver;
+use SergiX44\Hydrator\Annotation\Mutate;
 use SergiX44\Hydrator\Annotation\SkipConstructor;
 use SergiX44\Hydrator\Annotation\UnionResolver;
 use SergiX44\Hydrator\Exception\InvalidObjectException;
@@ -138,6 +139,11 @@ public function hydrate(string|object $object, array|object $data): object
                 continue;
             }
 
+            $mutator = $this->getAttributeInstance($property, Mutate::class);
+            if ($mutator !== null) {
+                $data[$key] = $mutator->apply($data[$key]);
+            }
+
             $this->hydrateProperty($object, $class, $property, $propertyType, $data[$key]);
         }
 

src/Mutations/JsonDecodeArray.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace SergiX44\Hydrator\Mutations;
+
+use SergiX44\Hydrator\Mutator;
+
+class JsonDecodeArray implements Mutator
+{
+    public function mutate(mixed $value): mixed
+    {
+        return json_decode($value, true, 512, JSON_THROW_ON_ERROR);
+    }
+}

src/Mutations/JsonDecodeObject.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace SergiX44\Hydrator\Mutations;
+
+use SergiX44\Hydrator\Mutator;
+
+class JsonDecodeObject implements Mutator
+{
+    public function mutate(mixed $value): mixed
+    {
+        return json_decode($value, false, 512, JSON_THROW_ON_ERROR);
+    }
+}

src/Mutator.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace SergiX44\Hydrator;
+
+interface Mutator
+{
+    public function mutate(mixed $value): mixed;
+}

tests/Fixtures/ObjectWithArrayToDeserialize.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace SergiX44\Hydrator\Tests\Fixtures;
+
+use SergiX44\Hydrator\Annotation\Mutate;
+use SergiX44\Hydrator\Mutations\JsonDecodeObject;
+
+final class ObjectWithArrayToDeserialize
+{
+    public string $name;
+
+    #[Mutate(JsonDecodeObject::class)]
+    public array $value;
+}

tests/HydratorTest.php

@@ -875,4 +875,16 @@ public function testSkipConstructorWithContainer(): void
         $this->assertSame(Fixtures\StringableEnum::foo, $object->stringableEnum);
         $this->assertSame(Fixtures\NumerableEnum::foo, $object->numerableEnums[0]);
     }
+
+    public function testMutateProperty(): void
+    {
+        $object = (new Hydrator())->hydrate(Fixtures\ObjectWithArrayToDeserialize::class, [
+            'name'  => 'foo',
+            'value' => json_encode(['foo' => 'bar'], JSON_THROW_ON_ERROR),
+        ]);
+
+        $this->assertSame('foo', $object->name);
+        $this->assertIsArray($object->value);
+        $this->assertSame(['foo' => 'bar'], $object->value);
+    }
 }