refactor: Mover more logic to TransformerRegistry.

rekalogika · Jan 13, 2024 · d6feb05 · d6feb05
1 parent bdf1494
commit d6feb05
Show file tree

Hide file tree

Showing 25 changed files with 199 additions and 80 deletions.
diff --git a/src/Contracts/MainTransformerInterface.php b/src/Contracts/MainTransformerInterface.php
@@ -18,13 +18,13 @@
 interface MainTransformerInterface
 {
     /**
-     * @param array<array-key,Type> $targetType If provided, it will be used instead of guessing the type
+     * @param array<array-key,Type> $targetTypes If provided, it will be used instead of guessing the type
      * @param array<string,mixed> $context
      */
     public function transform(
         mixed $source,
         mixed $target,
-        array $targetType,
+        array $targetTypes,
         array $context
     ): mixed;
 }
diff --git a/src/Contracts/TransformerInterface.php b/src/Contracts/TransformerInterface.php
@@ -34,7 +34,7 @@ interface TransformerInterface
     public function transform(
         mixed $source,
         mixed $target,
-        Type $sourceType,
+        ?Type $sourceType,
         ?Type $targetType,
         array $context
     ): mixed;

diff --git a/src/Exception/MissingMemberKeyTypeException.php b/src/Exception/MissingMemberKeyTypeException.php
@@ -13,13 +13,18 @@
 
 namespace Rekalogika\Mapper\Exception;
 
+use Rekalogika\Mapper\Contracts\MixedType;
 use Rekalogika\Mapper\Util\TypeUtil;
 use Symfony\Component\PropertyInfo\Type;
 
 class MissingMemberKeyTypeException extends MissingMemberTypeException
 {
-    public function __construct(Type $sourceType, Type $targetType)
+    public function __construct(?Type $sourceType, Type $targetType)
     {
+        if (null === $sourceType) {
+            $sourceType = MixedType::instance();
+        }
+
         parent::__construct(sprintf('Trying to map collection type "%s" to "%s", but the source member key is not the simple array-key type, and the target does not have the type information about the key of its child members. Usually you can fix this by adding a PHPdoc to the property containing the collection type.', TypeUtil::getDebugType($sourceType), TypeUtil::getDebugType($targetType)));
     }
 }
diff --git a/src/Exception/MissingMemberValueTypeException.php b/src/Exception/MissingMemberValueTypeException.php
@@ -13,13 +13,18 @@
 
 namespace Rekalogika\Mapper\Exception;
 
+use Rekalogika\Mapper\Contracts\MixedType;
 use Rekalogika\Mapper\Util\TypeUtil;
 use Symfony\Component\PropertyInfo\Type;
 
 class MissingMemberValueTypeException extends MissingMemberTypeException
 {
-    public function __construct(Type $sourceType, Type $targetType)
+    public function __construct(?Type $sourceType, Type $targetType)
     {
+        if (null === $sourceType) {
+            $sourceType = MixedType::instance();
+        }
+
         parent::__construct(sprintf('Trying to map collection type "%s" to "%s", but the target does not have the type information about the value of its child members. Usually you can fix this by adding a PHPdoc to the property containing the collection type.', TypeUtil::getDebugType($sourceType), TypeUtil::getDebugType($targetType)));
     }
 }
diff --git a/src/Exception/UnableToFindSuitableTransformerException.php b/src/Exception/UnableToFindSuitableTransformerException.php
@@ -20,17 +20,14 @@
 class UnableToFindSuitableTransformerException extends NotMappableValueException
 {
     /**
-     * @param Type $sourceType
-     * @param Type|array<array-key,Type|MixedType> $targetType
+     * @param array<array-key,Type|MixedType> $sourceTypes
+     * @param array<array-key,Type|MixedType> $targetTypes
      */
-    public function __construct(Type $sourceType, Type|MixedType|array $targetType)
+    public function __construct(array $sourceTypes, array $targetTypes)
     {
-        if (is_array($targetType)) {
-            $targetType = implode(', ', array_map(fn (Type|MixedType $type) => TypeUtil::getDebugType($type), $targetType));
-        } else {
-            $targetType = TypeUtil::getDebugType($targetType);
-        }
+        $sourceTypes = TypeUtil::getDebugType($sourceTypes);
+        $targetTypes = TypeUtil::getDebugType($targetTypes);
 
-        parent::__construct(sprintf('Unable to map the value "%s" to "%s"', TypeUtil::getDebugType($sourceType), $targetType));
+        parent::__construct(sprintf('Unable to find a suitable transformer for mapping the source types "%s" to the target types "%s"', $sourceTypes, $sourceTypes));
     }
 }
