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.

Use path

Matthew Kennedy56a0d1077dde
diff --git a/api/app/controllers/spree/api/v2/platform/menu_items_controller.rb b/api/app/controllers/spree/api/v2/platform/menu_items_controller.rb
index 6f85feeae2..2fcaf81720 100644
--- a/api/app/controllers/spree/api/v2/platform/menu_items_controller.rb
+++ b/api/app/controllers/spree/api/v2/platform/menu_items_controller.rb
@@ -12,6 +12,10 @@ module Spree
end
@moved_item.move_with_index(params[:new_position_idx].to_i, @new_parent)
+
+ if @moved_item.save
+ head :no_content
+ end
end
private
diff --git a/backend/app/controllers/spree/admin/menu_items_controller.rb b/backend/app/controllers/spree/admin/menu_items_controller.rb
index 19f4229066..9223718f30 100644
--- a/backend/app/controllers/spree/admin/menu_items_controller.rb
+++ b/backend/app/controllers/spree/admin/menu_items_controller.rb
@@ -5,8 +5,6 @@ module Spree
before_action :load_data
- def index; end
-
def collection_url
spree.edit_admin_menu_path(@menu)
end
@@ -18,6 +16,7 @@ module Spree
def load_data
@menu_item_types = Spree::MenuItem::ITEM_TYPE
@linked_resource_types = Spree::MenuItem::LINKED_RESOURCE_TYPE
+
@taxons = Spree::Taxon.all
@products = Spree::Product.all
end
diff --git a/backend/app/controllers/spree/admin/menus_controller.rb b/backend/app/controllers/spree/admin/menus_controller.rb
index 922353171f..0ebf0e2250 100644
--- a/backend/app/controllers/spree/admin/menus_controller.rb
+++ b/backend/app/controllers/spree/admin/menus_controller.rb
@@ -12,7 +12,7 @@ module Spree
end
def load_menu_items_ordered
- @menu_items_in_order = @menu.menu_items.order(:lft)
+ @menu_items = @menu.menu_items.roots.order(:lft)
end
end
end
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 96307dc4c1..4605f8116f 100644
--- a/backend/app/views/spree/admin/menu_items/_form.html.erb
+++ b/backend/app/views/spree/admin/menu_items/_form.html.erb
@@ -92,7 +92,7 @@
</div>
<div class="col-6">
- <%= render 'link_input', linked_resource: @menu_item.linked_resource_type, f: f %>
+ <%= render 'link_input', linked_resource_type: @menu_item.linked_resource_type, f: f %>
<div id="alertToClickUpdate" class="d-none">
<div class="alert alert-warning mt-3">
diff --git a/backend/app/views/spree/admin/menu_items/_link_input.html.erb b/backend/app/views/spree/admin/menu_items/_link_input.html.erb
index 3570c18bdf..a78b7644de 100644
--- a/backend/app/views/spree/admin/menu_items/_link_input.html.erb
+++ b/backend/app/views/spree/admin/menu_items/_link_input.html.erb
@@ -1,16 +1,12 @@
-<div id="linkResourcePanel" data-panel-type="<%= linked_resource %>">
- <% if defined?(Spree::Frontend) %>
- <% case linked_resource %>
- <% when 'URL' %>
- <%= render 'spree/admin/menu_items/link_inputs/url', f: f %>
- <% when 'Home Page' %>
- <%= render 'spree/admin/menu_items/link_inputs/home_page', f: f %>
- <% when 'Spree::Taxon' %>
- <%= render 'spree/admin/menu_items/link_inputs/taxon', linked_resource: linked_resource, f: f %>
- <% when 'Spree::Product' %>
- <%= render 'spree/admin/menu_items/link_inputs/product', linked_resource: linked_resource, f: f %>
- <% end %>
- <% else %>
+<div id="linkResourcePanel" data-panel-type="<%= linked_resource_type %>">
+ <% case linked_resource_type %>
+ <% when 'URL' %>
<%= render 'spree/admin/menu_items/link_inputs/url', f: f %>
+ <% when 'Home Page' %>
+ <%= render 'spree/admin/menu_items/link_inputs/home_page', f: f %>
+ <% when 'Spree::Taxon' %>
+ <%= render 'spree/admin/menu_items/link_inputs/taxon', linked_resource: linked_resource_type, f: f %>
+ <% when 'Spree::Product' %>
+ <%= render 'spree/admin/menu_items/link_inputs/product', linked_resource: linked_resource_type, f: f %>
<% end %>
</div>
diff --git a/backend/app/views/spree/admin/menus/edit.html.erb b/backend/app/views/spree/admin/menus/edit.html.erb
index 618d4acac4..a4edcf1502 100644
--- a/backend/app/views/spree/admin/menus/edit.html.erb
+++ b/backend/app/views/spree/admin/menus/edit.html.erb
@@ -38,11 +38,9 @@
<div class="card-body p-0 bg-light">
<div id="primaryMenuContainer" class="menu-container">
- <% if @menu_items_in_order.present? %>
- <% nested_set_options(@menu_items_in_order) do |item| %>
- <% if item.root? %>
- <%= build_menu_item(@menu, item) %>
- <% end %>
+ <% if @menu_items.root.present? %>
+ <% @menu_items.roots.each do |item| %>
+ <%= build_menu_item(@menu, item) %>
<% end %>
<% else %>
<div class="alert alert-info no-objects-found m-5">
diff --git a/backend/app/views/spree/admin/menus/nested_menu_items/_item_bar.html.erb b/backend/app/views/spree/admin/menus/nested_menu_items/_item_bar.html.erb
index 9717537c7b..0bdbc4aec1 100644
--- a/backend/app/views/spree/admin/menus/nested_menu_items/_item_bar.html.erb
+++ b/backend/app/views/spree/admin/menus/nested_menu_items/_item_bar.html.erb
@@ -6,7 +6,7 @@
<div class="d-flex align-items-center w-100 truncate">
<div>
<%= item.name %>
- <% if defined?(Spree::Frontend) && menu_item_link_to(item) != '#' %>
+ <% if menu_item_link_to(item) != '#' %>
<small class="text-muted mt-0">-></small> <span class="badge badge-light badge-light-muted-text"><%= menu_item_link_to(item) %></span>
<% end %>
<small class="form-text text-muted mt-0">
@@ -14,13 +14,14 @@
<%= "| #{Spree.t('admin.navigation.code')}: #{item.code}" if item.code.present? %>
</small>
</div>
-
- <% if item.image_asset.attached? && item.image_asset.image? %>
- <div class="ml-2">
- <div class="menu_items_image_holder">
- <%= image_tag main_app.url_for(item.image_asset) %>
+ <% if item.uses_attached_image %>
+ <% if item.image_asset.attached? && item.image_asset.image? %>
+ <div class="ml-2">
+ <div class="menu_items_image_holder">
+ <%= image_tag main_app.url_for(item.image_asset) %>
+ </div>
</div>
- </div>
+ <% end %>
<% end %>
</div>
diff --git a/core/app/helpers/spree/base_helper.rb b/core/app/helpers/spree/base_helper.rb
index f0bf0766e7..b4a17287dc 100644
--- a/core/app/helpers/spree/base_helper.rb
+++ b/core/app/helpers/spree/base_helper.rb
@@ -27,14 +27,9 @@ module Spree
def menu_item_link_to(item)
if Spree::MenuItem::DYNAMIC_RESOURCE_TYPE.include? item.linked_resource_type
- return if item.linked_resource.nil?
+ return if item.path.nil?
- case item.linked_resource_type
- when 'Spree::Product'
- spree.product_path(item.linked_resource)
- when 'Spree::Taxon'
- spree.nested_taxons_path(item.linked_resource.permalink)
- end
+ item.path
else
case item.linked_resource_type
when 'URL'
@@ -44,7 +39,7 @@ module Spree
'#'
end
when 'Home Page'
- spree.root_path
+ '/'
else
'#'
end
diff --git a/core/app/models/spree/app_configuration.rb b/core/app/models/spree/app_configuration.rb
index 4bcd1095de..fdffb4721b 100644
--- a/core/app/models/spree/app_configuration.rb
+++ b/core/app/models/spree/app_configuration.rb
@@ -76,6 +76,10 @@ module Spree
@searcher_class ||= Spree::Core::Search::Base
end
+ # These are used if no frontend is being used.
+ preference :api_product_path, :string, default: 'products'
+ preference :api_taxon_path, :string, default: 'categories'
+
attr_writer :searcher_class
end
end
diff --git a/core/app/models/spree/menu_item.rb b/core/app/models/spree/menu_item.rb
index 979e81ee66..0efeff4d2c 100644
--- a/core/app/models/spree/menu_item.rb
+++ b/core/app/models/spree/menu_item.rb
@@ -1,13 +1,13 @@
module Spree
class MenuItem < Spree::Base
- include Spree::Core::Engine.routes.url_helpers
-
belongs_to :menu
belongs_to :linked_resource, polymorphic: true
acts_as_nested_set dependent: :destroy
before_save :reset_link_attributes
+ before_save :check_for_image
+ before_save :build_path
has_one_attached :image_asset
@@ -17,23 +17,62 @@ module Spree
STATIC_RESOURCE_TYPE = ['Home Page']
DYNAMIC_RESOURCE_TYPE = ['Spree::Product', 'Spree::Taxon']
- if defined?(Spree::Frontend)
- LINKED_RESOURCE_TYPE.unshift(*STATIC_RESOURCE_TYPE)
- LINKED_RESOURCE_TYPE.push(*DYNAMIC_RESOURCE_TYPE)
- end
+ LINKED_RESOURCE_TYPE.unshift(*STATIC_RESOURCE_TYPE)
+ LINKED_RESOURCE_TYPE.push(*DYNAMIC_RESOURCE_TYPE)
validates :name, presence: true
validates :menu_id, presence: true, numericality: { only_integer: true }
validates :item_type, inclusion: { in: ITEM_TYPE }
validates :linked_resource_type, inclusion: { in: LINKED_RESOURCE_TYPE }
+ def self.refresh_paths(resorce, old_value)
+ where(linked_resource_type: resorce.class.name).where('path LIKE ?', "%/#{old_value}%").each do |item|
+ item.save!
+ end
+ end
+
private
+ def build_path
+ if DYNAMIC_RESOURCE_TYPE.include? linked_resource_type
+ return if linked_resource_id.nil?
+
+ case linked_resource_type
+ when 'Spree::Taxon'
+ self.path = if frontend_available?
+ Spree::Core::Engine.routes.url_helpers.nested_taxons_path(linked_resource.permalink)
+ else
+ "/#{Spree::Config[:api_taxon_path]}/#{linked_resource.permalink}"
+ end
+ when 'Spree::Product'
+ self.path = if frontend_available?
+ Spree::Core::Engine.routes.url_helpers.product_path(linked_resource)
+ else
+ "/#{Spree::Config[:api_product_path]}/#{linked_resource.slug}"
+ end
+ end
+ end
+ end
+
+ def check_for_image
+ self.uses_attached_image = if image_asset.attached?
+ true
+ else
+ false
+ end
+ end
+
def reset_link_attributes
if linked_resource_type_changed?
self.linked_resource_id = nil
self.url = nil
+ self.path = nil
+ self.new_window = false
end
end
+
+ def frontend_available?
+ Spree::Core::Engine.frontend_available?
+ end
end
end
diff --git a/core/app/models/spree/product.rb b/core/app/models/spree/product.rb
index 0f6894d827..55103f25aa 100644
--- a/core/app/models/spree/product.rb
+++ b/core/app/models/spree/product.rb
@@ -96,6 +96,8 @@ module Spree
after_save :reset_memoized_data
after_commit :reset_memoized_data
+ around_update :sync_menu_item_paths
+
before_validation :normalize_slug, on: :update
before_validation :validate_master
@@ -325,6 +327,17 @@ module Spree
private
+ def sync_menu_item_paths
+ old_slug = slug_before_last_save
+ slug_updated = true if slug_changed?
+
+ yield
+
+ if slug_updated
+ Spree::MenuItem.refresh_paths(self, old_slug)
+ end
+ end
+
def add_associations_from_prototype
if prototype_id && prototype = Spree::Prototype.find_by(id: prototype_id)
prototype.properties.each do |property|
diff --git a/core/app/models/spree/taxon.rb b/core/app/models/spree/taxon.rb
index 9898ed2c25..eab47f9328 100644
--- a/core/app/models/spree/taxon.rb
+++ b/core/app/models/spree/taxon.rb
@@ -35,6 +35,8 @@ module Spree
after_save :touch_ancestors_and_taxonomy
after_touch :touch_ancestors_and_taxonomy
+ around_update :sync_menu_item_paths
+
has_one :icon, as: :viewable, dependent: :destroy, class_name: 'Spree::TaxonImage'
self.whitelisted_ransackable_associations = %w[taxonomy]
@@ -94,6 +96,17 @@ module Spree
private
+ def sync_menu_item_paths
+ old_permalink = permalink_before_last_save
+ permalink_updated = true if permalink_changed?
+
+ yield
+
+ if permalink_updated
+ Spree::MenuItem.refresh_paths(self, old_permalink)
+ end
+ end
+
def touch_ancestors_and_taxonomy
# Touches all ancestors at once to avoid recursive taxonomy touch, and reduce queries.
ancestors.update_all(updated_at: Time.current)
diff --git a/core/db/migrate/20210408092939_create_spree_menu_items.rb b/core/db/migrate/20210408092939_create_spree_menu_items.rb
index 5c3b87221f..0dd2d24b67 100644
--- a/core/db/migrate/20210408092939_create_spree_menu_items.rb
+++ b/core/db/migrate/20210408092939_create_spree_menu_items.rb
@@ -4,7 +4,9 @@ class CreateSpreeMenuItems < ActiveRecord::Migration[6.0]
t.column :name, :string, null: false
t.column :subtitle, :string
t.column :url, :string
+ t.column :path, :string
t.column :new_window, :boolean, default: false
+ t.column :has_attached_image, :boolean, default: false
t.column :item_type, :string
t.column :linked_resource_type, :string, default: 'URL'
t.column :linked_resource_id, :integer
diff --git a/frontend/app/controllers/spree/store_controller.rb b/frontend/app/controllers/spree/store_controller.rb
index 884e8ed9e7..1fca946459 100644
--- a/frontend/app/controllers/spree/store_controller.rb
+++ b/frontend/app/controllers/spree/store_controller.rb
@@ -9,7 +9,6 @@ module Spree
skip_before_action :verify_authenticity_token, only: :ensure_cart, raise: false
before_action :redirect_to_default_locale
- before_action :load_menus
def account_link
render partial: 'spree/shared/link_to_account'
@@ -32,27 +31,11 @@ module Spree
render json: current_order(create_order_if_necessary: true) # force creation of order if doesn't exists
end
- def load_menus
- @menus = Spree::Menu.by_store(current_store)
- end
-
- def find_menu_by_unique_code(code)
- menu = @menus.by_unique_code(code)
-
- return if menu.nil?
-
+ def menu_by_code(code)
+ menu = Spree::Menu.includes(:menu_items).by_store(current_store).by_unique_code(code)
menu[0]
end
- helper_method :find_menu_by_unique_code
-
- def menu_items_for_menu_with_unique_code(code)
- menu = @menus.by_unique_code(code)[0] || nil
-
- return if menu.nil?
-
- menu.menu_items.order(:lft)
- end
- helper_method :menu_items_for_menu_with_unique_code
+ helper_method :menu_by_code
protected
diff --git a/frontend/app/views/spree/shared/_footer.html.erb b/frontend/app/views/spree/shared/_footer.html.erb
index 9d21f012bd..5eed31d771 100644
--- a/frontend/app/views/spree/shared/_footer.html.erb
+++ b/frontend/app/views/spree/shared/_footer.html.erb
@@ -1,5 +1,3 @@
-<% footer_menu_items = menu_items_for_menu_with_unique_code('spree-all-footer') %>
-
<% cache spree_nav_cache_key('footer') do %>
<footer id="footer" class="pt-2 mx-auto border-top footer-spree" data-turbolinks-permanent>
<div class="container">
@@ -51,8 +49,8 @@
</div>
<div class="row d-none d-xl-flex border-top py-5 text-uppercase footer-spree-menu-links">
- <% if footer_menu_items %>
- <% footer_menu_items.each do |root| %>
+ <% if menu_by_code('spree-all-footer').present? %>
+ <% menu_by_code('spree-all-footer').menu_items.each do |root| %>
<% if root.root? %>
<div class="col-3">
<div class="footer-spree-label">
diff --git a/frontend/app/views/spree/shared/_main_nav_bar.html.erb b/frontend/app/views/spree/shared/_main_nav_bar.html.erb
index faed48ba26..842ecdecbf 100644
--- a/frontend/app/views/spree/shared/_main_nav_bar.html.erb
+++ b/frontend/app/views/spree/shared/_main_nav_bar.html.erb
@@ -1,9 +1,10 @@
-<% main_menu_items = menu_items_for_menu_with_unique_code('spree-all-main') %>
+<% category = 'category' %>
+<% promo = 'promo' %>
-<% if main_menu_items %>
+<% if menu_by_code('spree-all-main').present? %>
<div class="h-100" role="navigation" aria-label="<%= Spree.t('nav_bar.desktop') %>">
<ul class="nav h-100 main-nav-bar">
- <% main_menu_items.each do |root| %>
+ <% menu_by_code('spree-all-main').menu_items.each do |root| %>
<% if root.root? %>
<li class="p-0 nav-item main-nav-bar-category">
<% has_dropdown = root.children.present? %>
@@ -18,7 +19,7 @@
<% root.children.each do |child| %>
<!-- Categories -->
- <% if child.code == 'category' && child.item_type == 'Container' %>
+ <% if child.code == category && child.item_type == 'Container' %>
<div class="category-links my-4 mx-2">
<div class="category-links-header text-uppercase">
<%= child.name %>
@@ -36,12 +37,12 @@
<% end %>
<!-- Promos -->
- <% if child.code == 'promo' && child.item_type == 'Container' %>
+ <% if child.code == promo && child.item_type == 'Container' %>
<% if child.children.present? %>
<% child.children.each do |promo_banner| %>
<%= link_to menu_item_link_to(promo_banner), class: "dropdown-item" do %>
<div class="category-image text-center my-4 mx-3">
- <% if promo_banner.image_asset.attached? && promo_banner.image_asset.image? %>
+ <% if promo_banner.uses_attached_image %>
<%= image_tag main_app.url_for(promo_banner.image_asset), title: promo_banner.subtitle %>
<% end %>
<div class="category-box">
diff --git a/frontend/app/views/spree/shared/_mobile_navigation.html.erb b/frontend/app/views/spree/shared/_mobile_navigation.html.erb
index 72cf4791e0..06931bd637 100644
--- a/frontend/app/views/spree/shared/_mobile_navigation.html.erb
+++ b/frontend/app/views/spree/shared/_mobile_navigation.html.erb
@@ -1,6 +1,4 @@
-<% main_menu_items = menu_items_for_menu_with_unique_code('spree-all-main') %>
-
-<% if main_menu_items %>
+<% if menu_by_code('spree-all-main').present? %>
<div class="position-fixed text-uppercase d-xl-none mobile-navigation" role="navigation" aria-label="<%= Spree.t('nav_bar.mobile') %>">
<div class="container d-flex align-items-center justify-content-between header-spree" data-hook>
<button class="m-0 p-0" id="mobile-navigation-back-button" aria-label="<%= Spree.t('nav_bar.go_to_previous_menu') %>">
@@ -20,7 +18,7 @@
</div>
<ul class="list-unstyled position-relative h-100 mobile-navigation-list">
- <% main_menu_items.each do |root| %>
+ <% menu_by_code('spree-all-main').menu_items.each do |root| %>
<% if root.root? %>
<li class="d-flex justify-content-between align-items-center mobile-navigation-list-item">
<%= link_to root.name, menu_item_link_to(root), class: 'w-75' %>