Supported BcMath\Number numberType

Author: picamator

README.md

@@ -68,7 +68,7 @@ Key Features
   * implements standard interfaces: `IteratorAggregate`, `JsonSerializable`, and `Countable`
   * supports embedded, collections Transfer Objects
   * supports PHP primitive data types
-  * supports `BackedEnum`, `DateTime`, `DateTimeImmutable`
+  * supports `BackedEnum`, `DateTime`, `DateTimeImmutable`, and `BcMath\\Number`
   * supports asymmetric property visibility
   * integrates external Transfer Objects
 

config/definition/transfer-generator.transfer.yml

@@ -60,6 +60,8 @@ DefinitionProperty:
     type: DefinitionEmbeddedType
   dateTimeType:
     type: DefinitionEmbeddedType
+  numberType:
+    type: DefinitionEmbeddedType
   isNullable:
     type: bool
     required:

schema/definition.schema.json

@@ -39,7 +39,7 @@
                         },
                         "dateTimeType": {
                             "type": "string",
-                            "description": "Includes DateTimeImmutable or DateTime or any of theirs sub-classes with fully qualified Enum name with namespace, optionally with alias.",
+                            "description": "Includes DateTimeImmutable or DateTime or any of full sub-class path, optionally with alias.",
                             "anyOf": [
                                 "DateTimeImmutable",
                                 "DateTime",
@@ -48,6 +48,13 @@
                                 }
                             ]
                         },
+                        "numberType": {
+                            "type": "string",
+                            "description": "Includes BcMath\\Number.",
+                            "anyOf": [
+                                "BcMath\\Number"
+                            ]
+                        },
                         "required": {
                             "type": "null",
                             "description": "Marks the property as not nullable."
@@ -66,6 +73,8 @@
                             "required": ["enumType"]
                         }, {
                             "required": ["dateTimeType"]
+                        }, {
+                            "required": ["numberType"]
                         }
                     ],
                     "additionalProperties": false

src/Generated/DefinitionPropertyTransfer.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Picamator\TransferObject\Transfer\Attribute;
+
+use Attribute;
+use BcMath\Number;
+
+/**
+ * @api
+ */
+#[Attribute(Attribute::TARGET_CLASS_CONSTANT)]
+final readonly class NumberPropertyTypeAttribute implements PropertyTypeAttributeInterface
+{
+    use DataAssertTrait;
+
+    public function __construct(private string $typeName)
+    {
+    }
+
+    public function fromArray(mixed $data): Number
+    {
+        /** @var \BcMath\Number $dateTime */
+        $dateTime = match (true) {
+            is_string($data) || is_int($data) => new $this->typeName($data),
+            $data instanceof Number => $data,
+            default => $this->assertInvalidType($data, $this->typeName),
+        };
+
+        return $dateTime;
+    }
+
+    /**
+     * @param \BcMath\Number|null $data
+     */
+    public function toArray(mixed $data): ?string
+    {
+        return $data?->__toString();
+    }
+
+    public function getInitialValue(): null
+    {
+        return null;
+    }
+}

src/Transfer/Attribute/NumberPropertyTypeAttribute.php

@@ -18,6 +18,7 @@
 use Picamator\TransferObject\TransferGenerator\Definition\Parser\Expander\DateTimeTypePropertyExpander;
 use Picamator\TransferObject\TransferGenerator\Definition\Parser\Expander\EnumTypePropertyExpander;
 use Picamator\TransferObject\TransferGenerator\Definition\Parser\Expander\NullablePropertyExpander;
+use Picamator\TransferObject\TransferGenerator\Definition\Parser\Expander\NumberTypePropertyExpander;
 use Picamator\TransferObject\TransferGenerator\Definition\Parser\Expander\PropertyExpanderInterface;
 use Picamator\TransferObject\TransferGenerator\Definition\Parser\Expander\ProtectedPropertyExpander;
 use Picamator\TransferObject\TransferGenerator\Definition\Parser\Expander\TransferTypePropertyExpander;
