Merge pull request #46 from localgovdrupal/1.x

1.0.0-beta2 release

.github/workflows/test.yml

@@ -24,13 +24,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        localgov-version:
-          - '2.x'
-        drupal-version:
-          - '~9.3'
-        php-version:
-          - '7.4'
-          - '8.1'
+        include:
+          - localgov-version: '2.x'
+            drupal-version: '~9.4'
+            php-version: '8.1'
+          - localgov-version: '3.x'
+            drupal-version: '~10.0'
+            php-version: '8.1'
 
     steps:
 
@@ -110,13 +110,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        localgov-version:
-          - '2.x'
-        drupal-version:
-          - '~9.3'
-        php-version:
-          - '7.4'
-          - '8.1'
+        include:
+          - localgov-version: '2.x'
+            drupal-version: '~9.4'
+            php-version: '8.1'
+          - localgov-version: '3.x'
+            drupal-version: '~10.0'
+            php-version: '8.1'
 
     steps:
 
@@ -146,13 +146,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        localgov-version:
-          - '2.x'
-        drupal-version:
-          - '~9.3'
-        php-version:
-          - '7.4'
-          - '8.1'
+        include:
+          - localgov-version: '2.x'
+            drupal-version: '~9.4'
+            php-version: '8.1'
+          - localgov-version: '3.x'
+            drupal-version: '~10.0'
+            php-version: '8.1'
 
     steps:
 
@@ -181,13 +181,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        localgov-version:
-          - '2.x'
-        drupal-version:
-          - '~9.3'
-        php-version:
-          - '7.4'
-          - '8.1'
+        include:
+          - localgov-version: '2.x'
+            drupal-version: '~9.4'
+            php-version: '8.1'
+          - localgov-version: '3.x'
+            drupal-version: '~10.0'
+            php-version: '8.1'
 
     steps:
 

README.md