diff --git a/src/MainTransformer.php b/src/MainTransformer.php
@@ -74,17 +74,17 @@ public static function getObjectCache(
     public function transform(
         mixed $source,
         mixed $target,
-        array $targetType,
+        array $targetTypes,
         array $context
     ): mixed {
         // if targettype is not provided, guess it from target
         // if the target is also missing then the target is mixed
 
-        if (count($targetType) === 0) {
+        if (count($targetTypes) === 0) {
             if ($target === null) {
-                $targetType = [MixedType::instance()];
+                $targetTypes = [MixedType::instance()];
             } else {
-                $targetType = [$this->typeResolver->guessTypeFromVariable($target)];
+                $targetTypes = [$this->typeResolver->guessTypeFromVariable($target)];
             }
         }
 
@@ -99,8 +99,8 @@ public function transform(
 
         $simpleTargetTypes = [];
 
-        foreach ($targetType as $singleTargetType) {
-            foreach ($this->typeResolver->getSimpleTypes($singleTargetType) as $simpleType) {
+        foreach ($targetTypes as $targetType) {
+            foreach ($this->typeResolver->getSimpleTypes($targetType) as $simpleType) {
                 $simpleTargetTypes[] = $simpleType;
             }
         }
@@ -111,26 +111,33 @@ public function transform(
 
         // iterate simple target types and find the suitable transformer
 
-        foreach ($simpleTargetTypes as $singleTargetType) {
-            $transformers = $this->transformerRegistry
-                ->findBySourceAndTargetType($sourceType, $singleTargetType);
+        $searchResult = $this->transformerRegistry
+            ->findBySourceAndTargetTypes(
+                [$sourceType],
+                $simpleTargetTypes
+            );
 
-            foreach ($transformers as $transformer) {
-                $transformer = $this->processTransformer($transformer);
+        foreach ($searchResult as $searchEntry) {
+            $transformer = $this->processTransformer($searchEntry->getTransformer());
 
-                /** @var mixed */
-                $result = $transformer->transform(
-                    source: $source,
-                    target: $target,
-                    sourceType: $sourceType,
-                    targetType: $singleTargetType instanceof MixedType ? null : $singleTargetType,
-                    context: $context
-                );
+            $sourceType = $searchEntry->getSourceType();
+            $sourceTypeForTransformer = $sourceType instanceof MixedType ? null : $sourceType;
 
-                return $result;
-            }
+            $targetTypes = $searchEntry->getTargetType();
+            $targetTypeForTransformer = $targetTypes instanceof MixedType ? null : $targetTypes;
+
+            /** @var mixed */
+            $result = $transformer->transform(
+                source: $source,
+                target: $target,
+                sourceType: $sourceTypeForTransformer,
+                targetType: $targetTypeForTransformer,
+                context: $context
+            );
+
+            return $result;
         }
 
-        throw new UnableToFindSuitableTransformerException($sourceType, $targetType);
+        throw new UnableToFindSuitableTransformerException([$sourceType], $simpleTargetTypes);
     }
 }
diff --git a/src/Mapper.php b/src/Mapper.php
@@ -52,7 +52,7 @@ public function map(mixed $source, object|string $target, array $context = []):
         $target = $this->transformer->transform(
             source: $source,
             target: $target,
-            targetType: [$targetType],
+            targetTypes: [$targetType],
             context: $context
         );
 

diff --git a/src/MethodMapper/ClassMethodTransformer.php b/src/MethodMapper/ClassMethodTransformer.php
@@ -38,7 +38,7 @@ public function __construct(
     public function transform(
         mixed $source,
         mixed $target,
-        Type $sourceType,
+        ?Type $sourceType,
         ?Type $targetType,
         array $context
     ): mixed {

diff --git a/src/Transformer/ArrayToObjectTransformer.php b/src/Transformer/ArrayToObjectTransformer.php
@@ -38,7 +38,7 @@ public function __construct(
     public function transform(
         mixed $source,
         mixed $target,
-        Type $sourceType,
+        ?Type $sourceType,
         ?Type $targetType,
         array $context
     ): mixed {

diff --git a/src/Transformer/CopyTransformer.php b/src/Transformer/CopyTransformer.php
@@ -23,7 +23,7 @@ final class CopyTransformer implements TransformerInterface
     public function transform(
         mixed $source,
         mixed $target,
-        Type $sourceType,
+        ?Type $sourceType,
         ?Type $targetType,
         array $context
     ): mixed {

diff --git a/src/Transformer/DateTimeTransformer.php b/src/Transformer/DateTimeTransformer.php
@@ -29,7 +29,7 @@ final class DateTimeTransformer implements TransformerInterface
     public function transform(
         mixed $source,
         mixed $target,
-        Type $sourceType,
+        ?Type $sourceType,
         ?Type $targetType,
         array $context
     ): mixed {

diff --git a/src/Transformer/NullTransformer.php b/src/Transformer/NullTransformer.php
@@ -25,7 +25,7 @@ final class NullTransformer implements TransformerInterface
     public function transform(
         mixed $source,
         mixed $target,
-        Type $sourceType,
+        ?Type $sourceType,
         ?Type $targetType,
         array $context
     ): mixed {

diff --git a/src/Transformer/ObjectToArrayTransformer.php b/src/Transformer/ObjectToArrayTransformer.php
@@ -35,7 +35,7 @@ public function __construct(
     public function transform(
         mixed $source,
         mixed $target,
-        Type $sourceType,
+        ?Type $sourceType,
         ?Type $targetType,
         array $context
     ): mixed {

diff --git a/src/Transformer/ObjectToObjectTransformer.php b/src/Transformer/ObjectToObjectTransformer.php
@@ -54,7 +54,7 @@ public function __construct(
     public function transform(
         mixed $source,
         mixed $target,
-        Type $sourceType,
+        ?Type $sourceType,
         ?Type $targetType,
         array $context
     ): mixed {
@@ -169,7 +169,7 @@ private function resolveTargetPropertyValue(
         $targetPropertyValue = $this->mainTransformer?->transform(
             source: $sourcePropertyValue,
             target: $targetPropertyValue,
-            targetType: $targetPropertyTypes,
+            targetTypes: $targetPropertyTypes,
             context: $context
         );
 

diff --git a/src/Transformer/ObjectToStringTransformer.php b/src/Transformer/ObjectToStringTransformer.php
@@ -24,7 +24,7 @@ final class ObjectToStringTransformer implements TransformerInterface
     public function transform(
         mixed $source,
         mixed $target,
-        Type $sourceType,
+        ?Type $sourceType,
         ?Type $targetType,
         array $context
     ): mixed {

diff --git a/src/Transformer/ScalarToScalarTransformer.php b/src/Transformer/ScalarToScalarTransformer.php
@@ -25,7 +25,7 @@ final class ScalarToScalarTransformer implements TransformerInterface
     public function transform(
         mixed $source,
         mixed $target,
-        Type $sourceType,
+        ?Type $sourceType,
         ?Type $targetType,
         array $context
     ): mixed {

diff --git a/src/Transformer/StringToBackedEnumTransformer.php b/src/Transformer/StringToBackedEnumTransformer.php
@@ -24,7 +24,7 @@ final class StringToBackedEnumTransformer implements TransformerInterface
     public function transform(
         mixed $source,
         mixed $target,
-        Type $sourceType,
+        ?Type $sourceType,
         ?Type $targetType,
         array $context
     ): mixed {

diff --git a/src/Transformer/TraversableToArrayAccessTransformer.php b/src/Transformer/TraversableToArrayAccessTransformer.php
@@ -41,7 +41,7 @@ public function __construct(
     public function transform(
         mixed $source,
         mixed $target,
-        Type $sourceType,
+        ?Type $sourceType,
         ?Type $targetType,
         array $context
     ): mixed {
@@ -121,7 +121,7 @@ public function transform(
                 $targetMemberKey = $this->getMainTransformer()->transform(
                     source: $sourceMemberKey,
                     target: null,
-                    targetType: $targetMemberKeyType,
+                    targetTypes: $targetMemberKeyType,
                     context: $context,
                 );
             }
@@ -145,7 +145,7 @@ public function transform(
             $targetMemberValue = $this->getMainTransformer()->transform(
                 source: $sourceMemberValue,
                 target: $targetMemberValue,
-                targetType: $targetMemberValueType,
+                targetTypes: $targetMemberValueType,
                 context: $context,
             );
 

diff --git a/src/Transformer/TraversableToTraversableTransformer.php b/src/Transformer/TraversableToTraversableTransformer.php
@@ -40,7 +40,7 @@ public function __construct(
     public function transform(
         mixed $source,
         mixed $target,
-        Type $sourceType,
+        ?Type $sourceType,
         ?Type $targetType,
         array $context
     ): mixed {
@@ -132,7 +132,7 @@ public function transform(
                     $targetPropertyKey = $this->getMainTransformer()->transform(
                         source: $sourcePropertyKey,
                         target: null,
-                        targetType: $targetMemberKeyType,
+                        targetTypes: $targetMemberKeyType,
                         context: $context,
                     );
                 }
@@ -144,7 +144,7 @@ public function transform(
                 $targetPropertyValue = $this->getMainTransformer()->transform(
                     source: $sourcePropertyValue,
                     target: null,
-                    targetType: $targetMemberValueType,
+                    targetTypes: $targetMemberValueType,
                     context: $context,
                 );
 

diff --git a/src/TransformerRegistry/SearchResult.php b/src/TransformerRegistry/SearchResult.php
@@ -0,0 +1,33 @@
+<?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\TransformerRegistry;
+
+/**
+ * @implements \IteratorAggregate<int,SearchResultEntry>
+ */
+class SearchResult implements \IteratorAggregate
+{
+    /**
+     * @param \Traversable<int,SearchResultEntry> $entries
+     */
+    public function __construct(
+        private \Traversable $entries
+    ) {
+    }
+
+    public function getIterator(): \Traversable
+    {
+        return $this->entries;
+    }
+}