fix: Code fixed - recursive loop checker work correctly

patrykbaszak · patrykbaszak · commit d2784ba294a4 · 2024-07-21T16:43:26.000+02:00
diff --git a/src/Mapper/Application/Attribute/Accessor.php b/src/Mapper/Application/Attribute/Accessor.php
@@ -20,9 +20,7 @@ class Accessor implements AttributeInterface
     public function __construct(
         public readonly ?string $getter = null,
         public readonly ?string $setter = null,
-        public bool $useForDenormalization = true,
-        public bool $useForMapping = false,
-        public bool $useForNormalization = true,
+        public readonly int $processType = self::DENORMALIZATION | self::NORMALIZATION | self::TRANSFORMATION | self::MAPPING,
         public readonly array $options = []
     ) {
     }
@@ -31,4 +29,9 @@ public function validate(\ReflectionProperty|\ReflectionParameter|\ReflectionCla
     {
         // todo implement
     }
+
+    public function getProcessType(): int
+    {
+        return $this->processType;
+    }
 }
diff --git a/src/Mapper/Application/Attribute/ApplyToCollectionItem.php b/src/Mapper/Application/Attribute/ApplyToCollectionItem.php
@@ -50,4 +50,9 @@ public function validate(\ReflectionProperty|\ReflectionParameter|\ReflectionCla
         //     }
         // }
     }
+
+    public function getProcessType(): int
+    {
+        return self::MAPPING | self::DENORMALIZATION | self::NORMALIZATION | self::TRANSFORMATION;
+    }
 }
diff --git a/src/Mapper/Application/Attribute/Callback.php b/src/Mapper/Application/Attribute/Callback.php
@@ -95,9 +95,7 @@ public function __construct(
          *          - Stage 4 Arbitrary callback to complete property mapping. Ex. logging
          */
         public int $stage,
-        public bool $useForDenormalization = true,
-        public bool $useForMapping = false,
-        public bool $useForNormalization = false,
+        public int $processType,
         /**
          * @var int $priority               The priority of the callback. The higher the value, the earlier the callback will be executed.
          */
@@ -139,4 +137,9 @@ public function validate(\ReflectionProperty|\ReflectionParameter|\ReflectionCla
         //     $this->throwException('You have to use {{var.name}} and {{source.getter}} placeholders in your callback string.', 5956, $reflection);
         // }
     }
+
+    public function getProcessType(): int
+    {
+        return $this->processType;
+    }
 }
diff --git a/src/Mapper/Application/Attribute/Discriminator.php b/src/Mapper/Application/Attribute/Discriminator.php
@@ -37,4 +37,9 @@ public function validate(\ReflectionProperty|\ReflectionParameter|\ReflectionCla
     {
         // todo implement
     }
+
+    public function getProcessType(): int
+    {
+        return self::MAPPING | self::DENORMALIZATION | self::NORMALIZATION | self::TRANSFORMATION;
+    }
 }
