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 taxons' permalink generation for translations (#12186)

Damian Kaczmarczyk04d2f4102a24
diff --git a/core/app/models/spree/taxon.rb b/core/app/models/spree/taxon.rb
index 726c38aee5..78b017d986 100644
--- a/core/app/models/spree/taxon.rb
+++ b/core/app/models/spree/taxon.rb
@@ -52,6 +52,7 @@ module Spree
after_touch :touch_ancestors_and_taxonomy
after_commit :regenerate_pretty_name_and_permalink, on: :update, if: :should_regenerate_pretty_name_and_permalink?
after_move :regenerate_pretty_name_and_permalink
+ after_move :regenerate_translations_pretty_name_and_permalink
has_one :store, through: :taxonomy
@@ -78,6 +79,7 @@ module Spree
self::Translation.class_eval do
before_save :set_permalink
before_save :set_pretty_name
+ after_save :regenerate_pretty_name_and_permalink, if: :should_regenerate_pretty_name_and_permalink?
def slug
permalink
@@ -92,15 +94,23 @@ module Spree
end
def set_pretty_name
- self[:pretty_name] = generate_pretty_name
+ self.pretty_name = generate_pretty_name
end
def name_with_fallback
- name.blank? ? translated_model.name : name
+ name.blank? ? translated_model[:name] : name
end
def pretty_name_with_fallback
- pretty_name.blank? ? translated_model.pretty_name : pretty_name
+ pretty_name.blank? ? translated_model[:pretty_name] : pretty_name
+ end
+
+ def regenerate_pretty_name_and_permalink
+ Spree::Taxon::Translation.where(spree_taxon_id: translated_model.cached_self_and_descendants_ids).each(&:update_pretty_name_and_permalink)
+ end
+
+ def update_pretty_name_and_permalink
+ update_columns(pretty_name: generate_pretty_name, permalink: generate_slug, updated_at: Time.current)
end
private
@@ -119,7 +129,7 @@ module Spree
if parent.present?
generate_pretty_name_including_parent
elsif pretty_name.blank?
- pretty_name_with_fallback
+ name_with_fallback
else
pretty_name
end
@@ -130,7 +140,7 @@ module Spree
end
def generate_pretty_name_including_parent
- [parent_pretty_name_with_fallback, (pretty_name.blank? ? name_with_fallback : pretty_name)].compact.join(' -> ')
+ [parent_pretty_name_with_fallback, (name.blank? ? name_with_fallback : name)].compact.join(' -> ')
end
def parent
@@ -139,12 +149,16 @@ module Spree
def parent_permalink_with_fallback
localized_parent = parent.translations.find_by(locale: locale)
- localized_parent.present? ? localized_parent.permalink : parent.permalink
+ localized_parent.present? ? localized_parent.permalink : parent[:permalink]
end
def parent_pretty_name_with_fallback
localized_parent = parent.translations.find_by(locale: locale)
- localized_parent.present? ? localized_parent.pretty_name : parent.pretty_name
+ localized_parent.present? ? localized_parent.pretty_name : parent[:pretty_name]
+ end
+
+ def should_regenerate_pretty_name_and_permalink?
+ saved_changes.key?(:name) || saved_changes.key?(:permalink)
end
end
@@ -166,7 +180,7 @@ module Spree
end
def set_pretty_name
- self[:pretty_name] = generate_pretty_name
+ self.pretty_name = generate_pretty_name
end
def generate_pretty_name
@@ -196,15 +210,17 @@ module Spree
end
def regenerate_pretty_name_and_permalink
- set_permalink
- update_columns(pretty_name: generate_pretty_name, updated_at: Time.current)
+ Mobility.with_locale(nil) do
+ update_columns(pretty_name: generate_pretty_name, permalink: generate_slug, updated_at: Time.current)
+ end
children.reload.each(&:regenerate_pretty_name_and_permalink_as_child)
end
def regenerate_pretty_name_and_permalink_as_child
- set_permalink
- update_columns(pretty_name: generate_pretty_name, updated_at: Time.current)
+ Mobility.with_locale(nil) do
+ update_columns(pretty_name: generate_pretty_name, permalink: generate_slug, updated_at: Time.current)
+ end
children.reload.each(&:regenerate_pretty_name_and_permalink_as_child)
end
@@ -261,5 +277,9 @@ module Spree
def copy_taxonomy_from_parent
self.taxonomy = parent.taxonomy if parent.present? && taxonomy.blank?
end
+
+ def regenerate_translations_pretty_name_and_permalink
+ translations.each(&:regenerate_pretty_name_and_permalink)
+ end
end
end
diff --git a/core/spec/models/spree/taxon_spec.rb b/core/spec/models/spree/taxon_spec.rb
index 8541bb7537..1bfa4e8129 100644
--- a/core/spec/models/spree/taxon_spec.rb
+++ b/core/spec/models/spree/taxon_spec.rb
@@ -283,6 +283,116 @@ describe Spree::Taxon, type: :model do
end
end
+ describe '#regenerate_pretty_name_and_permalink' do
+ let!(:taxon) { create(:taxon, name: 'Category#1', taxonomy: taxonomy) }
+
+ it 'regenerates pretty name and permalink' do
+ expect(taxon.pretty_name).to eq("#{taxon.parent.pretty_name} -> #{taxon.name}")
+ expect(taxon.permalink).to eq("#{taxon.parent.permalink}/#{taxon.name.to_url}")
+ end
+
+ context "when parent's permalink is changed" do
+ before do
+ taxon.parent.update!(permalink: 'new-permalink')
+ end
+
+ it 'updates the pretty name and permalink' do
+ expect(taxon.reload.pretty_name).to eq("#{taxon.parent.pretty_name} -> #{taxon.name}")
+ expect(taxon.permalink).to eq("new-permalink/#{taxon.name.to_url}")
+ end
+ end
+
+ context 'when parent name is changed' do
+ before do
+ taxon.parent.update!(name: 'New Parent')
+ end
+
+ it 'updates the pretty name and permalink' do
+ expect(taxon.reload.pretty_name).to eq("New Parent -> #{taxon.name}")
+ expect(taxon.permalink).to eq("#{taxon.parent.permalink}/#{taxon.name.to_url}")
+ end
+ end
+
+ context 'with translations' do
+ before do
+ Mobility.with_locale(:pl) do
+ taxon.update!(name: 'Kategoria#1')
+ taxon.reload
+
+ taxon.parent.update!(name: 'Kategoria')
+ end
+ end
+
+ it 'updates the pretty name and permalink for translations as well' do
+ Mobility.with_locale(:pl) do
+ expect(taxon.reload.pretty_name).to eq('Kategoria -> Kategoria#1')
+ expect(taxon.permalink).to eq('kategoria/kategoria-number-1')
+ end
+ end
+ end
+
+ context 'when taxon is moved' do
+ let(:parent2) { create(:taxon, name: 'Parent2', permalink: 'parent2', taxonomy: taxonomy) }
+ let(:taxon2) { create(:taxon, name: 'Child', parent: parent2, permalink: 'child', taxonomy: taxonomy) }
+
+ before do
+ taxon.parent.update!(name: 'Grandparent', permalink: 'grandparent')
+ taxon.update!(name: 'Parent', permalink: 'parent')
+
+ parent2
+ taxon2
+
+ Mobility.with_locale(:pl) do
+ taxon.parent.update!(name: 'Dziadek', permalink: 'dziadek')
+ taxon.update!(name: 'Rodzic')
+
+ parent2.update!(name: 'Rodzic2', permalink: 'rodzic2')
+ taxon2.update!(name: 'Dziecko')
+ end
+
+ expect(taxon.permalink).to eq('grandparent/parent')
+ expect(taxon.pretty_name).to eq('Grandparent -> Parent')
+
+ expect(taxon2.permalink).to eq('grandparent/parent2/child')
+ expect(taxon2.pretty_name).to eq('Grandparent -> Parent2 -> Child')
+
+ Mobility.with_locale(:pl) do
+ expect(taxon.reload.pretty_name).to eq('Dziadek -> Rodzic')
+ expect(taxon.permalink).to eq('dziadek/rodzic')
+
+ expect(taxon2.pretty_name).to eq('Dziadek -> Rodzic2 -> Dziecko')
+ expect(taxon2.permalink).to eq('dziadek/rodzic2/dziecko')
+ end
+ end
+
+ it 'updates the pretty name and permalink' do
+ taxon2.move_to_child_with_index(taxon, 0)
+
+ expect(taxon2.reload.pretty_name).to eq('Grandparent -> Parent -> Child')
+ expect(taxon2.permalink).to eq('grandparent/parent/child')
+
+ Mobility.with_locale(:pl) do
+ expect(taxon2.reload.pretty_name).to eq('Dziadek -> Rodzic -> Dziecko')
+ expect(taxon2.permalink).to eq('dziadek/rodzic/dziecko')
+ end
+ end
+
+ it 'updates the pretty name and permalink when move is done inside different locales' do
+ Mobility.with_locale(:pl) do
+ taxon2.move_to_child_with_index(taxon, 0)
+ end
+
+ expect(taxon2.permalink).to eq('grandparent/parent/child')
+ expect(taxon2.reload.pretty_name).to eq('Grandparent -> Parent -> Child')
+
+ Mobility.with_locale(:pl) do
+ expect(taxon2.reload.pretty_name).to eq('Dziadek -> Rodzic -> Dziecko')
+ expect(taxon2.permalink).to eq('dziadek/rodzic/dziecko')
+ end
+ end
+ end
+ end
+
describe '#pretty_name' do
let!(:taxon) { create(:taxon, name: 'Category#1', taxonomy: taxonomy) }