feat(customizable): add autoTransform functionality to parseValue methods

river0825 · river0825 · commit 017b3c3df555 · 2024-11-28T12:19:23.000+08:00
- Implemented validation for string, integer, and float types in custom fields.
- Updated the getValidationRule method in relevant custom field classes.
- Added tests to ensure validation works as expected.
diff --git a/Dockerfile b/Dockerfile
@@ -1,5 +1,5 @@
 ARG PHP_EXTENSIONS="pdo_sqlite intl"
-FROM thecodingmachine/php:8.0-v4-slim-apache AS php
+FROM thecodingmachine/php:8.1-v4-slim-apache AS php
 
 USER root
 
@@ -16,4 +16,4 @@ RUN sudo mv phive.phar /usr/local/bin/phive
 
 USER docker
 
-RUN phive install --force-accept-unsigned --trust-gpg-keys 67F861C3D889C656 phpDocumentor
+RUN echo 'y' | phive install --force-accept-unsigned --trust-gpg-keys 67F861C3D889C656 phpDocumentor
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,5 +1,3 @@
-version: '3.4'
-
 services:
   php:
     build: .
diff --git a/src/Concerns/Customizable.php b/src/Concerns/Customizable.php
@@ -18,6 +18,11 @@ trait Customizable
 {
     protected array $validatedCustomFieldValues = [];
 
+    protected function isAutoTransform(): bool
+    {
+        return false;
+    }
+
     /**
      * Boot Model Observer.
      */
@@ -51,7 +56,7 @@ public function validateCustomFields(): void
             return;
         }
         $customFieldsRules = $customFields->flatMap(function (CustomField $field) {
-            return $field->getValidationRule();
+            return $field->getValidationRule($this->isAutoTransform());
         })->all();
         $validator = Validator::make($unvalidatedCustomFields, $customFieldsRules);
         $this->validatedCustomFieldValues = $validator->validate();
@@ -130,7 +135,7 @@ public function loadCustomFieldValues(): void
 
         $this->customFieldValues->each(function (CustomFieldValue $customFieldValue) {
             $attribute = "custom_{$customFieldValue->customField->key}";
-            $this->setAttribute($attribute, $customFieldValue->customField->parseValue($customFieldValue->value));
+            $this->setAttribute($attribute, $customFieldValue->customField->parseValue($customFieldValue->value, $this->isAutoTransform()));
         });
     }
 
diff --git a/src/Models/BooleanCustomField.php b/src/Models/BooleanCustomField.php
@@ -8,7 +8,7 @@ class BooleanCustomField extends CustomField
 {
     use HasParent;
 
-    public function getValidationRule(): array
+    public function getValidationRule($autoTransform = false): array
     {
         $rules = ['boolean'];
         $rules[] = $this->required ? 'required' : 'nullable';
@@ -17,7 +17,7 @@ public function getValidationRule(): array
         ];
     }
 
-    public function parseValue($value): bool
+    public function parseValue($value, $autoTransform = false): bool
     {
         return filter_var($value, FILTER_VALIDATE_BOOLEAN);
     }
diff --git a/src/Models/CustomField.php b/src/Models/CustomField.php
@@ -64,12 +64,12 @@ public function values(): HasMany
         return $this->hasMany(CustomFieldValue::class);
     }
 
-    public function getValidationRule(): array
+    public function getValidationRule($autoTransform = false): array
     {
         return [];
     }
 
-    public function parseValue($value): mixed
+    public function parseValue($value, $autoTransform = false): mixed
     {
         return $value;
     }
diff --git a/src/Models/DateTimeCustomField.php b/src/Models/DateTimeCustomField.php
@@ -9,15 +9,15 @@ class DateTimeCustomField extends CustomField
 {
     use HasParent;
 
-    public function getValidationRule(): array
+    public function getValidationRule($autoTransform = false): array
     {
         $rules = ['date'];
         $rules[] = $this->required ? 'required' : 'nullable';
         return [
             $this->key => $rules,
         ];
     }
-    public function parseValue($value): string
+    public function parseValue($value, $autoTransform = false): string
     {
         return Carbon::parse($value)->toDateTimeString();
     }
diff --git a/src/Models/FloatCustomField.php b/src/Models/FloatCustomField.php
@@ -8,7 +8,7 @@ class FloatCustomField extends CustomField
 {
     use HasParent;
 
-    public function getValidationRule(): array
+    public function getValidationRule($autoTransform = false): array
     {
         $rules = ['numeric'];
         $rules[] = $this->required ? 'required' : 'nullable';
@@ -17,9 +17,8 @@ public function getValidationRule(): array
         ];
     }
 
-    public function parseValue($value): float
+    public function parseValue($value, $autoTransform = false): float
     {
         return (float) $value;
     }
-
 }
