refactor: changes & rebase

Author: jvancoillie

src/Autocomplete/assets/dist/controller.js

@@ -1,25 +1,25 @@
 import { Controller } from '@hotwired/stimulus';
 import TomSelect from 'tom-select';
 
-/******************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-
-function __classPrivateFieldGet(receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __classPrivateFieldGet(receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 }
 
 var _instances, _getCommonConfig, _createAutocomplete, _createAutocompleteWithHtmlContents, _createAutocompleteWithRemoteData, _stripTags, _mergeObjects, _createTomSelect, _dispatchEvent;
@@ -131,7 +131,7 @@ _instances = new WeakSet(), _getCommonConfig = function _getCommonConfig() {
             const url = this.getUrl(query);
             fetch(url)
                 .then(response => response.json())
-                .then(json => { this.setNextUrl(query, json.next_page); callback(json.results.options || json.results, json.results.optgroups || []); })
+                .then(json => { this.setNextUrl(query, json.next_page); callback(json.results.options, json.results.optgroups || []); })
                 .catch(() => callback());
         },
         shouldLoad: function (query) {

src/Autocomplete/assets/src/controller.ts

@@ -141,7 +141,7 @@ export default class extends Controller {
                 fetch(url)
                     .then(response => response.json())
                     // important: next_url must be set before invoking callback()
-                    .then(json => { this.setNextUrl(query, json.next_page); callback(json.results.options || json.results, json.results.optgroups || []) })
+                    .then(json => { this.setNextUrl(query, json.next_page); callback(json.results.options, json.results.optgroups || []) })
                     .catch(() => callback());
             },
             shouldLoad: function (query: string) {

src/Autocomplete/assets/test/controller.test.ts

@@ -87,71 +87,6 @@ describe('AutocompleteController', () => {
         expect(tomSelect.input).toBe(getByTestId(container, 'main-element'));
     });
 
-    it('connect with ajax URL BC data', async () => {
-        const container = mountDOM(`
-            <label for="the-select">Items</label>
-            <select
-                id="the-select"
-                data-testid="main-element"
-                data-controller="check autocomplete"
-                data-autocomplete-url-value="/path/to/autocomplete"
-            ></select>
-        `);
-
-        application = startStimulus();
-
-        await waitFor(() => {
-            expect(getByTestId(container, 'main-element')).toHaveClass('connected');
-        });
-
-        // initial Ajax request on focus
-        fetchMock.mock(
-            '/path/to/autocomplete?query=',
-            JSON.stringify({
-                results:  [
-                        {
-                            value: 3,
-                            text: 'salad'
-                        },
-                    ]
-            }),
-        );
-
-        fetchMock.mock(
-            '/path/to/autocomplete?query=foo',
-            JSON.stringify({
-                results:  [
-                        {
-                            value: 1,
-                            text: 'pizza'
-                        },
-                        {
-                            value: 2,
-                            text: 'popcorn'
-                        }
-                    ]
-            }),
-        );
-
-        const tomSelect = getByTestId(container, 'main-element').tomSelect;
-        const controlInput = tomSelect.control_input;
-
-        // wait for the initial Ajax request to finish
-        userEvent.click(controlInput);
-        await waitFor(() => {
-            expect(container.querySelectorAll('.option[data-selectable]')).toHaveLength(1);
-        });
-
-        // typing was not properly triggering, for some reason
-        //userEvent.type(controlInput, 'foo');
-        controlInput.value = 'foo';
-        controlInput.dispatchEvent(new Event('input'));
-
-        await waitFor(() => {
-            expect(container.querySelectorAll('.option[data-selectable]')).toHaveLength(2);
-        });
-    });
-
     it('connect with ajax URL', async () => {
         const container = mountDOM(`
             <label for="the-select">Items</label>

src/Autocomplete/src/AutocompleteResults.php

@@ -14,10 +14,12 @@
 final class AutocompleteResults
 {
     /**
-     * @param list<array{label: string, value: mixed}> $results
+     * @param list<array{text: string, value: mixed, group_by?: string}> $options
+     * @param list<array{label: string, value: string}>                  $optgroups
      */
     public function __construct(
-        public array $results,
+        public array $options,
+        public array $optgroups,
         public bool $hasNextPage,
     ) {
     }

src/Autocomplete/src/Controller/EntityAutocompleteController.php

@@ -52,7 +52,7 @@ public function __invoke(string $alias, Request $request): Response
         }
 
         return new JsonResponse([
-            'results' => $data->results,
+            'results' => ['options' => $data->options, 'optgroups' => $data->optgroups],
             'next_page' => $nextPage,
         ]);
     }

src/Autocomplete/src/DependencyInjection/AutocompleteExtension.php

@@ -83,6 +83,7 @@ private function registerBasicServices(ContainerBuilder $container): void
             ->register('ux.autocomplete.results_executor', AutocompleteResultsExecutor::class)
             ->setArguments([
                 new Reference('ux.autocomplete.doctrine_registry_wrapper'),
+                new Reference('property_accessor'),
                 new Reference('security.helper', ContainerInterface::NULL_ON_INVALID_REFERENCE),
             ])
         ;

src/Autocomplete/src/EntityAutocompleterInterface.php

@@ -48,7 +48,7 @@ public function getValue(object $entity): mixed;
     public function isGranted(Security $security): bool;
 
     /**
-     * Return Form option by name.
+     * Return group_by option.
      */
-    public function getFormOption(string $name): mixed;
+    public function getGroupBy(): mixed;
 }

src/Autocomplete/src/Form/WrappedEntityTypeAutocompleter.php

@@ -112,7 +112,12 @@ public function isGranted(Security $security): bool
         throw new \InvalidArgumentException('Invalid passed to the "security" option: it must be the boolean true, a string role or a callable.');
     }
 
-    public function getFormOption(string $name): mixed
+    public function getGroupBy(): mixed
+    {
+        return $this->getFormOption('group_by');
+    }
+
+    private function getFormOption(string $name): mixed
     {
         $form = $this->getForm();
         $formOptions = $form['autocomplete']->getConfig()->getOptions();

src/Autocomplete/tests/Fixtures/Autocompleter/CustomGroupByProductAutocompleter.php

@@ -12,8 +12,8 @@
 
 class CustomGroupByProductAutocompleter extends CustomProductAutocompleter
 {
-    public function getFormOption(string $name): mixed
+    public function getGroupBy(): mixed
     {
-        return 'group_by' === $name ? 'category.name' : null;
+        return 'category.name';
     }
 }

src/Autocomplete/tests/Fixtures/Autocompleter/CustomProductAutocompleter.php

@@ -59,7 +59,7 @@ public function isGranted(Security $security): bool
         return true;
     }
 
-    public function getFormOption(string $name): mixed
+    public function getGroupBy(): mixed
     {
         return null;
     }