Fix tests, add deprecations and update CHANGELOG

Author: norkunas

src/Autocomplete/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 2.13.0
+
+-   Add new BaseEntityAutocompleteType
+
 ## 2.9.0
 
 -   Add support for symfony/asset-mapper

src/Autocomplete/doc/index.rst

@@ -103,7 +103,7 @@ Or, create the field by hand::
 
     use Symfony\Bundle\SecurityBundle\Security;
     use Symfony\UX\Autocomplete\Form\AsEntityAutocompleteField;
-    use Symfony\UX\Autocomplete\Form\ParentEntityAutocompleteType;
+    use Symfony\UX\Autocomplete\Form\BaseEntityAutocompleteType;
 
     #[AsEntityAutocompleteField]
     class FoodAutocompleteField extends AbstractType
@@ -128,15 +128,19 @@ Or, create the field by hand::
 
         public function getParent(): string
         {
-            return ParentEntityAutocompleteType::class;
+            return BaseEntityAutocompleteType::class;
         }
     }
 
+.. versionadded:: 2.13
+
+    ``BaseEntityAutocompleteType`` is a new replacement for ``ParentEntityAutocompleteType``.
+
 There are 3 important things:
 
 #. The class needs the ``#[AsEntityAutocompleteField]`` attribute so that
    it's noticed by the autocomplete system.
-#. The ``getParent()`` method must return ``ParentEntityAutocompleteType``.
+#. The ``getParent()`` method must return ``BaseEntityAutocompleteType``.
 #. Inside ``configureOptions()``, you can configure your field using whatever
    normal ``EntityType`` options you need plus a few extra options (see `Form Options Reference`_).
 
@@ -216,7 +220,7 @@ e.g. ``FoodAutocompleteField`` from above):
     is automatically translated using the ``AutocompleteBundle`` domain.
 
 For the Ajax-powered autocomplete field classes (i.e. those whose
-``getParent()`` returns ``ParentEntityAutocompleteType``), in addition
+``getParent()`` returns ``BaseEntityAutocompleteType``), in addition
 to the options above, you can also pass:
 
 ``searchable_fields`` (default: ``null``)

src/Autocomplete/src/DependencyInjection/AutocompleteExtension.php

@@ -140,6 +140,7 @@ private function registerFormServices(ContainerBuilder $container): void
 
         $container
             ->register('ux.autocomplete.entity_type', ParentEntityAutocompleteType::class)
+            ->setDeprecated('symfony/ux-autocomplete', '2.13', 'The "%service_id%" form type is deprecated since 2.13. Use "ux.autocomplete.base_entity_type" instead.')
             ->setArguments([
                 new Reference('router'),
             ])

src/Autocomplete/src/Form/AutocompleteEntityTypeSubscriber.php

@@ -22,6 +22,8 @@
  * Helps transform ParentEntityAutocompleteType into a EntityType that will not load all options.
  *
  * @internal
+ *
+ * @deprecated since 2.13
  */
 final class AutocompleteEntityTypeSubscriber implements EventSubscriberInterface
 {

src/Autocomplete/src/Form/BaseEntityAutocompleteType.php

@@ -76,6 +76,11 @@ public function getParent(): string
         return EntityType::class;
     }
 
+    public function getBlockPrefix(): string
+    {
+        return 'ux_entity_autocomplete';
+    }
+
     /**
      * Uses the provided URL, or auto-generate from the provided alias.
      */

src/Autocomplete/src/Form/ParentEntityAutocompleteType.php