@@ -14,3 +14,13 @@ $ composer require --dev geocoder-php/nominatim-provider
 ```
 
 The localgovdrupal/localgov_geo and localgovdrupal/localgov_os_places_geocoder_provider packages are needed to use the Ordnance Survey Places API-based address lookup plugin.  Once these packages are installed, the *Localgov OS Places* plugin will become available for selection from the Localgov address lookup element's configuration form.
+
+## Editing webforms
+Webforms in Drupal are config entities, therefore are by default exported with the website configuration.
+It is often desirable that webforms are built and maintained by non-developers.
+To avoid the configuration being removed by deployments, install the [Config ignore](https://www.drupal.org/project/config_ignore) module and under `/admin/config/development/configuration/ignore` add the following:
+```
+webform.webform.*
+webform.webform_options.*
+```
+

composer.json

@@ -7,7 +7,7 @@
   "minimum-stability": "dev",
   "require": {
     "drupal/webform": "^6.0",
-    "drupal/geocoder": "^3.20",
+    "drupal/geocoder": "^3.20 || ^4.0",
     "localgovdrupal/localgov_os_places_geocoder_provider": "1.x-dev"
   },
   "require-dev": {

config/install/localgov_forms.webform.settings.yml

@@ -132,8 +132,6 @@ element:
   default_description_display: ''
   default_more_title: More
   default_section_title_tag: h2
-  default_algolia_places_app_id: ''
-  default_algolia_places_api_key: ''
   default_empty_option: true
   default_empty_option_required: ''
   default_empty_option_optional: ''

js/address_change.js

@@ -80,7 +80,7 @@
     attach: function (context, settings) {
 
       // Behaviors to only attach once.
-      $('.js-centralhub-address-lookup', context).once('central-hub-behaviours').each(function () {
+      $(once('central-hub-behaviours', '.js-centralhub-address-lookup', context)).each(function () {
         // Get form elements.
         var addressLookupElement = $(this);
         var searchElement = addressLookupElement.find('.js-address-searchstring');

js/address_select.js

@@ -207,7 +207,7 @@
   // Attach after an ajax refresh
   Drupal.behaviors.localgov_forms_webform = {
     attach: function (context, settings) {
-      $('.js-webform-type-localgov-webform-uk-address', context).once('localgov-address-webform').each(function () {
+      $(once('localgov-address-webform', '.js-webform-type-localgov-webform-uk-address', context)).each(function () {
         var centralHubElement = $(this);
         addManualEntryButton(centralHubElement);
 
@@ -226,14 +226,10 @@
       });
 
       // Manual address change handler first.
-      $(document).once('.js-address-entry-container input', context).ajaxSuccess(function (event, data) {
-        $('.js-address-entry-container input').on('change', localgov_forms_webform_manual_address_change_handler);
-      });
+      $('.js-address-entry-container input').on('change', localgov_forms_webform_manual_address_change_handler);
 
       // Select box change handler.
-      $(document).once('.js-address-select-container', context).ajaxSuccess(function (event, data) {
-        $('.js-address-select').on('change', localgov_forms_webform_change_handler);
-      });
+      $('.js-address-select').on('change', localgov_forms_webform_change_handler);
     },
     detach: function (context, settings, trigger) {
       $('.js-address-entry-container input').off('change', localgov_forms_webform_manual_address_change_handler);

localgov_forms.info.yml

@@ -1,7 +1,7 @@
 name: LocalGov Forms
 type: module
 description: Provides additional configuration, styling and components for the Drupal Webform module.
-core_version_requirement: ^8.8 || ^9
+core_version_requirement: ^8.8 || ^9 || ^10
 package: LocalGov Drupal
 
 dependencies:

localgov_forms.libraries.yml

@@ -21,6 +21,7 @@ localgov_forms.address_select:
   dependencies:
     - localgov_forms/localgov_forms.address_change
     - core/drupal
+    - core/once
     - core/jquery
 
 localgov_forms.address_change:
@@ -29,4 +30,5 @@ localgov_forms.address_change:
     js/address_change.js: {}
   dependencies:
     - core/drupal
+    - core/once
     - core/jquery

modules/localgov_forms_date/localgov_forms_date.info.yml

@@ -2,7 +2,7 @@ name: 'LocalGov Forms: Date'
 type: module
 description: 'A custom Date component'
 package: LocalGov Drupal
-core_version_requirement: ^8 || ^9
+core_version_requirement: ^8 || ^9 || ^10
 dependencies:
   - 'webform:webform'
   - 'localgov_forms:localgov_forms'

modules/localgov_forms_date/src/Plugin/WebformElement/LocalgovFormsDate.php

@@ -2,8 +2,8 @@
 
 namespace Drupal\localgov_forms_date\Plugin\WebformElement;
 
-use Drupal\webform\Plugin\WebformElement\DateList;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\webform\Plugin\WebformElement\DateList;
 
 /**
  * Provides a 'localgov_forms_date' element.

modules/localgov_forms_date/tests/modules/localgov_forms_date_test/localgov_forms_date_test.info.yml

@@ -2,7 +2,7 @@ name: 'Localgov form date test'
 description: 'Helper module to setup a webform with a localgov_forms_date field.'
 type: module
 package: Testing
-core_version_requirement: ^8.8 || ^9
+core_version_requirement: ^8.8 || ^9 || ^10
 
 dependencies:
 - webform:webform

src/Element/AddressLookupElement.php

@@ -2,9 +2,9 @@
 
 namespace Drupal\localgov_forms\Element;
 
+use Drupal\Component\Utility\Html;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Render\Element\FormElement;
-use Drupal\Component\Utility\Html;
 
 /**
  * Provides a central hub address lookup element.

src/Element/LocalgovWebformUKAddress.php

@@ -2,11 +2,11 @@
 
 namespace Drupal\localgov_forms\Element;
 
-use Drupal\Core\Form\FormStateInterface;
 use Drupal\Component\Utility\NestedArray;
-use Drupal\webform\Utility\WebformElementHelper;
-use Drupal\localgov_forms\WebformHelper;
+use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Render\Element;
+use Drupal\localgov_forms\WebformHelper;
+use Drupal\webform\Utility\WebformElementHelper;
 
 /**
  * Provides a 'localgov_webform_uk_address' form element.

src/Plugin/WebformElement/LocalgovWebformUKAddress.php

@@ -2,8 +2,8 @@
 
 namespace Drupal\localgov_forms\Plugin\WebformElement;
 
-use Drupal\webform\WebformSubmissionInterface;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\webform\WebformSubmissionInterface;
 
 /**
  * Provides a 'localgov_webform_uk_address' Webform element.

tests/modules/localgov_forms_test/localgov_forms_test.info.yml

@@ -2,7 +2,7 @@ name: 'Localgov form test'
 description: 'Helper module to setup a Contact webform.'
 type: module
 package: Testing
-core_version_requirement: ^8.8 || ^9
+core_version_requirement: ^8.8 || ^9 || ^10
 
 dependencies:
 - webform:webform

tests/modules/localgov_forms_test/src/Geocoder/Provider/LocalgovMockGeocoder.php

@@ -7,9 +7,9 @@
 use Geocoder\Collection as LocationCollectionInterface;
 use Geocoder\Exception\UnsupportedOperation;
 use Geocoder\Model\AddressCollection;
+use Geocoder\Provider\Provider as ProviderInterface;
 use Geocoder\Query\GeocodeQuery;
 use Geocoder\Query\ReverseQuery;
-use Geocoder\Provider\Provider as ProviderInterface;
 use LocalgovDrupal\OsPlacesGeocoder\Model\OsPlacesAddress;
 
 /**