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.

Make universal helper method for humanizing class names for drop-downs.

Matthew Kennedy0736373be115
diff --git a/backend/app/assets/javascripts/spree/backend/global/select2_autocomplete.es6 b/backend/app/assets/javascripts/spree/backend/global/select2_autocomplete.es6
index db137c4f54..efef4d2058 100644
--- a/backend/app/assets/javascripts/spree/backend/global/select2_autocomplete.es6
+++ b/backend/app/assets/javascripts/spree/backend/global/select2_autocomplete.es6
@@ -1,17 +1,20 @@
// SELECT2 AUTOCOMPLETE JS
// This JavaScript file allows Spree developers to set up Select2 autocomplete search
-// using the API v2 by simply adding data attributes to the <select> DOM element.
+// using the API v2 by simply adding data attributes to a select element with the class: 'select2autocomplete'
+// as shown here: <select class="select2autocomplete"></select>.
// REQUIRED ATTRIBUTES
// You must provide a URL for the API V2, use the format shown below.
// See the backend.js file for other API V2 URL's.
//
+// Example:
// data-autocomplete-url-value="products_api_v2"
// OPTIONAL ATTRIBUTES
-// These attributes have sensible defaults, you many not need to use them in many cases,
-// but they do provide a powerful toolkit to refine your search when needed.
+// These optional attributes have sensible defaults, you many not need to use them in many cases,
+// but they do provide a powerful toolkit to refine your autocomplete search as required.
//
+// Examples:
// data-autocomplete-placeholder-value="Seach Pages" <- Sets the placeholder | DEFAULT is: 'Search'
// data-autocomplete-clear-value="boolean" <- Allow select2 to be cleared | DEFAULT is: false (no clear button)
// data-autocomplete-multiple-value="boolean" <- Multiple or Single select | DEFAULT is: false (single)
@@ -26,8 +29,9 @@
// here we only want to retuen Pages that have linkable slugs, not homepages, and so we filter those using the
// data attributes shown below.
//
-// data-autocomplete-additional-query-value="type_not_eq" <- Pass a second hard coded filter query value | DEFAULT: null (not used)
-// data-autocomplete-additional-term-value="Spree::Cms::Pages::Homepage" <- Pass a second hard coded term | DEFAULT: null (not used)
+// Examples:
+// data-autocomplete-additional-query-value="type_not_eq" <- Additional hard coded query | DEFAULT: null (not used)
+// data-autocomplete-additional-term-value="Spree::Cms::Pages::Homepage" <- Additional hard coded term | DEFAULT: null (not used)
document.addEventListener('DOMContentLoaded', function() {
const select2Autocompletes = document.querySelectorAll('select.select2autocomplete')
@@ -59,7 +63,7 @@ $.fn.select2Autocomplete = function(params) {
// Required params
const apiUrl = params.apiUrl || null
- // Optional params
+ // Optional Params
const select2placeHolder = params.placeholder || Spree.translations.search
const select2Multiple = params.multiple || false
const select2allowClear = params.allow_clear || false
diff --git a/backend/app/helpers/spree/admin/base_helper.rb b/backend/app/helpers/spree/admin/base_helper.rb
index 250cd0cedb..93511817ee 100644
--- a/backend/app/helpers/spree/admin/base_helper.rb
+++ b/backend/app/helpers/spree/admin/base_helper.rb
@@ -31,6 +31,32 @@ module Spree
)
end
+ def spree_humanize_dropdown_values(obj, const = 'TYPES')
+ formatted_types = []
+
+ if obj.is_a? String
+ obj.constantize.const_get(const).each do |type|
+ formatted_types << [spree_humanize_type(type), type]
+ end
+ else
+ obj.class::const_get(const).each do |type|
+ formatted_types << [spree_humanize_type(type), type]
+ end
+ end
+
+ formatted_types
+ end
+
+ def spree_humanize_type(obj)
+ last_word = obj.split('::', 10).last
+
+ if last_word.starts_with?('Cms')
+ last_word.slice(3, 100).gsub(/(?<=[a-z])(?=[A-Z])/, ' ')
+ else
+ last_word.gsub(/(?<=[a-z])(?=[A-Z])/, ' ')
+ end
+ end
+
def error_message_on(object, method, _options = {})
object = convert_to_model(object)
obj = object.respond_to?(:errors) ? object : instance_variable_get("@#{object}")
diff --git a/backend/app/helpers/spree/admin/cms_helper.rb b/backend/app/helpers/spree/admin/cms_helper.rb
index c60f081b45..5b2c88d3d6 100644
--- a/backend/app/helpers/spree/admin/cms_helper.rb
+++ b/backend/app/helpers/spree/admin/cms_helper.rb
@@ -47,25 +47,6 @@ module Spree
spree.page_path(page.slug)
end
end
-
- def linkable_as_path(item)
- item.parameterize(separator: '_')
- end
-
- def humanize_dropdown_values(obj)
- formatted_types = []
-
- obj.class::TYPES.each do |type|
- formatted_types << [humanize_cms_type(type), type]
- end
-
- formatted_types
- end
-
- def humanize_cms_type(obj)
- last_word = obj.split('::', 10).last
- last_word.gsub(/(?<=[a-z])(?=[A-Z])/, ' ')
- end
end
end
end
diff --git a/backend/app/helpers/spree/admin/menu_helper.rb b/backend/app/helpers/spree/admin/menu_helper.rb
index 76059dd6f0..977b9b4434 100644
--- a/backend/app/helpers/spree/admin/menu_helper.rb
+++ b/backend/app/helpers/spree/admin/menu_helper.rb
@@ -22,46 +22,9 @@ module Spree
data: { item_id: item.id })
end
- def resorce_types_dropdown_values
- formatted_resouces = []
-
- Spree::MenuItem::LINKED_RESOURCE_TYPE.each do |resource_type|
- formatted = if Spree::MenuItem::DYNAMIC_RESOURCE_TYPE.include? resource_type
- str = resource_type.split('::', 10).last
- if str.starts_with?('Cms')
- str.slice(3, 100)
- else
- str
- end
- else
- resource_type
- end
-
- formatted_resouces << [formatted, resource_type]
- end
-
- formatted_resouces
- end
-
- def menu_locations_dropdown_values
- menu_items_for_select = []
-
- Spree::Menu::MENU_LOCATIONS.each do |location|
- parameterized_location = location.parameterize(separator: '_')
-
- menu_items_for_select << [location, parameterized_location]
- end
-
- menu_items_for_select
- end
-
def default_menu_for_store?(menu)
menu.store.default_locale == menu.locale
end
-
- def to_path_format(string)
- string.parameterize(separator: '_')
- end
end
end
end
diff --git a/backend/app/views/spree/admin/cms_pages/_form.html.erb b/backend/app/views/spree/admin/cms_pages/_form.html.erb
index 8facdacc84..61eb950ce3 100644
--- a/backend/app/views/spree/admin/cms_pages/_form.html.erb
+++ b/backend/app/views/spree/admin/cms_pages/_form.html.erb
@@ -10,7 +10,7 @@
<div class="row">
<%= f.field_container :type, class: ['form-group col-12 col-md-6'] do %>
<%= f.label :type, Spree.t('admin.cms.page_type') %>
- <%= f.select(:type, humanize_dropdown_values(@cms_page), {include_blank: false}, class: 'select2') %>
+ <%= f.select(:type, spree_humanize_dropdown_values(@cms_page), {include_blank: false}, class: 'select2') %>
<%= f.error_message_on :type %>
<% end %>
diff --git a/backend/app/views/spree/admin/cms_pages/_section_template.html.erb b/backend/app/views/spree/admin/cms_pages/_section_template.html.erb
index 75d308d246..fc22bd2e98 100644
--- a/backend/app/views/spree/admin/cms_pages/_section_template.html.erb
+++ b/backend/app/views/spree/admin/cms_pages/_section_template.html.erb
@@ -5,7 +5,7 @@
<div class="d-flex align-items-center overflow-hidden w-100">
<div>
<h6 class="mb-0"><small><%= section.name %></small></h6>
- <small class="form-text text-muted mt-0">Type: <%= humanize_cms_type(section.type) %></small>
+ <small class="form-text text-muted mt-0">Type: <%= spree_humanize_type(section.type) %></small>
</div>
</div>
diff --git a/backend/app/views/spree/admin/cms_pages/index.html.erb b/backend/app/views/spree/admin/cms_pages/index.html.erb
index 9f48e73216..f072c3cd5c 100644
--- a/backend/app/views/spree/admin/cms_pages/index.html.erb
+++ b/backend/app/views/spree/admin/cms_pages/index.html.erb
@@ -27,7 +27,7 @@
<%= active_badge(page.draft_mode?) %>
</td>
<td>
- <%= humanize_cms_type(page.type) %>
+ <%= spree_humanize_type(page.type) %>
</td>
<td>
<%= page.store.unique_name %>
diff --git a/backend/app/views/spree/admin/cms_sections/_form.html.erb b/backend/app/views/spree/admin/cms_sections/_form.html.erb
index bf0f98ed9d..3833227845 100644
--- a/backend/app/views/spree/admin/cms_sections/_form.html.erb
+++ b/backend/app/views/spree/admin/cms_sections/_form.html.erb
@@ -17,7 +17,7 @@
<div class="col-12 col-md-6">
<%= f.field_container :type, class: ['form-group'] do %>
<%= f.label :type, Spree.t('admin.navigation.section_type') %>
- <%= f.select(:type, humanize_dropdown_values(@cms_section), {include_blank: false}) %>
+ <%= f.select(:type, spree_humanize_dropdown_values(@cms_section), {include_blank: false}) %>
<%= f.error_message_on :type %>
<% end %>
</div>
@@ -50,7 +50,7 @@
<div class="card mb-3">
<div class="card-header">
<h5 class="mb-0">
- <%= Spree.t('admin.cms.settings_for', section: humanize_cms_type(@cms_section.type)) %>
+ <%= Spree.t('admin.cms.settings_for', section: spree_humanize_type(@cms_section.type)) %>
</h5>
</div>
<div class="card-body">
diff --git a/backend/app/views/spree/admin/menu_items/_form.html.erb b/backend/app/views/spree/admin/menu_items/_form.html.erb
index 151b2014c1..12bcc70f45 100644
--- a/backend/app/views/spree/admin/menu_items/_form.html.erb
+++ b/backend/app/views/spree/admin/menu_items/_form.html.erb
@@ -95,7 +95,7 @@
<div class="col-6">
<%= f.field_container :linked_resource_type, class: ['form-group'] do %>
<%= f.label :linked_resource_type, Spree.t('admin.navigation.link_to') %>
- <%= f.select(:linked_resource_type, resorce_types_dropdown_values, {include_blank: false}, class: 'link_switcher') %>
+ <%= f.select(:linked_resource_type, spree_humanize_dropdown_values(@menu_item, 'LINKED_RESOURCE_TYPE'), {include_blank: false}, class: 'link_switcher') %>
<%= f.error_message_on :linked_resource_type %>
<% end %>
</div>
diff --git a/backend/app/views/spree/admin/menus/_form.html.erb b/backend/app/views/spree/admin/menus/_form.html.erb
index ee7fed3b38..333e7dfca2 100644
--- a/backend/app/views/spree/admin/menus/_form.html.erb
+++ b/backend/app/views/spree/admin/menus/_form.html.erb
@@ -8,7 +8,7 @@
<%= f.field_container :location, class: ['form-group'] do %>
<%= f.label :location, Spree.t('location') %>
- <%= f.select(:location, menu_locations_dropdown_values, {include_blank: false}, class: 'select2') %>
+ <%= f.select(:location, spree_humanize_dropdown_values(@menu, 'MENU_LOCATIONS'), {include_blank: false}, class: 'select2') %>
<%= f.error_message_on :location %>
<% end %>
</div>
diff --git a/backend/app/views/spree/admin/menus/index.html.erb b/backend/app/views/spree/admin/menus/index.html.erb
index 9a5d9f27be..60aab86ec6 100644
--- a/backend/app/views/spree/admin/menus/index.html.erb
+++ b/backend/app/views/spree/admin/menus/index.html.erb
@@ -20,7 +20,7 @@
<div class="col-12 col-lg-6">
<div class="form-group">
<%= label_tag :q_location_eq, Spree.t(:location) %>
- <%= f.select :location_eq, menu_locations_dropdown_values, { include_blank: true }, class: 'select2-clear js-filterable' %>
+ <%= f.select :location_eq, spree_humanize_dropdown_values('Spree::Menu', 'MENU_LOCATIONS'), { include_blank: true }, class: 'select2-clear js-filterable' %>
</div>
</div>
</div>
diff --git a/backend/app/views/spree/admin/shared/_link_fields.html.erb b/backend/app/views/spree/admin/shared/_link_fields.html.erb
index 15c2d28b3a..34d90f1bcc 100644
--- a/backend/app/views/spree/admin/shared/_link_fields.html.erb
+++ b/backend/app/views/spree/admin/shared/_link_fields.html.erb
@@ -1,6 +1,6 @@
<% if resource.linked_resource_type.present? %>
<div data-panel-type="<%= resource.linked_resource_type %>">
- <%= render "spree/admin/shared/linkables/#{to_path_format(resource.linked_resource_type)}", resource: resource, f: f %>
+ <%= render "spree/admin/shared/linkables/#{spree_class_name_as_path(resource.linked_resource_type)}", resource: resource, f: f %>
</div>
<% end %>
<div id="linkClickUpdate" class="d-none">
diff --git a/backend/app/views/spree/admin/shared/linkables/_spree_cmspage.html.erb b/backend/app/views/spree/admin/shared/linkables/_spree_cms_page.erb
similarity index 86%
rename from backend/app/views/spree/admin/shared/linkables/_spree_cmspage.html.erb
rename to backend/app/views/spree/admin/shared/linkables/_spree_cms_page.erb
index aa538054d2..a512a5fe4c 100644
--- a/backend/app/views/spree/admin/shared/linkables/_spree_cmspage.html.erb
+++ b/backend/app/views/spree/admin/shared/linkables/_spree_cms_page.erb
@@ -17,9 +17,9 @@
autocomplete_return_attr_value: 'title',
autocomplete_search_query_value: 'title_i_cont',
- # hard coded additional filter to filter out homepages from
- # results, home pages dont have a slug, and we already have
- # a dedicated home page link to type.
+ # Hard coded additional filter to filter out homepages from
+ # the results. Homepages don't have a slug, and we already have
+ # a dedicated Home Page link_to type.
autocomplete_additional_query_value: 'type_not_eq',
autocomplete_additional_term_value: 'Spree::Cms::Pages::Homepage' } %>
diff --git a/core/app/helpers/spree/base_helper.rb b/core/app/helpers/spree/base_helper.rb
index b8f98150ff..ca880c4447 100644
--- a/core/app/helpers/spree/base_helper.rb
+++ b/core/app/helpers/spree/base_helper.rb
@@ -21,7 +21,11 @@ module Spree
def spree_resource_path(resource)
last_word = resource.class.name.split('::', 10).last
- last_word.underscore.humanize.parameterize(separator: '_')
+ spree_class_name_as_path(last_word)
+ end
+
+ def spree_class_name_as_path(class_name)
+ class_name.underscore.humanize.parameterize(separator: '_')
end
def display_price(product_or_variant)