Consistently pass destination object & class in context

Author: mark-gerarts

src/AutoMapper.php

@@ -20,7 +20,6 @@
 class AutoMapper implements AutoMapperInterface
 {
     public const DESTINATION_CONTEXT = '__destination';
-    
     public const DESTINATION_CLASS_CONTEXT = '__destination_class';
 
     /**
@@ -68,15 +67,21 @@ public function map($source, string $destinationClass, array $context = [])
             }
         }
 
+        $context = array_merge(
+            [self::DESTINATION_CLASS_CONTEXT => $destinationClass],
+            $context
+        );
         $mapping = $this->getMapping($sourceClass, $destinationClass);
         if ($mapping->providesCustomMapper()) {
             return $this->getCustomMapper($mapping)->map($source, $destinationClass);
         }
 
         if ($mapping->hasCustomConstructor()) {
-            $destinationObject = $mapping->getCustomConstructor()($source, $this, array_merge([
-                self::DESTINATION_CLASS_CONTEXT => $destinationClass
-            ]));
+            $destinationObject = $mapping->getCustomConstructor()(
+                $source,
+                $this,
+                $context
+            );
         }
         elseif (interface_exists($destinationClass)) {
             // If we're mapping to an interface a valid custom constructor has
@@ -89,6 +94,8 @@ public function map($source, string $destinationClass, array $context = [])
             $destinationObject = new $destinationClass;
         }
 
+        $context[self::DESTINATION_CONTEXT] = $destinationObject;
+
         return $this->doMap($source, $destinationObject, $mapping, $context);
     }
 
@@ -100,7 +107,6 @@ public function mapMultiple(
         string $destinationClass,
         array $context = []
     ): array {
-
         if(!is_iterable($sourceCollection)){
             throw new InvalidArgumentException(
                 'The collection provided should be iterable.'
@@ -132,16 +138,29 @@ public function mapToObject($source, $destination, array $context = [])
 
         $destinationClass = \get_class($destination);
 
+        $context = array_merge(
+            [
+                self::DESTINATION_CONTEXT => $destination,
+                self::DESTINATION_CLASS_CONTEXT => $destinationClass
+            ],
+            $context
+        );
+
         $mapping = $this->getMapping($sourceClass, $destinationClass);
         if ($mapping->providesCustomMapper()) {
-            return $this->getCustomMapper($mapping)->mapToObject($source, $destination, [
-                self::DESTINATION_CONTEXT => $destination,
-            ]);
+            return $this->getCustomMapper($mapping)->mapToObject(
+                $source,
+                $destination,
+                $context
+            );
         }
 
-        return $this->doMap($source, $destination, $mapping, array_merge([
-            self::DESTINATION_CONTEXT => $destination,
-        ], $context));
+        return $this->doMap(
+            $source,
+            $destination,
+            $mapping,
+            $context
+        );
     }
 
     /**

test/AutoMapperTest.php

@@ -123,21 +123,6 @@ public function testMapToAnExistingObjectContext()
         ;
         $mapper = new AutoMapper($this->config);
         $mapper->mapToObject($source, $destination);
-
-        // Make sure context added only for mapToObject method
-        $this->config
-            ->getMappingFor(Source::class, Destination::class)
-            ->forMember('name', Operation::mapFrom(function(Source $source, AutoMapperInterface $mapper, array $context) {
-                $this->assertArrayNotHasKey(AutoMapper::DESTINATION_CONTEXT, $context);
-
-                return $source->name;
-            }))
-        ;
-        $mapper = new AutoMapper($this->config);
-
-        $source = new Source();
-        $source->name = 'Hello';
-        $mapper->map($source, Destination::class);
     }
 
     public function testSourceDoesntGetOverridden()
@@ -731,7 +716,7 @@ public function testAnExceptionIsThrownForNoIterableSourceInMultpleMappings()
         $mapper = new AutoMapper($this->config);
 
         $sourceCollection = new \stdClass();
-        
+
         $mapper->mapMultiple($sourceCollection, Destination::class);
     }
 }

test/Scenarios/ContextTest.php

@@ -129,4 +129,37 @@ public function testMapToMergesTheParentContext()
 
         $this->assertEquals('map-to-value', $result->source->name);
     }
+
+    public function testDestinationClassIsPassed()
+    {
+        $config = new AutoMapperConfig();
+        $config->registerMapping(Source::class, Destination::class)
+            ->forMember('name', function ($source, $mapper, $context = []) {
+                $this->assertArrayHasKey(
+                    AutoMapper::DESTINATION_CONTEXT,
+                    $context
+                );
+                $this->assertArrayHasKey(
+                    AutoMapper::DESTINATION_CLASS_CONTEXT,
+                    $context
+                );
+                $this->assertInstanceOf(
+                    Destination::class,
+                    $context[AutoMapper::DESTINATION_CONTEXT]
+                );
+                $this->assertEquals(
+                    Destination::class,
+                    $context[AutoMapper::DESTINATION_CLASS_CONTEXT]
+                );
+
+                return 'some value';
+            });
+        $mapper = new AutoMapper($config);
+        $source = new Source('a name');
+
+        $mapper->map(
+            $source,
+            Destination::class
+        );
+    }
 }