fix(bundle): allow to set remove default property config (#278)

Author: Korbeil

CHANGELOG.md

@@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Fixed
+- [GH#278](https://github.com/jolicode/automapper/pull/278) Allow to set remove default property config in symfony bundle
 
 ## [9.4.0] - 2025-05-30
 ### Added

docs/bundle/configuration.md

@@ -15,6 +15,7 @@ automapper:
   auto_register: true
   map_private_properties: true
   allow_readonly_target_to_populate: false
+  remove_default_properties: true
   normalizer:
     enabled: false
     only_registered_mapping: false
@@ -56,6 +57,10 @@ automapper:
 * `map_private_properties` (default: `true`): If the mapper should map private properties;
 * `allow_readonly_target_to_populate` (default: `false`): Will throw an exception if you use a readonly class as target
   to populate if set to `false`.
+* `remove_default_properties` (default: `false`): Before 9.4 when renaming a property, the mapper would keep the old
+  property name in the target object which resulted in a duplicated property, this option will remove the default properties 
+  from the target object when mapping and will always be true in next major version, you should set it to `true` to avoid
+  any issues in the future;
 * `normalizer`:  Configure how the normalizer should behave;
     * `enabled` (default: `false`): If the normalizer should be enabled;
     * `only_registered_mapping` (default: `false`): If the normalizer should only use the registered mapping;

src/Symfony/Bundle/DependencyInjection/AutoMapperExtension.php

@@ -14,6 +14,7 @@
 use AutoMapper\Loader\EvalLoader;
 use AutoMapper\Loader\FileLoader;
 use AutoMapper\Loader\FileReloadStrategy;
+use AutoMapper\Metadata\MetadataFactory;
 use AutoMapper\Normalizer\AutoMapperNormalizer;
 use AutoMapper\Provider\ProviderInterface;
 use AutoMapper\Symfony\Bundle\CacheWarmup\CacheWarmer;
@@ -73,6 +74,14 @@ public function load(array $configs, ContainerBuilder $container): void
             )))
         ;
 
+        if (!$config['remove_default_properties']) {
+            trigger_deprecation('jolicode/automapper', '9.4', 'Not removing default properties is deprecated and will be always true in future versions, set \'remove_default_properties\' config parameter to true, and check that your mapping is correct.', __CLASS__);
+        }
+
+        $container->getDefinition(MetadataFactory::class)
+            ->setArgument('$removeDefaultProperties', $config['remove_default_properties'])
+        ;
+
         if ($config['map_private_properties']) {
             $container->getDefinition('automapper.property_info.reflection_extractor')
                 ->replaceArgument('$accessFlags', ReflectionExtractor::ALLOW_PUBLIC | ReflectionExtractor::ALLOW_PRIVATE | ReflectionExtractor::ALLOW_PROTECTED);

src/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -32,6 +32,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->booleanNode('auto_register')->defaultTrue()->end()
                 ->booleanNode('map_private_properties')->defaultTrue()->end()
                 ->booleanNode('allow_readonly_target_to_populate')->defaultFalse()->end()
+                ->booleanNode('remove_default_properties')->defaultFalse()->end()
                 ->arrayNode('normalizer')
                     ->children()
                         ->booleanNode('enabled')->defaultFalse()->end()