Merge pull request #214 from hypervel/feature/data-object-auto-cast

feat: support auto-cast in data object and eloquent caster

Author: albertcht

src/core/src/Database/Eloquent/Casts/AsDataObject.php

@@ -0,0 +1,71 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hypervel\Database\Eloquent\Concerns;
+
+use Hyperf\Contract\CastsAttributes;
+use Hypervel\Support\DataObject;
+use InvalidArgumentException;
+
+class AsDataObject implements CastsAttributes
+{
+    protected static $reflectionCache = [];
+
+    public function __construct(
+        protected string $argument
+    ) {
+        if (! is_subclass_of($this->argument, DataObject::class)) {
+            throw new InvalidArgumentException(sprintf(
+                'The given class %s is not a subclass of %s.',
+                $this->argument,
+                DataObject::class
+            ));
+        }
+    }
+
+    /**
+     * Cast the given value.
+     *
+     * @param array<string, mixed> $attributes
+     * @param mixed $model
+     */
+    public function get(
+        $model,
+        string $key,
+        mixed $value,
+        array $attributes,
+    ): ?DataObject {
+        if (! $data = json_decode((string) $value, true)) {
+            return null;
+        }
+
+        return call_user_func_array(
+            [$this->argument, 'make'],
+            [$data, true]
+        );
+    }
+
+    /**
+     * Prepare the given value for storage.
+     *
+     * @param array<string, mixed> $attributes
+     * @param mixed $model
+     */
+    public function set(
+        $model,
+        string $key,
+        mixed $value,
+        array $attributes,
+    ): string {
+        return json_encode($value);
+    }
+
+    /**
+     * Specify a custom caster class for the data object.
+     */
+    public static function castUsing(string $class): string
+    {
+        return sprintf('%s:%s', static::class, $class);
+    }
+}

src/core/src/Database/Eloquent/Concerns/HasAttributes.php

@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hypervel\Database\Eloquent\Concerns;
+
+use Hyperf\Contract\Castable;
+use Hyperf\Contract\CastsAttributes;
+use Hyperf\Contract\CastsInboundAttributes;
+
+trait HasAttributes
+{
+    /**
+     * The cache of the casters.
+     */
+    protected static array $casterCache = [];
+
+    /**
+     * The cache of the casts.
+     */
+    protected static array $castsCache = [];
+
+    /**
+     * Resolve the custom caster class for a given key.
+     */
+    protected function resolveCasterClass(string $key): CastsAttributes|CastsInboundAttributes
+    {
+        $castType = $this->getCasts()[$key];
+        if ($caster = static::$casterCache[static::class][$castType] ?? null) {
+            return $caster;
+        }
+
+        $arguments = [];
+
+        $castClass = $castType;
+        if (is_string($castClass) && str_contains($castClass, ':')) {
+            $segments = explode(':', $castClass, 2);
+
+            $castClass = $segments[0];
+            $arguments = explode(',', $segments[1]);
+        }
+
+        if (is_subclass_of($castClass, Castable::class)) {
+            $castClass = $castClass::castUsing();
+        }
+
+        if (is_object($castClass)) {
+            return static::$casterCache[static::class][$castType] = $castClass;
+        }
+
+        return static::$casterCache[static::class][$castType] = new $castClass(...$arguments);
+    }
+
+    /**
+     * Get the casts array.
+     */
+    public function getCasts(): array
+    {
+        if (! is_null($cache = static::$castsCache[static::class] ?? null)) {
+            return $cache;
+        }
+
+        if ($this->getIncrementing()) {
+            return static::$castsCache[static::class] = array_merge([$this->getKeyName() => $this->getKeyType()], $this->casts, $this->casts());
+        }
+
+        return static::$castsCache[static::class] = $this->casts;
+    }
+
+    /**
+     * Get the attributes that should be cast.
+     *
+     * @return array<string, string>
+     */
+    protected function casts(): array
+    {
+        return [];
+    }
+}

src/core/src/Database/Eloquent/Model.php

@@ -8,6 +8,7 @@
 use Hyperf\Stringable\Str;
 use Hypervel\Broadcasting\Contracts\HasBroadcastChannel;
 use Hypervel\Context\Context;
+use Hypervel\Database\Eloquent\Concerns\HasAttributes;
 use Hypervel\Database\Eloquent\Concerns\HasCallbacks;
 use Hypervel\Database\Eloquent\Concerns\HasObservers;
 use Hypervel\Database\Eloquent\Concerns\HasRelations;
@@ -65,6 +66,7 @@
  */
 abstract class Model extends BaseModel implements UrlRoutable, HasBroadcastChannel
 {
+    use HasAttributes;
     use HasCallbacks;
     use HasRelations;
     use HasRelationships;