Unit tests

Author: dvlpp

docs/guide/upgrading/9.0.md

@@ -517,6 +517,10 @@ class PostForm extends SharpForm
 
 ## SharpFormAutocompleteFormField was split in two subclasses for local and remote cases
 
+REWRITE THIS WITH:
+- no more `setAdditionalTemplateData`
+- 
+
 This isn’t a breaking change, since `SharpFormAutocompleteFormField::make($key, $mode)` is still supported, but deprecated. You should migrate to the new `SharpFormAutocompleteLocalField` and `SharpFormAutocompleteRemoteField` classes.
 
 In 8.x:

src/Form/Fields/Formatters/AutocompleteLocalFormatter.php

@@ -20,26 +20,6 @@ public function toFront(SharpFormField $field, $value)
         return is_null($value) || is_array($value)
             ? $value
             : [$field->itemIdAttribute() => $value];
-        
-//        if(is_null($value)) {
-//            return null;
-//        }
-//
-//        if(is_array($value)) {
-//            $selectedValue = isset($value[$field->itemIdAttribute()])
-//                ? collect($field->localValues())
-//                    ->firstWhere($field->itemIdAttribute(), $value[$field->itemIdAttribute()])
-//                : null;
-//        } else {
-//            $selectedValue = collect($field->localValues())->firstWhere($field->itemIdAttribute(), $value);
-//        }
-//
-//        return $selectedValue
-//            ? [
-//                ...$selectedValue,
-//                '_html' => $field->renderResultItem($selectedValue),
-//            ]
-//            : null;
     }
 
     public function fromFront(SharpFormField $field, string $attribute, $value)

src/Form/Fields/Formatters/AutocompleteRemoteFormatter.php

