Merge pull request #306 from jolicode/feat/object-mapper

Be compatible with Symfony/ObjectMapper

Author: joelwurtz

CHANGELOG.md

@@ -16,6 +16,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Initial support for nested properties
 - Add support for object invokable transformer in attribute transformer
 - Add a new interface `PropertyTransformerComputeInterface` to allow property transformers with supports, to compute a value that will be fixed during code generation.
+- Support ObjectMapper attributes
+- Add an implementation for Symfony `ObjectMapperInterface` using AutoMapper
 
 ### Changed
 - [BC Break] `PropertyTransformerSupportInterface` does not use a `TypesMatching` anymore, you can get the type directly from `SourcePropertyMetadata` or `TargetPropertyMetadata`.

composer.json

@@ -46,6 +46,7 @@
         "symfony/framework-bundle": "^7.4 || ^8.0",
         "symfony/http-client": "^7.4 || ^8.0",
         "symfony/http-kernel": "^7.4 || ^8.0",
+        "symfony/object-mapper": "^7.4 || ^8.0",
         "symfony/phpunit-bridge": "^8.0",
         "symfony/serializer": "^7.4 || ^8.0",
         "symfony/stopwatch": "^7.4 || ^8.0",

phpstan.neon

@@ -4,3 +4,9 @@ parameters:
 		- src/
 
 	tmpDir: cache
+
+	ignoreErrors:
+		-
+			message: "#^Method AutoMapper\\\\ObjectMapper\\\\ObjectMapper\\:\\:map\\(\\) should return T of object but returns object\\|null\\.$#"
+			count: 1
+			path: src/ObjectMapper/ObjectMapper.php

src/AttributeReference/Reference.php