diff --git a/src/Mapper/Application/Attribute/Groups.php b/src/Mapper/Application/Attribute/Groups.php
@@ -12,10 +12,11 @@ class Groups implements AttributeInterface
 {
     use ThrowAttributeValidationExceptionTrait;
 
+    /** @var string[] */
     public array $groups;
 
     /**
-     * @param string|array         $groups  the groups that the property should be included in
+     * @param string|array<string> $groups  the groups that the property should be included in
      * @param array<string, mixed> $options Options are for modificators of the mapping process. If You need them, You can use them.
      */
     public function __construct(
diff --git a/src/Mapper/Application/Attribute/MaxDepth.php b/src/Mapper/Application/Attribute/MaxDepth.php
@@ -6,25 +6,12 @@
 
 use PBaszak\UltraMapper\Mapper\Application\Contract\AttributeInterface;
 use PBaszak\UltraMapper\Mapper\Application\Exception\ThrowAttributeValidationExceptionTrait;
-use PBaszak\UltraMapper\Mapper\Domain\Model\Process;
 
 #[\Attribute(\Attribute::TARGET_PROPERTY)]
 class MaxDepth implements AttributeInterface
 {
     use ThrowAttributeValidationExceptionTrait;
 
-    public const DENORMALIZATION = 1; // 0001
-    public const NORMALIZATION = 2; // 0010
-    public const MAPPING = 4; // 0100
-    public const TRANSFORMATION = 8; // 1000
-
-    public const PROCESS_TYPE_MAP = [
-        Process::DENORMALIZATION_PROCESS => self::DENORMALIZATION,
-        Process::NORMALIZATION_PROCESS => self::NORMALIZATION,
-        Process::MAPPING_PROCESS => self::MAPPING,
-        Process::TRANSFORMATION_PROCESS => self::TRANSFORMATION,
-    ];
-
     /**
      * @param int                  $maxDepth the maximum depth of the object graph that should be mapped
      * @param mixed                $fillWith the value that should be used to fill the property if the depth is exceeded
diff --git a/src/Mapper/Application/Attribute/SimpleObject.php b/src/Mapper/Application/Attribute/SimpleObject.php
@@ -34,4 +34,9 @@ public function validate(\ReflectionProperty|\ReflectionParameter|\ReflectionCla
     {
         // todo implement
     }
+
+    public function getProcessType(): int
+    {
+        return self::MAPPING | self::DENORMALIZATION | self::NORMALIZATION | self::TRANSFORMATION;
+    }
 }
diff --git a/src/Mapper/Application/Attribute/TargetProperty.php b/src/Mapper/Application/Attribute/TargetProperty.php
diff --git a/src/Mapper/Application/Attribute/TargetPropertyName.php b/src/Mapper/Application/Attribute/TargetPropertyName.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PBaszak\UltraMapper\Mapper\Application\Attribute;
+
+use PBaszak\UltraMapper\Mapper\Application\Contract\AttributeInterface;
+use PBaszak\UltraMapper\Mapper\Application\Exception\ThrowAttributeValidationExceptionTrait;
+
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_PARAMETER | \Attribute::IS_REPEATABLE)]
+class TargetPropertyName implements AttributeInterface
+{
+    use ThrowAttributeValidationExceptionTrait;
+
+    /**
+     * @param string               $name    the name of the target property
+     * @param array<string, mixed> $options Options are for modificators of the mapping process. If You need them, You can use them.
+     */
+    public function __construct(
+        public readonly string $name,
+        public readonly int $processType = self::DENORMALIZATION | self::NORMALIZATION | self::TRANSFORMATION | self::MAPPING,
+        public readonly array $options = []
+    ) {
+    }
+
+    public function validate(\ReflectionProperty|\ReflectionParameter|\ReflectionClass $reflection): void
+    {
+        // there cannot be two target properties with the same processType
+        // todo implement
+    }
+
+    public function getProcessType(): int
+    {
+        return $this->processType;
+    }
+}
diff --git a/src/Mapper/Application/Attribute/TargetPropertyPath.php b/src/Mapper/Application/Attribute/TargetPropertyPath.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PBaszak\UltraMapper\Mapper\Application\Attribute;
+
+use PBaszak\UltraMapper\Mapper\Application\Contract\AttributeInterface;
+use PBaszak\UltraMapper\Mapper\Application\Exception\ThrowAttributeValidationExceptionTrait;
+
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::IS_REPEATABLE)]
+class TargetPropertyPath implements AttributeInterface
+{
+    use ThrowAttributeValidationExceptionTrait;
+
+    /**
+     * @param ?string              $path    The path to the target property. If null, the name of the target property is used.
+     * @param array<string, mixed> $options Options are for modificators of the mapping process. If You need them, You can use them.
+     */
+    public function __construct(
+        public readonly ?string $path = null,
+        public readonly int $processType = self::DENORMALIZATION | self::NORMALIZATION | self::TRANSFORMATION | self::MAPPING,
+        public readonly array $options = []
+    ) {
+    }
+
+    public function validate(\ReflectionProperty|\ReflectionParameter|\ReflectionClass $reflection): void
+    {
+        // there cannot be two target properties with the same processType
+        // todo implement
+    }
+
+    public function getProcessType(): int
+    {
+        return $this->processType;
+    }
+}
diff --git a/src/Mapper/Application/Exception/ThrowAttributeValidationExceptionTrait.php b/src/Mapper/Application/Exception/ThrowAttributeValidationExceptionTrait.php
@@ -4,6 +4,8 @@
 
 namespace PBaszak\UltraMapper\Mapper\Application\Exception;
 
