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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Fix automated slug generation for product and taxon
kpokorski4275b03cbcd0
diff --git a/api/spec/requests/spree/api/v2/storefront/products_spec.rb b/api/spec/requests/spree/api/v2/storefront/products_spec.rbindex c2531d86a9..4e51dd9851 100644--- a/api/spec/requests/spree/api/v2/storefront/products_spec.rb+++ b/api/spec/requests/spree/api/v2/storefront/products_spec.rb@@ -996,15 +996,15 @@ describe 'API V2 Storefront Products Spec', type: :request docontext 'with localized_slugs' dolet(:store2) { create(:store, default_locale: 'en', supported_locales: 'en,pl,es') }- let(:product_with_slug) { create(:product, stores: [store2], slug: 'test_slug_en') }- let!(:translation1) { product_with_slug.translations.create(slug: 'test_slug_pl', locale: 'pl') }- let!(:translation2) { product_with_slug.translations.create(slug: 'test_slug_es', locale: 'es') }+ let(:product_with_slug) { create(:product, stores: [store2], slug: 'test-slug-en') }+ let!(:translation1) { product_with_slug.translations.create(slug: 'test-slug-pl', locale: 'pl') }+ let!(:translation2) { product_with_slug.translations.create(slug: 'test-slug-es', locale: 'es') }let(:expected_result) do{- en: 'test_slug_en',- pl: 'test_slug_pl',- es: 'test_slug_es'+ en: 'test-slug-en',+ pl: 'test-slug-pl',+ es: 'test-slug-es'}end@@ -1021,7 +1021,7 @@ describe 'API V2 Storefront Products Spec', type: :request docontext 'with slug fallback to default locale' dolet(:store2) { create(:store, default_locale: 'en', supported_locales: 'en,pl,es') }let!(:product_with_slug) { create(:product, stores: [store2], slug: default_locale_slug) }- let(:default_locale_slug) { 'test_slug_en' }+ let(:default_locale_slug) { 'test-slug-en' }before doallow_any_instance_of(Spree::Api::V2::Storefront::ProductsController).to receive(:current_store).and_return(store2)@@ -1037,8 +1037,8 @@ describe 'API V2 Storefront Products Spec', type: :request dolet(:store2) { create(:store, default_locale: 'en', supported_locales: 'en,pl,es') }let(:product_with_slug) { create(:product, stores: [store2], slug: default_locale_slug) }let!(:translation2) { product_with_slug.translations.create(slug: translated_slug, locale: 'es') }- let(:default_locale_slug) { 'test_slug_en' }- let(:translated_slug) { 'test_slug_es' }+ let(:default_locale_slug) { 'test-slug-en' }+ let(:translated_slug) { 'test-slug-es' }before doallow_any_instance_of(Spree::Api::V2::Storefront::ProductsController).to receive(:current_store).and_return(store2)diff --git a/api/spec/requests/spree/api/v2/storefront/taxons_spec.rb b/api/spec/requests/spree/api/v2/storefront/taxons_spec.rbindex 2281e184c6..ed2e618292 100644--- a/api/spec/requests/spree/api/v2/storefront/taxons_spec.rb+++ b/api/spec/requests/spree/api/v2/storefront/taxons_spec.rb@@ -226,9 +226,9 @@ describe 'Taxons Spec', type: :request dolet(:expected_slugs) do{- en: 'categories/test_slug_en',- pl: 'categories/test_slug_pl',- es: 'categories/test_slug_es'+ en: 'categories/test-slug-en',+ pl: 'categories/test-slug-pl',+ es: 'categories/test-slug-es'}end@@ -246,7 +246,7 @@ describe 'Taxons Spec', type: :request dolet(:store2) { create(:store, default_locale: 'en', supported_locales: 'en,pl,es') }let(:taxonomy) { create(:taxonomy, name: 'categories', store: store2) }let!(:taxon_with_slug) { create(:taxon, taxonomy: taxonomy, name: 'test slug en', permalink: default_locale_slug) }- let(:default_locale_slug) { 'test_slug_en' }+ let(:default_locale_slug) { 'test-slug-en' }before doallow_any_instance_of(Spree::Api::V2::Storefront::TaxonsController).to receive(:current_store).and_return(store2)@@ -264,7 +264,7 @@ describe 'Taxons Spec', type: :request dolet!(:taxon_with_slug) { create(:taxon, taxonomy: taxonomy, permalink: default_locale_slug) }let!(:translations) { taxon_with_slug.translations.create([ { name: 'test slug en', permalink: translated_slug, locale: 'es' } ]) }let(:default_locale_slug) { 'test_slug_en' }- let(:translated_slug) { 'test_slug_es' }+ let(:translated_slug) { 'test-slug-es' }before doallow_any_instance_of(Spree::Api::V2::Storefront::TaxonsController).to receive(:current_store).and_return(store2)diff --git a/core/app/models/spree/product.rb b/core/app/models/spree/product.rbindex 9fa421806e..2042c0b612 100644--- a/core/app/models/spree/product.rb+++ b/core/app/models/spree/product.rb@@ -42,9 +42,25 @@ module Spreetranslates(*TRANSLATABLE_FIELDS)self::Translation.class_eval do+ before_save :set_slugacts_as_paranoid# deleted translation values also need to be accessible for index views listing deleted resourcesdefault_scope { unscope(where: :deleted_at) }+ def set_slug+ self.slug = generate_slug+ end++ private++ def generate_slug+ if name.blank? && slug.blank?+ translated_model.name.to_url+ elsif slug.blank?+ name.to_url+ else+ slug.to_url+ end+ endendfriendly_id :slug_candidates, use: [:history, :mobility]diff --git a/core/app/models/spree/taxon.rb b/core/app/models/spree/taxon.rbindex 4b51433c4d..f8a91bd8c1 100644--- a/core/app/models/spree/taxon.rb+++ b/core/app/models/spree/taxon.rb@@ -62,19 +62,40 @@ module Spreeself::Translation.class_eval doalias_attribute :slug, :permalink-- before_create :set_permalink+ before_save :set_permalinkdef set_permalink- parent = translated_model.parent- name_with_fallback = name || translated_model.name+ self.permalink = generate_slug+ end++ private+ def generate_slugif parent.present?- self.permalink = [parent.permalink, (permalink.blank? ? name_with_fallback.to_url : permalink.split('/').last)].join('/')+ generate_permalink_including_parent+ elsif permalink.blank?+ name_with_fallback.to_urlelse- self.permalink = name_with_fallback.to_url if permalink.blank?+ permalink.to_urlendend++ def generate_permalink_including_parent+ [parent_permalink_with_fallback, (permalink.blank? ? name_with_fallback.to_url : permalink.split('/').last.to_url)].join('/')+ end++ def name_with_fallback+ name.blank? ? translated_model.name : name+ end++ def parent+ translated_model.parent+ end++ def parent_permalink_with_fallback+ localized_parent = parent.translations.find_by(locale: locale)+ localized_parent.present? ? localized_parent.permalink : parent.permalink+ endend# indicate which filters should be used for a taxondiff --git a/core/lib/spree/core/product_duplicator.rb b/core/lib/spree/core/product_duplicator.rbindex 91b308c58a..e24c2695b4 100644--- a/core/lib/spree/core/product_duplicator.rb+++ b/core/lib/spree/core/product_duplicator.rb@@ -26,7 +26,10 @@ module Spreedef duplicate_productproduct.dup.tap do |new_product|- product.translations.each { |t| new_product.send(:name=, "COPY OF #{t.name}", locale: t.locale) }+ new_product.translations.each do |t|+ t.name = "COPY OF #{t.name}"+ t.slug = nil+ endnew_product.taxons = product.taxonsnew_product.stores = product.storesnew_product.created_at = nildiff --git a/core/spec/models/spree/product_spec.rb b/core/spec/models/spree/product_spec.rbindex 6f3b559f09..c09c772a81 100644--- a/core/spec/models/spree/product_spec.rb+++ b/core/spec/models/spree/product_spec.rb@@ -254,14 +254,14 @@ describe Spree::Product, type: :model docontext 'when more than one translation exists' dobefore {- product.send(:slug=, "french_slug", locale: :fr)+ product.send(:slug=, "french-slug", locale: :fr)product.save!}it 'renames slug for all translations' doproduct.destroyexpect(product.translations.with_deleted.where(locale: :en).first.slug).to match(/[0-9]+_product-[0-9]+/)- expect(product.translations.with_deleted.where(locale: :fr).first.slug).to match(/[0-9]+_french_slug/)+ expect(product.translations.with_deleted.where(locale: :fr).first.slug).to match(/[0-9]+_french-slug/)endend@@ -921,7 +921,7 @@ describe Spree::Product, type: :model dodescribe '#localized_slugs_for_store' dolet(:store) { create(:store, default_locale: 'fr', supported_locales: 'en,pl,fr') }- let(:product) { create(:product, stores: [store], slug: 'test_slug_en') }+ let(:product) { create(:product, stores: [store], name: 'Test product', slug: 'test_slug_en') }let!(:product_translation_fr) { product.translations.create(slug: 'test_slug_fr', locale: 'fr') }before { Spree::Locales::SetFallbackLocaleForStore.new.call(store: store) }@@ -934,9 +934,9 @@ describe Spree::Product, type: :model dolet(:expected_slugs) do{- 'en' => 'test_slug_en',- 'fr' => 'test_slug_fr',- 'pl' => 'test_slug_pl'+ 'en' => 'test-slug-en',+ 'fr' => 'test-slug-fr',+ 'pl' => 'test-slug-pl'}end@@ -948,9 +948,9 @@ describe Spree::Product, type: :model docontext 'when one of the supported locales does not have a translation' dolet(:expected_slugs) do{- 'en' => 'test_slug_en',- 'fr' => 'test_slug_fr',- 'pl' => 'test_slug_fr'+ 'en' => 'test-slug-en',+ 'fr' => 'test-slug-fr',+ 'pl' => 'test-slug-fr'}end@@ -958,5 +958,59 @@ describe Spree::Product, type: :model doexpect(subject).to match(expected_slugs)endend++ context 'the slugs are generated from name when slug field is empty' do+ before do+ product_translation_fr.update(slug: nil, name: "slug from name")+ end++ let(:expected_slugs) do+ {+ 'en' => 'test-slug-en',+ 'fr' => 'slug-from-name',+ 'pl' => 'slug-from-name'+ }+ end++ it "saves slugs generated from name" do+ expect(subject).to match(expected_slugs)+ end+ end++ context 'the slugs are generated from default locale name when name and slug for translation is empty' do+ before do+ product_translation_fr.update(slug: nil, name: nil)+ end++ let(:expected_slugs) do+ {+ 'en' => 'test-slug-en',+ 'fr' => 'test-product',+ 'pl' => 'test-product'+ }+ end++ it 'saves slugs generated from fallback name' do+ expect(subject).to match(expected_slugs)+ end+ end++ context 'the slugs are generated from invalid slug format' do+ before do+ product_translation_fr.update(slug: "slug with_spaces")+ end++ let(:expected_slugs) do+ {+ 'en' => 'test-slug-en',+ 'fr' => 'slug-with-spaces',+ 'pl' => 'slug-with-spaces'+ }+ end++ it 'saves slugs in valid format' do+ expect(subject).to match(expected_slugs)+ end+ endendenddiff --git a/core/spec/models/spree/taxon_spec.rb b/core/spec/models/spree/taxon_spec.rbindex c921ccc389..e3ef36edd9 100644--- a/core/spec/models/spree/taxon_spec.rb+++ b/core/spec/models/spree/taxon_spec.rb@@ -188,6 +188,7 @@ describe Spree::Taxon, type: :model dolet(:taxonomy) { create(:taxonomy, name: 'categories', store: store) }let(:taxon) { create(:taxon, taxonomy: taxonomy, permalink: 'test_slug_en') }let!(:taxon_translation_fr) { taxon.translations.create(slug: 'test_slug_fr', locale: 'fr') }+ let!(:root_taxon) { taxonomy.taxons.find_by(parent_id: nil) }before { Spree::Locales::SetFallbackLocaleForStore.new.call(store: store) }@@ -199,9 +200,9 @@ describe Spree::Taxon, type: :model dolet(:expected_slugs) do{- 'en' => 'categories/test_slug_en',- 'fr' => 'categories/test_slug_fr',- 'pl' => 'categories/test_slug_pl'+ 'en' => 'categories/test-slug-en',+ 'fr' => 'categories/test-slug-fr',+ 'pl' => 'categories/test-slug-pl'}end@@ -213,9 +214,9 @@ describe Spree::Taxon, type: :model docontext 'when one of the supported locales does not have a translation' dolet(:expected_slugs) do{- 'en' => 'categories/test_slug_en',- 'fr' => 'categories/test_slug_fr',- 'pl' => 'categories/test_slug_fr'+ 'en' => 'categories/test-slug-en',+ 'fr' => 'categories/test-slug-fr',+ 'pl' => 'categories/test-slug-fr'}end@@ -223,5 +224,38 @@ describe Spree::Taxon, type: :model doexpect(subject).to match(expected_slugs)endend++ context 'when setting the slug translations for taxonomy' do+ let!(:root_taxon_translation_pl) { root_taxon.translations.create(slug: 'slug with space', locale: 'pl') }++ let(:expected_slugs) do+ {+ 'en' => 'categories',+ 'fr' => 'categories',+ 'pl' => 'slug-with-space'+ }+ end++ it "sets the slugs in slug format" do+ expect(root_taxon.localized_slugs_for_store(store)).to match(expected_slugs)+ end+ end++ context 'when setting the slugs in taxon under taxomony with different parent slug' do+ let!(:root_taxon_translation_pl) { root_taxon.translations.create(slug: 'slug with space', locale: 'pl') }+ let!(:taxon_translation_pl) { taxon.translations.create(locale: 'pl') }++ let(:expected_slugs) do+ {+ 'en' => 'categories/test-slug-en',+ 'fr' => 'categories/test-slug-fr',+ 'pl' => "slug-with-space/#{taxon.name.to_url}"+ }+ end++ it "sets the slug in valid format" do+ expect(taxon.localized_slugs_for_store(store)).to match(expected_slugs)+ end+ endendend