Add form templates #minor (#67)

* Add FormTemplate to forms

* Apply fixes from StyleCI

* Update to use getMorphClass

Co-authored-by: bmadzarac <bojan.madzarac@asseco-see.hr>
Co-authored-by: StyleCI Bot <bot@styleci.io>

Author: 3 people

config/asseco-custom-fields.php

@@ -3,6 +3,7 @@
 use Asseco\BlueprintAudit\App\MigrationMethodPicker;
 use Asseco\CustomFields\App\Models\CustomField;
 use Asseco\CustomFields\App\Models\Form;
+use Asseco\CustomFields\App\Models\FormTemplate;
 use Asseco\CustomFields\App\Models\PlainType;
 use Asseco\CustomFields\App\Models\Relation;
 use Asseco\CustomFields\App\Models\RemoteType;
@@ -35,6 +36,7 @@
         'relation'        => Relation::class,
         'validation'      => Validation::class,
         'value'           => Value::class,
+        'form_template'   => FormTemplate::class,
     ],
 
     'plain_types' => [

migrations/2022_02_01_143227_create_form_templates_table.php

@@ -0,0 +1,42 @@
+<?php
+
+use Asseco\BlueprintAudit\App\MigrationMethodPicker;
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateFormTemplatesTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('form_templates', function (Blueprint $table) {
+            if (config('asseco-custom-fields.migrations.uuid')) {
+                $table->uuid('id')->primary();
+                $table->foreignUuid('form_id')->constrained();
+            } else {
+                $table->id();
+                $table->foreignId('form_id')->constrained();
+            }
+
+            $table->string('name');
+            MigrationMethodPicker::pick($table, config('asseco-custom-fields.migrations.timestamps'));
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table('form_templates', function (Blueprint $table) {
+            $table->dropIfExists('form_templates');
+        });
+    }
+}

routes/api.php

@@ -3,6 +3,7 @@
 use Asseco\CustomFields\App\Contracts\PlainType;
 use Asseco\CustomFields\App\Http\Controllers\CustomFieldController;
 use Asseco\CustomFields\App\Http\Controllers\FormController;
+use Asseco\CustomFields\App\Http\Controllers\FormTemplateController;
 use Asseco\CustomFields\App\Http\Controllers\ModelController;
 use Asseco\CustomFields\App\Http\Controllers\PlainCustomFieldController;
 use Asseco\CustomFields\App\Http\Controllers\RelationController;
@@ -58,3 +59,4 @@
         Route::apiResource('forms', FormController::class);
     });
 });
+Route::apiResource('form-templates', FormTemplateController::class);

src/App/Contracts/FormTemplate.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Asseco\CustomFields\App\Contracts;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * @mixin Model|\Asseco\CustomFields\App\Models\FormTemplate
+ */
+interface FormTemplate
+{
+}

src/App/Http/Controllers/FormTemplateController.php

@@ -0,0 +1,84 @@
+<?php
+
+namespace Asseco\CustomFields\App\Http\Controllers;
+
+use Asseco\CustomFields\App\Contracts\FormTemplate as FormTemplateContract;
+use Asseco\CustomFields\App\Http\Requests\FormTemplateRequest;
+use Asseco\CustomFields\App\Models\FormTemplate;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Arr;
+
+class FormTemplateController extends Controller
+{
+    protected FormTemplateContract $formTemplate;
+
+    public function __construct(FormTemplateContract $formTemplate)
+    {
+        $this->formTemplate = $formTemplate;
+    }
+
+    /**
+     * Display a listing of the resource.
+     *
+     * @return JsonResponse
+     */
+    public function index(): JsonResponse
+    {
+        return response()->json($this->formTemplate::all());
+    }
+
+    /**
+     * Store a newly created resource in storage.
+     *
+     * @param  FormTemplateRequest  $request
+     * @return JsonResponse
+     */
+    public function store(FormTemplateRequest $request): JsonResponse
+    {
+        $formTemplate = $this->formTemplate::query()
+            ->create(Arr::except($request->validated(), 'form_data'));
+
+        $formTemplate->createCustomFieldValues(Arr::get($request->validated(), 'form_data', []));
+
+        return response()->json($formTemplate->refresh()->load('customFieldValues.customField.selectable'), JsonResponse::HTTP_CREATED);
+    }
+
+    /**
+     * Display the specified resource.
+     *
+     * @param  FormTemplate  $formTemplate
+     * @return JsonResponse
+     */
+    public function show(FormTemplate $formTemplate): JsonResponse
+    {
+        return response()->json($formTemplate);
+    }
+
+    /**
+     * Update the specified resource in storage.
+     *
+     * @param  FormTemplateRequest  $request
+     * @param  FormTemplate  $formTemplate
+     * @return JsonResponse
+     */
+    public function update(FormTemplateRequest $request, FormTemplate $formTemplate): JsonResponse
+    {
+        $formTemplate->createCustomFieldValues(Arr::get($request->validated(), 'form_data', []));
+        $formTemplate->update(Arr::except($request->validated(), 'form_data'));
+
+        return response()->json($formTemplate->refresh()->load('customFieldValues.customField.selectable'));
+    }
+
+    /**
+     * Remove the specified resource from storage.
+     *
+     * @param  FormTemplate  $formTemplate
+     * @return JsonResponse
+     */
+    public function destroy(FormTemplate $formTemplate): JsonResponse
+    {
+        $isDeleted = $formTemplate->delete();
+
+        return response()->json($isDeleted ? 'true' : 'false');
+    }
+}