diff --git a/src/Models/IntegerCustomField.php b/src/Models/IntegerCustomField.php
@@ -8,7 +8,7 @@ class IntegerCustomField extends CustomField
 {
     use HasParent;
 
-    public function getValidationRule(): array
+    public function getValidationRule($autoTransform = false): array
     {
         $rules = ['integer'];
         $rules[] = $this->required ? 'required' : 'nullable';
@@ -17,9 +17,8 @@ public function getValidationRule(): array
         ];
     }
 
-    public function parseValue($value): int
+    public function parseValue($value, $autoTransform = false): int
     {
         return (int) $value;
     }
-
 }
diff --git a/src/Models/SelectCustomField.php b/src/Models/SelectCustomField.php
@@ -9,7 +9,7 @@ class SelectCustomField extends CustomField
 {
     use HasParent;
 
-    public function getValidationRule(): array
+    public function getValidationRule($autoTransform = false): array
     {
         $options = $this->available_options->pluck('value')->toArray();
         $rules = [Rule::in($options)];
@@ -18,7 +18,7 @@ public function getValidationRule(): array
             $this->key => $rules,
         ];
     }
-    public function parseValue($value): string
+    public function parseValue($value, $autoTransform = false): string
     {
         return $value;
     }
diff --git a/src/Models/TextCustomField.php b/src/Models/TextCustomField.php
@@ -8,17 +8,24 @@ class TextCustomField extends CustomField
 {
     use HasParent;
 
-    public function getValidationRule(): array
+    public function getValidationRule($autoTransform = false): array
     {
-        $rules = ['string'];
+        if (!$autoTransform) {
+            $rules = ['string'];
+        }
+
         $rules[] = $this->required ? 'required' : 'nullable';
         return [
             $this->key => $rules,
         ];
     }
 
-    public function parseValue($value): string
+    public function parseValue($value, $autoTransform = false): string
     {
+        if ($autoTransform) {
+            return (string) $value;
+        }
+
         return $value;
     }
 }
diff --git a/tests/Classes/UserAutoTransform.php b/tests/Classes/UserAutoTransform.php
@@ -0,0 +1,39 @@
+<?php
+
+namespace OnrampLab\CustomFields\Tests\Classes;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Foundation\Auth\User as BaseUser;
+use OnrampLab\CustomFields\Concerns\Customizable;
+
+class UserAutoTransform extends BaseUser
+{
+    use HasFactory;
+    use Customizable;
+
+    protected $guarded = [];
+    protected $table = 'users';
+
+    protected static function newFactory(): Factory
+    {
+        return UserAutoTransformFactory::new();
+    }
+
+    protected function isAutoTransform(): bool
+    {
+        return true;
+    }
+
+    public function account(): BelongsTo
+    {
+        return $this->belongsTo(Account::class);
+    }
+
+    public function getCustomFieldContext(): Model
+    {
+        return $this->account;
+    }
+}
diff --git a/tests/Classes/UserAutoTransformFactory.php b/tests/Classes/UserAutoTransformFactory.php
@@ -0,0 +1,33 @@
+<?php
+
+namespace OnrampLab\CustomFields\Tests\Classes;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Support\Str;
+
+class UserAutoTransformFactory extends Factory
+{
+    /**
+     * The name of the factory's corresponding model.
+     *
+     * @var string
+     */
+    protected $model = UserAutoTransform::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array
+     */
+    public function definition()
+    {
+        return [
+            'name' => $this->faker->name(),
+            'email' => $this->faker->unique()->safeEmail(),
+            'email_verified_at' => now(),
+            'password' => '$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi', // password
+            'remember_token' => Str::random(10),
+            'account_id' => Account::factory()
+        ];
+    }
+}
diff --git a/tests/Migrations/2023_05_30_000155_add_account_id_to_users_table.php b/tests/Migrations/2023_05_30_000155_add_account_id_to_users_table.php
@@ -14,7 +14,7 @@
     public function up()
     {
         Schema::table('users', function (Blueprint $table) {
-            $table->unsignedBigInteger('account_id');
+            $table->unsignedBigInteger('account_id')->nullable();
         });
     }
 
