chore(concern): [Customizable] add load custom field values method

Author: moon-brillar

src/Concerns/Customizable.php

@@ -18,6 +18,9 @@ trait Customizable
 {
     protected array $validatedCustomFieldValues = [];
 
+    /**
+     * Boot Model Observer.
+     */
     public static function bootCustomizable(): void
     {
         static::observe(ModelObserver::class);
@@ -53,11 +56,10 @@ public function validateCustomFields(): void
         $this->validatedCustomFieldValues = $validator->validate();
     }
 
-    protected function getTableColumns(): Collection
-    {
-        return Collection::make(Schema::getColumnListing($this->getTable()));
-    }
 
+    /**
+     * Get the custom fields associated with the model.
+     */
     public function getCustomFields(): Collection
     {
         $context = $this->getCustomFieldContext();
@@ -76,11 +78,17 @@ public function getCustomFields(): Collection
         return $customFields;
     }
 
+    /**
+     * Get the context model associated with the model.
+     */
     public function getCustomFieldContext(): ?Model
     {
         return null;
     }
 
+    /**
+     * Save the custom field values.
+     */
     public function saveCustomFieldValues(): void
     {
         $validatedCustomFieldValues = $this->validatedCustomFieldValues;
@@ -101,4 +109,27 @@ public function saveCustomFieldValues(): void
             }
         });
     }
+
+    /**
+     * Load custom field values and set them as model attributes.
+     */
+    public function loadCustomFieldValues(): void
+    {
+        if (! $this->customFieldValues) {
+            return;
+        }
+
+        $this->customFieldValues->each(function (CustomFieldValue $customFieldValue) {
+            $attribute = $customFieldValue->customField->key;
+            $this->setAttribute($attribute, $customFieldValue->customField->parseValue($customFieldValue->value));
+        });
+    }
+
+    /**
+     * Get the table columns of the model.
+     */
+    protected function getTableColumns(): Collection
+    {
+        return Collection::make(Schema::getColumnListing($this->getTable()));
+    }
 }

tests/Unit/Concerns/CustomizableTest.php

@@ -2,10 +2,12 @@
 
 namespace OnrampLab\CustomFields\Tests\Unit\Concerns;
 
+use Illuminate\Validation\ValidationException;
 use OnrampLab\CustomFields\Models\CustomField;
 use OnrampLab\CustomFields\Tests\Classes\Account;
 use OnrampLab\CustomFields\Tests\Classes\User;
 use OnrampLab\CustomFields\Tests\TestCase;
+use OnrampLab\CustomFields\ValueObjects\AvailableOption;
 
 class CustomizableTest extends TestCase
 {
@@ -18,7 +20,7 @@ protected function setUp(): void
             'type' => 'text',
             'model_class' => User::class,
             'contextable_id' => $this->account->id,
-            'contextable_type' => get_class($this->account)
+            'contextable_type' => $this->account->getMorphClass()
         ];
         $this->customField = CustomField::factory()->create($attributes);
         $this->user = User::factory()->create(['account_id' => $this->account->id, 'zip_code' => '12345']);
@@ -34,4 +36,57 @@ public function custom_field_values_relationship_should_work(): void
         $this->assertEquals($this->user->id, $customFieldValues->first()->customizable_id);
         $this->assertEquals(get_class($this->user), $customFieldValues->first()->customizable_type);
     }
+
+    /**
+     * @test
+     */
+    public function validate_custom_fields_should_work()
+    {
+        $this->expectException(ValidationException::class);
+        $this->user->zip_code = 123;
+        $this->user->validateCustomFields();
+    }
+
+    /**
+     * @test
+     * @dataProvider customFieldDataProvider
+     */
+    public function custom_load_custom_field_values_should_work($type, $value, $expected): void
+    {
+        $attributes = [
+            'key' => 'field',
+            'type' => $type,
+            'model_class' => User::class,
+            'contextable_id' => $this->account->id,
+            'contextable_type' => $this->account->getMorphClass()
+        ];
+        if ($type == 'select') {
+            $attributes['available_options'] = [
+                new AvailableOption([
+                    'name' => 'Option 1',
+                    'value' => 'Option 1',
+                ]),
+                new AvailableOption([
+                    'name' => 'Option 2',
+                    'value' => 'Option 2',
+                ])
+            ];
+        }
+        $customField = CustomField::factory()->create($attributes);
+        $user = User::factory()->create(['account_id' => $this->account->id, 'field' => $value]);
+        $user->loadCustomFieldValues();
+        $this->assertEquals($expected, $user->field);
+    }
+
+    public function customFieldDataProvider(): array
+    {
+        return [
+            'Text field' => ['text', 'Value', 'Value'],
+            'Integer field' => ['integer', '42', 42],
+            'Float field' => ['float', '3.14', 3.14],
+            'Datetime field' => ['datetime', '2023-05-16 12:34:56', '2023-05-16 12:34:56'],
+            'Select field' => ['select', 'Option 1', 'Option 1'],
+            'Boolean field' => ['boolean', '1', true],
+        ];
+    }
 }