src/App/Http/Requests/FormTemplateRequest.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Asseco\CustomFields\App\Http\Requests;
+
+use Illuminate\Foundation\Http\FormRequest as LaravelFormRequest;
+
+class FormTemplateRequest extends LaravelFormRequest
+{
+    public function rules()
+    {
+        return [
+            'form_data' => 'array',
+            'form_id' => 'required|string|exists:forms,id',
+            'name' => 'required|string',
+        ];
+    }
+}

src/App/Models/Form.php

@@ -5,11 +5,13 @@
 namespace Asseco\CustomFields\App\Models;
 
 use Asseco\CustomFields\App\Contracts\CustomField;
+use Asseco\CustomFields\App\Contracts\FormTemplate;
 use Asseco\CustomFields\Database\Factories\FormFactory;
 use Exception;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Support\Arr;
 
 class Form extends Model implements \Asseco\CustomFields\App\Contracts\Form
@@ -57,6 +59,11 @@ protected static function booted()
         });
     }
 
+    public function templates(): HasMany
+    {
+        return $this->hasMany(get_class(app(FormTemplate::class)));
+    }
+
     protected function relateCustomFieldsFromDefinition()
     {
         $components = Arr::get($this->definition, 'components', []);
@@ -153,7 +160,7 @@ public function createValues(array $formData, string $modelType, $modelId): arra
 
             $values[] = $customField->values()->updateOrCreate([
                 'model_type' => $modelType,
-                'model_id'   => $modelId,
+                'model_id' => $modelId,
             ],
                 [$type => $formCustomField]
             );

src/App/Models/FormTemplate.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Asseco\CustomFields\App\Models;
+
+use Asseco\CustomFields\App\Contracts\Form;
+use Asseco\CustomFields\App\Traits\Customizable;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Support\Arr;
+
+class FormTemplate extends Model implements \Asseco\CustomFields\App\Contracts\FormTemplate
+{
+    use Customizable;
+
+    protected $guarded = ['id', 'created_at', 'updated_at'];
+
+    public function form(): BelongsTo
+    {
+        return $this->belongsTo(get_class(app(Form::class)));
+    }
+
+    /**
+     * @param  array  $formData
+     * @return array
+     */
+    public function createCustomFieldValues(array $formData = []): array
+    {
+        if (empty($formData)) {
+            return [];
+        }
+
+        $values = [];
+
+        /**
+         * @var \Asseco\CustomFields\App\Contracts\CustomField $customField
+         */
+        foreach ($this->form->customFields as $customField) {
+            $formCustomField = Arr::get($formData, $customField->name);
+
+            if (!$formCustomField) {
+                continue;
+            }
+
+            $type = $customField->getValueColumn();
+
+            $values[] = $customField->values()->updateOrCreate([
+                'model_type' => $this->getMorphClass(),
+                'model_id' => $this->id,
+            ],
+                [$type => $formCustomField]
+            );
+        }
+
+        return $values;
+    }
+}

src/CustomFieldsServiceProvider.php

@@ -6,6 +6,7 @@
 
 use Asseco\CustomFields\App\Contracts\CustomField;
 use Asseco\CustomFields\App\Contracts\Form;
+use Asseco\CustomFields\App\Contracts\FormTemplate;
 use Asseco\CustomFields\App\Contracts\PlainType;
 use Asseco\CustomFields\App\Contracts\PlainTypes\BooleanType;
 use Asseco\CustomFields\App\Contracts\PlainTypes\DateTimeType;
@@ -69,6 +70,7 @@ protected function bindClasses()
         $this->app->bind(Relation::class, config('asseco-custom-fields.models.relation'));
         $this->app->bind(Validation::class, config('asseco-custom-fields.models.validation'));
         $this->app->bind(Value::class, config('asseco-custom-fields.models.value'));
+        $this->app->bind(FormTemplate::class, config('asseco-custom-fields.models.form_template'));
 
         $this->app->bind(BooleanType::class, config('asseco-custom-fields.plain_types.boolean'));
         $this->app->bind(DateTimeType::class, config('asseco-custom-fields.plain_types.date_time'));