@@ -17,11 +17,11 @@ public function toFront(SharpFormField $field, $value)
     {
         $value = ArrayConverter::modelToArray($value);
 
-        if(is_null($value)) {
+        if (is_null($value)) {
             return null;
         }
 
-        if(is_array($value)) {
+        if (is_array($value)) {
             return $field->itemWithRenderedTemplates($value);
         }
 

src/Form/Fields/Utils/IsSharpFormAutocompleteField.php

@@ -5,7 +5,6 @@
 interface IsSharpFormAutocompleteField
 {
     public function setItemIdAttribute(string $itemIdAttribute): self;
-    public function setAdditionalTemplateData(array $data): self;
     public function isRemote(): bool;
     public function isLocal(): bool;
     public function itemIdAttribute(): string;

src/Form/Fields/Utils/SharpFormAutocompleteCommonField.php

@@ -22,12 +22,16 @@ trait SharpFormAutocompleteCommonField
 
     public function itemWithRenderedTemplates(array $item): array
     {
+        $resultItem = $this->resultItemTemplate
+            ? ['_htmlResult' => $this->renderResultItem($item)]
+            : [];
+
         return [
             ...$item,
             '_html' => $this->listItemTemplate
                 ? $this->renderListItem($item)
                 : ($item['label'] ?? $item[$this->itemIdAttribute] ?? null),
-            '_htmlResult' => $this->resultItemTemplate ? $this->renderResultItem($item) : null,
+            ...$resultItem,
         ];
     }
 
@@ -70,13 +74,6 @@ public function renderResultItem(array $data): string
         return $this->resultItemTemplate->with($data)->render();
     }
 
-    public function setAdditionalTemplateData(array $data): self
-    {
-        // TODO keep this ?
-        
-        return $this;
-    }
-
     public function isRemote(): bool
     {
         return $this->mode === 'remote';
@@ -97,8 +94,6 @@ protected function validationRulesBase(): array
         return [
             'mode' => 'required|in:local,remote',
             'itemIdAttribute' => 'required',
-//            'listItemTemplate' => 'required',
-//            'resultItemTemplate' => 'required',
             'templateData' => 'nullable|array',
         ];
     }
@@ -110,8 +105,6 @@ protected function toArrayBase(): array
                 'mode' => $this->mode,
                 'placeholder' => $this->placeholder,
                 'itemIdAttribute' => $this->itemIdAttribute,
-                'listItemTemplate' => $this->listItemTemplate,
-                'resultItemTemplate' => $this->resultItemTemplate,
                 'localized' => $this->localized,
             ],
             $this->dynamicAttributes

src/Form/Fields/Utils/SharpFormFieldWithOptions.php

@@ -20,15 +20,14 @@ protected static function formatOptions(array|Collection $options, string $idAtt
 
         if (is_array($firstOption) && isset($firstOption[$idAttribute])) {
             // We assume that we already have ["id", "label"] in this case
-            return $options
-                ->when($format)->map($format)
-                ->all();
+            return $options->map($format)->values()->all();
         }
 
         // Simple [key => value] array case
         return $options
             ->map(fn ($label, $id) => compact('id', 'label'))
-            ->when($format)->map($format)
+            ->map($format)
+            ->values()
             ->all();
     }
 
@@ -38,6 +37,8 @@ protected static function formatDynamicOptions(array|Collection &$options, int $
             return [];
         }
 
+        $format ??= fn ($option) => $option;
+
         return collect($options)
             ->map(function ($values) use ($depth, $format) {
                 if ($depth > 1) {
@@ -46,7 +47,7 @@ protected static function formatDynamicOptions(array|Collection &$options, int $
 
                 return collect($values)
                     ->map(fn ($label, $id) => compact('id', 'label'))
-                    ->when($format)->map($format)
+                    ->map($format)
                     ->values()
                     ->all();
             })

…ollers/Api/ApiAutocompleteController.php …rs/Api/ApiFormAutocompleteController.phpsrc/Http/Controllers/Api/ApiAutocompleteController.php renamed to src/Http/Controllers/Api/ApiFormAutocompleteController.php src/Http/Controllers/Api/ApiAutocompleteController.php renamed to src/Http/Controllers/Api/ApiFormAutocompleteController.php

@@ -5,12 +5,10 @@
 use Code16\Sharp\Form\Fields\SharpFormAutocompleteRemoteField;
 use Code16\Sharp\Utils\Transformers\ArrayConverter;
 use Illuminate\Http\Request;
-use Illuminate\Routing\Router;
 use Illuminate\Support\Arr;
-use Illuminate\Support\Facades\Http;
 use Illuminate\Validation\ValidationException;
 
-class ApiAutocompleteController extends ApiController
+class ApiFormAutocompleteController extends ApiController
 {
     public function index(string $entityKey, string $autocompleteFieldKey)
     {
@@ -25,18 +23,18 @@ public function index(string $entityKey, string $autocompleteFieldKey)
 
         $field = $form->findFieldByKey($autocompleteFieldKey);
 
-        if(!$field instanceof SharpFormAutocompleteRemoteField) {
+        if (!$field instanceof SharpFormAutocompleteRemoteField) {
             throw ValidationException::withMessages([
                 'autocompleteFieldKey' => 'Unknown remote autocomplete field : '.$autocompleteFieldKey,
             ]);
         }
 
         request()->validate([
             'endpoint' => ['nullable', 'starts_with:'.str($field->remoteEndpoint())->before('{{')],
-            'search' => ['required', 'string'],
+            'search' => ['nullable', 'string'],
         ]);
 
-        if($callback = $field->getQueryResultsCallback()) {
+        if ($callback = $field->getQueryResultsCallback()) {
             $data = collect($callback(request()->input('search')))->map(fn ($record) => ArrayConverter::modelToArray($record));
         } else {
 //            if($field->isExternalEndpoint()) {
@@ -57,7 +55,7 @@ public function index(string $entityKey, string $autocompleteFieldKey)
 //            } else {
                 $response = app()->handle(
                     tap(Request::create(
-                        uri: url($field->remoteEndpoint()),
+                        uri: url($field->remoteEndpoint()), // TODO allow full URLs (route(...)) = check if route exists
                         method: $field->remoteMethod(),
                         parameters: [
                             $field->remoteSearchAttribute() => request()->input('search'),

src/routes/api.php

@@ -1,8 +1,8 @@
 <?php
 
-use Code16\Sharp\Http\Controllers\Api\ApiAutocompleteController;
 use Code16\Sharp\Http\Controllers\Api\ApiEntityListController;
 use Code16\Sharp\Http\Controllers\Api\ApiEntityListFiltersController;
+use Code16\Sharp\Http\Controllers\Api\ApiFormAutocompleteController;
 use Code16\Sharp\Http\Controllers\Api\ApiFormEditorUploadFormController;
 use Code16\Sharp\Http\Controllers\Api\ApiFormUploadController;
 use Code16\Sharp\Http\Controllers\Api\ApiFormUploadThumbnailController;
@@ -93,6 +93,6 @@
     Route::post('/upload', [ApiFormUploadController::class, 'store'])
         ->name('code16.sharp.api.form.upload');
 
-    Route::get('/autocomplete/{entityKey}/{autocompleteFieldKey}', [ApiAutocompleteController::class, 'index'])
+    Route::get('/form/autocomplete/{entityKey}/{autocompleteFieldKey}', [ApiFormAutocompleteController::class, 'index'])
         ->name('code16.sharp.api.form.autocomplete.index');
 });

…Formatters/AutocompleteFormatterTest.php …tters/AutocompleteLocalFormatterTest.phptests/Unit/Form/Fields/Formatters/AutocompleteFormatterTest.php renamed to tests/Unit/Form/Fields/Formatters/AutocompleteLocalFormatterTest.php tests/Unit/Form/Fields/Formatters/AutocompleteFormatterTest.php renamed to tests/Unit/Form/Fields/Formatters/AutocompleteLocalFormatterTest.php

@@ -2,7 +2,6 @@
 
 use Code16\Sharp\Form\Fields\Formatters\AutocompleteLocalFormatter;
 use Code16\Sharp\Form\Fields\SharpFormAutocompleteLocalField;
-use Code16\Sharp\Form\Fields\SharpFormAutocompleteRemoteField;
 use Illuminate\Support\Str;
 
 it('allows to format local value to front', function () {
@@ -47,20 +46,6 @@ public function toArray()
     expect($toFront)->toEqual(['id' => $value]);
 });
 
-it('allows to format remote value to front', function () {
-    $value = [
-        'id' => Str::random(),
-        'label' => Str::random(),
-    ];
-
-    $toFront = (new AutocompleteLocalFormatter)->toFront(
-        SharpFormAutocompleteRemoteField::make('text'),
-        $value,
-    );
-
-    expect($toFront)->toEqual($value);
-});
-
 it('allows to format null value to front', function () {
     expect(
         (new AutocompleteLocalFormatter)->toFront(

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

@@ -0,0 +1,46 @@
+<?php
+
+use Code16\Sharp\Form\Fields\Formatters\AutocompleteRemoteFormatter;
+use Code16\Sharp\Form\Fields\SharpFormAutocompleteRemoteField;
+use Illuminate\Support\Str;
+
+it('allows to format remote value to front', function () {
+    $value = [
+        'id' => 1,
+        'name' => 'Bob',
+        'age' => 42,
+    ];
+
+    $toFront = (new AutocompleteRemoteFormatter)
+        ->toFront(
+            SharpFormAutocompleteRemoteField::make('text')
+                ->setListItemTemplate('{{ $name }}, {{ $age }}')
+                ->setResultItemTemplate('{{ $name }}, {{ $age }}'),
+            $value,
+        );
+
+    expect($toFront)->toEqual([
+        'id' => 1,
+        'name' => 'Bob',
+        'age' => 42,
+        '_html' => 'Bob, 42',
+        '_htmlResult' => 'Bob, 42',
+    ]);
+});
+
+it('allows to format remote value from front', function () {
+    // Front always send an object
+    $value = [
+        'id' => Str::random(),
+        'label' => Str::random(),
+    ];
+
+    // Back always need an id
+    expect(
+        (new AutocompleteRemoteFormatter)->fromFront(
+            SharpFormAutocompleteRemoteField::make('text'),
+            'attribute',
+            $value,
+        )
+    )->toBe($value['id']);
+});