Add AttributeTypecastHandler (#5)

vjik · Jun 17, 2024 · 7e5065b · 7e5065b
1 parent f9f0e37
commit 7e5065b
Show file tree

Hide file tree

Showing 14 changed files with 195 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Cycle Typecast Change Log
 
+## 2.2.0 June 17, 2024
+
+- New #5: Add `AttributeTypecastHandler`
+
 ## 2.1.0 February 01, 2024
 
 - New #3: Add enum types `IntegerEnumType` and `StringEnumType`
@@ -8,8 +12,8 @@
 
 - New #2: Add abstract typecast handler
 - Chg #2: Refactoring `Typecaster` (changed method names and returned values)
-- Chg #2: Raise the minimum PHP version to `^8.0` and Cycle ORM to `^2.1` 
+- Chg #2: Raise the minimum PHP version to `^8.0` and Cycle ORM to `^2.1`
 
 ## 1.0.0 December 1, 2021
 
-- Initial release.
+- Initial release
diff --git a/README.md b/README.md
@@ -9,9 +9,9 @@
 
 The package provides:
 
-- `Typecaster` that help typecast data in [Cycle ORM](https://cycle-orm.dev/);
-- `TypeInterface` that must be implemented by classes used in `Typecaster`;
-- abstract `TypecastHandler` that used `Typecaster` for typecast data;
+- `Typecaster` that help typecast data in [Cycle ORM](https://cycle-orm.dev/) and abstract `TypecastHandler` that used it;
+- `AttributeTypecastHandler` that use attributes for typecast data;
+- `TypeInterface` that must be implemented by classes used in `Typecaster` and `AttributeTypecastHandler`;
 - classes for `DateTimeImmutable`, `UUID`, `Array` and `Enum` types.
 
 ## Installation
@@ -24,6 +24,26 @@ composer require vjik/cycle-typecast
 
 ## General Usage
 
+### Attributes
+
+```php
+#[Entity(
+    // ...
+    typecast: AttributeTypecastHandler::class,
+)]
+final class User
+{
+    // ...
+
+    #[Column(type: 'primary', primary: true)]
+    #[UuidToBytesType]
+    private UuidInterface $id;
+
+    #[Column(type: 'int')]
+    #[DateTimeImmutableToIntegerType]
+    private DateTimeImmutable $createDate;
+```
+
 ### Custom Typecast Handler
 
 ```php

diff --git a/psalm.xml b/psalm.xml
@@ -13,4 +13,7 @@
             <directory name="vendor" />
         </ignoreFiles>
     </projectFiles>
+    <issueHandlers>
+        <MixedAssignment errorLevel="suppress" />
+    </issueHandlers>
 </psalm>
diff --git a/psalm80.xml b/psalm80.xml
@@ -13,4 +13,7 @@
             <file name="src/StringEnumType.php" />
         </ignoreFiles>
     </projectFiles>
+    <issueHandlers>
+        <MixedAssignment errorLevel="suppress" />
+    </issueHandlers>
 </psalm>
diff --git a/src/ArrayToStringType.php b/src/ArrayToStringType.php
@@ -4,8 +4,10 @@
 
 namespace Vjik\CycleTypecast;
 
+use Attribute;
 use InvalidArgumentException;
 
+#[Attribute(Attribute::TARGET_PROPERTY)]
 final class ArrayToStringType implements TypeInterface
 {
     /**

diff --git a/src/AttributeTypecastHandler.php b/src/AttributeTypecastHandler.php
@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vjik\CycleTypecast;
+
+use Cycle\ORM\Parser\CastableInterface;
+use Cycle\ORM\Parser\UncastableInterface;
+use Cycle\ORM\SchemaInterface;
+use ReflectionAttribute;
+use ReflectionClass;
+
+use function class_exists;
+
+final class AttributeTypecastHandler implements CastableInterface, UncastableInterface
+{
+    /**
+     * @var TypeInterface[]
+     * @psalm-var array<string, TypeInterface>
+     */
+    private array $types = [];
+
+    public function __construct(SchemaInterface $schema, string $role)
+    {
+        $entityClass = $schema->define($role, SchemaInterface::ENTITY);
+        if (is_string($entityClass) && class_exists($entityClass)) {
+            $reflection = new ReflectionClass($entityClass);
+            foreach ($reflection->getProperties() as $property) {
+                $attributes = $property->getAttributes(TypeInterface::class, ReflectionAttribute::IS_INSTANCEOF);
+                if (empty($attributes)) {
+                    continue;
+                }
+                $this->types[$property->getName()] = $attributes[0]->newInstance();
+            }
+        }
+    }
+
+    public function setRules(array $rules): array
+    {
+        foreach ($rules as $key => $_rule) {
+            if (isset($this->types[$key])) {
+                unset($rules[$key]);
+            }
+        }
+        return $rules;
+    }
+
+    public function cast(array $data): array
+    {
+        /** @psalm-var array<non-empty-string, mixed> $data */
+        foreach ($data as $key => $value) {
+            if (isset($this->types[$key])) {
+                $data[$key] = $this->types[$key]->convertToPhpValue($value);
+            }
+        }
+        return $data;
+    }
+
+    public function uncast(array $data): array
+    {
+        /** @psalm-var array<non-empty-string, mixed> $data */
+        foreach ($data as $key => $value) {
+            if (isset($this->types[$key])) {
+                $data[$key] = $this->types[$key]->convertToDatabaseValue($value);
+            }
+        }
+        return $data;
+    }
+}
diff --git a/src/DateTimeImmutable/DateTimeImmutableToIntegerType.php b/src/DateTimeImmutable/DateTimeImmutableToIntegerType.php
@@ -4,12 +4,14 @@
 
 namespace Vjik\CycleTypecast\DateTimeImmutable;
 
+use Attribute;
 use DateTimeImmutable;
 use InvalidArgumentException;
 
 use function is_int;
 use function is_string;
 
+#[Attribute(Attribute::TARGET_PROPERTY)]
 final class DateTimeImmutableToIntegerType extends DateTimeImmutableType
 {
     protected function toDatabaseValue(DateTimeImmutable $value): string

diff --git a/src/IntegerEnumType.php b/src/IntegerEnumType.php
@@ -4,9 +4,11 @@
 
 namespace Vjik\CycleTypecast;
 
+use Attribute;
 use BackedEnum;
 use InvalidArgumentException;
 
+#[Attribute(Attribute::TARGET_PROPERTY)]
 final class IntegerEnumType implements TypeInterface
 {
     /**

diff --git a/src/StringEnumType.php b/src/StringEnumType.php
@@ -4,9 +4,11 @@
 
 namespace Vjik\CycleTypecast;
 
+use Attribute;
 use BackedEnum;
 use InvalidArgumentException;
 
+#[Attribute(Attribute::TARGET_PROPERTY)]
 final class StringEnumType implements TypeInterface
 {
     /**

diff --git a/src/UuidString/UuidStringToBytesType.php b/src/UuidString/UuidStringToBytesType.php
@@ -4,11 +4,13 @@
 
 namespace Vjik\CycleTypecast\UuidString;
 
+use Attribute;
 use Exception;
 use InvalidArgumentException;
 use Ramsey\Uuid\Uuid;
 use Ramsey\Uuid\UuidInterface;
 
+#[Attribute(Attribute::TARGET_PROPERTY)]
 final class UuidStringToBytesType extends UuidStringType
 {
     protected function toDatabaseValue(UuidInterface $value): string

diff --git a/tests/AttributeTypecastHandlerTest.php b/tests/AttributeTypecastHandlerTest.php
@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vjik\CycleTypecast\Tests;
+
+use Cycle\ORM\SchemaInterface;
+use PHPUnit\Framework\TestCase;
+use Ramsey\Uuid\Uuid;
+use Vjik\CycleTypecast\AttributeTypecastHandler;
+use Vjik\CycleTypecast\Tests\Support\EntityWithAttributes;
+
+final class AttributeTypecastHandlerTest extends TestCase
+{
+    public function testBase(): void
+    {
+        $schema = $this->createMock(SchemaInterface::class);
+        $schema
+            ->method('define')
+            ->with('role_user', SchemaInterface::ENTITY)
+            ->willReturn(EntityWithAttributes::class);
+
+        $typecastHandler = new AttributeTypecastHandler($schema, 'role_user');
+
+        $uuid = Uuid::fromString('1f2d3897-a226-4eec-bd2c-d0145ef25df9');
+
+        $data = $typecastHandler->uncast([
+            'id' => '1f2d3897-a226-4eec-bd2c-d0145ef25df9',
+            'names' => ['John', 'Doe'],
+        ]);
+        $this->assertSame(
+            [
+                'id' => $uuid->getBytes(),
+                'names' => 'John,Doe',
+            ],
+            $data,
+        );
+
+        $data = $typecastHandler->cast([
+            'id' => $uuid->getBytes(),
+            'names' => 'John,Doe',
+        ]);
+        $this->assertSame(
+            [
+                'id' => '1f2d3897-a226-4eec-bd2c-d0145ef25df9',
+                'names' => ['John', 'Doe'],
+            ],
+            $data,
+        );
+
+        $rules = $typecastHandler->setRules([
+            'id' => 'string',
+            'names' => 'array',
+            'age' => 'int',
+        ]);
+        $this->assertSame(['age' => 'int'], $rules);
+    }
+}
diff --git a/tests/Support/EntityWithAttributes.php b/tests/Support/EntityWithAttributes.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vjik\CycleTypecast\Tests\Support;
+
+use Vjik\CycleTypecast\ArrayToStringType;
+use Vjik\CycleTypecast\UuidString\UuidStringToBytesType;
+
+final class EntityWithAttributes
+{
+    #[UuidStringToBytesType]
+    public string $id;
+
+    #[ArrayToStringType(',')]
+    public array $names;
+
+    public int $age;
+}
diff --git a/tests/Support/StubDateTimeImmutableType.php b/tests/Support/StubDateTimeImmutableType.php
@@ -4,9 +4,11 @@
 
 namespace Vjik\CycleTypecast\Tests\Support;
 
+use Attribute;
 use DateTimeImmutable;
 use Vjik\CycleTypecast\DateTimeImmutable\DateTimeImmutableType;
 
+#[Attribute(Attribute::TARGET_PROPERTY)]
 final class StubDateTimeImmutableType extends DateTimeImmutableType
 {
     protected function toDatabaseValue(DateTimeImmutable $value): mixed

diff --git a/tests/Support/StubUuidStringType.php b/tests/Support/StubUuidStringType.php
@@ -4,9 +4,11 @@
 
 namespace Vjik\CycleTypecast\Tests\Support;
 
+use Attribute;
 use Ramsey\Uuid\UuidInterface;
 use Vjik\CycleTypecast\UuidString\UuidStringType;
 
+#[Attribute(Attribute::TARGET_PROPERTY)]
 final class StubUuidStringType extends UuidStringType
 {
     protected function toDatabaseValue(UuidInterface $value): mixed