feat(remover): remove existing values when adder and remover

Author: joelwurtz

src/Extractor/MappingExtractor.php

@@ -112,6 +112,7 @@ public function getReadAccessor(string $class, string $property, bool $allowExtr
     public function getWriteMutator(string $source, string $target, string $property, array $context = [], bool $allowExtraProperties = false): ?WriteMutator
     {
         $writeInfo = $this->writeInfoExtractor->getWriteInfo($target, $property, $context);
+        $removeMethodName = null;
 
         if (null === $writeInfo || PropertyWriteInfo::TYPE_NONE === $writeInfo->getType()) {
             if ('array' === $target) {
@@ -147,13 +148,16 @@ public function getWriteMutator(string $source, string $target, string $property
 
         if (PropertyWriteInfo::TYPE_ADDER_AND_REMOVER === $writeInfo->getType()) {
             $type = WriteMutator::TYPE_ADDER_AND_REMOVER;
+            $removeMethodName = $writeInfo->getRemoverInfo()->getName();
             $writeInfo = $writeInfo->getAdderInfo();
         }
 
         return new WriteMutator(
             $type,
             $writeInfo->getName(),
-            PropertyReadInfo::VISIBILITY_PUBLIC !== $writeInfo->getVisibility()
+            PropertyReadInfo::VISIBILITY_PUBLIC !== $writeInfo->getVisibility(),
+            null,
+            $removeMethodName,
         );
     }
 

src/Extractor/WriteMutator.php

@@ -35,6 +35,7 @@ public function __construct(
         private readonly string $property,
         private readonly bool $private = false,
         public readonly ?\ReflectionParameter $parameter = null,
+        private readonly ?string $removeMethodName = null,
     ) {
     }
 
@@ -100,6 +101,22 @@ public function getExpression(Expr $output, Expr $value, bool $byRef = false): E
         throw new CompileException('Invalid accessor for write expression');
     }
 
+    public function getRemoveExpression(Expr $object, Expr $value): ?Expr
+    {
+        if (self::TYPE_ADDER_AND_REMOVER === $this->type && $this->removeMethodName) {
+            /*
+             * Create method call expression to remove value
+             *
+             * $object->removeMethodName($value);
+             */
+            return new Expr\MethodCall($object, $this->removeMethodName, [
+                new Arg($value),
+            ]);
+        }
+
+        return null;
+    }
+
     /**
      * Get AST expression for binding closure when dealing with private property.
      */

src/Transformer/AbstractArrayTransformer.php

@@ -64,6 +64,17 @@ public function transform(Expr $input, Expr $target, PropertyMetadata $propertyM
              *
              * $target->add($output);
              */
+            $loopRemoveValueVar = new Expr\Variable($uniqueVariableScope->getUniqueName('removeValue'));
+            $removeExpr = $propertyMapping->target->writeMutator->getRemoveExpression($target, $loopRemoveValueVar);
+
+            if ($propertyMapping->target->readAccessor !== null && $removeExpr !== null) {
+                $statements[] = new Stmt\Foreach_($propertyMapping->target->readAccessor->getExpression($target), $loopRemoveValueVar, [
+                    'stmts' => [
+                        new Stmt\Expression($removeExpr),
+                    ],
+                ]);
+            }
+
             $mappedValueVar = new Expr\Variable($uniqueVariableScope->getUniqueName('mappedValue'));
             $itemStatements[] = new Stmt\Expression(new Expr\Assign($mappedValueVar, $output));
             $itemStatements[] = new Stmt\If_(new Expr\BinaryOp\NotIdentical(new Expr\ConstFetch(new Name('null')), $mappedValueVar), [

tests/AutoMapperTest.php

@@ -839,13 +839,11 @@ public function testAdderAndRemoverWithInstance(): void
         $this->autoMapper->map($petOwnerAsArray, $petOwner);
 
         self::assertIsArray($petOwner->getPets());
-        self::assertCount(3, $petOwner->getPets());
-        self::assertSame('Nemo', $petOwner->getPets()[0]->name);
-        self::assertSame('fish', $petOwner->getPets()[0]->type);
-        self::assertSame('Félix', $petOwner->getPets()[1]->name);
-        self::assertSame('cat', $petOwner->getPets()[1]->type);
-        self::assertSame('Coco', $petOwner->getPets()[2]->name);
-        self::assertSame('dog', $petOwner->getPets()[2]->type);
+        self::assertCount(2, $petOwner->getPets());
+        self::assertSame('Félix', $petOwner->getPets()[0]->name);
+        self::assertSame('cat', $petOwner->getPets()[0]->type);
+        self::assertSame('Coco', $petOwner->getPets()[1]->name);
+        self::assertSame('dog', $petOwner->getPets()[1]->type);
     }
 
     public function testAdderAndRemoverWithNull(): void

tests/AutoMapperTest/ArrayConsistency/expected.to.data

@@ -0,0 +1,7 @@
+AutoMapper\Tests\AutoMapperTest\ArrayConsistency\To {
+  +values: [
+    1
+    2
+    3
+  ]
+}

tests/AutoMapperTest/ArrayConsistency/expected.toAdder.data

@@ -0,0 +1,7 @@
+AutoMapper\Tests\AutoMapperTest\ArrayConsistency\ToAdder {
+  -values: [
+    1
+    2
+    3
+  ]
+}

tests/AutoMapperTest/ArrayConsistency/map.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AutoMapper\Tests\AutoMapperTest\ArrayConsistency;
+
+use AutoMapper\Tests\AutoMapperBuilder;
+
+class From
+{
+    public array $values;
+}
+
+class To
+{
+    public array $values;
+}
+
+class ToAdder
+{
+    private array $values;
+
+    public function addValue(mixed $value): void
+    {
+        $this->values[] = $value;
+    }
+
+    public function removeValue(mixed $value): void
+    {
+        foreach ($this->values as $key => $existing) {
+            if ($existing === $value) {
+                unset($this->values[$key]);
+                $this->values = array_values($this->values);
+            }
+        }
+    }
+
+    public function getValues(): array
+    {
+        return $this->values;
+    }
+}
+
+return (function () {
+    $autoMapper = AutoMapperBuilder::buildAutoMapper();
+
+    $from = new From();
+    $to = new To();
+    $toAdder = new ToAdder();
+    $from->values = [1, 2, 3];
+    $to->values = [4, 5, 6];
+    $toAdder->addValue(4);
+    $toAdder->addValue(5);
+    $toAdder->addValue(6);
+
+    yield 'to' => $autoMapper->map($from, $to);
+
+    yield 'toAdder' => $autoMapper->map($from, $toAdder);
+})();

tests/Fixtures/PetOwner.php

@@ -33,6 +33,7 @@ public function removePet(Pet $pet): void
 
         if ($index !== false) {
             unset($this->pets[$index]);
+            $this->pets = array_values($this->pets);
         }
     }
 }