Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Add Select2 Autocomplete for Products & Taxon.

Matthew Kennedy7ec410504986
diff --git a/backend/app/assets/javascripts/spree/backend.js b/backend/app/assets/javascripts/spree/backend.js
index e6bc938608..40cebcaa6f 100644
--- a/backend/app/assets/javascripts/spree/backend.js
+++ b/backend/app/assets/javascripts/spree/backend.js
@@ -16,7 +16,7 @@
//= require underscore-min.js
//= require jsonapi-serializer.min
-//= require spree/backend/global/index
+//= require spree/backend/global/_index
//= require spree
//= require spree/backend/spree-select2
@@ -39,7 +39,7 @@
//= require spree/backend/product_picker
//= require spree/backend/progress
//= require spree/backend/promotions
-//= require spree/backend/menus/index
+//= require spree/backend/menus/_index
//= require spree/backend/returns/expedited_exchanges_warning
//= require spree/backend/returns/return_item_selection
//= require spree/backend/shipments
diff --git a/backend/app/assets/javascripts/spree/backend/global/index.js b/backend/app/assets/javascripts/spree/backend/global/_index.js
similarity index 74%
rename from backend/app/assets/javascripts/spree/backend/global/index.js
rename to backend/app/assets/javascripts/spree/backend/global/_index.js
index 1ed9015e4c..88f3cdeebb 100644
--- a/backend/app/assets/javascripts/spree/backend/global/index.js
+++ b/backend/app/assets/javascripts/spree/backend/global/_index.js
@@ -4,5 +4,6 @@
//= require spree/backend/global/ransack
//= require spree/backend/global/radio_panel_toggle
//= require spree/backend/global/responsive_menus
+//= require spree/backend/global/select2_autocomplete
+//= require spree/backend/global/select2_populate
//= require spree/backend/global/sortable
-//= require spree/backend/global/utils
diff --git a/backend/app/assets/javascripts/spree/backend/global/select2_autocomplete.es6 b/backend/app/assets/javascripts/spree/backend/global/select2_autocomplete.es6
new file mode 100644
index 0000000000..879151c39c
--- /dev/null
+++ b/backend/app/assets/javascripts/spree/backend/global/select2_autocomplete.es6
@@ -0,0 +1,48 @@
+// Allows you to use one autocomplete for sevral use cases with sensible defaults.
+// Requires two params passing to work, the api V1 URI, and the data attribute -> data_attrbute_name: 'products'
+$.fn.select2Autocomplete = function(params) {
+ // Required params
+ const apiUrl = params.apiUrl
+ const dataAttrName = params.data_attrbute_name
+
+ // Custom params
+ const select2placeHolder = params.placeholder || `${Spree.translations.search}: ${dataAttrName}` // Pass your own custom place holder as a string.
+ const select2Multiple = params.multiple || false // Pass true to use multiple Select2.
+ const select2allowClear = params.allow_clear || false // Pass true to use Allow Clear on the Select2, you will also need to set include_blank: true on the select el.
+ const returnAttribute = params.return_attribute || 'name' // Pass a custom return attribute -> return_attribute: 'pretty_name'
+ const minimumInput = params.minimum_input || 3 // Pass a custom minimum input
+ const searchQuery = params.search_query || 'name_cont' // Pass a search query -> search_query: 'name_or_master_sku_cont'
+
+ function formatList(values) {
+ return values.map(function (obj) {
+ return {
+ id: obj.id,
+ text: obj[returnAttribute]
+ }
+ })
+ }
+
+ this.select2({
+ multiple: select2Multiple,
+ allowClear: select2allowClear,
+ placeholder: select2placeHolder,
+ minimumInputLength: minimumInput,
+ ajax: {
+ url: apiUrl,
+ dataType: 'json',
+ data: function (params) {
+ return {
+ q: {
+ [searchQuery]: params.term
+ },
+ token: Spree.api_key
+ }
+ },
+ processResults: function(data) {
+ return {
+ results: formatList(data[dataAttrName])
+ }
+ }
+ }
+ })
+}
diff --git a/backend/app/assets/javascripts/spree/backend/global/utils.es6 b/backend/app/assets/javascripts/spree/backend/global/select2_populate.es6
similarity index 100%
rename from backend/app/assets/javascripts/spree/backend/global/utils.es6
rename to backend/app/assets/javascripts/spree/backend/global/select2_populate.es6
diff --git a/backend/app/assets/javascripts/spree/backend/menus/index.es6 b/backend/app/assets/javascripts/spree/backend/menus/_index.es6
similarity index 100%
rename from backend/app/assets/javascripts/spree/backend/menus/index.es6
rename to backend/app/assets/javascripts/spree/backend/menus/_index.es6
diff --git a/backend/app/views/spree/admin/menu_items/link_inputs/_resource.html.erb b/backend/app/views/spree/admin/menu_items/link_inputs/_resource.html.erb
index dd542aa635..5ea28e2755 100644
--- a/backend/app/views/spree/admin/menu_items/link_inputs/_resource.html.erb
+++ b/backend/app/views/spree/admin/menu_items/link_inputs/_resource.html.erb
@@ -1,31 +1,53 @@
-<%= f.field_container :linked_resource_id, class: ['form-group'] do %>
- <% if @menu_item.linked_resource_type == 'Spree::Taxon' %>
- <%= f.label :linked_resource_id, Spree.t('taxon') %>
- <% elsif @menu_item.linked_resource_type == 'Spree::Product' %>
- <%= f.label :linked_resource_id, Spree.t('product') %>
- <% end %>
+<% resorce_holder = [] %>
+<% id_holder = nil %>
+<% name_holder = nil %>
+<% active_id_holder = nil %>
- <%= f.select :linked_resource_id, options_from_collection_for_select([], nil, nil, @menu_item.linked_resource_id), {include_blank: true}, multiple: false, class: 'select2-clear' %>
- <%= f.error_message_on :linked_resource_id %>
- <small class="form-text text-muted"><%= @menu_item.destination %></small>
-<% end %>
+<% if @menu_item.linked_resource_type == 'Spree::Taxon' %>
+ <% label_text = Spree.t('taxon') %>
-<script>
- document.addEventListener('DOMContentLoaded', function() {
- populateSelectOptionsFromApi({
- targetElement: '#menu_item_linked_resource_id',
+ <% if @menu_item.linked_resource %>
+ <% resorce_holder = [@menu_item.linked_resource] %>
+ <% id_holder = :id %>
+ <% name_holder = :pretty_name %>
+ <% active_id_holder = @menu_item.linked_resource.id %>
+ <% end %>
- <% if @menu_item.linked_resource_type == 'Spree::Taxon' %>
- apiUrl: Spree.routes.taxons_api_v2,
- returnAttribute: 'pretty_name',
- <% elsif @menu_item.linked_resource_type == 'Spree::Product' %>
- apiUrl: Spree.routes.products_api_v2,
- returnAttribute: 'name',
- <% end %>
+ <script>
+ document.addEventListener('DOMContentLoaded', function() {
+ $('.autocomplete').select2Autocomplete({
+ data_attrbute_name: 'taxons',
+ placeholder: "<%= Spree.t('admin.navigation.seach_for_a_taxon') %>",
+ allow_clear: true,
+ apiUrl: Spree.routes.taxons_api,
+ return_attribute: 'pretty_name',
+ })
+ })
+ </script>
+<% elsif @menu_item.linked_resource_type == 'Spree::Product' %>
+ <% label_text = Spree.t('product') %>
+ <% if @menu_item.linked_resource %>
+ <% resorce_holder = [@menu_item.linked_resource] %>
+ <% id_holder = :id %>
+ <% name_holder = :name %>
+ <% active_id_holder = @menu_item.linked_resource.id %>
+ <% end %>
- <% if @menu_item.linked_resource_id %>
- selectedOption: <%= @menu_item.linked_resource_id %>
- <% end %>
+ <script>
+ document.addEventListener('DOMContentLoaded', function() {
+ $('.autocomplete').select2Autocomplete({
+ data_attrbute_name: 'products',
+ placeholder: "<%= Spree.t('admin.navigation.seach_for_a_product') %>",
+ allow_clear: true,
+ apiUrl: Spree.routes.products_api
+ })
})
- });
-</script>
+ </script>
+<% end %>
+
+<%= f.field_container :linked_resource_id, class: ['form-group'] do %>
+ <%= f.label :linked_resource_id, label_text %>
+ <%= f.select :linked_resource_id, options_from_collection_for_select(resorce_holder, id_holder, name_holder, active_id_holder), { include_blank: true }, class: 'autocomplete' %>
+ <%= f.error_message_on :linked_resource_id %>
+ <small class="form-text text-muted"><%= @menu_item.destination %></small>
+<% end %>
diff --git a/backend/app/views/spree/admin/shared/_translations.html.erb b/backend/app/views/spree/admin/shared/_translations.html.erb
index 54ccb87ad8..fbab291135 100644
--- a/backend/app/views/spree/admin/shared/_translations.html.erb
+++ b/backend/app/views/spree/admin/shared/_translations.html.erb
@@ -29,6 +29,7 @@
remove: Spree.t(:remove),
rename: Spree.t(:rename),
save: Spree.t(:save, scope: :actions),
+ search: Spree.t(:search),
searching: Spree.t(:searching),
server_error: Spree.t(:server_error),
select_an_option: Spree.t(:select_an_option),
diff --git a/backend/spec/features/admin/menus/edit_menu_spec.rb b/backend/spec/features/admin/menus/edit_menu_spec.rb
index 6a39cca564..27925b08b2 100644
--- a/backend/spec/features/admin/menus/edit_menu_spec.rb
+++ b/backend/spec/features/admin/menus/edit_menu_spec.rb
@@ -49,7 +49,7 @@ describe 'Menu Edit', type: :feature do
expect(page).to have_text 'Click the Update button below to change the link.'
click_on 'Update'
- select2 product_2.name, from: 'Product'
+ select2 product_2.name, from: 'Product', search: true
click_on 'Update'
assert_admin_flash_alert_success('Menu item "Link To Somewhere" has been successfully updated!')
@@ -72,7 +72,7 @@ describe 'Menu Edit', type: :feature do
expect(page).to have_text 'Click the Update button below to change the link.'
click_on 'Update'
- select2 taxon_2.name, from: 'Taxon'
+ select2 taxon_2.name, from: 'Taxon', search: true
click_on 'Update'
assert_admin_flash_alert_success('Menu item "Link To Somewhere" has been successfully updated!')
diff --git a/backend/spec/features/admin/menus/new_menu_spec.rb b/backend/spec/features/admin/menus/new_menu_spec.rb
index 82c7d160f4..06d5425d6d 100644
--- a/backend/spec/features/admin/menus/new_menu_spec.rb
+++ b/backend/spec/features/admin/menus/new_menu_spec.rb
@@ -34,8 +34,9 @@ describe 'New Menu', type: :feature do
end
end
- context 'when a user tries to create a menu with a duplicate code' do
- let!(:main_menu) { create(:menu, name: 'Main Menu') }
+ context 'when a user tries to create a menu with a duplicate code withn scope of stores', js: true do
+ let!(:store_1) { create(:store) }
+ let!(:main_menu) { create(:menu, name: 'Main Menu', store_ids: [store_1.id]) }
before do
visit spree.new_admin_menu_path
@@ -44,8 +45,12 @@ describe 'New Menu', type: :feature do
it 'warns the user that the Unique code has already been taken' do
fill_in 'Name', with: 'Main Menu'
fill_in 'Unique Code', with: main_menu.unique_code
+
+ select2 store_1.unique_name, from: 'Stores'
click_on 'Create'
- expect(page).to have_text ('Unique code has already been taken')
+ expect(page).to have_text (Spree.t('admin.navigation.unique_code_store_error',
+ code: main_menu.unique_code,
+ menus: main_menu.name))
end
end
@@ -70,7 +75,7 @@ describe 'New Menu', type: :feature do
expect(page).to have_text 'Main Menu has no items. Click the Add New Item button to begin adding links to this menu.'
expect(page).to have_selector('a', text: Spree.t('admin.navigation.add_new_item'))
- expect(page).not_to have_css('.translation_missing', visible: :all)
+ expect(page).not_to have_css('.translation_missing', visible: :all)
end
end
end
diff --git a/core/app/models/spree/menu.rb b/core/app/models/spree/menu.rb
index 667b9608ae..93ec638a22 100644
--- a/core/app/models/spree/menu.rb
+++ b/core/app/models/spree/menu.rb
@@ -36,7 +36,7 @@ module Spree
unless menus.empty?
errors.add(:unique_code,
- Spree.t('admin.navigation.scope_unique_name_store_id_error',
+ Spree.t('admin.navigation.unique_code_store_error',
code: unique_code,
menus: menus[0]))
end
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index f1badf4514..f742cbb5bd 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -601,8 +601,10 @@ en:
menus: Menus
menu_items: '%{menu_name} Items'
public_details: Public Details
- scope_unique_name_store_id_error: 'The code: %{code} is already used for Menu: %{menus}, make sure your unique code is unique within the store it is being used for.'
+ unique_code_store_error: 'The code: %{code} is already used for Menu: %{menus}, make sure your unique code is unique within the store it is being used for.'
subtitle: Subtitle
+ seach_for_a_product: Search for a Product
+ seach_for_a_taxon: Search for a Taxon
settings: Settings
set_a_code: Give your Menu Item a code, this is optional, but can be useful if you need to identify this menu item.
type: Type