Support validate custom fields and save custom field values

composer.json

@@ -24,7 +24,8 @@
     "require": {
         "php": ">=8.0",
         "doctrine/dbal": "^3.6",
-        "illuminate/support": "^8.0|^9.0"
+        "illuminate/support": "^8.0|^9.0",
+        "tightenco/parental": "^1.0"
     },
     "require-dev": {
         "mockery/mockery": "^1.5",
@@ -41,7 +42,9 @@
     },
     "autoload": {
         "psr-4": {
-            "OnrampLab\\CustomFields\\": "src/"
+            "OnrampLab\\CustomFields\\": "src/",
+            "OnrampLab\\CustomFields\\Database\\Factories\\": "database/factories"
+
         }
     },
     "autoload-dev": {

database/factories/CustomFieldFactory.php

@@ -18,12 +18,13 @@ public function definition()
     {
         return [
             'friendly_name' => $this->faker->word(),
-            'field_key' => $this->faker->slug(),
-            'field_type' => $this->faker->randomElement(['text', 'integer']),
+            'key' => $this->faker->slug(),
+            'type' => $this->faker->randomElement(['text', 'integer']),
+            'available_options' => [],
             'required' => $this->faker->boolean(),
             'default_value' => $this->faker->optional()->word,
             'description' => $this->faker->optional()->paragraph,
-            'model' => $this->faker->word(),
+            'model_class' => $this->faker->word(),
             'contextable_id' => $this->faker->randomNumber(),
             'contextable_type' => $this->faker->word(),
         ];

database/factories/CustomFieldValueFactory.php

@@ -20,8 +20,8 @@ public function definition()
         return [
             'custom_field_id' => CustomField::factory(),
             'value' => $this->faker->word(),
-            'model_id' => $this->faker->randomNumber(),
-            'model_type' => $this->faker->word(),
+            'customizable_id' => $this->faker->randomNumber(),
+            'customizable_type' => $this->faker->word(),
         ];
     }
 }

database/migrations/2023_05_18_002949_create_custom_fields_table.php

@@ -18,14 +18,14 @@ public function up()
             $table->string('friendly_name');
             $table->string('key');
             $table->enum('type', ['text', 'integer', 'float', 'datetime', 'select', 'boolean']);
-            $table->json('available_options');
+            $table->json('available_options')->nullable();
             $table->boolean('required')->default(0);
             $table->string('default_value')->nullable();
             $table->text('description')->nullable();
             $table->string('model_class');
             $table->unsignedBigInteger('contextable_id')->nullable();
             $table->string('contextable_type')->nullable();
-            $table->unique(['key', 'model_class', 'contextable_type', 'contextable_id']);
+            $table->unique(['key', 'model_class', 'contextable_type', 'contextable_id'], 'custom_fields_key_model_class_contextable_unique');
             $table->timestamps();
         });
     }

src/AttributeCastors/AvailableOptionsCastor.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace OnrampLab\CustomFields\AttributeCastors;
+
+use InvalidArgumentException;
+use OnrampLab\CustomFields\Models\CustomField;
+use Illuminate\Support\Collection;
+use OnrampLab\CustomFields\ValueObjects\AvailableOption;
+
+class AvailableOptionsCastor
+{
+    /**
+     * Cast the given value.
+     *
+     * @param  CustomField  $model
+     * @param  string  $key
+     * @param  mixed  $value
+     * @param  array  $attributes
+     * @return Collection<AvailableOption>
+     */
+    public function get($model, $key, $value, $attributes)
+    {
+        $data = json_decode(data_get($attributes, 'available_options') ?? '[]', true);
+
+        return Collection::make($data)
+            ->map(function (array $option) {
+                return new AvailableOption($option);
+            });
+    }
+
+    /**
+     * Prepare the given value for storage.
+     *
+     * @param  CustomField  $model
+     * @param  string  $key
+     * @param  Collection|array  $value
+     * @param  array  $attributes
+     * @return array
+     */
+    public function set($model, $key, $value, $attributes)
+    {
+        $value = Collection::make($value);
+        $isValid = $value->every(function ($option) {
+            return $option instanceof AvailableOption;
+        });
+
+        if (!$isValid) {
+            throw new InvalidArgumentException('This given value is not an AvailableOption instance.');
+        }
+
+        return [
+            'available_options' => json_encode($value->toArray()),
+        ];
+    }
+}

src/Concerns/Contextable.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace OnrampLab\CustomFields\Concerns;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphMany;
+use OnrampLab\CustomFields\Models\CustomField;
+
+/**
+ * @mixin Model
+ */
+trait Contextable
+{
+    /**
+     * Retrieve model's custom fields
+     */
+    public function customFields(): MorphMany
+    {
+        return $this->morphMany(CustomField::class, 'contextable');
+    }
+}

