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.

Fix menu_item polymorphic association for rails 7

Matthew Kennedye708e89955bc
diff --git a/core/app/models/concerns/spree/display_link.rb b/core/app/models/concerns/spree/display_link.rb
index 13cbca56ea..838906e9d8 100644
--- a/core/app/models/concerns/spree/display_link.rb
+++ b/core/app/models/concerns/spree/display_link.rb
@@ -1,42 +1,30 @@
module Spree
module DisplayLink
- def link
- case linked_resource_type
- when 'Spree::Taxon'
- return if linked_resource&.permalink.blank?
+ extend ActiveSupport::Concern
+
+ included do
+ belongs_to :linked_resource, polymorphic: true
+
+ def link
+ case linked_resource_type
+ when 'Spree::Taxon'
+ return if linked_resource&.permalink.blank?
- if spree_routes.method_defined?(:nested_taxons_path)
- spree_routes.nested_taxons_path(linked_resource.permalink)
- else
"/#{Spree::Config[:storefront_taxons_path]}/#{linked_resource.permalink}"
- end
- when 'Spree::Product'
- return if linked_resource&.slug.blank?
+ when 'Spree::Product'
+ return if linked_resource&.slug.blank?
- if spree_routes.method_defined?(:products_path)
- spree_routes.product_path(linked_resource)
- else
"/#{Spree::Config[:storefront_products_path]}/#{linked_resource.slug}"
- end
- when 'Spree::CmsPage'
- return if linked_resource&.slug.blank?
+ when 'Spree::CmsPage'
+ return if linked_resource&.slug.blank?
- if spree_routes.method_defined?(:page_path)
- spree_routes.page_path(linked_resource.slug)
- else
"/#{Spree::Config[:storefront_pages_path]}/#{linked_resource.slug}"
+ when 'Spree::Linkable::Homepage'
+ '/'
+ when 'Spree::Linkable::Uri'
+ destination
end
- when 'Home Page'
- '/'
- when 'URL'
- destination
end
end
-
- private
-
- def spree_routes
- Spree::Core::Engine.routes.url_helpers
- end
end
end
diff --git a/core/app/models/spree/cms_section.rb b/core/app/models/spree/cms_section.rb
index 3f75332f35..bb858a2306 100644
--- a/core/app/models/spree/cms_section.rb
+++ b/core/app/models/spree/cms_section.rb
@@ -23,8 +23,6 @@ module Spree
end
end
- belongs_to :linked_resource, polymorphic: true
-
default_scope { order(position: :asc) }
validates :name, :cms_page, :type, presence: true
diff --git a/core/app/models/spree/linkable/homepage.rb b/core/app/models/spree/linkable/homepage.rb
new file mode 100644
index 0000000000..3124ed0485
--- /dev/null
+++ b/core/app/models/spree/linkable/homepage.rb
@@ -0,0 +1,3 @@
+module Spree::Linkable::Homepage
+ # Placeholder for polymorphic lookup.
+end
diff --git a/core/app/models/spree/linkable/uri.rb b/core/app/models/spree/linkable/uri.rb
new file mode 100644
index 0000000000..a6b0990b18
--- /dev/null
+++ b/core/app/models/spree/linkable/uri.rb
@@ -0,0 +1,3 @@
+module Spree::Linkable::Uri
+ # Placeholder for polymorphic lookup.
+end
diff --git a/core/app/models/spree/menu_item.rb b/core/app/models/spree/menu_item.rb
index c42f1db850..3bb2d79d9a 100644
--- a/core/app/models/spree/menu_item.rb
+++ b/core/app/models/spree/menu_item.rb
@@ -4,8 +4,10 @@ module Spree
acts_as_nested_set dependent: :destroy
+ ITEM_TYPE = %w[Link Container]
+ LINKED_RESOURCE_TYPE = ['Spree::Linkable::Uri', 'Spree::Linkable::Homepage', 'Spree::Product', 'Spree::Taxon', 'Spree::CmsPage']
+
belongs_to :menu, touch: true
- belongs_to :linked_resource, polymorphic: true
before_create :ensure_item_belongs_to_root
before_update :reset_link_attributes
@@ -14,15 +16,6 @@ module Spree
after_save :touch_ancestors_and_menu
after_touch :touch_ancestors_and_menu
- ITEM_TYPE = %w[Link Container]
-
- LINKED_RESOURCE_TYPE = ['URL']
- STATIC_RESOURCE_TYPE = ['Home Page']
- DYNAMIC_RESOURCE_TYPE = ['Spree::Product', 'Spree::Taxon', 'Spree::CmsPage']
-
- LINKED_RESOURCE_TYPE.unshift(*STATIC_RESOURCE_TYPE)
- LINKED_RESOURCE_TYPE.push(*DYNAMIC_RESOURCE_TYPE)
-
validates :name, :menu, presence: true
validates :item_type, inclusion: { in: ITEM_TYPE }
validates :linked_resource_type, inclusion: { in: LINKED_RESOURCE_TYPE }
@@ -50,7 +43,7 @@ module Spree
self.destination = nil
self.new_window = false
- self.linked_resource_type = 'URL' if item_type == 'Container'
+ self.linked_resource_type = 'Spree::Linkable::Uri' if item_type == 'Container'
end
end
diff --git a/core/db/migrate/20211201202851_update_linkable_resource_types.rb b/core/db/migrate/20211201202851_update_linkable_resource_types.rb
new file mode 100644
index 0000000000..ab15ab8c1b
--- /dev/null
+++ b/core/db/migrate/20211201202851_update_linkable_resource_types.rb
@@ -0,0 +1,10 @@
+class UpdateLinkableResourceTypes < ActiveRecord::Migration[5.2]
+ def change
+ change_column_default :spree_menu_items, :linked_resource_type, 'Spree::Linkable::Uri'
+
+ Spree::MenuItem.where(linked_resource_type: 'URL').update_all(linked_resource_type: 'Spree::Linkable::Uri')
+ Spree::CmsSection.where(linked_resource_type: 'URL').update_all(linked_resource_type: 'Spree::Linkable::Uri')
+ Spree::MenuItem.where(linked_resource_type: 'Home Page').update_all(linked_resource_type: 'Spree::Linkable::Homepage')
+ Spree::CmsSection.where(linked_resource_type: 'Home Page').update_all(linked_resource_type: 'Spree::Linkable::Homepage')
+ end
+end
diff --git a/core/lib/spree/testing_support/factories/menu_item_factory.rb b/core/lib/spree/testing_support/factories/menu_item_factory.rb
index 9171412422..c1297766fa 100644
--- a/core/lib/spree/testing_support/factories/menu_item_factory.rb
+++ b/core/lib/spree/testing_support/factories/menu_item_factory.rb
@@ -2,7 +2,7 @@ FactoryBot.define do
factory :menu_item, class: Spree::MenuItem do
sequence(:name) { |n| "Link no. #{n} To Somewhere" }
item_type { 'Link' }
- linked_resource_type { 'URL' }
+ linked_resource_type { 'Spree::Linkable::Uri' }
menu
icon
diff --git a/core/spec/models/spree/menu_item_spec.rb b/core/spec/models/spree/menu_item_spec.rb
index d502d7e8fa..a4365f71c3 100644
--- a/core/spec/models/spree/menu_item_spec.rb
+++ b/core/spec/models/spree/menu_item_spec.rb
@@ -74,14 +74,14 @@ describe Spree::MenuItem, type: :model do
end
end
- describe '#reset_link_attributes from URL to Home Page' do
+ describe '#reset_link_attributes from URL to Homepage' do
let(:i_b) do
create(:menu_item, name: 'Home', item_type: 'Link', menu: menu,
- parent: menu.root, linked_resource_type: 'URL', destination: 'http://somewhere.com', new_window: true, linked_resource_id: 5)
+ parent: menu.root, linked_resource_type: 'Spree::Linkable::Uri', destination: 'http://somewhere.com', new_window: true, linked_resource_id: 5)
end
before do
- i_b.update!(linked_resource_type: 'Home Page')
+ i_b.update!(linked_resource_type: 'Spree::Linkable::Homepage')
end
it 'sets destination to /' do
@@ -92,7 +92,7 @@ describe Spree::MenuItem, type: :model do
describe '#reset_link_attributes from Link to Container' do
let(:i_c) do
create(:menu_item, name: 'Home', item_type: 'Link', menu: menu,
- parent: menu.root, linked_resource_type: 'URL', destination: 'http://somewhere.com', new_window: true, linked_resource_id: 5)
+ parent: menu.root, linked_resource_type: 'Spree::Linkable::Uri', destination: 'http://somewhere.com', new_window: true, linked_resource_id: 5)
end
before do
@@ -110,9 +110,9 @@ describe Spree::MenuItem, type: :model do
let(:cms_page) { create(:cms_standard_page) }
let(:cms_page_with_no_slug) { create(:cms_homepage) }
- let(:item_url) { create(:menu_item, name: 'URL To Random Site', item_type: 'Link', menu: menu, linked_resource_type: 'URL', destination: 'https://some-other-website.com') }
- let(:item_empty_url) { create(:menu_item, name: 'URL To Random Site', item_type: 'Link', menu: menu, linked_resource_type: 'URL', destination: nil) }
- let(:item_home) { create(:menu_item, name: 'Home', item_type: 'Link', menu: menu, linked_resource_type: 'Home Page') }
+ let(:item_url) { create(:menu_item, name: 'URL To Random Site', item_type: 'Link', menu: menu, linked_resource_type: 'Spree::Linkable::Uri', destination: 'https://some-other-website.com') }
+ let(:item_empty_url) { create(:menu_item, name: 'URL To Random Site', item_type: 'Link', menu: menu, linked_resource_type: 'Spree::Linkable::Uri', destination: nil) }
+ let(:item_home) { create(:menu_item, name: 'Home', item_type: 'Link', menu: menu, linked_resource_type: 'Spree::Linkable::Homepage') }
let(:item_product) { create(:menu_item, name: product.name, item_type: 'Link', menu: menu, linked_resource_type: 'Spree::Product') }
let(:item_taxon) { create(:menu_item, name: taxon.name, item_type: 'Link', menu: menu, linked_resource_type: 'Spree::Taxon') }
let(:item_cms_page) { create(:menu_item, name: cms_page.title, item_type: 'Link', menu: menu, linked_resource_type: 'Spree::CmsPage') }
@@ -170,7 +170,7 @@ describe Spree::MenuItem, type: :model do
end
describe '#paremeterize_code' do
- let(:item) { create(:menu_item, name: 'URL', item_type: 'Link', menu: menu, parent: menu.root, linked_resource_type: 'URL', code: 'My Fantastic Code') }
+ let(:item) { create(:menu_item, name: 'URL', item_type: 'Link', menu: menu, parent: menu.root, linked_resource_type: 'Spree::Linkable::Uri', code: 'My Fantastic Code') }
it 'paramatizes a code when one is given' do
expect(item.code).to eql 'my-fantastic-code'
@@ -178,7 +178,7 @@ describe Spree::MenuItem, type: :model do
end
describe '#ensure_item_belongs_to_root' do
- let(:item_x) { create(:menu_item, name: 'URL', item_type: 'Link', menu: menu, linked_resource_type: 'URL', code: 'My Fantastic Code') }
+ let(:item_x) { create(:menu_item, name: 'URL', item_type: 'Link', menu: menu, linked_resource_type: 'Spree::Linkable::Uri', code: 'My Fantastic Code') }
it 'Sets new items parent_id to root.id' do
expect(item_x.parent_id).to eql menu.root.id