feat(SubMapper): Now available as additional argument in `PropertyM…

…apper` & `ObjectMapper`.

CHANGELOG.md

@@ -24,6 +24,8 @@
 * feat: `ObjectMapper`
 * refactor: Compiler pass namespace.
 * refactor(`CompilerPass`): Reduce code duplication.
+* feat(`SubMapper`): Now available as additional argument in `PropertyMapper` &
+  `ObjectMapper`.
 
 ## 0.5.26
 

config/services.php

@@ -168,6 +168,7 @@
         ->args([
             '$objectToObjectMetadataFactory' => service('rekalogika.mapper.object_to_object_metadata_factory'),
             '$propertyMapperLocator' => tagged_locator('rekalogika.mapper.property_mapper'),
+            '$subMapperFactory' => service('rekalogika.mapper.sub_mapper.factory'),
         ])
         ->tag('rekalogika.mapper.transformer', ['priority' => -900]);
 

src/MapperFactory/MapperFactory.php

@@ -317,6 +317,7 @@ protected function getObjectToObjectTransformer(): TransformerInterface
             $this->objectToObjectTransformer = new ObjectToObjectTransformer(
                 objectToObjectMetadataFactory: $this->getObjectToObjectMetadataFactory(),
                 propertyMapperLocator: $this->getPropertyMapperLocator(),
+                subMapperFactory: $this->getSubMapperFactory(),
             );
         }
 

src/ServiceMethod/ServiceMethodExtraArgumentUtil.php

@@ -16,6 +16,7 @@
 use Rekalogika\Mapper\Context\Context;
 use Rekalogika\Mapper\Exception\InvalidArgumentException;
 use Rekalogika\Mapper\MainTransformer\MainTransformerInterface;