src/Concerns/Customizable.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace OnrampLab\CustomFields\Concerns;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphMany;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Support\Facades\Validator;
+use OnrampLab\CustomFields\Models\CustomField;
+use OnrampLab\CustomFields\Models\CustomFieldValue;
+use OnrampLab\CustomFields\Observers\ModelObserver;
+
+/**
+ * @mixin Model
+ */
+trait Customizable
+{
+    protected ?array $validatedCustomFieldValues = [];
+
+    public static function bootCustomizable(): void
+    {
+        static::observe(ModelObserver::class);
+    }
+
+    /**
+     * Retrieve model's custom field values
+     */
+    public function customFieldValues(): MorphMany
+    {
+        return $this->morphMany(CustomFieldValue::class, 'customizable');
+    }
+
+    /**
+     * Validate custom field values
+     */
+    public function validateCustomFields(): void
+    {
+        $customFields = $this->getCustomFields();
+        if ($customFields->isEmpty()) {
+            return;
+        }
+        $tableColumns = $this->getTableColumns();
+        $modelAttributes = Collection::make($this->getAttributes());
+        $modelAttributeKeys = $modelAttributes->keys();
+        $customFieldColumns = $modelAttributeKeys->diff($tableColumns);
+        $customFieldsRules = $customFields->flatMap(function (CustomField $field) {
+            return $field->getValidationRule();
+        })->all();
+
+        $customFieldValues = $modelAttributes->only($customFieldColumns)->toArray();
+        $validator = Validator::make($customFieldValues, $customFieldsRules);
+        $this->validatedCustomFieldValues = $validator->validate();
+        $this->setRawAttributes($modelAttributes->only($tableColumns)->toArray());
+    }
+
+    protected function getTableColumns(): Collection
+    {
+        return Collection::make(Schema::getColumnListing($this->getTable()));
+    }
+
+    public function getCustomFields(): Collection
+    {
+        $context = $this->getContext();
+        $query = CustomField::query();
+        if (is_null($context)) {
+            $customFields = $query->get();
+        } else {
+            $customFields = $query
+                ->where('contextable_type', get_class($context))
+                ->where('contextable_id', $context->id)
+                ->get();
+        }
+
+        return $customFields;
+    }
+
+    public function getContext(): ?Model
+    {
+        return null;
+    }
+
+    public function saveCustomFieldValues(): void
+    {
+        $validatedCustomFieldValues = $this->validatedCustomFieldValues;
+        if (empty($validatedCustomFieldValues)) {
+            return;
+        }
+        $customFields = $this->getCustomFields();
+        $customFields->each(function ($customField) use ($validatedCustomFieldValues) {
+            if (array_key_exists($customField->key, $validatedCustomFieldValues)) {
+                $value = $validatedCustomFieldValues[$customField->key];
+                $constraints = [
+                    'custom_field_id' => $customField->id,
+                    'customizable_type' => get_class($this),
+                    'customizable_id' => $this->id
+                ];
+                $values = ['value' => $value];
+                CustomFieldValue::updateOrCreate($constraints, $values);
+            }
+        });
+    }
+}

src/Models/BooleanCustomField.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace OnrampLab\CustomFields\Models;
+
+use Parental\HasParent;
+
+class BooleanCustomField extends CustomField
+{
+    use HasParent;
+
+    public function getValidationRule(): array
+    {
+        return [
+            $this->key => ['boolean'],
+        ];
+    }
+}

src/Models/CustomField.php

@@ -5,11 +5,21 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Factories\Factory;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use OnrampLab\CustomFields\AttributeCastors\AvailableOptionsCastor;
 use OnrampLab\CustomFields\Database\Factories\CustomFieldFactory;
+use Parental\HasChildren;
 
 class CustomField extends Model
 {
     use HasFactory;
+    use HasChildren;
+
+    public const TYPE_TEXT = 'text';
+    public const TYPE_INTEGER = 'integer';
+    public const TYPE_FLOAT = 'float';
+    public const TYPE_DATETIME = 'datetime';
+    public const TYPE_SELECT = 'select';
 
     /**
      * The attributes that are mass assignable.
@@ -18,18 +28,42 @@ class CustomField extends Model
      */
     protected $fillable = [
         'friendly_name',
-        'field_key',
-        'field_type',
+        'key',
+        'type',
+        'available_options',
         'required',
         'default_value',
         'description',
-        'model',
-        'context_type',
-        'context_id'
+        'model_class',
+        'contextable_type',
+        'contextable_id'
+    ];
+
+    protected $casts = [
+        'required' => 'boolean',
+        'available_options' => AvailableOptionsCastor::class,
+    ];
+
+    protected array $childTypes = [
+        CustomField::TYPE_TEXT => TextCustomField::class,
+        CustomField::TYPE_INTEGER => IntegerCustomField::class,
+        CustomField::TYPE_FLOAT => FloatCustomField::class,
+        CustomField::TYPE_DATETIME => DateTimeCustomField::class,
+        CustomField::TYPE_SELECT => SelectCustomField::class
     ];
 
     protected static function newFactory(): Factory
     {
         return CustomFieldFactory::new();
     }
+
+    public function values(): HasMany
+    {
+        return $this->hasMany(CustomFieldValue::class);
+    }
+
+    public function getValidationRule(): array
+    {
+        return [];
+    }
 }

src/Models/CustomFieldValue.php

@@ -5,6 +5,7 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Factories\Factory;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use OnrampLab\CustomFields\Database\Factories\CustomFieldValueFactory;
 
 class CustomFieldValue extends Model
@@ -19,12 +20,17 @@ class CustomFieldValue extends Model
     protected $fillable = [
         'custom_field_id',
         'value',
-        'model_id',
-        'model_type',
+        'customizable_id',
+        'customizable_type',
     ];
 
     protected static function newFactory(): Factory
     {
         return CustomFieldValueFactory::new();
     }
+
+    public function customField(): BelongsTo
+    {
+        return $this->belongsTo(CustomField::class);
+    }
 }

src/Models/DateTimeCustomField.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace OnrampLab\CustomFields\Models;
+
+use Parental\HasParent;
+
+class DateTimeCustomField extends CustomField
+{
+    use HasParent;
+
+    public function getValidationRule(): array
+    {
+        return [
+            $this->key => ['date'],
+        ];
+    }
+}

src/Models/FloatCustomField.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace OnrampLab\CustomFields\Models;
+
+use Parental\HasParent;
+
+class FloatCustomField extends CustomField
+{
+    use HasParent;
+
+    public function getValidationRule(): array
+    {
+        return [
+            $this->key => ['numeric'],
+        ];
+    }
+}