feat: introduce custom transformers (#10)

jolicode · Dec 18, 2023 · 901a867 · 901a867
1 parent 50b2840
commit 901a867
Show file tree

Hide file tree

Showing 32 changed files with 759 additions and 89 deletions.
diff --git a/CHANGELOG.md b/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]
+### Added
+- [GH#10](https://github.com/jolicode/automapper/pull/10) Introduce custom transformers
 
 ## [8.1.0] - 2023-12-14
 ### Added

diff --git a/src/AutoMapper.php b/src/AutoMapper.php
@@ -5,6 +5,7 @@
 namespace AutoMapper;
 
 use AutoMapper\Exception\NoMappingFoundException;
+use AutoMapper\Extractor\ClassMethodToCallbackExtractor;
 use AutoMapper\Extractor\FromSourceMappingExtractor;
 use AutoMapper\Extractor\FromTargetMappingExtractor;
 use AutoMapper\Extractor\MapToContextPropertyInfoExtractorDecorator;
@@ -15,6 +16,8 @@
 use AutoMapper\Transformer\ArrayTransformerFactory;
 use AutoMapper\Transformer\BuiltinTransformerFactory;
 use AutoMapper\Transformer\ChainTransformerFactory;
+use AutoMapper\Transformer\CustomTransformer\CustomTransformerInterface;
+use AutoMapper\Transformer\CustomTransformer\CustomTransformersRegistry;
 use AutoMapper\Transformer\DateTimeTransformerFactory;
 use AutoMapper\Transformer\EnumTransformerFactory;
 use AutoMapper\Transformer\MultipleTransformerFactory;
@@ -58,6 +61,7 @@ class AutoMapper implements AutoMapperInterface, AutoMapperRegistryInterface, Ma
     public function __construct(
         private readonly ClassLoaderInterface $classLoader,
         private readonly ChainTransformerFactory $chainTransformerFactory,
+        public readonly CustomTransformersRegistry $customTransformersRegistry,
         private readonly ?MapperGeneratorMetadataFactoryInterface $mapperConfigurationFactory = null
     ) {
     }
@@ -147,6 +151,11 @@ public function bindTransformerFactory(TransformerFactoryInterface $transformerF
         }
     }
 
