feat: Planned Matcher logic

Author: patrykbaszak

src/Mapper/Application/Contract/MapperInterface.php

@@ -4,6 +4,7 @@
 
 namespace PBaszak\UltraMapper\Mapper\Application\Contract;
 
+use PBaszak\UltraMapper\Mapper\Application\Model\Context;
 use PBaszak\UltraMapper\Mapper\Application\Model\Envelope;
 
 interface MapperInterface
@@ -21,7 +22,7 @@ interface MapperInterface
      * @param string        $blueprintClass The class of the blueprint. Defines properties to map.
      * @param TypeInterface $from           you have to define what type are you passing in the $data
      * @param TypeInterface $to             you have to define what type you want to get
-     * @param bool          $isCollection   if the data is a collection of objects or arrays then set this to true
+     * @param Context       $context        if the data is a collection of objects or arrays then set this to true
      *
      * @return Envelope the mapped data wrapped in the Evelope
      */
@@ -31,6 +32,6 @@ public function map(
         string $blueprintClass,
         TypeInterface $from,
         TypeInterface $to,
-        bool $isCollection = false
+        Context $context,
     ): Envelope;
 }

src/Mapper/Application/Model/Context.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PBaszak\UltraMapper\Mapper\Application\Model;
+
+class Context
+{
+    /**
+     * @param string[] $groups
+     */
+    public function __construct(
+        /** @var string[] $groups */
+        public array $groups = ['Default'],
+        public bool $isCollection = false,
+    ) {
+    }
+}

src/Mapper/Application/Service/Mapper.php

@@ -10,6 +10,7 @@
 use PBaszak\UltraMapper\Mapper\Application\Contract\MapperInterface;
 use PBaszak\UltraMapper\Mapper\Application\Contract\ModificatorInterface;
 use PBaszak\UltraMapper\Mapper\Application\Contract\TypeInterface;
+use PBaszak\UltraMapper\Mapper\Application\Model\Context;
 use PBaszak\UltraMapper\Mapper\Application\Model\Envelope;
 use PBaszak\UltraMapper\Mapper\Domain\Contract\ClassMapperInterface;
 use PBaszak\UltraMapper\Mapper\Domain\Resolver\MapperResolver;
@@ -50,9 +51,9 @@ public function map(
         string $blueprintClass,
         TypeInterface $from,
         TypeInterface $to,
-        bool $isCollection = false
+        Context $context = new Context(),
     ): Envelope {
-        $mapper = $this->getMapper($blueprintClass, $from, $to, $isCollection);
+        $mapper = $this->getMapper($blueprintClass, $from, $to, $context);
 
         return $mapper->map($data, $output);
     }
@@ -64,7 +65,7 @@ protected function getMapper(
         string $blueprintClass,
         TypeInterface $from,
         TypeInterface $to,
-        bool $isCollection = false
+        Context $context,
     ): ClassMapperInterface {
         $shortName = $this->mapperResolver->getMapperShortClassName(...func_get_args(), ...$this->modificator->getModifiers());
 
@@ -80,7 +81,7 @@ protected function getMapper(
                 $this->modificator->prepareBlueprint($blueprint, $processType, $processUse);
             }
 
-            (new Matcher())->matchBlueprints($processType, ...$blueprints);
+            (new Matcher())->matchBlueprints($context, $processType, ...$blueprints);
 
             // modify blueprints
 

src/Mapper/Domain/Contract/MatcherInterface.php

@@ -6,15 +6,21 @@
 
 use PBaszak\UltraMapper\Blueprint\Application\Model\Blueprint;
 use PBaszak\UltraMapper\Mapper\Application\Contract\MapperInterface;
+use PBaszak\UltraMapper\Mapper\Application\Model\Context;
 use PBaszak\UltraMapper\Mapper\Domain\Model\Process;
 
 interface MatcherInterface
 {
     public const OPTION_ID = 'id';
-    public const OPTION_PATH = 'path';
     public const OPTION_ORIGIN = MapperInterface::BLUEPRINT_PROCESS_USE;
     public const OPTION_SOURCE = MapperInterface::FROM_PROCESS_USE;
     public const OPTION_TARGET = MapperInterface::TO_PROCESS_USE;
 
-    public function matchBlueprints(Process $processType, Blueprint $origin, Blueprint $source, Blueprint $target): void;
+    public function matchBlueprints(
+        Context $context,
+        Process $processType,
+        Blueprint $origin,
+        Blueprint $source,
+        Blueprint $target
+    ): void;
 }

src/Mapper/Domain/Service/Matcher.php

@@ -7,6 +7,7 @@
 use PBaszak\UltraMapper\Blueprint\Application\Model\Assets\ClassBlueprint;
 use PBaszak\UltraMapper\Blueprint\Application\Model\Assets\PropertyBlueprint;
 use PBaszak\UltraMapper\Blueprint\Application\Model\Blueprint;
+use PBaszak\UltraMapper\Mapper\Application\Model\Context;
 use PBaszak\UltraMapper\Mapper\Domain\Contract\MatcherInterface;
 use PBaszak\UltraMapper\Mapper\Domain\Exception\PropertyNotMatchedException;
 use PBaszak\UltraMapper\Mapper\Domain\Model\Process;
@@ -22,7 +23,7 @@ class Matcher implements MatcherInterface
         SameNameStrategy::class,
     ];
 
-    public function matchBlueprints(Process $processType, Blueprint $origin, Blueprint $source, Blueprint $target): void
+    public function matchBlueprints(Context $context, Process $processType, Blueprint $origin, Blueprint $source, Blueprint $target): void
     {
         $this->addLinks($origin, $source, $target);
         $rootBlueprints = array_map(

src/Mapper/Domain/Service/matcher.md

@@ -0,0 +1,9 @@
+# Matcher
+
+1. translacja atrybutów z Symfony Serializera / JMS Serializera na atrybuty z Ultra Mapper Serializer
+2. sprawdzenie blueprintów pod kątem wystąpienia pętli i zasugerowanie stosowania atrybutu `MaxDepth`, jeśli pętla zostanie wykryta
+3. iterowanie rekurencyjne po właściwościach:
+    1. Wyrzucanie właściwości niezgodnych z grupą `Groups` lub z atrybutem `Ignore`.
+    2. matchowanie właściwości po nazwach i atrybucie `TargetProperty`
+    3. sprawdzanie typów właściwości, sprawdzenie czy się matchują, jeśli nie, to exception. Jeśli tak to ekstra. Jeśli są to klasy nie będące prostymi obiektami `SimpleObject`, to iterowanie po ich właściwościach
+4. wstępne matchowanie klas z typów. Decyduje zagnieżdżenie z `TargetProperty`. Jeśli klas jest wiele to określany jest procent podobieństwa, gdzie tożsame klasy zamykają temat porównania, a brak tożsamości prowadzi do oparcia się o procentową zgodność i wybierana jest klasa o wyższej zgodności i te są ostatecznie matchowane. W przypadku wielu klas, typu unii, powinien zostać zdefiniowany atrybut `Discriminator`.