Support for Date and DateTime casting, fixes #53

Author: pascalbaljet

src/Components/HandlesBoundValues.php

@@ -2,9 +2,11 @@
 
 namespace ProtoneMedia\LaravelFormComponents\Components;
 
+use DateTimeInterface;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\MorphMany;
+use Illuminate\Support\Carbon;
 use ProtoneMedia\LaravelFormComponents\FormDataBinder;
 
 trait HandlesBoundValues
@@ -52,9 +54,51 @@ private function getBoundValue($bind, string $name)
 
         $bind = $bind ?: $this->getBoundTarget();
 
-        return $this->manyRelation
-            ? $this->getAttachedKeysFromRelation($bind, $name)
-            : data_get($bind, $name);
+        if ($this->manyRelation) {
+            return  $this->getAttachedKeysFromRelation($bind, $name);
+        }
+
+        $boundValue = data_get($bind, $name);
+
+        if ($bind instanceof Model && $boundValue instanceof DateTimeInterface) {
+            return $this->formatDateTime($bind, $name, $boundValue);
+        }
+
+        return $boundValue;
+    }
+
+    /**
+     * Formats a DateTimeInterface if the key is specified as a date or datetime in the model.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @param string $key
+     * @param DateTimeInterface $date
+     * @return void
+     */
+    private function formatDateTime(Model $model, string $key, DateTimeInterface $date)
+    {
+        $cast = $model->getCasts()[$key] ?? null;
+
+        if (!$cast || $cast === 'date' || $cast === 'datetime') {
+            return Carbon::instance($date)->toJSON();
+        }
+
+        if ($this->isCustomDateTimeCast($cast)) {
+            return $date->format(explode(':', $cast, 2)[1]);
+        }
+
+        return $date;
+    }
+
+    /**
+     * Determine if the cast type is a custom date time cast.
+     *
+     * @param  string  $cast
+     * @return bool
+     */
+    protected function isCustomDateTimeCast($cast)
+    {
+        return strncmp($cast, 'date:', 5) === 0 || strncmp($cast, 'datetime:', 9) === 0;
     }
 
     /**

tests/Feature/ActivityModel.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace ProtoneMedia\LaravelFormComponents\Tests\Feature;
+
+use Illuminate\Database\Eloquent\Model;
+
+class ActivityModel extends Model
+{
+    public $casts = [
+        'date_b' => 'date',
+        'date_c' => 'datetime',
+        'date_d' => 'date:Y',
+        'date_e' => 'datetime:Y-m',
+    ];
+
+    public $dates = ['date_a'];
+}

tests/Feature/DateTimeCastTest.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace ProtoneMedia\LaravelFormComponents\Tests\Feature;
+
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Facades\View;
+use ProtoneMedia\LaravelFormComponents\Tests\TestCase;
+
+class DateTimeCastTest extends TestCase
+{
+    /** @test */
+    public function it_supports_date_casts_and_custom_casts()
+    {
+        $this->registerTestRoute('date-time-casts');
+
+        Carbon::setTestNow(Carbon::parse('2021-11-01 12:00:00'));
+
+        ActivityModel::unguard();
+
+        View::share('model', new ActivityModel([
+            'date_a' => now(),
+            'date_b' => now(),
+            'date_c' => now(),
+            'date_d' => now(),
+            'date_e' => now(),
+        ]));
+
+        $this->visit('/date-time-casts')
+            ->seeElement('input[name="date_a"][value="2021-11-01T12:00:00.000000Z"]')
+            ->seeElement('input[name="date_b"][value="2021-11-01T00:00:00.000000Z"]')
+            ->seeElement('input[name="date_c"][value="2021-11-01T12:00:00.000000Z"]')
+            ->seeElement('input[name="date_d"][value="2021"]')
+            ->seeElement('input[name="date_e"][value="2021-11"]');
+    }
+}

tests/Feature/DateTimeModel.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace ProtoneMedia\LaravelFormComponents\Tests\Feature;
+
+use Illuminate\Database\Eloquent\Model;
+
+class ActivityModel extends Model
+{
+    public $casts = [
+        'date_b' => 'date',
+        'date_c' => 'datetime',
+        'date_d' => 'date:Y',
+        'date_e' => 'datetime:Y-m',
+    ];
+
+    public $dates = ['date_a'];
+}

tests/Feature/database/create_activities_table.php

@@ -0,0 +1,33 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateActivitiesTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('activities', function (Blueprint $table) {
+            $table->date('date_a');
+            $table->date('date_b');
+            $table->dateTime('date_c');
+            $table->date('date_d');
+            $table->dateTime('date_e');
+        });
+    }
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('activities');
+    }
+}

tests/Feature/views/date-time-casts.blade.php

@@ -0,0 +1,11 @@
+<x-form>
+    @bind($model)
+        <x-form-input name="date_a" />
+        <x-form-input name="date_b" />
+        <x-form-input name="date_c" />
+        <x-form-input name="date_d" />
+        <x-form-input name="date_e" />
+
+        <x-form-submit />
+    @endbind
+</x-form>