feat(extractor): remove default property mapping, if at least one attribute is set (#239)

Fix #238

This does not change the current behavior as it's a BC break for
existing app, however it add a flag and deprecation notice that warn
user that this behavior will change in the next major release.

I also use ignore : true so we can show why it's not mapped for the user

Author: joelwurtz

src/AutoMapper.php

@@ -147,6 +147,7 @@ public static function create(
         ?ExpressionLanguageProvider $expressionLanguageProvider = null,
         EventDispatcherInterface $eventDispatcher = new EventDispatcher(),
         iterable $providers = [],
+        bool $removeDefaultProperties = false,
     ): AutoMapperInterface {
         if (\count($transformerFactories) > 0) {
             trigger_deprecation('jolicode/automapper', '9.0', 'The "$transformerFactories" property will be removed in version 10.0, AST transformer factories must be included within AutoMapper.', __METHOD__);
@@ -189,7 +190,8 @@ public static function create(
             $classMetadataFactory,
             $nameConverter,
             $expressionLanguage,
-            $eventDispatcher
+            $eventDispatcher,
+            $removeDefaultProperties,
         );
 
         $mapperGenerator = new MapperGenerator(

src/Event/PropertyMetadataEvent.php

@@ -30,6 +30,7 @@ public function __construct(
         public ?array $groups = null,
         public ?bool $disableGroupsCheck = null,
         public int $priority = 0,
+        public readonly bool $isFromDefaultExtractor = false,
     ) {
     }
 }

src/Metadata/MetadataFactory.php

@@ -74,7 +74,11 @@ public function __construct(
         private readonly EventDispatcherInterface $eventDispatcher,
         public readonly MetadataRegistry $metadataRegistry,
         private readonly ClassDiscriminatorResolver $classDiscriminatorResolver,
+        private readonly bool $removeDefaultProperties = false,
     ) {
+        if (!$this->removeDefaultProperties) {
+            trigger_deprecation('jolicode/automapper', '9.4', 'Not removing default properties is deprecated, pass this parameter to true and add necessary attributes if needed', __CLASS__);
+        }
     }
 
     /**
@@ -192,7 +196,7 @@ private function createGeneratorMetadata(MapperMetadata $mapperMetadata): Genera
 
         // First get properties from the source
         foreach ($extractor->getProperties($mapperMetadata->source) as $property) {
-            $propertyEvent = new PropertyMetadataEvent($mapperMetadata, new SourcePropertyMetadataEvent($property), new TargetPropertyMetadataEvent($property));
+            $propertyEvent = new PropertyMetadataEvent($mapperMetadata, new SourcePropertyMetadataEvent($property), new TargetPropertyMetadataEvent($property), isFromDefaultExtractor: true);
 
             $this->eventDispatcher->dispatch($propertyEvent);
 
@@ -204,7 +208,7 @@ private function createGeneratorMetadata(MapperMetadata $mapperMetadata): Genera
                 continue;
             }
 
-            $propertyEvent = new PropertyMetadataEvent($mapperMetadata, new SourcePropertyMetadataEvent($property), new TargetPropertyMetadataEvent($property));
+            $propertyEvent = new PropertyMetadataEvent($mapperMetadata, new SourcePropertyMetadataEvent($property), new TargetPropertyMetadataEvent($property), isFromDefaultExtractor: true);
 
             $this->eventDispatcher->dispatch($propertyEvent);
 
@@ -214,6 +218,15 @@ private function createGeneratorMetadata(MapperMetadata $mapperMetadata): Genera
         foreach ($mapperEvent->properties as $propertyEvent) {
             $this->eventDispatcher->dispatch($propertyEvent);
 
+            if ($this->removeDefaultProperties) {
+                foreach ($propertyEvents as $propertyEventExisting) {
+                    if ($propertyEventExisting->source->property === $propertyEvent->source->property && $propertyEventExisting->isFromDefaultExtractor && !$propertyEventExisting->ignored) {
+                        $propertyEventExisting->ignored = true;
+                        $propertyEventExisting->ignoreReason = 'Default property is ignored because a custom property is defined.';
+                    }
+                }
+            }
+
             $propertyEvents[$propertyEvent->target->property] = $propertyEvent;
         }
 
@@ -340,6 +353,7 @@ public static function create(
         AdvancedNameConverterInterface|NameConverterInterface|null $nameConverter = null,
         ExpressionLanguage $expressionLanguage = new ExpressionLanguage(),
         EventDispatcherInterface $eventDispatcher = new EventDispatcher(),
+        bool $removeDefaultProperties = false,
     ): self {
         // Create property info extractors
         $flags = ReflectionExtractor::ALLOW_PUBLIC;
@@ -428,6 +442,7 @@ public static function create(
             $eventDispatcher,
             $metadataRegistry,
             $classDiscriminatorResolver,
+            $removeDefaultProperties,
         );
     }
 }

tests/AutoMapperBuilder.php

@@ -28,6 +28,7 @@ public static function buildAutoMapper(
         string $dateTimeFormat = \DateTimeInterface::RFC3339,
         ?ExpressionLanguageProvider $expressionLanguageProvider = null,
         EventDispatcherInterface $eventDispatcher = new EventDispatcher(),
+        bool $removeDefaultProperties = false,
     ): AutoMapper {
         $skipCacheRemove = $_SERVER['SKIP_CACHE_REMOVE'] ?? false;
 
@@ -52,6 +53,7 @@ classPrefix: $classPrefix,
             expressionLanguageProvider: $expressionLanguageProvider,
             eventDispatcher: $eventDispatcher,
             providers: $providers,
+            removeDefaultProperties: $removeDefaultProperties,
         );
     }
 }

tests/Fixtures/User.php

@@ -4,11 +4,14 @@
 
 namespace AutoMapper\Tests\Fixtures;
 
+use AutoMapper\Attribute\MapTo;
+
 class User
 {
     /**
      * @var int
      */
+    #[MapTo(target: 'array', property: '_id')]
     private $id;
 
     /**

tests/Normalizer/AutoMapperNormalizerTest.php

@@ -68,6 +68,26 @@ public function testNormalize(): void
         $normalized = $this->normalizer->normalize($object);
         self::assertIsArray($normalized);
         self::assertEquals($expected['id'], $normalized['id']);
+        self::assertEquals($expected['id'], $normalized['_id']);
+        self::assertEquals($expected['name'], $normalized['name']);
+        self::assertEquals($expected['age'], $normalized['age']);
+    }
+
+    public function testNormalizeNoDefaultProperties(): void
+    {
+        $object = new Fixtures\User(1, 'Jack', 37);
+        $expected = ['id' => 1, 'name' => 'Jack', 'age' => 37];
+
+        $normalizer = new AutoMapperNormalizer(AutoMapperBuilder::buildAutoMapper(
+            mapPrivatePropertiesAndMethod: true,
+            classPrefix: 'AutoMapperNoDefaultProperties_',
+            removeDefaultProperties: true
+        ));
+        $normalized = $normalizer->normalize($object);
+
+        self::assertIsArray($normalized);
+        self::assertArrayNotHasKey('id', $normalized);
+        self::assertEquals($expected['id'], $normalized['_id']);
         self::assertEquals($expected['name'], $normalized['name']);
         self::assertEquals($expected['age'], $normalized['age']);
     }