@@ -34,6 +35,7 @@
 use Picamator\TransferObject\TransferGenerator\Definition\Validator\Property\DateTimeTypePropertyValidator;
 use Picamator\TransferObject\TransferGenerator\Definition\Validator\Property\EnumTypePropertyValidator;
 use Picamator\TransferObject\TransferGenerator\Definition\Validator\Property\NamePropertyValidator;
+use Picamator\TransferObject\TransferGenerator\Definition\Validator\Property\NumberTypePropertyValidator;
 use Picamator\TransferObject\TransferGenerator\Definition\Validator\Property\PropertyValidatorInterface;
 use Picamator\TransferObject\TransferGenerator\Definition\Validator\Property\RequiredTypePropertyValidator;
 use Picamator\TransferObject\TransferGenerator\Definition\Validator\Property\ReservedNamePropertyValidator;
@@ -91,9 +93,15 @@ protected function createPropertyValidators(): ArrayObject
             $this->createCollectionTypePropertyValidator(),
             $this->createEnumTypePropertyValidator(),
             $this->createDateTimeTypePropertyValidator(),
+            $this->createNumberTypePropertyValidator(),
         ]);
     }
 
+    protected function createNumberTypePropertyValidator(): PropertyValidatorInterface
+    {
+        return new NumberTypePropertyValidator();
+    }
+
     protected function createDateTimeTypePropertyValidator(): PropertyValidatorInterface
     {
         return new DateTimeTypePropertyValidator();
@@ -173,11 +181,17 @@ protected function createPropertyExpander(): PropertyExpanderInterface
             ->setNextExpander($this->createTransferTypePropertyExpander())
             ->setNextExpander($this->createEnumTypePropertyExpander())
             ->setNextExpander($this->createProtectedPropertyExpander())
-            ->setNextExpander($this->createDateTimeTypePropertyExpander());
+            ->setNextExpander($this->createDateTimeTypePropertyExpander())
+            ->setNextExpander($this->createNumberTypePropertyExpander());
 
         return $propertyExpander;
     }
 
+    protected function createNumberTypePropertyExpander(): PropertyExpanderInterface
+    {
+        return new NumberTypePropertyExpander();
+    }
+
     protected function createDateTimeTypePropertyExpander(): PropertyExpanderInterface
     {
         return new DateTimeTypePropertyExpander();

src/TransferGenerator/Definition/DefinitionFactory.php

@@ -13,4 +13,5 @@ enum DefinitionTypeKeyEnum: string
     case COLLECTION_TYPE = DefinitionPropertyTransfer::COLLECTION_TYPE;
     case ENUM_TYPE = DefinitionPropertyTransfer::ENUM_TYPE;
     case DATE_TIME_TYPE = DefinitionPropertyTransfer::DATE_TIME_TYPE;
+    case NUMBER_TYPE = DefinitionPropertyTransfer::NUMBER_TYPE;
 }

src/TransferGenerator/Definition/Enum/DefinitionTypeKeyEnum.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Picamator\TransferObject\TransferGenerator\Definition\Parser\Expander;
+
+use Picamator\TransferObject\Generated\DefinitionEmbeddedTypeTransfer;
+use Picamator\TransferObject\Generated\DefinitionPropertyTransfer;
+
+final class NumberTypePropertyExpander extends AbstractPropertyExpander
+{
+    use NamespacePropertyExpanderTrait;
+
+    private const string NUMBER_TYPE_KEY = 'numberType';
+
+    protected function isApplicable(array $propertyType): bool
+    {
+        return $this->getNumberType($propertyType) !== null;
+    }
+
+    protected function handleExpander(array $propertyType, DefinitionPropertyTransfer $propertyTransfer): void
+    {
+        $numberType = $this->getNumberType($propertyType) ?? '';
+        $namespaceTransfer = $this->createDefinitionNamespaceTransfer($numberType);
+
+        $typeTransfer = new DefinitionEmbeddedTypeTransfer();
+        $typeTransfer->name = $namespaceTransfer->alias ?: $namespaceTransfer->baseName;
+        $typeTransfer->namespace = $namespaceTransfer;
+
+        $propertyTransfer->numberType = $typeTransfer;
+    }
+
+    /**
+     * @param array<string,string|null> $propertyType
+     */
+    private function getNumberType(array $propertyType): ?string
+    {
+        $numberType = $propertyType[self::NUMBER_TYPE_KEY] ?? null;
+
+        return is_string($numberType) ? $numberType : null;
+    }
+}