@@ -23,6 +23,8 @@
 
 /**
  * All form types that want to expose autocomplete functionality should use this for its getParent().
+ *
+ * @deprecated since 2.13, use "Symfony\UX\Autocomplete\Form\BaseEntityAutocompleteType" instead
  */
 final class ParentEntityAutocompleteType extends AbstractType implements DataMapperInterface
 {

src/Autocomplete/templates/autocomplete_form_theme.html.twig

@@ -1,9 +1,15 @@
 {# EasyAdminAutocomplete form type #}
 {% block ux_entity_autocomplete_widget %}
-    {{ form_widget(form.autocomplete, { attr: form.autocomplete.vars.attr|merge({ required: required }) }) }}
+    {% if form.autocomplete is defined %}
+        {{ form_widget(form.autocomplete, { attr: form.autocomplete.vars.attr|merge({ required: required }) }) }}
+    {% else %}
+        {{ form_widget(form) }}
+    {% endif %}
 {% endblock ux_entity_autocomplete_widget %}
 
 {% block ux_entity_autocomplete_label %}
-    {% set id = form.autocomplete.vars.id %}
+    {% if form.autocomplete is defined %}
+        {% set id = form.autocomplete.vars.id %}
+    {% endif %}
     {{ block('form_label') }}
-{% endblock ux_entity_autocomplete_label %}
+{% endblock ux_entity_autocomplete_label %}

src/Autocomplete/tests/Functional/AutocompleteFormRenderingTest.php

@@ -30,10 +30,10 @@ public function testFieldsRenderWithStimulusController()
         $this->browser()
             ->throwExceptions()
             ->get('/test-form')
-            ->assertElementAttributeContains('#product_category_autocomplete', 'data-controller', 'custom-autocomplete symfony--ux-autocomplete--autocomplete')
-            ->assertElementAttributeContains('#product_category_autocomplete', 'data-symfony--ux-autocomplete--autocomplete-url-value', '/test/autocomplete/category_autocomplete_type')
-            ->assertElementAttributeContains('#product_category_autocomplete', 'data-symfony--ux-autocomplete--autocomplete-min-characters-value', '2')
-            ->assertElementAttributeContains('#product_category_autocomplete', 'data-symfony--ux-autocomplete--autocomplete-max-results-value', '25')
+            ->assertElementAttributeContains('#product_category', 'data-controller', 'custom-autocomplete symfony--ux-autocomplete--autocomplete')
+            ->assertElementAttributeContains('#product_category', 'data-symfony--ux-autocomplete--autocomplete-url-value', '/test/autocomplete/category_autocomplete_type')
+            ->assertElementAttributeContains('#product_category', 'data-symfony--ux-autocomplete--autocomplete-min-characters-value', '2')
+            ->assertElementAttributeContains('#product_category', 'data-symfony--ux-autocomplete--autocomplete-max-results-value', '25')
 
             ->assertElementAttributeContains('#product_portionSize', 'data-controller', 'symfony--ux-autocomplete--autocomplete')
             ->assertElementAttributeContains('#product_tags', 'data-controller', 'symfony--ux-autocomplete--autocomplete')
@@ -52,25 +52,25 @@ public function testCategoryFieldSubmitsCorrectly()
             ->throwExceptions()
             ->get('/test-form')
             // the field renders empty (but the placeholder is there)
-            ->assertElementCount('#product_category_autocomplete option', 1)
+            ->assertElementCount('#product_category option', 1)
             ->assertNotContains('First cat')
 
             ->post('/test-form', [
                 'body' => [
-                    'product' => ['category' => ['autocomplete' => $firstCat->getId()]],
+                    'product' => ['category' => (string) $firstCat->getId()],
                 ],
             ])
             // the option does NOT match something returned by query_builder
             // so ONLY the placeholder shows up
-            ->assertElementCount('#product_category_autocomplete option', 1)
+            ->assertElementCount('#product_category option', 1)
             ->assertNotContains('First cat')
             ->post('/test-form', [
                 'body' => [
-                    'product' => ['category' => ['autocomplete' => $fooCat->getId()]],
+                    'product' => ['category' => (string) $fooCat->getId()],
                 ],
             ])
             // the one option + placeholder now shows up
-            ->assertElementCount('#product_category_autocomplete option', 2)
+            ->assertElementCount('#product_category option', 2)
             ->assertContains('which CategoryAutocompleteType uses')
         ;
     }
@@ -83,23 +83,21 @@ public function testProperlyLoadsChoicesWithIdValueObjects()
         $this->browser()
             ->throwExceptions()
             ->get('/test-form')
-            ->assertElementCount('#product_ingredients_autocomplete option', 0)
+            ->assertElementCount('#product_ingredients option', 0)
             ->assertNotContains('Flour')
             ->assertNotContains('Sugar')
             ->post('/test-form', [
                 'body' => [
                     'product' => [
                         'ingredients' => [
-                            'autocomplete' => [
-                                (string) $ingredient1->getId(),
-                                (string) $ingredient2->getId(),
-                            ],
+                            (string) $ingredient1->getId(),
+                            (string) $ingredient2->getId(),
                         ],
                     ],
                 ],
             ])
             // assert that selected options are not lost
-            ->assertElementCount('#product_ingredients_autocomplete option', 2)
+            ->assertElementCount('#product_ingredients option', 2)
             ->assertContains('Flour')
             ->assertContains('Sugar')
         ;
@@ -110,7 +108,7 @@ public function testMultipleDoesNotFailWithoutSelectedChoices()
         $this->browser()
             ->throwExceptions()
             ->get('/test-form')
-            ->assertElementCount('#product_ingredients_autocomplete option', 0)
+            ->assertElementCount('#product_ingredients option', 0)
             ->assertNotContains('Flour')
             ->assertNotContains('Sugar')
             ->post('/test-form', [
@@ -122,7 +120,7 @@ public function testMultipleDoesNotFailWithoutSelectedChoices()
                     ],
                 ],
             ])
-            ->assertElementCount('#product_ingredients_autocomplete option', 0)
+            ->assertElementCount('#product_ingredients option', 0)
         ;
     }
 }