+use Rekalogika\Mapper\SubMapper\SubMapperInterface;
 
 class ServiceMethodExtraArgumentUtil
 {
@@ -54,6 +55,7 @@ public static function getExtraArguments(
             $extraArguments[] = match ($type->getName()) {
                 Context::class => ServiceMethodSpecification::ARGUMENT_CONTEXT,
                 MainTransformerInterface::class => ServiceMethodSpecification::ARGUMENT_MAIN_TRANSFORMER,
+                SubMapperInterface::class => ServiceMethodSpecification::ARGUMENT_SUB_MAPPER,
                 default => throw new InvalidArgumentException(
                     sprintf(
                         'Extra argument with type "%s" for property mapper "%s" in class "%s" is unsupported.',

src/ServiceMethod/ServiceMethodRunner.php

@@ -15,27 +15,31 @@
 
 use Psr\Container\ContainerInterface;
 use Rekalogika\Mapper\Context\Context;
-use Rekalogika\Mapper\Exception\LogicException;
 use Rekalogika\Mapper\MainTransformer\MainTransformerInterface;
+use Rekalogika\Mapper\SubMapper\SubMapperFactoryInterface;
+use Symfony\Component\PropertyInfo\Type;
 
 class ServiceMethodRunner
 {
     public static function create(
         ContainerInterface $serviceLocator,
-        MainTransformerInterface $mainTransformer
+        MainTransformerInterface $mainTransformer,
+        SubMapperFactoryInterface $subMapperFactory,
     ): self {
-        return new self($serviceLocator, $mainTransformer);
+        return new self($serviceLocator, $mainTransformer, $subMapperFactory);
     }
 
     private function __construct(
         private ContainerInterface $serviceLocator,
-        private MainTransformerInterface $mainTransformer
+        private MainTransformerInterface $mainTransformer,
+        private SubMapperFactoryInterface $subMapperFactory,
     ) {
     }
 
     public function run(
         ServiceMethodSpecification $serviceMethodSpecification,
-        mixed $input,
+        mixed $source,
+        ?Type $targetType,
         Context $context,
     ): mixed {
         /** @var object */
@@ -49,11 +53,16 @@ public function run(
             $arguments[] = match ($extraArgument) {
                 ServiceMethodSpecification::ARGUMENT_CONTEXT => $context,
                 ServiceMethodSpecification::ARGUMENT_MAIN_TRANSFORMER => $this->mainTransformer,
-                default => throw new LogicException('Unknown extra argument: ' . $extraArgument, context: $context),
+                ServiceMethodSpecification::ARGUMENT_SUB_MAPPER => $this->subMapperFactory->createSubMapper(
+                    mainTransformer: $this->mainTransformer,
+                    source: $source,
+                    targetType: $targetType,
+                    context: $context
+                ),
             };
         }
 
         /** @psalm-suppress MixedMethodCall */
-        return $service->{$method}($input, ...$arguments);
+        return $service->{$method}($source, ...$arguments);
     }
 }

src/ServiceMethod/ServiceMethodSpecification.php

@@ -17,7 +17,7 @@
 {
     public const ARGUMENT_CONTEXT = 'context';
     public const ARGUMENT_MAIN_TRANSFORMER = 'main_transformer';
-    public const ARGUMENT_NONE = 'none'; // should not be used
+    public const ARGUMENT_SUB_MAPPER = 'sub_mapper';
 
     /**
      * @param array<int,self::ARGUMENT_*> $extraArguments

src/SubMapper/Exception/CacheNotSupportedException.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of rekalogika/mapper package.
+ *
+ * (c) Priyadi Iman Nurcahyo <https://rekalogika.dev>
+ *
+ * For the full copyright and license information, please view the LICENSE file
+ * that was distributed with this source code.
+ */
+
+namespace Rekalogika\Mapper\SubMapper\Exception;
+
+use Rekalogika\Mapper\Context\Context;
+use Rekalogika\Mapper\Exception\RuntimeException;
+
+class CacheNotSupportedException extends RuntimeException
+{
+    public function __construct(Context $context)
+    {
+        parent::__construct('The "cache()" method is not supported, and should be unnecessary in a sub-mapper under a property mapper.', context: $context);
+    }
+}

src/SubMapper/Implementation/SubMapper.php

@@ -16,6 +16,7 @@
 use Rekalogika\Mapper\Context\Context;
 use Rekalogika\Mapper\Exception\UnexpectedValueException;
 use Rekalogika\Mapper\ObjectCache\ObjectCache;
+use Rekalogika\Mapper\SubMapper\Exception\CacheNotSupportedException;
 use Rekalogika\Mapper\SubMapper\SubMapperInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareTrait;
@@ -36,7 +37,7 @@ public function __construct(
         private PropertyTypeExtractorInterface $propertyTypeExtractor,
         private PropertyAccessorInterface $propertyAccessor,
         private mixed $source,
-        private Type $targetType,
+        private ?Type $targetType,
         private Context $context,
     ) {
     }
@@ -122,6 +123,10 @@ public function mapForProperty(
 
     public function cache(mixed $target): void
     {
+        if ($this->targetType === null) {
+            throw new CacheNotSupportedException($this->context);
+        }
+
         ($this->context)(ObjectCache::class)->saveTarget(
             source: $this->source,
             targetType: $this->targetType,

src/SubMapper/Implementation/SubMapperFactory.php

@@ -35,7 +35,7 @@ public function __construct(
     public function createSubMapper(
         MainTransformerInterface $mainTransformer,
         mixed $source,
-        Type $targetType,
+        ?Type $targetType,
         Context $context,
     ): SubMapperInterface {
         $subMapper = new SubMapper(

src/SubMapper/SubMapperFactoryInterface.php

@@ -25,7 +25,7 @@ interface SubMapperFactoryInterface
     public function createSubMapper(
         MainTransformerInterface $mainTransformer,
         mixed $source,
-        Type $targetType,
+        ?Type $targetType,
         Context $context
     ): SubMapperInterface;
 }

src/Transformer/ObjectMapperTransformer.php

@@ -57,15 +57,6 @@ public function transform(
             throw new InvalidArgumentException('Target type must not be null.', context: $context);
         }
 
-        // prepare subMapper
-
-        $subMapper = $this->subMapperFactory->createSubMapper(
-            mainTransformer: $this->getMainTransformer(),
-            source: $source,
-            targetType: $targetType,
-            context: $context
-        );
-
         // target class must be valid
 
         $targetClass = $targetType->getClassName();
@@ -97,12 +88,14 @@ public function transform(
 
         $serviceMethodRunner = ServiceMethodRunner::create(
             serviceLocator: $this->serviceLocator,
-            mainTransformer: $this->getMainTransformer()
+            mainTransformer: $this->getMainTransformer(),
+            subMapperFactory: $this->subMapperFactory
         );
 
         return $serviceMethodRunner->run(
             serviceMethodSpecification: $serviceMethodSpecification,
-            input: $source,
+            source: $source,
+            targetType: $targetType,
             context: $context
         );
     }

src/Transformer/ObjectToObjectTransformer.php

@@ -18,6 +18,7 @@
 use Rekalogika\Mapper\Exception\InvalidArgumentException;
 use Rekalogika\Mapper\ObjectCache\ObjectCache;
 use Rekalogika\Mapper\ServiceMethod\ServiceMethodRunner;
+use Rekalogika\Mapper\SubMapper\SubMapperFactoryInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareTrait;
 use Rekalogika\Mapper\Transformer\Contracts\TransformerInterface;
@@ -48,6 +49,7 @@ final class ObjectToObjectTransformer implements TransformerInterface, MainTrans
     public function __construct(
         private ObjectToObjectMetadataFactoryInterface $objectToObjectMetadataFactory,
         private ContainerInterface $propertyMapperLocator,
+        private SubMapperFactoryInterface $subMapperFactory,
         ReaderWriter $readerWriter = null,
     ) {
         $this->readerWriter = $readerWriter ?? new ReaderWriter();
@@ -257,12 +259,14 @@ private function transformValue(
         if ($serviceMethodSpecification = $propertyMapping->getPropertyMapper()) {
             $serviceMethodRunner = ServiceMethodRunner::create(
                 serviceLocator: $this->propertyMapperLocator,
-                mainTransformer: $this->getMainTransformer()
+                mainTransformer: $this->getMainTransformer(),
+                subMapperFactory: $this->subMapperFactory
             );
 
             return $serviceMethodRunner->run(
                 serviceMethodSpecification: $serviceMethodSpecification,
-                input: $source,
+                source: $source,
+                targetType: null,
                 context: $context
             );
         }