Merge pull request #12 from EventSaucePHP/feature/resolve-nested-prop…

…erties [FEATURE] Added ability to define nested input
EventSaucePHP · Apr 28, 2022 · 2e626d8 · 2e626d8
2 parents 86cc979 + 855440a
commit 2e626d8
Show file tree

Hide file tree

Showing 7 changed files with 75 additions and 15 deletions.
diff --git a/src/Fixtures/ClassWithPropertyMappedFromNestedKey.php b/src/Fixtures/ClassWithPropertyMappedFromNestedKey.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace EventSauce\ObjectHydrator\Fixtures;
+
+use EventSauce\ObjectHydrator\MapFrom;
+
+#[ExampleData(['nested' => ['name' => 'Frank']])]
+class ClassWithPropertyMappedFromNestedKey
+{
+    public function __construct(
+        #[MapFrom('nested.name', separator: '.')]
+        public string $name
+    )
+    {
+    }
+}
diff --git a/src/MapFrom.php b/src/MapFrom.php
@@ -5,21 +5,23 @@
 namespace EventSauce\ObjectHydrator;
 
 use Attribute;
+use function explode;
 use function is_string;
 
-#[Attribute(Attribute::TARGET_PARAMETER)]
+#[Attribute(Attribute::TARGET_PARAMETER | Attribute::TARGET_PROPERTY)]
 final class MapFrom
 {
-    /** @var array<string, string> */
+    /** @var array<string, array<string>> */
     public array $keys = [];
 
-    public function __construct(string|array $keyOrMap)
+    public function __construct(string|array $keyOrMap, public ?string $separator = null)
     {
         if (is_string($keyOrMap)) {
-            $this->keys[$keyOrMap] = $keyOrMap;
+            $this->keys[$keyOrMap] = $this->separator ? explode($this->separator, $keyOrMap) : [$keyOrMap];
         } else {
-            foreach ($keyOrMap as $index => $key) {
-                $this->keys[is_string($index) ? $index : $key] = $key;
+            foreach ($keyOrMap as $index => $toKey) {
+                $fromKey = is_string($index) ? $index : $toKey;
+                $this->keys[$toKey] = $this->separator ? explode($this->separator, $fromKey) : [$fromKey];
             }
         }
     }

diff --git a/src/ObjectHydrator.php b/src/ObjectHydrator.php
@@ -45,10 +45,19 @@ public function hydrateObject(string $className, array $payload): object
             foreach ($classDefinition->propertyDefinitions as $definition) {
                 $value = [];
 
-                foreach ($definition->keys as $from => $to) {
-                    if (array_key_exists($from, $payload)) {
-                        $value[$to] = $payload[$from];
+                foreach ($definition->keys as $to => $from) {
+                    $p = $payload;
+
+                    foreach ($from as $fromSegment) {
+                        if ( ! is_array($p) || ! array_key_exists($fromSegment, $p)) {
+                            goto next_property;
+                        }
+                        $p = $p[$fromSegment];
                     }
+
+                    $value[$to] = $p;
+
+                    next_property:
                 }
 
                 if ($value === []) {

diff --git a/src/ObjectHydratorDumper.php b/src/ObjectHydratorDumper.php
@@ -4,8 +4,8 @@
 
 namespace EventSauce\ObjectHydrator;
 
-use function array_keys;
 use function array_pop;
+use function array_values;
 use function count;
 use function explode;
 use function implode;
@@ -86,7 +86,8 @@ private function dumpClassHydrator(string $className, ClassDefinition $classDefi
             $property = $definition->property;
 
             if (count($keys) === 1) {
-                $from = array_keys($keys)[0];
+                $from = array_values($keys)[0];
+                $from = implode('\'][\'', $from);
                 $body .= <<<CODE
 
             \$value = \$payload['$from'] ?? null;
@@ -99,10 +100,13 @@ private function dumpClassHydrator(string $className, ClassDefinition $classDefi
             } else {
                 $collectKeys = '';
 
-                foreach ($keys as $from => $to) {
+                foreach ($keys as $to => $from) {
+                    $from = implode('\'][\'', $from);
                     $collectKeys .= <<<CODE
 
-            if (array_key_exists('$from', \$payload)) {
+            \$to = \$payload['$from'] ?? null;
+
+            if (\$to !== null) {
                 \$value['$to'] = \$payload['$from'];
             }
 

diff --git a/src/ObjectHydratorTestCase.php b/src/ObjectHydratorTestCase.php
@@ -13,6 +13,7 @@
 use EventSauce\ObjectHydrator\Fixtures\ClassWithMappedStringProperty;
 use EventSauce\ObjectHydrator\Fixtures\ClassWithNotCastedDateTimeInput;
 use EventSauce\ObjectHydrator\Fixtures\ClassWithPropertyCasting;
+use EventSauce\ObjectHydrator\Fixtures\ClassWithPropertyMappedFromNestedKey;
 use EventSauce\ObjectHydrator\Fixtures\ClassWithPropertyThatUsesListCasting;
 use EventSauce\ObjectHydrator\Fixtures\ClassWithPropertyThatUsesListCastingToClasses;
 use EventSauce\ObjectHydrator\Fixtures\ClassWithStaticConstructor;
@@ -39,6 +40,32 @@ public function properties_can_be_mapped_from_a_specific_key(): void
         self::assertEquals('Frank', $object->name);
     }
 
+    /**
+     * @test
+     */
+    public function mapping_a_nested_key(): void
+    {
+        $hydrator = $this->createObjectHydrator();
+
+        /** @var ClassWithPropertyMappedFromNestedKey $object */
+        $object = $hydrator->hydrateObject(ClassWithPropertyMappedFromNestedKey::class, ['nested' => ['name' => 'Frank']]);
+
+        self::assertInstanceOf(ClassWithPropertyMappedFromNestedKey::class, $object);
+        self::assertEquals('Frank', $object->name);
+    }
+
+    /**
+     * @test
+     */
+    public function trying_to_map_a_nested_key_from_shallow_input(): void
+    {
+        $hydrator = $this->createObjectHydrator();
+
+        $this->expectExceptionObject(UnableToHydrateObject::dueToError(ClassWithPropertyMappedFromNestedKey::class));
+
+        $hydrator->hydrateObject(ClassWithPropertyMappedFromNestedKey::class, ['nested' => 'Frank']);
+    }
+
     /**
      * @test
      */

diff --git a/src/PropertyDefinition.php b/src/PropertyDefinition.php
@@ -10,7 +10,7 @@
 final class PropertyDefinition
 {
     public function __construct(
-        /** @var array<string, string> */
+        /** @var array<string, array<string>> */
         public array $keys,
         public string $property,
         public array $propertyCasters,

diff --git a/src/ReflectionDefinitionProvider.php b/src/ReflectionDefinitionProvider.php
@@ -40,7 +40,7 @@ public function provideDefinition(string $className): ClassDefinition
             $firstTypeName = $parameterType->firstTypeName();
             $definition = [
                 'property' => $paramName,
-                'keys' => [$paramName => $paramName],
+                'keys' => [$paramName => [$paramName]],
                 'enum' => $parameterType->isEnum(),
             ];