refactor: Refactor exception.

CHANGELOG.md

@@ -7,6 +7,7 @@
 * refactor: Move transformer query logic to `TransformerRegistry`.
 * refactor: Mover more logic to `TransformerRegistry`.
 * refactor: Move `MainTransformer` to its own namespace.
+* refactor: Refactor exception.
 
 ## 0.5.4
 

src/Exception/UnableToFindSuitableTransformerException.php → src/MainTransformer/Exception/CannotFindTransformerException.php

@@ -11,13 +11,13 @@
  * that was distributed with this source code.
  */
 
-namespace Rekalogika\Mapper\Exception;
+namespace Rekalogika\Mapper\MainTransformer\Exception;
 
 use Rekalogika\Mapper\Transformer\Contracts\MixedType;
 use Rekalogika\Mapper\Util\TypeUtil;
 use Symfony\Component\PropertyInfo\Type;
 
-class UnableToFindSuitableTransformerException extends NotMappableValueException
+class CannotFindTransformerException extends \RuntimeException
 {
     /**
      * @param array<int,Type|MixedType> $sourceTypes
@@ -28,6 +28,6 @@ public function __construct(array $sourceTypes, array $targetTypes)
         $sourceTypes = TypeUtil::getDebugType($sourceTypes);
         $targetTypes = TypeUtil::getDebugType($targetTypes);
 
-        parent::__construct(sprintf('Unable to find a suitable transformer for mapping the source types "%s" to the target types "%s"', $sourceTypes, $sourceTypes));
+        parent::__construct(sprintf('Cannot find a matching transformer for mapping the source types "%s" to the target types "%s"', $sourceTypes, $sourceTypes));
     }
 }

src/Exception/MapperReturnsUnexpectedValueException.php → src/MainTransformer/Exception/TransformerReturnsUnexpectedValueException.php

@@ -11,18 +11,20 @@
  * that was distributed with this source code.
  */
 
-namespace Rekalogika\Mapper\Exception;
+namespace Rekalogika\Mapper\MainTransformer\Exception;
 
+use Rekalogika\Mapper\Exception\UnexpectedValueException;
+use Rekalogika\Mapper\Transformer\Contracts\MixedType;
 use Rekalogika\Mapper\Util\TypeUtil;
 use Symfony\Component\PropertyInfo\Type;
 
-class MapperReturnsUnexpectedValueException extends UnexpectedValueException
+class TransformerReturnsUnexpectedValueException extends UnexpectedValueException
 {
-    public function __construct(Type|null $type, mixed $target)
+    public function __construct(Type|MixedType $type, mixed $target)
     {
         $message = sprintf(
             'Mapper returns unexpected value. Expected type "%s", but got "%s"',
-            $type === null ? 'unknown' : TypeUtil::getTypeString($type),
+            TypeUtil::getTypeString($type),
             get_debug_type($target),
         );
 

src/MainTransformer/MainTransformer.php

@@ -14,14 +14,16 @@
 namespace Rekalogika\Mapper\MainTransformer;
 
 use Rekalogika\Mapper\Exception\LogicException;
-use Rekalogika\Mapper\Exception\UnableToFindSuitableTransformerException;
+use Rekalogika\Mapper\MainTransformer\Exception\CannotFindTransformerException;
+use Rekalogika\Mapper\MainTransformer\Exception\TransformerReturnsUnexpectedValueException;
 use Rekalogika\Mapper\ObjectCache\ObjectCache;
 use Rekalogika\Mapper\ObjectCache\ObjectCacheFactoryInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MixedType;
 use Rekalogika\Mapper\Transformer\Contracts\TransformerInterface;
 use Rekalogika\Mapper\TransformerRegistry\TransformerRegistryInterface;
 use Rekalogika\Mapper\TypeResolver\TypeResolverInterface;
+use Rekalogika\Mapper\Util\TypeCheck;
 use Symfony\Component\PropertyInfo\Type;
 
 class MainTransformer implements MainTransformerInterface
@@ -150,9 +152,13 @@ public function transform(
                 context: $context
             );
 
+            if (!TypeCheck::isVariableInstanceOf($result, $targetType)) {
+                throw new TransformerReturnsUnexpectedValueException($targetType, $result);
+            }
+
             return $result;
         }
 
-        throw new UnableToFindSuitableTransformerException($sourceTypes, $targetTypes);
+        throw new CannotFindTransformerException($sourceTypes, $targetTypes);
     }
 }

