fix(array): fix array and collection when using deep target populate

Author: joelwurtz

castor.php

@@ -35,10 +35,14 @@ function qa_phpstan(bool $generateBaseline = false)
 }
 
 #[AsTask('mapper', namespace: 'debug', description: 'Debug a mapper', aliases: ['debug'])]
-function debug_mapper(string $source, string $target)
+function debug_mapper(string $source, string $target, string $load = '')
 {
     require_once __DIR__ . '/vendor/autoload.php';
 
+    if ($load) {
+        require_once $load;
+    }
+
     $automapper = AutoMapper\AutoMapper::create();
     // get private property loader value
     $loader = new ReflectionProperty($automapper, 'classLoader');

src/Transformer/AbstractArrayTransformer.php

@@ -6,9 +6,11 @@
 
 use AutoMapper\Extractor\WriteMutator;
 use AutoMapper\Generator\UniqueVariableScope;
+use AutoMapper\MapperContext;
 use AutoMapper\Metadata\PropertyMetadata;
 use PhpParser\Node\Expr;
 use PhpParser\Node\Name;
+use PhpParser\Node\Scalar;
 use PhpParser\Node\Stmt;
 
 /**
@@ -31,8 +33,21 @@ public function transform(Expr $input, Expr $target, PropertyMetadata $propertyM
          * $values = [];.
          */
         $valuesVar = new Expr\Variable($uniqueVariableScope->getUniqueName('values'));
+        $baseAssign = new Expr\Array_();
+
+        if ($propertyMapping->target->readAccessor !== null) {
+            $baseAssign = new Expr\Ternary(
+                new Expr\BinaryOp\Coalesce(
+                    new Expr\ArrayDimFetch(new Expr\Variable('context'), new Scalar\String_(MapperContext::DEEP_TARGET_TO_POPULATE)),
+                    new Expr\ConstFetch(new Name('false'))
+                ),
+                $propertyMapping->target->readAccessor->getExpression(new Expr\Variable('result')),
+                new Expr\Array_()
+            );
+        }
+
         $statements = [
-            new Stmt\Expression(new Expr\Assign($valuesVar, new Expr\Array_())),
+            new Stmt\Expression(new Expr\Assign($valuesVar, $baseAssign)),
         ];
 
         $loopValueVar = new Expr\Variable($uniqueVariableScope->getUniqueName('value'));

src/Transformer/ArrayToDoctrineCollectionTransformer.php

@@ -5,11 +5,13 @@
 namespace AutoMapper\Transformer;
 
 use AutoMapper\Generator\UniqueVariableScope;
+use AutoMapper\MapperContext;
 use AutoMapper\Metadata\PropertyMetadata;
 use Doctrine\Common\Collections\ArrayCollection;
 use PhpParser\Node\Arg;
 use PhpParser\Node\Expr;
 use PhpParser\Node\Name;
+use PhpParser\Node\Scalar;
 use PhpParser\Node\Stmt;
 
 /**
@@ -30,8 +32,22 @@ public function transform(Expr $input, Expr $target, PropertyMetadata $propertyM
          * $collection = new ArrayCollection();.
          */
         $collectionVar = new Expr\Variable($uniqueVariableScope->getUniqueName('collection'));
+
+        $baseAssign = new Expr\New_(new Name(ArrayCollection::class));
+
+        if ($propertyMapping->target->readAccessor !== null) {
+            $baseAssign = new Expr\Ternary(
+                new Expr\BinaryOp\Coalesce(
+                    new Expr\ArrayDimFetch(new Expr\Variable('context'), new Scalar\String_(MapperContext::DEEP_TARGET_TO_POPULATE)),
+                    new Expr\ConstFetch(new Name('false'))
+                ),
+                $propertyMapping->target->readAccessor->getExpression(new Expr\Variable('result')),
+                $baseAssign,
+            );
+        }
+
         $statements = [
-            new Stmt\Expression(new Expr\Assign($collectionVar, new Expr\New_(new Name(ArrayCollection::class)))),
+            new Stmt\Expression(new Expr\Assign($collectionVar, $baseAssign)),
         ];
 
         $loopValueVar = new Expr\Variable($uniqueVariableScope->getUniqueName('value'));

src/Transformer/ArrayTransformerFactory.php

@@ -52,6 +52,10 @@ protected function createTransformer(Type $sourceType, Type $targetType, SourceP
         $subItemTransformer = $this->chainTransformerFactory->getTransformer($types, $source, $target, $mapperMetadata);
 
         if (null !== $subItemTransformer) {
+            if ($subItemTransformer instanceof ObjectTransformer) {
+                $subItemTransformer->deepTargetToPopulate = false;
+            }
+
             $sourceCollectionKeyTypes = $sourceType->getCollectionKeyTypes();
             $sourceCollectionKeyType = $sourceCollectionKeyTypes[0] ?? null;
 

src/Transformer/DoctrineCollectionTransformerFactory.php

@@ -36,6 +36,10 @@ protected function createTransformer(Type $sourceType, Type $targetType, SourceP
                 return null;
             }
 
+            if ($subItemTransformer instanceof ObjectTransformer) {
+                $subItemTransformer->deepTargetToPopulate = false;
+            }
+
             return new ArrayToDoctrineCollectionTransformer($subItemTransformer);
         }
 

src/Transformer/ObjectTransformer.php

@@ -20,11 +20,12 @@
  *
  * @internal
  */
-final readonly class ObjectTransformer implements TransformerInterface, DependentTransformerInterface, AssignedByReferenceTransformerInterface, CheckTypeInterface
+final class ObjectTransformer implements TransformerInterface, DependentTransformerInterface, AssignedByReferenceTransformerInterface, CheckTypeInterface
 {
     public function __construct(
-        private Type $sourceType,
-        private Type $targetType,
+        private readonly Type $sourceType,
+        private readonly Type $targetType,
+        public bool $deepTargetToPopulate = true,
     ) {
     }
 
@@ -38,7 +39,7 @@ public function transform(Expr $input, Expr $target, PropertyMetadata $propertyM
         ];
 
         // ($context['deep_target_to_populate'] ?? false) ? $source->property : null
-        if ($propertyMapping->target->readAccessor !== null) {
+        if ($propertyMapping->target->readAccessor !== null && $this->deepTargetToPopulate) {
             $newContextArgs[] = new Arg(
                 new Expr\Ternary(
                     new Expr\BinaryOp\Coalesce(

tests/AutoMapperTest/DeepPopulateWithArrayCollection/expected.array.data

@@ -0,0 +1,16 @@
+AutoMapper\Tests\AutoMapperTest\DeepPopulateWithArrayCollection\Foo {
+  +bars: [
+    AutoMapper\Tests\AutoMapperTest\DeepPopulateWithArrayCollection\Bar {
+      +bar: "bar1"
+    }
+    AutoMapper\Tests\AutoMapperTest\DeepPopulateWithArrayCollection\Bar {
+      +bar: "bar2"
+    }
+    AutoMapper\Tests\AutoMapperTest\DeepPopulateWithArrayCollection\Bar {
+      +bar: "bar3"
+    }
+    AutoMapper\Tests\AutoMapperTest\DeepPopulateWithArrayCollection\Bar {
+      +bar: "bar4"
+    }
+  ]
+}

tests/AutoMapperTest/DeepPopulateWithArrayCollection/expected.collection.data

@@ -0,0 +1,18 @@
+AutoMapper\Tests\AutoMapperTest\DeepPopulateWithArrayCollection\FooWithArrayCollection {
+  +bars: Doctrine\Common\Collections\ArrayCollection {
+    -elements: [
+      AutoMapper\Tests\AutoMapperTest\DeepPopulateWithArrayCollection\Bar {
+        +bar: "bar1"
+      }
+      AutoMapper\Tests\AutoMapperTest\DeepPopulateWithArrayCollection\Bar {
+        +bar: "bar2"
+      }
+      AutoMapper\Tests\AutoMapperTest\DeepPopulateWithArrayCollection\Bar {
+        +bar: "bar3"
+      }
+      AutoMapper\Tests\AutoMapperTest\DeepPopulateWithArrayCollection\Bar {
+        +bar: "bar4"
+      }
+    ]
+  }
+}

tests/AutoMapperTest/DeepPopulateWithArrayCollection/map.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AutoMapper\Tests\AutoMapperTest\DeepPopulateWithArrayCollection;
+
+use AutoMapper\Tests\AutoMapperBuilder;
+use Doctrine\Common\Collections\ArrayCollection;
+
+class Bar
+{
+    public string $bar;
+}
+
+class Foo
+{
+    /** @var array<Bar> */
+    public array $bars;
+}
+
+class FooWithArrayCollection
+{
+    /** @var ArrayCollection<Bar> */
+    public ArrayCollection $bars;
+}
+
+return (function () {
+    $autoMapper = AutoMapperBuilder::buildAutoMapper();
+
+    $data = [
+        'bars' => [
+            ['bar' => 'bar3'],
+            ['bar' => 'bar4'],
+        ],
+    ];
+
+    $bar1 = new Bar();
+    $bar1->bar = 'bar1';
+
+    $bar2 = new Bar();
+    $bar2->bar = 'bar2';
+
+    $existingObject = new Foo();
+    $existingObject->bars = [$bar1, $bar2];
+
+    $existingObjectWithArrayCollection = new FooWithArrayCollection();
+    $existingObjectWithArrayCollection->bars = new ArrayCollection([$bar1, $bar2]);
+
+    yield 'array' => $autoMapper->map($data, $existingObject, ['deep_target_to_populate' => true]);
+
+    yield 'collection' => $autoMapper->map($data, $existingObjectWithArrayCollection, ['deep_target_to_populate' => true]);
+})();