Add new PreparesForValidation system to properly handle AutocompleteListFormatter validation errors

Author: dvlpp

src/Form/Fields/Embeds/SharpFormEditorEmbed.php

@@ -16,6 +16,7 @@
 use Code16\Sharp\Utils\Traits\HandleValidation;
 use Code16\Sharp\Utils\Transformers\WithCustomTransformers;
 use Illuminate\Support\Facades\Blade;
+use Illuminate\Support\Facades\Validator;
 use Illuminate\Support\HtmlString;
 use Illuminate\Support\Str;
 use Illuminate\View\View;
@@ -49,15 +50,15 @@ public function toConfigArray(bool $isForm): array
             'embedHeaderTitle' => $this->embedHeaderTitle ?: $this->label,
         ];
 
-        $this->validate($config, [
+        Validator::make($config, [
             'key' => ['required'],
             'label' => ['required'],
             'tag' => ['required', 'regex:/^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$/'],
             'attributes' => ['array'],
         ], [
             'attributes.required' => 'Your Embed should at least have one form field',
             'tag.regex' => 'the tag name should only contain letters, figures and carets',
-        ]);
+        ])->validate();
 
         return $config;
     }

src/Form/Fields/Formatters/AutocompleteListFormatter.php

@@ -2,9 +2,10 @@
 
 namespace Code16\Sharp\Form\Fields\Formatters;
 
+use Code16\Sharp\Form\Fields\SharpFormAutocompleteListField;
 use Code16\Sharp\Form\Fields\SharpFormField;
 
-class AutocompleteListFormatter extends SharpFieldFormatter
+class AutocompleteListFormatter extends SharpFieldFormatter implements PreparesForValidation
 {
     public function toFront(SharpFormField $field, $value)
     {
@@ -31,7 +32,9 @@ public function fromFront(SharpFormField $field, string $attribute, $value): arr
                 $item = $item[$autocompleteField->key()] ?? null;
 
                 if ($item === null) {
-                    return null;
+                    return [
+                        $autocompleteField->itemIdAttribute() => null,
+                    ];
                 }
 
                 return [
@@ -40,7 +43,20 @@ public function fromFront(SharpFormField $field, string $attribute, $value): arr
                     ),
                 ];
             })
-            ->whereNotNull()
+            ->all();
+    }
+
+    /**
+     * @param  SharpFormAutocompleteListField  $field
+     */
+    public function prepareForValidation(SharpFormField $field, string $key, $value): array
+    {
+        $autocompleteField = $field->autocompleteField();
+
+        return collect($value)
+            ->map(fn ($item) => [
+                $autocompleteField->key() => $item[$autocompleteField->itemIdAttribute()],
+            ])
             ->all();
     }
 }

src/Form/Fields/Formatters/PreparesForValidation.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Code16\Sharp\Form\Fields\Formatters;
+
+use Code16\Sharp\Form\Fields\SharpFormField;
+
+interface PreparesForValidation
+{
+    public function prepareForValidation(SharpFormField $field, string $key, $value): array;
+}

src/Utils/Traits/HandleValidation.php

@@ -2,6 +2,7 @@
 
 namespace Code16\Sharp\Utils\Traits;
 
+use Code16\Sharp\Form\Fields\Formatters\PreparesForValidation;
 use Illuminate\Contracts\Validation\Factory as Validator;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Validation\ValidationException;
@@ -10,6 +11,22 @@ trait HandleValidation
 {
     final public function validate(array $params, array $rules, array $messages = []): void
     {
+        $params = collect($params)
+            ->map(function ($value, $key) {
+                if (! $field = $this->findFieldByKey($key)) {
+                    return $value;
+                }
+
+                if ($field->formatter() instanceof PreparesForValidation) {
+                    return $field
+                        ->formatter()
+                        ->prepareForValidation($field, $key, $value);
+                }
+
+                return $value;
+            })
+            ->all();
+
         $validator = app(Validator::class)->make($params, $rules, $messages);
 
         if ($validator->fails()) {

tests/Http/Form/FormControllerTest.php

@@ -3,6 +3,8 @@
 use Code16\Sharp\Enums\PageAlertLevel;
 use Code16\Sharp\Exceptions\Form\SharpApplicativeException;
 use Code16\Sharp\Exceptions\Form\SharpFormUpdateException;
+use Code16\Sharp\Form\Fields\SharpFormAutocompleteListField;
+use Code16\Sharp\Form\Fields\SharpFormAutocompleteLocalField;
 use Code16\Sharp\Form\Fields\SharpFormCheckField;
 use Code16\Sharp\Form\Fields\SharpFormEditorField;
 use Code16\Sharp\Form\Fields\SharpFormTextField;
@@ -307,6 +309,40 @@ public function update($id, array $data)
         ->assertSessionHasErrors('name');
 });
 
+it('calls prepareForValidation() before validation on applicable fields', function () {
+    fakeFormFor('person', new class() extends PersonForm
+    {
+        public function buildFormFields(FieldsContainer $formFields): void
+        {
+            $formFields->addField(
+                SharpFormAutocompleteListField::make('jobs')
+                    ->setItemField(
+                        SharpFormAutocompleteLocalField::make('job')
+                            ->setLocalValues([
+                                1 => 'Physicist',
+                                2 => 'Chemist',
+                            ])
+                    )
+            );
+        }
+
+        public function update($id, array $data)
+        {
+            $this->validate($data, ['jobs.*.job' => 'required']);
+        }
+    });
+
+    $this
+        ->post('/sharp/s-list/person/s-form/person', [
+            'jobs' => [
+                ['id' => null,  'job' => ['id' => 1, 'label' => 'Physicist']],
+                ['id' => null],
+            ],
+        ])
+        ->assertSessionDoesntHaveErrors('jobs.0.job')
+        ->assertSessionHasErrors('jobs.1.job');
+});
+
 it('handles application exception as 417', function () {
     fakeFormFor('person', new class() extends PersonForm
     {

tests/Unit/Form/Fields/Formatters/AutocompleteListFormatterTest.php

@@ -68,5 +68,30 @@
     )->toBe([
         ['id' => 'A'],
         ['id' => 'B'],
+        ['id' => null],
+        ['id' => null],
+        ['id' => null],
+        ['id' => null],
+    ]);
+});
+
+it('formats data in prepareForValidation()', function () {
+    $formatter = new AutocompleteListFormatter();
+    $field = SharpFormAutocompleteListField::make('list')
+        ->setItemField(SharpFormAutocompleteRemoteField::make('item')
+            ->setRemoteEndpoint('/endpoint'),
+        );
+
+    expect(
+        $formatter->prepareForValidation(
+            $field,
+            'attribute', [
+                ['id' => 'A'],
+                ['id' => 'B'],
+            ]
+        )
+    )->toBe([
+        ['item' => 'A'],
+        ['item' => 'B'],
     ]);
 });