src/Exception/CachedTargetObjectNotFoundException.php → src/ObjectCache/Exception/CachedTargetObjectNotFoundException.php

@@ -11,7 +11,9 @@
  * that was distributed with this source code.
  */
 
-namespace Rekalogika\Mapper\Exception;
+namespace Rekalogika\Mapper\ObjectCache\Exception;
+
+use Rekalogika\Mapper\Exception\RuntimeException;
 
 class CachedTargetObjectNotFoundException extends RuntimeException
 {

src/Exception/CircularReferenceException.php → src/ObjectCache/Exception/CircularReferenceException.php

@@ -11,12 +11,14 @@
  * that was distributed with this source code.
  */
 
-namespace Rekalogika\Mapper\Exception;
+namespace Rekalogika\Mapper\ObjectCache\Exception;
 
+use Rekalogika\Mapper\Exception\ExceptionInterface;
+use Rekalogika\Mapper\Exception\RuntimeException;
 use Rekalogika\Mapper\Util\TypeUtil;
 use Symfony\Component\PropertyInfo\Type;
 
-class CircularReferenceException extends \RuntimeException implements ExceptionInterface
+class CircularReferenceException extends RuntimeException implements ExceptionInterface
 {
     public function __construct(mixed $source, Type $targetType)
     {

src/Exception/NonSimpleTypeException.php → src/ObjectCache/Exception/NonSimpleTypeException.php

@@ -11,8 +11,9 @@
  * that was distributed with this source code.
  */
 
-namespace Rekalogika\Mapper\Exception;
+namespace Rekalogika\Mapper\ObjectCache\Exception;
 
+use Rekalogika\Mapper\Exception\UnexpectedValueException;
 use Rekalogika\Mapper\Util\TypeUtil;
 use Symfony\Component\PropertyInfo\Type;
 

src/ObjectCache/ObjectCache.php

@@ -13,10 +13,10 @@
 
 namespace Rekalogika\Mapper\ObjectCache;
 
-use Rekalogika\Mapper\Exception\CachedTargetObjectNotFoundException;
-use Rekalogika\Mapper\Exception\CircularReferenceException;
 use Rekalogika\Mapper\Exception\LogicException;
-use Rekalogika\Mapper\Exception\NonSimpleTypeException;
+use Rekalogika\Mapper\ObjectCache\Exception\CachedTargetObjectNotFoundException;
+use Rekalogika\Mapper\ObjectCache\Exception\CircularReferenceException;
+use Rekalogika\Mapper\ObjectCache\Exception\NonSimpleTypeException;
 use Rekalogika\Mapper\TypeResolver\TypeResolverInterface;
 use Symfony\Component\PropertyInfo\Type;
 

src/Transformer/ArrayToObjectTransformer.php

@@ -14,9 +14,9 @@
 namespace Rekalogika\Mapper\Transformer;
 
 use Rekalogika\Mapper\Exception\InvalidArgumentException;
-use Rekalogika\Mapper\Exception\InvalidTypeInArgumentException;
 use Rekalogika\Mapper\Transformer\Contracts\TransformerInterface;
 use Rekalogika\Mapper\Transformer\Contracts\TypeMapping;
+use Rekalogika\Mapper\Transformer\Exception\InvalidTypeInArgumentException;
 use Rekalogika\Mapper\Util\TypeCheck;
 use Rekalogika\Mapper\Util\TypeFactory;
 use Symfony\Component\PropertyInfo\Type;

src/Transformer/Contracts/TransformerInterface.php

@@ -13,10 +13,10 @@
 
 namespace Rekalogika\Mapper\Transformer\Contracts;
 
-use Rekalogika\Mapper\Exception\CircularReferenceException;
 use Rekalogika\Mapper\Exception\ExceptionInterface;
 use Rekalogika\Mapper\Exception\InvalidArgumentException;
 use Rekalogika\Mapper\Exception\LogicException;
+use Rekalogika\Mapper\ObjectCache\Exception\CircularReferenceException;
 use Symfony\Component\PropertyInfo\Type;
 
 interface TransformerInterface

src/Exception/ClassNotInstantiableException.php → src/Transformer/Exception/ClassNotInstantiableException.php

@@ -11,7 +11,7 @@
  * that was distributed with this source code.
  */
 
-namespace Rekalogika\Mapper\Exception;
+namespace Rekalogika\Mapper\Transformer\Exception;
 
 class ClassNotInstantiableException extends NotMappableValueException
 {

src/Exception/IncompleteConstructorArgument.php → src/Transformer/Exception/IncompleteConstructorArgument.php

@@ -11,7 +11,7 @@
  * that was distributed with this source code.
  */
 
-namespace Rekalogika\Mapper\Exception;
+namespace Rekalogika\Mapper\Transformer\Exception;
 
 class IncompleteConstructorArgument extends NotMappableValueException
 {

src/Exception/InstantiationFailureException.php → src/Transformer/Exception/InstantiationFailureException.php

@@ -11,7 +11,7 @@
  * that was distributed with this source code.
  */
 
-namespace Rekalogika\Mapper\Exception;
+namespace Rekalogika\Mapper\Transformer\Exception;
 
 class InstantiationFailureException extends NotMappableValueException
 {

src/Exception/InvalidClassException.php → src/Transformer/Exception/InvalidClassException.php

@@ -11,8 +11,9 @@
  * that was distributed with this source code.
  */
 
-namespace Rekalogika\Mapper\Exception;
+namespace Rekalogika\Mapper\Transformer\Exception;
 
+use Rekalogika\Mapper\Exception\UnexpectedValueException;
 use Rekalogika\Mapper\Util\TypeUtil;
 use Symfony\Component\PropertyInfo\Type;
 

src/Exception/InvalidTypeInArgumentException.php → src/Transformer/Exception/InvalidTypeInArgumentException.php

@@ -11,8 +11,9 @@
  * that was distributed with this source code.
  */
 
-namespace Rekalogika\Mapper\Exception;
+namespace Rekalogika\Mapper\Transformer\Exception;
 
+use Rekalogika\Mapper\Exception\InvalidArgumentException;
 use Rekalogika\Mapper\Util\TypeUtil;
 use Symfony\Component\PropertyInfo\Type;
 

src/Exception/MissingMemberKeyTypeException.php → src/Transformer/Exception/MissingMemberKeyTypeException.php

@@ -11,7 +11,7 @@
  * that was distributed with this source code.
  */
 
-namespace Rekalogika\Mapper\Exception;
+namespace Rekalogika\Mapper\Transformer\Exception;
 
 use Rekalogika\Mapper\Transformer\Contracts\MixedType;
 use Rekalogika\Mapper\Util\TypeUtil;

src/Exception/MissingMemberTypeException.php → src/Transformer/Exception/MissingMemberTypeException.php

@@ -11,7 +11,7 @@
  * that was distributed with this source code.
  */
 
-namespace Rekalogika\Mapper\Exception;
+namespace Rekalogika\Mapper\Transformer\Exception;
 
 abstract class MissingMemberTypeException extends NotMappableValueException
 {

src/Exception/MissingMemberValueTypeException.php → src/Transformer/Exception/MissingMemberValueTypeException.php

@@ -11,7 +11,7 @@
  * that was distributed with this source code.
  */
 
-namespace Rekalogika\Mapper\Exception;
+namespace Rekalogika\Mapper\Transformer\Exception;
 
 use Rekalogika\Mapper\Transformer\Contracts\MixedType;
 use Rekalogika\Mapper\Util\TypeUtil;

src/Exception/NotMappableValueException.php → src/Transformer/Exception/NotMappableValueException.php

@@ -11,7 +11,9 @@
  * that was distributed with this source code.
  */
 
-namespace Rekalogika\Mapper\Exception;
+namespace Rekalogika\Mapper\Transformer\Exception;
+
+use Rekalogika\Mapper\Exception\UnexpectedValueException;
 
 abstract class NotMappableValueException extends UnexpectedValueException
 {

src/Transformer/ObjectToObjectTransformer.php

@@ -13,18 +13,18 @@
 
 namespace Rekalogika\Mapper\Transformer;
 
-use Rekalogika\Mapper\Exception\CachedTargetObjectNotFoundException;
-use Rekalogika\Mapper\Exception\ClassNotInstantiableException;
-use Rekalogika\Mapper\Exception\IncompleteConstructorArgument;
-use Rekalogika\Mapper\Exception\InstantiationFailureException;
 use Rekalogika\Mapper\Exception\InvalidArgumentException;
-use Rekalogika\Mapper\Exception\InvalidClassException;
 use Rekalogika\Mapper\MainTransformer\MainTransformer;
+use Rekalogika\Mapper\ObjectCache\Exception\CachedTargetObjectNotFoundException;
 use Rekalogika\Mapper\ObjectCache\ObjectCacheFactoryInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareTrait;
 use Rekalogika\Mapper\Transformer\Contracts\TransformerInterface;
 use Rekalogika\Mapper\Transformer\Contracts\TypeMapping;
+use Rekalogika\Mapper\Transformer\Exception\ClassNotInstantiableException;
+use Rekalogika\Mapper\Transformer\Exception\IncompleteConstructorArgument;
+use Rekalogika\Mapper\Transformer\Exception\InstantiationFailureException;
+use Rekalogika\Mapper\Transformer\Exception\InvalidClassException;
 use Rekalogika\Mapper\TypeResolver\TypeResolverInterface;
 use Rekalogika\Mapper\Util\TypeCheck;
 use Rekalogika\Mapper\Util\TypeFactory;

src/Transformer/StringToBackedEnumTransformer.php

@@ -16,6 +16,7 @@
 use Rekalogika\Mapper\Exception\InvalidArgumentException;
 use Rekalogika\Mapper\Transformer\Contracts\TransformerInterface;
 use Rekalogika\Mapper\Transformer\Contracts\TypeMapping;
+use Rekalogika\Mapper\Transformer\Exception\InvalidTypeInArgumentException;
 use Rekalogika\Mapper\Util\TypeFactory;
 use Symfony\Component\PropertyInfo\Type;
 
@@ -35,7 +36,7 @@ public function transform(
         $class = $targetType?->getClassName();
 
         if ($class === null || !\enum_exists($class)) {
-            throw new InvalidArgumentException(sprintf('Target must be an enum class-string, "%s" given', get_debug_type($class)));
+            throw new InvalidTypeInArgumentException('Target must be an enum class-string, "%s" given', $targetType);
         }
 
         // @todo maybe add option to handle values not in the enum

src/Transformer/TraversableToArrayAccessTransformer.php

@@ -15,16 +15,17 @@
 
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
-use Rekalogika\Mapper\Exception\CachedTargetObjectNotFoundException;
 use Rekalogika\Mapper\Exception\InvalidArgumentException;
-use Rekalogika\Mapper\Exception\InvalidTypeInArgumentException;
-use Rekalogika\Mapper\Exception\MissingMemberKeyTypeException;
 use Rekalogika\Mapper\MainTransformer\MainTransformer;
+use Rekalogika\Mapper\ObjectCache\Exception\CachedTargetObjectNotFoundException;
 use Rekalogika\Mapper\ObjectCache\ObjectCacheFactoryInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareTrait;
 use Rekalogika\Mapper\Transformer\Contracts\TransformerInterface;
 use Rekalogika\Mapper\Transformer\Contracts\TypeMapping;
+use Rekalogika\Mapper\Transformer\Exception\ClassNotInstantiableException;
+use Rekalogika\Mapper\Transformer\Exception\InvalidTypeInArgumentException;
+use Rekalogika\Mapper\Transformer\Exception\MissingMemberKeyTypeException;
 use Rekalogika\Mapper\Util\TypeCheck;
 use Rekalogika\Mapper\Util\TypeFactory;
 use Symfony\Component\PropertyInfo\Type;
@@ -193,7 +194,7 @@ private function instantiateArrayAccessOrArray(
             try {
                 $result = $reflectionClass->newInstance();
             } catch (\ReflectionException) {
-                throw new InvalidArgumentException(sprintf('We do not know how to instantiate class "%s"', $class));
+                throw new ClassNotInstantiableException($class);
             }
 
             if (!$result instanceof \ArrayAccess) {

src/Transformer/TraversableToTraversableTransformer.php

@@ -13,16 +13,16 @@
 
 namespace Rekalogika\Mapper\Transformer;
 
-use Rekalogika\Mapper\Exception\CachedTargetObjectNotFoundException;
 use Rekalogika\Mapper\Exception\InvalidArgumentException;
-use Rekalogika\Mapper\Exception\MissingMemberKeyTypeException;
-use Rekalogika\Mapper\Exception\MissingMemberValueTypeException;
 use Rekalogika\Mapper\MainTransformer\MainTransformer;
+use Rekalogika\Mapper\ObjectCache\Exception\CachedTargetObjectNotFoundException;
 use Rekalogika\Mapper\ObjectCache\ObjectCacheFactoryInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareTrait;
 use Rekalogika\Mapper\Transformer\Contracts\TransformerInterface;
 use Rekalogika\Mapper\Transformer\Contracts\TypeMapping;
+use Rekalogika\Mapper\Transformer\Exception\MissingMemberKeyTypeException;
+use Rekalogika\Mapper\Transformer\Exception\MissingMemberValueTypeException;
 use Rekalogika\Mapper\Transformer\Model\TraversableCountableWrapper;
 use Rekalogika\Mapper\Util\TypeCheck;
 use Rekalogika\Mapper\Util\TypeFactory;

src/Util/TypeCheck.php

@@ -112,9 +112,26 @@ public static function isEnum(?Type $type): bool
         if ($type === null) {
             return false;
         }
+
+        $class = $type->getClassName();
+
         return $type->getBuiltinType() === Type::BUILTIN_TYPE_OBJECT
-            && $type->getClassName() !== null
-            && enum_exists($type->getClassName());
+            && $class !== null
+            && enum_exists($class);
+    }
+
+    public static function isBackedEnum(?Type $type): bool
+    {
+        if ($type === null) {
+            return false;
+        }
+
+        $class = $type->getClassName();
+
+        return $type->getBuiltinType() === Type::BUILTIN_TYPE_OBJECT
+            && $class !== null
+            && enum_exists($class)
+            && is_a($class, \BackedEnum::class, true);
     }
 
     public static function isResource(?Type $type): bool
@@ -212,8 +229,12 @@ public static function isTypeInstanceOf(
     /**
      * @todo support generics
      */
-    public static function isVariableInstanceOf(mixed $variable, Type $type): bool
+    public static function isVariableInstanceOf(mixed $variable, Type|MixedType $type): bool
     {
+        if ($type instanceof MixedType) {
+            return true;
+        }
+
         if (self::isObject($type)) {
             $class = $type->getClassName();