+use PBaszak\UltraMapper\Mapper\Application\Exception\AttributeValidationException as AttributeException;
+
 trait ThrowAttributeValidationExceptionTrait
 {
     /**
@@ -14,6 +16,6 @@ protected function throwAttributeValidationException(string $message, int $code,
         $class = $reflection instanceof \ReflectionClass ? $reflection->getName() : $reflection->getDeclaringClass()->getName();
         $property = $reflection instanceof \ReflectionClass ? null : $reflection->getName();
 
-        throw new AttributeValidationException(sprintf('The %s attribute on %s%s is invalid. %s', (new \ReflectionClass($this))->getShortName(), $class, $property ? '::'.$property : '', $message), $code);
+        throw new AttributeException(sprintf('The %s attribute on %s%s is invalid. %s', (new \ReflectionClass($this))->getShortName(), $class, $property ? '::'.$property : '', $message), $code);
     }
 }
diff --git a/src/Mapper/Domain/Modules/Checker/Contract/CheckerInterface.php b/src/Mapper/Domain/Modules/Checker/Contract/CheckerInterface.php
@@ -6,8 +6,8 @@
 
 use PBaszak\UltraMapper\Blueprint\Application\Model\Blueprint;
 use PBaszak\UltraMapper\Mapper\Application\Model\Context;
-use PBaszak\UltraMapper\Mapper\Domain\Checker\Exception\CheckerException;
 use PBaszak\UltraMapper\Mapper\Domain\Model\Process;
+use PBaszak\UltraMapper\Mapper\Domain\Modules\Checker\Exception\CheckerException;
 
 /**
  * Interface CheckerInterface is used to check if the blueprint
diff --git a/src/Mapper/Domain/Modules/Checker/Contract/CheckerStrategyInterface.php b/src/Mapper/Domain/Modules/Checker/Contract/CheckerStrategyInterface.php
@@ -6,8 +6,8 @@
 
 use PBaszak\UltraMapper\Blueprint\Application\Model\Blueprint;
 use PBaszak\UltraMapper\Mapper\Application\Model\Context;
-use PBaszak\UltraMapper\Mapper\Domain\Checker\Exception\CheckerException;
 use PBaszak\UltraMapper\Mapper\Domain\Model\Process;
+use PBaszak\UltraMapper\Mapper\Domain\Modules\Checker\Exception\CheckerException;
 
 interface CheckerStrategyInterface
 {
diff --git a/tests/Assets/pbaszak_ultramapper_tests_assets_dummysimplewithattribute.yaml b/tests/Assets/pbaszak_ultramapper_tests_assets_dummysimplewithattribute.yaml
@@ -114,12 +114,15 @@ blueprints:
                         defaultValue: null
 filesHashes:
     /app/tests/Assets/DummySimpleWithAttribute.php: 5de157db33ad5536dfb49fe841a058a3
-    /app/src/Mapper/Application/Attribute/Callback.php: 99643441133906d4dcd15b67a24e47f7
-    /app/src/Mapper/Application/Attribute/Ignore.php: e38c1b054ff976591a460c3084c22209
+    /app/src/Mapper/Application/Attribute/Callback.php: 7ba81d4a5d36143504c6bcc2909e6a1c
+    /app/src/Mapper/Application/Attribute/Ignore.php: 3ff46e0eb1d09e4a9d5b7c97302034de
 events:
     - 'Blueprint created. Root class: PBaszak\UltraMapper\Tests\Assets\DummySimpleWithAttribute.'
     - 'Class Blueprint PBaszak\UltraMapper\Tests\Assets\DummySimpleWithAttribute added. Blueprint name: pbaszak_ultramapper_tests_assets_dummysimplewithattribute.'
     - 'File hash added. File: /app/tests/Assets/DummySimpleWithAttribute.php, hash: 5de157db33ad5536dfb49fe841a058a3.'
-    - 'File hash added. File: /app/src/Mapper/Application/Attribute/Callback.php, hash: 99643441133906d4dcd15b67a24e47f7.'
-    - 'File hash already exists. File: /app/src/Mapper/Application/Attribute/Callback.php, hash: 99643441133906d4dcd15b67a24e47f7.'
-    - 'File hash added. File: /app/src/Mapper/Application/Attribute/Ignore.php, hash: e38c1b054ff976591a460c3084c22209.'
+    - 'File hash added. File: /app/src/Mapper/Application/Attribute/Callback.php, hash: 7ba81d4a5d36143504c6bcc2909e6a1c.'
+    - 'File hash already exists. File: /app/src/Mapper/Application/Attribute/Callback.php, hash: 7ba81d4a5d36143504c6bcc2909e6a1c.'
+    - 'File hash added. File: /app/src/Mapper/Application/Attribute/Ignore.php, hash: 3ff46e0eb1d09e4a9d5b7c97302034de.'
+    - 'File hash already exists. File: /app/src/Mapper/Application/Attribute/Callback.php, hash: 7ba81d4a5d36143504c6bcc2909e6a1c.'
+    - 'File hash already exists. File: /app/src/Mapper/Application/Attribute/Callback.php, hash: 7ba81d4a5d36143504c6bcc2909e6a1c.'
+    - 'File hash already exists. File: /app/src/Mapper/Application/Attribute/Ignore.php, hash: 3ff46e0eb1d09e4a9d5b7c97302034de.'
diff --git a/tests/Mapper/Unit/Domain/Matcher/Checker/RecursiveLoopCheckerTest.php b/tests/Mapper/Unit/Domain/Matcher/Checker/RecursiveLoopCheckerTest.php
@@ -9,9 +9,9 @@
 use PBaszak\UltraMapper\Mapper\Application\Attribute\Ignore;
 use PBaszak\UltraMapper\Mapper\Application\Attribute\MaxDepth;
 use PBaszak\UltraMapper\Mapper\Application\Model\Context;
-use PBaszak\UltraMapper\Mapper\Domain\Matcher\Checker\RecursiveLoopChecker;
-use PBaszak\UltraMapper\Mapper\Domain\Matcher\Exception\BlueprintCheckerException;
 use PBaszak\UltraMapper\Mapper\Domain\Model\Process;
+use PBaszak\UltraMapper\Mapper\Domain\Modules\Checker\Exception\CheckerException;
+use PBaszak\UltraMapper\Mapper\Domain\Modules\Checker\Strategy\RecursiveLoopChecker;
 use PHPUnit\Framework\Attributes\Group;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
@@ -26,7 +26,7 @@ public function shouldThrowExceptionOnLoopDetected(): void
             public self $property;
         };
 
-        $this->expectException(BlueprintCheckerException::class);
+        $this->expectException(CheckerException::class);
         (new RecursiveLoopChecker())->check(
             Blueprint::create(get_class($class)),
             new Process([Process::DENORMALIZATION_PROCESS]),
@@ -42,7 +42,7 @@ public function shouldThrowExceptionOnLoopDetectedInTheGroupContext(): void
             public self $property;
         };
 
-        $this->expectException(BlueprintCheckerException::class);
+        $this->expectException(CheckerException::class);
         (new RecursiveLoopChecker())->check(
             Blueprint::create(get_class($class)),
             new Process([Process::DENORMALIZATION_PROCESS]),
diff --git a/tools/phpstan/fpm-baseline.neon b/tools/phpstan/fpm-baseline.neon

Original file line number	Diff line number	Diff line change
`@@ -20,9 +20,7 @@ class Accessor implements AttributeInterface`
`20`	`20`	`public function __construct(`
`21`	`21`	`public readonly ?string $getter = null,`
`22`	`22`	`public readonly ?string $setter = null,`
`23`		`- public bool $useForDenormalization = true,`
`24`		`- public bool $useForMapping = false,`
`25`		`- public bool $useForNormalization = true,`
	`23`	`+ public readonly int $processType = self::DENORMALIZATION \| self::NORMALIZATION \| self::TRANSFORMATION \| self::MAPPING,`
`26`	`24`	`public readonly array $options = []`
`27`	`25`	`) {`
`28`	`26`	`}`
`@@ -31,4 +29,9 @@ public function validate(\ReflectionProperty\|\ReflectionParameter\|\ReflectionCla`
`31`	`29`	`{`
`32`	`30`	`// todo implement`
`33`	`31`	`}`
	`32`	`+`
	`33`	`+ public function getProcessType(): int`
	`34`	`+ {`
	`35`	`+ return $this->processType;`
	`36`	`+ }`
`34`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,4 +50,9 @@ public function validate(\ReflectionProperty\|\ReflectionParameter\|\ReflectionCla`
`50`	`50`	`// }`
`51`	`51`	`// }`
`52`	`52`	`}`
	`53`	`+`
	`54`	`+ public function getProcessType(): int`
	`55`	`+ {`
	`56`	`+ return self::MAPPING \| self::DENORMALIZATION \| self::NORMALIZATION \| self::TRANSFORMATION;`
	`57`	`+ }`
`53`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,4 +37,9 @@ public function validate(\ReflectionProperty\|\ReflectionParameter\|\ReflectionCla`
`37`	`37`	`{`
`38`	`38`	`// todo implement`
`39`	`39`	`}`
	`40`	`+`
	`41`	`+ public function getProcessType(): int`
	`42`	`+ {`
	`43`	`+ return self::MAPPING \| self::DENORMALIZATION \| self::NORMALIZATION \| self::TRANSFORMATION;`
	`44`	`+ }`
`40`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,4 +34,9 @@ public function validate(\ReflectionProperty\|\ReflectionParameter\|\ReflectionCla`
`34`	`34`	`{`
`35`	`35`	`// todo implement`
`36`	`36`	`}`
	`37`	`+`
	`38`	`+ public function getProcessType(): int`
	`39`	`+ {`
	`40`	`+ return self::MAPPING \| self::DENORMALIZATION \| self::NORMALIZATION \| self::TRANSFORMATION;`
	`41`	`+ }`
`37`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,8 @@`
`4`	`4`
`5`	`5`	`namespace PBaszak\UltraMapper\Mapper\Application\Exception;`
`6`	`6`
	`7`	`+use PBaszak\UltraMapper\Mapper\Application\Exception\AttributeValidationException as AttributeException;`
	`8`	`+`
`7`	`9`	`trait ThrowAttributeValidationExceptionTrait`
`8`	`10`	`{`
`9`	`11`	`/**`
`@@ -14,6 +16,6 @@ protected function throwAttributeValidationException(string $message, int $code,`
`14`	`16`	`$class = $reflection instanceof \ReflectionClass ? $reflection->getName() : $reflection->getDeclaringClass()->getName();`
`15`	`17`	`$property = $reflection instanceof \ReflectionClass ? null : $reflection->getName();`
`16`	`18`
`17`		`- throw new AttributeValidationException(sprintf('The %s attribute on %s%s is invalid. %s', (new \ReflectionClass($this))->getShortName(), $class, $property ? '::'.$property : '', $message), $code);`
	`19`	`+ throw new AttributeException(sprintf('The %s attribute on %s%s is invalid. %s', (new \ReflectionClass($this))->getShortName(), $class, $property ? '::'.$property : '', $message), $code);`
`18`	`20`	`}`
`19`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,8 @@`
`6`	`6`
`7`	`7`	`use PBaszak\UltraMapper\Blueprint\Application\Model\Blueprint;`
`8`	`8`	`use PBaszak\UltraMapper\Mapper\Application\Model\Context;`
`9`		`-use PBaszak\UltraMapper\Mapper\Domain\Checker\Exception\CheckerException;`
`10`	`9`	`use PBaszak\UltraMapper\Mapper\Domain\Model\Process;`
	`10`	`+use PBaszak\UltraMapper\Mapper\Domain\Modules\Checker\Exception\CheckerException;`
`11`	`11`
`12`	`12`	`interface CheckerStrategyInterface`
`13`	`13`	`{`