src/TransferGenerator/Definition/Parser/Expander/NumberTypePropertyExpander.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Picamator\TransferObject\TransferGenerator\Definition\Validator\Property;
+
+use BcMath\Number;
+use Picamator\TransferObject\Generated\DefinitionPropertyTransfer;
+use Picamator\TransferObject\Generated\ValidatorMessageTransfer;
+use Picamator\TransferObject\Shared\Validator\ValidatorMessageTrait;
+
+readonly class NumberTypePropertyValidator implements PropertyValidatorInterface
+{
+    use ValidatorMessageTrait;
+
+    private const string INVALID_NUMBER_TYPE_ERROR_MESSAGE_TEMPLATE
+        = 'Property "%s" type "%s" is not a BcMath\Number.';
+
+    public function isApplicable(DefinitionPropertyTransfer $propertyTransfer): bool
+    {
+        return $propertyTransfer->numberType !== null;
+    }
+
+    public function validate(DefinitionPropertyTransfer $propertyTransfer): ValidatorMessageTransfer
+    {
+        $numberClassName = $propertyTransfer->numberType?->namespace?->withoutAlias ?: '';
+
+        if ($numberClassName === Number::class) {
+            return $this->createSuccessMessageTransfer();
+        }
+
+        $errorMessage = $this->getErrorMessage($propertyTransfer);
+
+        return $this->createErrorMessageTransfer($errorMessage);
+    }
+
+    private function getErrorMessage(DefinitionPropertyTransfer $propertyTransfer): string
+    {
+        return sprintf(
+            self::INVALID_NUMBER_TYPE_ERROR_MESSAGE_TEMPLATE,
+            $propertyTransfer->propertyName,
+            $propertyTransfer->numberType?->namespace->withoutAlias ?? '',
+        );
+    }
+}

src/TransferGenerator/Definition/Validator/Property/NumberTypePropertyValidator.php

@@ -9,6 +9,7 @@
 use Picamator\TransferObject\Transfer\Attribute\CollectionPropertyTypeAttribute;
 use Picamator\TransferObject\Transfer\Attribute\DateTimePropertyTypeAttribute;
 use Picamator\TransferObject\Transfer\Attribute\EnumPropertyTypeAttribute;
+use Picamator\TransferObject\Transfer\Attribute\NumberPropertyTypeAttribute;
 use Picamator\TransferObject\Transfer\Attribute\PropertyTypeAttribute;
 
 enum AttributeEnum: string
@@ -18,5 +19,6 @@ enum AttributeEnum: string
     case ENUM_TYPE_ATTRIBUTE = EnumPropertyTypeAttribute::class;
     case ARRAY_OBJECT_TYPE_ATTRIBUTE = ArrayObjectPropertyTypeAttribute::class;
     case ARRAY_TYPE_ATTRIBUTE = ArrayPropertyTypeAttribute::class;
-    case DATE_TIME_ATTRIBUTE = DateTimePropertyTypeAttribute::class;
+    case DATE_TIME_TYPE_ATTRIBUTE = DateTimePropertyTypeAttribute::class;
+    case NUMBER_TYPE_ATTRIBUTE = NumberPropertyTypeAttribute::class;
 }