@@ -4,6 +4,11 @@
 
 namespace AutoMapper\AttributeReference;
 
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr;
+use PhpParser\Node\Name;
+use PhpParser\Node\Scalar;
+
 class Reference
 {
     public function __construct(
@@ -14,4 +19,40 @@ public function __construct(
         public ?string $methodName = null,
     ) {
     }
+
+    public function getReferenceExpression(): Expr
+    {
+        if ($this->methodName) {
+            /** ReflectionReference::fromMethod($className, $methodName) */
+            return new Expr\StaticCall(
+                new Name\FullyQualified(ReflectionReference::class),
+                'fromMethod',
+                [
+                    new Arg(new Scalar\String_($this->className)),
+                    new Arg(new Scalar\String_($this->methodName)),
+                ]
+            );
+        }
+
+        if ($this->propertyName) {
+            /** ReflectionReference::fromProperty($className, $propertyName) */
+            return new Expr\StaticCall(
+                new Name\FullyQualified(ReflectionReference::class),
+                'fromProperty',
+                [
+                    new Arg(new Scalar\String_($this->className)),
+                    new Arg(new Scalar\String_($this->propertyName)),
+                ]
+            );
+        }
+
+        /** ReflectionReference::fromClass($className) */
+        return new Expr\StaticCall(
+            new Name\FullyQualified(ReflectionReference::class),
+            'fromClass',
+            [
+                new Arg(new Scalar\String_($this->className)),
+            ]
+        );
+    }
 }

src/AutoMapper.php

@@ -130,6 +130,7 @@ public function mapCollection(iterable $collection, string $target, array $conte
     /**
      * @param ProviderInterface[]                                $providers
      * @param iterable<string|int, PropertyTransformerInterface> $propertyTransformers
+     * @param iterable<string|int, object>                       $extraMapperServices
      *
      * @return self
      */
@@ -142,6 +143,7 @@ public static function create(
         EventDispatcherInterface $eventDispatcher = new EventDispatcher(),
         iterable $providers = [],
         ?ObjectManager $objectManager = null,
+        iterable $extraMapperServices = [],
     ): AutoMapperInterface {
         if (class_exists(AttributeLoader::class)) {
             $loaderClass = new AttributeLoader();
@@ -190,6 +192,14 @@ public static function create(
             }
         }
 
+        foreach ($extraMapperServices as $key => $mapperService) {
+            if (\is_int($key)) {
+                $key = $mapperService::class;
+            }
+
+            $serviceLocator->set($key, $mapperService);
+        }
+
         $metadataRegistry = new MetadataRegistry($configuration);
         $classDiscriminatorResolver = new ClassDiscriminatorResolver();
 

src/Event/GenerateMapperEvent.php

@@ -7,19 +7,21 @@
 use AutoMapper\ConstructorStrategy;
 use AutoMapper\Metadata\Discriminator;
 use AutoMapper\Metadata\MapperMetadata;
+use AutoMapper\Metadata\Provider;
+use Symfony\Contracts\EventDispatcher\Event;
 
 /**
  * @internal
  */
-final class GenerateMapperEvent
+final class GenerateMapperEvent extends Event
 {
     /**
      * @param PropertyMetadataEvent[] $properties A list of properties to add to this mapping
      */
     public function __construct(
         public readonly MapperMetadata $mapperMetadata,
         public array $properties = [],
-        public ?string $provider = null,
+        public ?Provider $provider = null,
         public ?bool $checkAttributes = null,
         public ?ConstructorStrategy $constructorStrategy = null,
         public ?bool $allowReadOnlyTargetToPopulate = null,

src/Event/PropertyMetadataEvent.php

@@ -4,6 +4,7 @@
 
 namespace AutoMapper\Event;
 
+use AutoMapper\AttributeReference\Reference;
 use AutoMapper\Metadata\MapperMetadata;
 use AutoMapper\Transformer\TransformerInterface;
 
@@ -24,7 +25,7 @@ public function __construct(
         public ?string $dateTimeFormat = null,
         public ?bool $ignored = null,
         public ?string $ignoreReason = null,
-        public ?string $if = null,
+        public string|Reference|null $if = null,
         public ?array $groups = null,
         public ?bool $disableGroupsCheck = null,
         public int $priority = 0,

src/EventListener/ApiPlatform/JsonLdListener.php

@@ -11,6 +11,7 @@
 use AutoMapper\Event\PropertyMetadataEvent;
 use AutoMapper\Event\SourcePropertyMetadata;
 use AutoMapper\Event\TargetPropertyMetadata;
+use AutoMapper\Metadata\Provider;
 use AutoMapper\Provider\ApiPlatform\IriProvider;
 use AutoMapper\Transformer\ApiPlatform\JsonLdContextTransformer;
 use AutoMapper\Transformer\ApiPlatform\JsonLdIdTransformer;
@@ -68,7 +69,7 @@ public function __invoke(GenerateMapperEvent $event): void
         }
 
         if ($event->mapperMetadata->source === 'array' && $this->resourceClassResolver->isResourceClass($event->mapperMetadata->target)) {
-            $event->provider ??= IriProvider::class;
+            $event->provider ??= new Provider(Provider::TYPE_SERVICE, IriProvider::class);
         }
     }
 }

src/EventListener/Doctrine/DoctrineProviderListener.php

@@ -5,6 +5,7 @@
 namespace AutoMapper\EventListener\Doctrine;
 
 use AutoMapper\Event\GenerateMapperEvent;
+use AutoMapper\Metadata\Provider;
 use AutoMapper\Provider\Doctrine\DoctrineProvider;
 use Doctrine\Persistence\ObjectManager;
 
@@ -21,6 +22,6 @@ public function __invoke(GenerateMapperEvent $event): void
             return;
         }
 
-        $event->provider ??= DoctrineProvider::class;
+        $event->provider ??= new Provider(Provider::TYPE_SERVICE, DoctrineProvider::class);
     }
 }

src/EventListener/MapProviderListener.php

@@ -7,6 +7,7 @@
 use AutoMapper\Attribute\MapProvider;
 use AutoMapper\Event\GenerateMapperEvent;
 use AutoMapper\Exception\BadMapDefinitionException;
+use AutoMapper\Metadata\Provider;
 
 /**
  * @internal
@@ -60,7 +61,7 @@ public function __invoke(GenerateMapperEvent $event): void
         if (false === $eventProvider) {
             $event->provider = null;
         } else {
-            $event->provider = $eventProvider;
+            $event->provider = new Provider(Provider::TYPE_SERVICE, $eventProvider);
         }
     }
 }