diff --git a/tests/Unit/Concerns/CustomizableAutoTransformTest.php b/tests/Unit/Concerns/CustomizableAutoTransformTest.php
@@ -0,0 +1,62 @@
+<?php
+
+namespace OnrampLab\CustomFields\Tests\Unit\Concerns;
+
+use Carbon\Carbon;
+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\Classes\UserAutoTransform;
+use OnrampLab\CustomFields\Tests\TestCase;
+use OnrampLab\CustomFields\ValueObjects\AvailableOption;
+
+class CustomizableAutoTransformTest extends TestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->account = Account::factory()->create();
+        $attributes = [
+            'key' => 'zip_code',
+            'type' => 'text',
+            'required' => false,
+            'model_class' => User::class,
+            'contextable_id' => $this->account->id,
+            'contextable_type' => $this->account->getMorphClass()
+        ];
+        $this->customField = CustomField::factory()->create($attributes);
+        $this->user = UserAutoTransform::factory()->create(['account_id' => $this->account->id, 'custom' => ['zip_code' => '12345']]);
+    }
+
+    /**
+     * @test
+     * @dataProvider customFieldDataProvider
+     */
+    public function custom_load_custom_field_values_should_work($type, $value, $expected, $required, $defaultValue): void
+    {
+        $attributes = [
+            'key' => 'field',
+            'type' => $type,
+            'required' => $required,
+            'default_value' => $defaultValue,
+            'model_class' => UserAutoTransform::class,
+            'contextable_id' => $this->account->id,
+            'contextable_type' => $this->account->getMorphClass()
+        ];
+
+        $customField = CustomField::factory()->create($attributes);
+        $user = UserAutoTransform::factory()->create(['account_id' => $this->account->id, 'custom' => ['field' => $value]]);
+        $user->loadCustomFieldValues();
+        $this->assertEquals($expected, $user->custom_field);
+    }
+
+    public function customFieldDataProvider(): array
+    {
+        return [
+            'Text field from int' => ['text', 10, '10', true, ''],
+            'Text field from float' => ['text', 10.1, '10.1', true, ''],
+            'Text field from datetime' => ['text', Carbon::parse("2024/01/01 11:11:59"), '2024-01-01 11:11:59', true, ''],
+        ];
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-version: '3.4'`
`2`		`-`
`3`	`1`	`services:`
`4`	`2`	`php:`
`5`	`3`	`build: .`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ class BooleanCustomField extends CustomField`
`8`	`8`	`{`
`9`	`9`	`use HasParent;`
`10`	`10`
`11`		`- public function getValidationRule(): array`
	`11`	`+ public function getValidationRule($autoTransform = false): array`
`12`	`12`	`{`
`13`	`13`	`$rules = ['boolean'];`
`14`	`14`	`$rules[] = $this->required ? 'required' : 'nullable';`
`@@ -17,7 +17,7 @@ public function getValidationRule(): array`
`17`	`17`	`];`
`18`	`18`	`}`
`19`	`19`
`20`		`- public function parseValue($value): bool`
	`20`	`+ public function parseValue($value, $autoTransform = false): bool`
`21`	`21`	`{`
`22`	`22`	`return filter_var($value, FILTER_VALIDATE_BOOLEAN);`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -64,12 +64,12 @@ public function values(): HasMany`
`64`	`64`	`return $this->hasMany(CustomFieldValue::class);`
`65`	`65`	`}`
`66`	`66`
`67`		`- public function getValidationRule(): array`
	`67`	`+ public function getValidationRule($autoTransform = false): array`
`68`	`68`	`{`
`69`	`69`	`return [];`
`70`	`70`	`}`
`71`	`71`
`72`		`- public function parseValue($value): mixed`
	`72`	`+ public function parseValue($value, $autoTransform = false): mixed`
`73`	`73`	`{`
`74`	`74`	`return $value;`
`75`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,15 +9,15 @@ class DateTimeCustomField extends CustomField`
`9`	`9`	`{`
`10`	`10`	`use HasParent;`
`11`	`11`
`12`		`- public function getValidationRule(): array`
	`12`	`+ public function getValidationRule($autoTransform = false): array`
`13`	`13`	`{`
`14`	`14`	`$rules = ['date'];`
`15`	`15`	`$rules[] = $this->required ? 'required' : 'nullable';`
`16`	`16`	`return [`
`17`	`17`	`$this->key => $rules,`
`18`	`18`	`];`
`19`	`19`	`}`
`20`		`- public function parseValue($value): string`
	`20`	`+ public function parseValue($value, $autoTransform = false): string`
`21`	`21`	`{`
`22`	`22`	`return Carbon::parse($value)->toDateTimeString();`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ class FloatCustomField extends CustomField`
`8`	`8`	`{`
`9`	`9`	`use HasParent;`
`10`	`10`
`11`		`- public function getValidationRule(): array`
	`11`	`+ public function getValidationRule($autoTransform = false): array`
`12`	`12`	`{`
`13`	`13`	`$rules = ['numeric'];`
`14`	`14`	`$rules[] = $this->required ? 'required' : 'nullable';`
`@@ -17,9 +17,8 @@ public function getValidationRule(): array`
`17`	`17`	`];`
`18`	`18`	`}`
`19`	`19`
`20`		`- public function parseValue($value): float`
	`20`	`+ public function parseValue($value, $autoTransform = false): float`
`21`	`21`	`{`
`22`	`22`	`return (float) $value;`
`23`	`23`	`}`
`24`		`-`
`25`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ class IntegerCustomField extends CustomField`
`8`	`8`	`{`
`9`	`9`	`use HasParent;`
`10`	`10`
`11`		`- public function getValidationRule(): array`
	`11`	`+ public function getValidationRule($autoTransform = false): array`
`12`	`12`	`{`
`13`	`13`	`$rules = ['integer'];`
`14`	`14`	`$rules[] = $this->required ? 'required' : 'nullable';`
`@@ -17,9 +17,8 @@ public function getValidationRule(): array`
`17`	`17`	`];`
`18`	`18`	`}`
`19`	`19`
`20`		`- public function parseValue($value): int`
	`20`	`+ public function parseValue($value, $autoTransform = false): int`
`21`	`21`	`{`
`22`	`22`	`return (int) $value;`
`23`	`23`	`}`
`24`		`-`
`25`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ class SelectCustomField extends CustomField`
`9`	`9`	`{`
`10`	`10`	`use HasParent;`
`11`	`11`
`12`		`- public function getValidationRule(): array`
	`12`	`+ public function getValidationRule($autoTransform = false): array`
`13`	`13`	`{`
`14`	`14`	`$options = $this->available_options->pluck('value')->toArray();`
`15`	`15`	`$rules = [Rule::in($options)];`
`@@ -18,7 +18,7 @@ public function getValidationRule(): array`
`18`	`18`	`$this->key => $rules,`
`19`	`19`	`];`
`20`	`20`	`}`
`21`		`- public function parseValue($value): string`
	`21`	`+ public function parseValue($value, $autoTransform = false): string`
`22`	`22`	`{`
`23`	`23`	`return $value;`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,17 +8,24 @@ class TextCustomField extends CustomField`
`8`	`8`	`{`
`9`	`9`	`use HasParent;`
`10`	`10`
`11`		`- public function getValidationRule(): array`
	`11`	`+ public function getValidationRule($autoTransform = false): array`
`12`	`12`	`{`
`13`		`- $rules = ['string'];`
	`13`	`+ if (!$autoTransform) {`
	`14`	`+ $rules = ['string'];`
	`15`	`+ }`
	`16`	`+`
`14`	`17`	`$rules[] = $this->required ? 'required' : 'nullable';`
`15`	`18`	`return [`
`16`	`19`	`$this->key => $rules,`
`17`	`20`	`];`
`18`	`21`	`}`
`19`	`22`
`20`		`- public function parseValue($value): string`
	`23`	`+ public function parseValue($value, $autoTransform = false): string`
`21`	`24`	`{`
	`25`	`+ if ($autoTransform) {`
	`26`	`+ return (string) $value;`
	`27`	`+ }`
	`28`	`+`
`22`	`29`	`return $value;`
`23`	`30`	`}`
`24`	`31`	`}`