feat(database): support dto fields (#1305)

Author: brendt

packages/database/src/Builder/ModelInspector.php

@@ -11,6 +11,8 @@
 use Tempest\Database\Relation;
 use Tempest\Database\Table;
 use Tempest\Database\Virtual;
+use Tempest\Mapper\CastWith;
+use Tempest\Mapper\SerializeWith;
 use Tempest\Reflection\ClassReflector;
 use Tempest\Reflection\PropertyReflector;
 use Tempest\Support\Arr\ImmutableArray;
@@ -130,10 +132,18 @@ public function getBelongsTo(string $name): ?BelongsTo
             return $belongsTo;
         }
 
+        if ($property->hasAttribute(Virtual::class)) {
+            return null;
+        }
+
         if (! $property->getType()->isRelation()) {
             return null;
         }
 
+        if ($property->hasAttribute(SerializeWith::class) || $property->getType()->asClass()->haSAttribute(SerializeWith::class)) {
+            return null;
+        }
+
         if ($property->hasAttribute(HasOne::class)) {
             return null;
         }
@@ -189,6 +199,10 @@ public function getHasMany(string $name): ?HasMany
             return $hasMany;
         }
 
+        if ($property->hasAttribute(Virtual::class)) {
+            return null;
+        }
+
         if (! $property->getIterableType()?->isRelation()) {
             return null;
         }
@@ -199,6 +213,20 @@ public function getHasMany(string $name): ?HasMany
         return $hasMany;
     }
 
+    public function isRelation(string|PropertyReflector $name): bool
+    {
+        $name = ($name instanceof PropertyReflector) ? $name->getName() : $name;
+
+        return $this->getBelongsTo($name) !== null || $this->getHasOne($name) !== null || $this->getHasMany($name) !== null;
+    }
+
+    public function getRelation(string|PropertyReflector $name): ?Relation
+    {
+        $name = ($name instanceof PropertyReflector) ? $name->getName() : $name;
+
+        return $this->getBelongsTo($name) ?? $this->getHasOne($name) ?? $this->getHasMany($name);
+    }
+
     public function getSelectFields(): ImmutableArray
     {
         if (! $this->isObjectModel()) {
@@ -228,13 +256,6 @@ public function getSelectFields(): ImmutableArray
         return $selectFields;
     }
 
-    public function getRelation(string|PropertyReflector $name): ?Relation
-    {
-        $name = ($name instanceof PropertyReflector) ? $name->getName() : $name;
-
-        return $this->getBelongsTo($name) ?? $this->getHasOne($name) ?? $this->getHasMany($name);
-    }
-
     public function resolveRelations(string $relationString, string $parent = ''): array
     {
         if ($relationString === '') {

packages/database/src/Builder/QueryBuilders/InsertQueryBuilder.php

@@ -119,7 +119,7 @@ private function resolveData(): array
                 $value = $property->getValue($model);
 
                 // BelongsTo and reverse HasMany relations are included
-                if ($property->getType()->isRelation()) {
+                if ($definition->isRelation($property)) {
                     $column .= '_id';
 
                     $value = match (true) {

packages/database/src/Builder/QueryBuilders/UpdateQueryBuilder.php

@@ -114,7 +114,7 @@ private function resolveValues(): ImmutableArray
                 throw new CannotUpdateHasOneRelation($modelClass->getName(), $property->getName());
             }
 
-            if ($property->getType()->isRelation()) {
+            if ($modelDefinition->isRelation($property)) {
                 $column .= '_id';
 
                 $value = match (true) {

packages/database/src/IsDatabaseModel.php

@@ -45,8 +45,12 @@ public static function all(array $relations = []): array
             ->all();
     }
 
-    public static function get(Id $id, array $relations = []): ?self
+    public static function get(string|int|Id $id, array $relations = []): ?self
     {
+        if (! ($id instanceof Id)) {
+            $id = new Id($id);
+        }
+
         return self::select()
             ->with(...$relations)
             ->get($id);

packages/database/src/QueryStatements/CreateTableStatement.php

@@ -189,6 +189,20 @@ public function json(
         return $this;
     }
 
+    public function dto(
+        string $name,
+        bool $nullable = false,
+        ?string $default = null,
+    ): self {
+        $this->statements[] = new JsonStatement(
+            name: $name,
+            nullable: $nullable,
+            default: $default,
+        );
+
+        return $this;
+    }
+
     public function array(
         string $name,
         bool $nullable = false,

packages/mapper/src/Casters/DtoCaster.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Tempest\Mapper\Casters;
+
+use Tempest\Mapper\Caster;
+use Tempest\Mapper\Exceptions\CannotCastValue;
+
+use function Tempest\map;
+
+final class DtoCaster implements Caster
+{
+    public function cast(mixed $input): mixed
+    {
+        if (! json_validate($input)) {
+            throw new CannotCastValue('json string');
+        }
+
+        ['type' => $type, 'data' => $data] = json_decode($input, true);
+
+        return map($data)->to($type);
+    }
+}

packages/mapper/src/Exceptions/CannotCastValue.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Mapper\Exceptions;
+
+use Exception;
+
+final class CannotCastValue extends Exception
+{
+    public function __construct(string $expectedType)
+    {
+        parent::__construct('Could not cast value, input should be of type ' . $expectedType);
+    }
+}

packages/mapper/src/Serializers/DtoSerializer.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Tempest\Mapper\Serializers;
+
+use Tempest\Mapper\Exceptions\CannotSerializeValue;
+use Tempest\Mapper\Serializer;
+
+use function Tempest\map;
+
+final class DtoSerializer implements Serializer
+{
+    public function serialize(mixed $input): array|string
+    {
+        if (! is_object($input)) {
+            throw new CannotSerializeValue('object');
+        }
+
+        $data = map($input)->toArray();
+
+        return json_encode([
+            'type' => get_class($input),
+            'data' => $data,
+        ]);
+    }
+}

tests/Integration/Database/Fixtures/DtoForModelWithSerializer.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Tests\Tempest\Integration\Database\Fixtures;
+
+use Tempest\Mapper\Casters\DtoCaster;
+use Tempest\Mapper\CastWith;
+use Tempest\Mapper\Serializers\DtoSerializer;
+use Tempest\Mapper\SerializeWith;
+
+#[CastWith(DtoCaster::class)]
+#[SerializeWith(DtoSerializer::class)]
+final class DtoForModelWithSerializer
+{
+    public function __construct(
+        public string $data,
+    ) {}
+}

tests/Integration/Database/Fixtures/DtoForModelWithSerializerOnProperty.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Tests\Tempest\Integration\Database\Fixtures;
+
+final class DtoForModelWithSerializerOnProperty
+{
+    public function __construct(
+        public string $data,
+    ) {}
+}