feat: Mapping carbon types and allowing partial failure of deserializ…

…ation

src/GoodPhp/Serialization/SerializerBuilder.php

@@ -16,6 +16,7 @@
 use GoodPhp\Serialization\TypeAdapter\Primitive\BuiltIn\DateTimeMapper;
 use GoodPhp\Serialization\TypeAdapter\Primitive\BuiltIn\Nullable\NullableTypeAdapterFactory;
 use GoodPhp\Serialization\TypeAdapter\Primitive\BuiltIn\ScalarMapper;
+use GoodPhp\Serialization\TypeAdapter\Primitive\Carbon\CarbonMapper;
 use GoodPhp\Serialization\TypeAdapter\Primitive\ClassProperties\ClassPropertiesPrimitiveTypeAdapterFactory;
 use GoodPhp\Serialization\TypeAdapter\Primitive\ClassProperties\Naming\BuiltInNamingStrategy;
 use GoodPhp\Serialization\TypeAdapter\Primitive\ClassProperties\Naming\NamingStrategy;
@@ -148,6 +149,7 @@ public function build(): Serializer
 			->addMapperLast(new ArrayMapper())
 			->addMapperLast(new CollectionMapper())
 			->addMapperLast(new DateTimeMapper())
+			->addMapperLast(new CarbonMapper())
 			->addFactoryLast(new ClassPropertiesPrimitiveTypeAdapterFactory(
 				new SerializedNameAttributeNamingStrategy($this->namingStrategy ?? BuiltInNamingStrategy::PRESERVING),
 				$this->hydrator ?? new ConstructorHydrator(),

src/GoodPhp/Serialization/TypeAdapter/Exception/UnexpectedEnumValueException.php

@@ -5,7 +5,7 @@
 use RuntimeException;
 use Throwable;
 
-class UnexpectedEnumValueException extends RuntimeException
+class UnexpectedEnumValueException extends RuntimeException implements UnexpectedValueException
 {
 	public function __construct(
 		public readonly string|int $value,

src/GoodPhp/Serialization/TypeAdapter/Exception/UnexpectedValueTypeException.php → src/GoodPhp/Serialization/TypeAdapter/Exception/UnexpectedTypeException.php

@@ -6,7 +6,7 @@
 use RuntimeException;
 use Throwable;
 
-class UnexpectedValueTypeException extends RuntimeException
+class UnexpectedTypeException extends RuntimeException
 {
 	public function __construct(
 		public readonly mixed $value,

src/GoodPhp/Serialization/TypeAdapter/Exception/UnexpectedValueException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace GoodPhp\Serialization\TypeAdapter\Exception;
+
+interface UnexpectedValueException extends \Throwable
+{
+
+}

src/GoodPhp/Serialization/TypeAdapter/Primitive/Carbon/CarbonMapper.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace GoodPhp\Serialization\TypeAdapter\Primitive\Carbon;
+
+use Carbon\Carbon;
+use Carbon\CarbonImmutable;
+use GoodPhp\Serialization\TypeAdapter\Primitive\MapperMethods\MapFrom;
+use GoodPhp\Serialization\TypeAdapter\Primitive\MapperMethods\MapTo;
+use GoodPhp\Serialization\TypeAdapter\Primitive\PrimitiveTypeAdapter;
+
+class CarbonMapper
+{
+	#[MapTo(PrimitiveTypeAdapter::class)]
+	public function toCarbon(Carbon $value): string
+	{
+		return $value->toISOString();
+	}
+
+	#[MapFrom(PrimitiveTypeAdapter::class)]
+	public function fromCarbon(string $value): Carbon
+	{
+		return new Carbon($value);
+	}
+
+	#[MapTo(PrimitiveTypeAdapter::class)]
+	public function toCarbonImmutable(CarbonImmutable $value): string
+	{
+		return $value->toISOString();
+	}
+
+	#[MapFrom(PrimitiveTypeAdapter::class)]
+	public function fromCarbonImmutable(string $value): CarbonImmutable
+	{
+		return new CarbonImmutable($value);
+	}
+}

src/GoodPhp/Serialization/TypeAdapter/Primitive/ClassProperties/Property/DefaultBoundClassProperty.php

@@ -6,9 +6,12 @@
 
 use GoodPhp\Reflection\Reflection\PropertyReflection;
 use GoodPhp\Serialization\MissingValue;
+use GoodPhp\Serialization\TypeAdapter\Exception\UnexpectedEnumValueException;
+use GoodPhp\Serialization\TypeAdapter\Exception\UnexpectedValueException;
 use GoodPhp\Serialization\TypeAdapter\Primitive\ClassProperties\MissingValueException;
 use GoodPhp\Serialization\TypeAdapter\TypeAdapter;
 use Illuminate\Support\Arr;
+use Webmozart\Assert\Assert;
 
 /**
  * This handles the built-in default mechanism of binding properties. Specifically, it handles:
@@ -29,8 +32,12 @@ public function __construct(
 		private readonly bool               $optional,
 		private readonly bool               $hasDefaultValue,
 		private readonly bool               $nullable,
+		private readonly bool               $useDefaultForUnexpected,
 	)
 	{
+		if ($this->useDefaultForUnexpected) {
+			Assert::true($this->hasDefaultValue, "When using #[UseDefaultForUnexpected], the property must have a default value.");
+		}
 	}
 
 	public function serializedName(): string
@@ -76,8 +83,16 @@ public function deserialize(array $data): array
 			throw new MissingValueException();
 		}
 
-		return [
-			$this->property->name() => $this->typeAdapter->deserialize($data[$this->serializedName])
-		];
+		try {
+			return [
+				$this->property->name() => $this->typeAdapter->deserialize($data[$this->serializedName])
+			];
+		} catch (UnexpectedValueException $e) {
+			if ($this->useDefaultForUnexpected) {
+				return [];
+			}
+
+			throw $e;
+		}
 	}
 }

src/GoodPhp/Serialization/TypeAdapter/Primitive/ClassProperties/Property/DefaultBoundClassPropertyFactory.php

@@ -43,6 +43,7 @@ public function create(
 			optional: $optional,
 			hasDefaultValue: $this->hasDefaultValue($property),
 			nullable: $type instanceof NullableType,
+			useDefaultForUnexpected: $property->attributes()->has(UseDefaultForUnexpected::class),
 		);
 	}
 

src/GoodPhp/Serialization/TypeAdapter/Primitive/ClassProperties/Property/UseDefaultForUnexpected.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace GoodPhp\Serialization\TypeAdapter\Primitive\ClassProperties\Property;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_PROPERTY)]
+class UseDefaultForUnexpected
+{
+
+}

src/GoodPhp/Serialization/TypeAdapter/Primitive/MapperMethods/MapperMethod/InstanceMapperMethod.php

@@ -8,7 +8,7 @@
 use GoodPhp\Reflection\Type\NamedType;
 use GoodPhp\Reflection\Type\Type;
 use GoodPhp\Serialization\Serializer;
-use GoodPhp\Serialization\TypeAdapter\Exception\UnexpectedValueTypeException;
+use GoodPhp\Serialization\TypeAdapter\Exception\UnexpectedTypeException;
 use GoodPhp\Serialization\TypeAdapter\Primitive\MapperMethods\Acceptance\AcceptanceStrategy;
 use GoodPhp\Serialization\TypeAdapter\Primitive\MapperMethods\TypeAdapter\MapperMethodsPrimitiveTypeAdapterFactory;
 use TypeError;
@@ -29,12 +29,13 @@ public function accepts(NamedType $type, Attributes $attributes, Serializer $ser
 		return $this->acceptanceStrategy->accepts($this->methodValueType, $type, $serializer);
 	}
 
-	public function invoke(mixed $value, Type $type, Serializer $serializer, MapperMethodsPrimitiveTypeAdapterFactory $skipPast): mixed
+	public function invoke(mixed $value, Type $type, Attributes $attributes, Serializer $serializer, MapperMethodsPrimitiveTypeAdapterFactory $skipPast): mixed
 	{
 		$map = [
 			MapperMethodsPrimitiveTypeAdapterFactory::class => $skipPast,
 			Serializer::class                               => $serializer,
 			Type::class                                     => $type,
+			Attributes::class => $attributes,
 		];
 
 		try {
@@ -58,7 +59,7 @@ public function invoke(mixed $value, Type $type, Serializer $serializer, MapperM
 				throw $e;
 			}
 
-			throw new UnexpectedValueTypeException($value, $this->method->parameters()->first()->type());
+			throw new UnexpectedTypeException($value, $this->method->parameters()->first()->type());
 		}
 	}
 }

src/GoodPhp/Serialization/TypeAdapter/Primitive/MapperMethods/MapperMethod/MapperMethod.php

@@ -12,5 +12,5 @@ interface MapperMethod
 {
 	public function accepts(NamedType $type, Attributes $attributes, Serializer $serializer): bool;
 
-	public function invoke(mixed $value, Type $type, Serializer $serializer, MapperMethodsPrimitiveTypeAdapterFactory $skipPast): mixed;
+	public function invoke(mixed $value, Type $type, Attributes $attributes, Serializer $serializer, MapperMethodsPrimitiveTypeAdapterFactory $skipPast): mixed;
 }

src/GoodPhp/Serialization/TypeAdapter/Primitive/MapperMethods/TypeAdapter/MapperMethodsPrimitiveTypeAdapter.php

@@ -2,6 +2,7 @@
 
 namespace GoodPhp\Serialization\TypeAdapter\Primitive\MapperMethods\TypeAdapter;
 
+use GoodPhp\Reflection\Reflection\Attributes\Attributes;
 use GoodPhp\Reflection\Type\Type;
 use GoodPhp\Serialization\Serializer;
 use GoodPhp\Serialization\TypeAdapter\Primitive\MapperMethods\MapperMethod\MapperMethod;
@@ -15,6 +16,7 @@ public function __construct(
 		private readonly ?MapperMethod $fromMapper,
 		private readonly ?PrimitiveTypeAdapter $fallbackDelegate,
 		private readonly Type $type,
+		private readonly Attributes $attributes,
 		private readonly Serializer $serializer,
 		private readonly MapperMethodsPrimitiveTypeAdapterFactory $skipPast,
 	) {
@@ -29,7 +31,7 @@ public function __construct(
 	public function serialize(mixed $value): mixed
 	{
 		return $this->toMapper ?
-			$this->toMapper->invoke($value, $this->type, $this->serializer, $this->skipPast) :
+			$this->toMapper->invoke($value, $this->type, $this->attributes, $this->serializer, $this->skipPast) :
 			$this->fallbackDelegate->serialize($value);
 	}
 
@@ -39,7 +41,7 @@ public function serialize(mixed $value): mixed
 	public function deserialize(mixed $value): mixed
 	{
 		return $this->fromMapper ?
-			$this->fromMapper->invoke($value, $this->type, $this->serializer, $this->skipPast) :
+			$this->fromMapper->invoke($value, $this->type, $this->attributes, $this->serializer, $this->skipPast) :
 			$this->fallbackDelegate->deserialize($value);
 	}
 }

src/GoodPhp/Serialization/TypeAdapter/Primitive/MapperMethods/TypeAdapter/MapperMethodsPrimitiveTypeAdapterFactory.php

@@ -44,6 +44,7 @@ public function create(string $typeAdapterType, Type $type, Attributes $attribut
 			fromMapper: $fromMapper,
 			fallbackDelegate: $fallbackDelegate,
 			type: $type,
+			attributes: $attributes,
 			serializer: $serializer,
 			skipPast: $this,
 		);