+    public function bindCustomTransformer(CustomTransformerInterface $customTransformer): void
+    {
+        $this->customTransformersRegistry->addCustomTransformer($customTransformer);
+    }
+
     public static function create(
         bool $mapPrivateProperties = false,
         ClassLoaderInterface $loader = null,
@@ -167,11 +176,14 @@ public static function create(
         $classMetadataFactory = new ClassMetadataFactory($loaderClass);
 
         if (null === $loader) {
-            $loader = new EvalLoader(new Generator(
-                (new ParserFactory())->create(ParserFactory::PREFER_PHP7),
-                new ClassDiscriminatorFromClassMetadata($classMetadataFactory),
-                $allowReadOnlyTargetToPopulate
-            ));
+            $loader = new EvalLoader(
+                new Generator(
+                    new ClassMethodToCallbackExtractor(),
+                    (new ParserFactory())->create(ParserFactory::PREFER_PHP7),
+                    new ClassDiscriminatorFromClassMetadata($classMetadataFactory),
+                    $allowReadOnlyTargetToPopulate
+                )
+            );
         }
 
         $flags = ReflectionExtractor::ALLOW_PUBLIC | ReflectionExtractor::ALLOW_PROTECTED | ReflectionExtractor::ALLOW_PRIVATE;
@@ -186,12 +198,15 @@ public static function create(
             [new MapToContextPropertyInfoExtractorDecorator($reflectionExtractor)]
         );
 
+        $customTransformerRegistry = new CustomTransformersRegistry();
+
         $transformerFactory = new ChainTransformerFactory();
         $sourceTargetMappingExtractor = new SourceTargetMappingExtractor(
             $propertyInfoExtractor,
             new MapToContextPropertyInfoExtractorDecorator($reflectionExtractor),
             $reflectionExtractor,
             $transformerFactory,
+            $customTransformerRegistry,
             $classMetadataFactory
         );
 
@@ -200,6 +215,7 @@ public static function create(
             $reflectionExtractor,
             $reflectionExtractor,
             $transformerFactory,
+            $customTransformerRegistry,
             $classMetadataFactory,
             $nameConverter
         );
@@ -209,19 +225,25 @@ public static function create(
             new MapToContextPropertyInfoExtractorDecorator($reflectionExtractor),
             $reflectionExtractor,
             $transformerFactory,
+            $customTransformerRegistry,
             $classMetadataFactory,
             $nameConverter
         );
 
-        $autoMapper = $autoRegister ? new self($loader, $transformerFactory, new MapperGeneratorMetadataFactory(
-            $sourceTargetMappingExtractor,
-            $fromSourceMappingExtractor,
-            $fromTargetMappingExtractor,
-            $classPrefix,
-            $attributeChecking,
-            $dateTimeFormat,
-            $mapPrivateProperties
-        )) : new self($loader, $transformerFactory);
+        $autoMapper = $autoRegister ? new self(
+            $loader,
+            $transformerFactory,
+            $customTransformerRegistry,
+            new MapperGeneratorMetadataFactory(
+                $sourceTargetMappingExtractor,
+                $fromSourceMappingExtractor,
+                $fromTargetMappingExtractor,
+                $classPrefix,
+                $attributeChecking,
+                $dateTimeFormat,
+                $mapPrivateProperties
+            ),
+        ) : new self($loader, $transformerFactory, $customTransformerRegistry);
 
         $transformerFactory->addTransformerFactory(new MultipleTransformerFactory($transformerFactory));
         $transformerFactory->addTransformerFactory(new NullableTransformerFactory($transformerFactory));

diff --git a/src/AutoMapperRegistryInterface.php b/src/AutoMapperRegistryInterface.php
@@ -8,6 +8,8 @@
  * Allows to retrieve a mapper.
  *
  * @author Joel Wurtz <[email protected]>
+ *
+ * @internal
  */
 interface AutoMapperRegistryInterface
 {

diff --git a/src/Extractor/AstExtractor.php → ...ractor/ClassMethodToCallbackExtractor.php b/src/Extractor/AstExtractor.php → ...ractor/ClassMethodToCallbackExtractor.php
@@ -16,12 +16,15 @@
 use PhpParser\ParserFactory;
 
 /**
+ * Extracts the code of the given method from a given class and wraps it inside a closure, in order to inject it
+ * in the generated mappers.
+ *
  * @author Nicolas Philippe <[email protected]>
  * @author Baptiste Leduc <[email protected]>
  *
  * @internal
  */
-final readonly class AstExtractor
+final readonly class ClassMethodToCallbackExtractor
 {
     private Parser $parser;
 
@@ -31,9 +34,6 @@ public function __construct(?Parser $parser = null)
     }
 
     /**
-     * Extracts the code of the given method from a given class, and wraps it inside a closure, in order to inject it
-     * in the generated mappers.
-     *
      * @param class-string $class
      * @param Arg[]        $inputParameters
      */
@@ -63,16 +63,6 @@ public function extract(string $class, string $method, array $inputParameters):
             throw new InvalidArgumentException("Input parameters and method parameters in class \"{$class}\" do not match.");
         }
 
-        foreach ($classMethod->getParams() as $key => $parameter) {
-            /** @var Expr\Variable $inputParameterValue */
-            $inputParameterValue = $inputParameters[$key]->value;
-
-            if ($parameter->var instanceof Expr\Variable && $inputParameterValue->name !== $parameter->var->name) {
-                $parameterName = \is_string($parameter->var->name) ? $parameter->var->name : 'N/A';
-                throw new InvalidArgumentException("Method parameter \"{$parameterName}\" does not match type \"{$inputParameters[$key]->getType()}\" from input parameter \"{$inputParameters[$key]->name}\" in \"{$class}::{$method}\" method.");
-            }
-        }
-
         $closureParameters = [];
         foreach ($classMethod->getParams() as $parameter) {
             if ($parameter->var instanceof Expr\Variable && $parameter->type instanceof Identifier) {

diff --git a/src/Extractor/FromSourceMappingExtractor.php b/src/Extractor/FromSourceMappingExtractor.php
@@ -6,6 +6,7 @@
 
 use AutoMapper\Exception\InvalidMappingException;
 use AutoMapper\MapperMetadataInterface;
+use AutoMapper\Transformer\CustomTransformer\CustomTransformersRegistry;
 use AutoMapper\Transformer\TransformerFactoryInterface;
 use Symfony\Component\PropertyInfo\PropertyInfoExtractorInterface;
 use Symfony\Component\PropertyInfo\PropertyReadInfo;
@@ -31,10 +32,11 @@ public function __construct(
         PropertyReadInfoExtractorInterface $readInfoExtractor,
         PropertyWriteInfoExtractorInterface $writeInfoExtractor,
         TransformerFactoryInterface $transformerFactory,
+        CustomTransformersRegistry $customTransformerRegistry,
         ClassMetadataFactoryInterface $classMetadataFactory = null,
         private readonly ?AdvancedNameConverterInterface $nameConverter = null,
     ) {
-        parent::__construct($propertyInfoExtractor, $readInfoExtractor, $writeInfoExtractor, $transformerFactory, $classMetadataFactory);
+        parent::__construct($propertyInfoExtractor, $readInfoExtractor, $writeInfoExtractor, $transformerFactory, $customTransformerRegistry, $classMetadataFactory);
     }
 
     public function getPropertiesMapping(MapperMetadataInterface $mapperMetadata): array
@@ -66,10 +68,15 @@ public function getPropertiesMapping(MapperMetadataInterface $mapperMetadata): a
             $targetTypes = [];
 
             foreach ($sourceTypes as $type) {
-                $targetTypes[] = $this->transformType($mapperMetadata->getTarget(), $type);
+                $targetType = $this->transformType($mapperMetadata->getTarget(), $type);
+
+                if ($targetType) {
+                    $targetTypes[] = $targetType;
+                }
             }
 
-            $transformer = $this->transformerFactory->getTransformer($sourceTypes, $targetTypes, $mapperMetadata);
+            $transformer = $this->customTransformerRegistry->getCustomTransformerClass($mapperMetadata, $sourceTypes, $targetTypes, $property)
+                ?? $this->transformerFactory->getTransformer($sourceTypes, $targetTypes, $mapperMetadata);
 
             if (null === $transformer) {
                 continue;

diff --git a/src/Extractor/FromTargetMappingExtractor.php b/src/Extractor/FromTargetMappingExtractor.php
@@ -6,6 +6,7 @@
 
 use AutoMapper\Exception\InvalidMappingException;
 use AutoMapper\MapperMetadataInterface;
+use AutoMapper\Transformer\CustomTransformer\CustomTransformersRegistry;
 use AutoMapper\Transformer\TransformerFactoryInterface;
 use Symfony\Component\PropertyInfo\PropertyInfoExtractorInterface;
 use Symfony\Component\PropertyInfo\PropertyReadInfo;
@@ -32,10 +33,11 @@ public function __construct(
         PropertyReadInfoExtractorInterface $readInfoExtractor,
         PropertyWriteInfoExtractorInterface $writeInfoExtractor,
         TransformerFactoryInterface $transformerFactory,
+        CustomTransformersRegistry $customTransformerRegistry,
         ClassMetadataFactoryInterface $classMetadataFactory = null,
         private readonly ?AdvancedNameConverterInterface $nameConverter = null,
     ) {
-        parent::__construct($propertyInfoExtractor, $readInfoExtractor, $writeInfoExtractor, $transformerFactory, $classMetadataFactory);
+        parent::__construct($propertyInfoExtractor, $readInfoExtractor, $writeInfoExtractor, $transformerFactory, $customTransformerRegistry, $classMetadataFactory);
     }
 
     public function getPropertiesMapping(MapperMetadataInterface $mapperMetadata): array
@@ -61,10 +63,15 @@ public function getPropertiesMapping(MapperMetadataInterface $mapperMetadata): a
             $sourceTypes = [];
 
             foreach ($targetTypes as $type) {
-                $sourceTypes[] = $this->transformType($mapperMetadata->getSource(), $type);
+                $sourceType = $this->transformType($mapperMetadata->getSource(), $type);
+
+                if ($sourceType) {
+                    $sourceTypes[] = $sourceType;
+                }
             }
 
-            $transformer = $this->transformerFactory->getTransformer($sourceTypes, $targetTypes, $mapperMetadata);
+            $transformer = $this->customTransformerRegistry->getCustomTransformerClass($mapperMetadata, $sourceTypes, $targetTypes, $property)
+                ?? $this->transformerFactory->getTransformer($sourceTypes, $targetTypes, $mapperMetadata);
 
             if (null === $transformer) {
                 continue;

diff --git a/src/Extractor/MappingExtractor.php b/src/Extractor/MappingExtractor.php
@@ -4,6 +4,7 @@
 
 namespace AutoMapper\Extractor;
 
+use AutoMapper\Transformer\CustomTransformer\CustomTransformersRegistry;
 use AutoMapper\Transformer\TransformerFactoryInterface;
 use Symfony\Component\PropertyInfo\PropertyInfoExtractorInterface;
 use Symfony\Component\PropertyInfo\PropertyReadInfo;
@@ -25,6 +26,7 @@ public function __construct(
         protected readonly PropertyReadInfoExtractorInterface $readInfoExtractor,
         protected readonly PropertyWriteInfoExtractorInterface $writeInfoExtractor,
         protected readonly TransformerFactoryInterface $transformerFactory,
+        protected readonly CustomTransformersRegistry $customTransformerRegistry,
         private readonly ?ClassMetadataFactoryInterface $classMetadataFactory = null,
     ) {
     }

diff --git a/src/Extractor/PropertyMapping.php b/src/Extractor/PropertyMapping.php
@@ -4,6 +4,7 @@
 
 namespace AutoMapper\Extractor;
 
+use AutoMapper\Transformer\CustomTransformer\CustomTransformerInterface;
 use AutoMapper\Transformer\TransformerInterface;
 
 /**
@@ -17,7 +18,8 @@ public function __construct(
         public readonly ReadAccessor $readAccessor,
         public readonly ?WriteMutator $writeMutator,
         public readonly ?WriteMutator $writeMutatorConstructor,
-        public readonly TransformerInterface $transformer,
+        /** @var TransformerInterface|class-string<CustomTransformerInterface> */
+        public readonly TransformerInterface|string $transformer,
         public readonly string $property,
         public readonly bool $checkExists = false,
         public readonly ?array $sourceGroups = null,

diff --git a/src/Extractor/SourceTargetMappingExtractor.php b/src/Extractor/SourceTargetMappingExtractor.php
@@ -42,9 +42,11 @@ public function getPropertiesMapping(MapperMetadataInterface $mapperMetadata): a
                     continue;
                 }
 
-                $sourceTypes = $this->propertyInfoExtractor->getTypes($mapperMetadata->getSource(), $property);
-                $targetTypes = $this->propertyInfoExtractor->getTypes($mapperMetadata->getTarget(), $property);
-                $transformer = $this->transformerFactory->getTransformer($sourceTypes, $targetTypes, $mapperMetadata);
+                $sourceTypes = $this->propertyInfoExtractor->getTypes($mapperMetadata->getSource(), $property) ?? [];
+                $targetTypes = $this->propertyInfoExtractor->getTypes($mapperMetadata->getTarget(), $property) ?? [];
+
+                $transformer = $this->customTransformerRegistry->getCustomTransformerClass($mapperMetadata, $sourceTypes, $targetTypes, $property)
+                    ?? $this->transformerFactory->getTransformer($sourceTypes, $targetTypes, $mapperMetadata);
 
                 if (null === $transformer) {
                     continue;