Add permalink history for taxon on friendly-id

Author: JustShah

.circleci/config.yml

@@ -224,7 +224,7 @@ commands:
             mkdir -p /tmp/dummy_extension
             cd /tmp/dummy_extension
             bundle init
-            bundle add rails -v "< 8.0" --skip-install
+            bundle add rails -v "< 8.1" --skip-install
             bundle add sqlite3 -v "~> 2.0" --skip-install
             test -n "<<parameters.extra_gems>>" && bundle add <<parameters.extra_gems>> --skip-install
             bundle add solidus --path "$(ruby -e"puts File.expand_path ENV['CIRCLE_WORKING_DIRECTORY']")"
@@ -352,7 +352,7 @@ workflows:
             {
               parameters:
                 {
-                  rails: ["7.0", "7.1", "7.2"],
+                  rails: ["7.0", "7.1", "7.2", "8.0"],
                   ruby: ["3.1"],
                   database: ["mysql"],
                   paperclip: [true],
@@ -364,7 +364,7 @@ workflows:
             {
               parameters:
                 {
-                  rails: ["7.0", "7.1", "7.2"],
+                  rails: ["7.0", "7.1", "7.2", "8.0"],
                   ruby: ["3.1"],
                   database: ["postgres"],
                   paperclip: [false],
@@ -388,7 +388,7 @@ workflows:
             {
               parameters:
                 {
-                  rails: ["7.2", "main"],
+                  rails: ["7.2", "8.0", "main"],
                   ruby: ["3.3.5"],
                   database: ["sqlite"],
                   paperclip: [false],

Gemfile

@@ -8,7 +8,7 @@ gemspec require: false
 if /(stable|main)/.match? ENV['RAILS_VERSION']
   gem 'rails', github: 'rails', require: false, branch: ENV['RAILS_VERSION']
 else
-  gem 'rails', ENV['RAILS_VERSION'] || ['> 7.0', '< 8.0.0.beta1'], require: false
+  gem 'rails', ENV['RAILS_VERSION'] || ['> 7.0', '< 8.1.0.beta1'], require: false
 end
 # rubocop:enable Bundler/DuplicatedGem
 

admin/app/components/solidus_admin/ui/forms/input/component.rb

@@ -93,13 +93,24 @@ def call
       with_content options_for_select(@attributes.delete(:choices), @attributes.delete(:value))
     end
 
-    tag.public_send(
-      @tag,
-      content,
+    options = {
       "data-controller": stimulus_id,
       "data-#{stimulus_id}-custom-validity-value": @error.presence,
       "data-action": "#{stimulus_id}#clearCustomValidity",
       **@attributes
-    )
+    }
+
+    if tag.method(@tag).parameters.any? { |_type, name| name == :content }
+      tag.public_send(
+        @tag,
+        content,
+        **options
+      )
+    else
+      tag.public_send(
+        @tag,
+        **options
+      )
+    end
   end
 end

api/spec/requests/spree/api/shipments_spec.rb

@@ -75,7 +75,7 @@ module Spree::Api
           it 'returns proper error' do
             subject
             expect(response.status).to eq(422)
-            expect(json_response['exception']).to eq("param is missing or the value is empty: stock_location_id")
+            expect(json_response['exception']).to match(/param is missing or the value is empty( or invalid)?: stock_location_id/)
           end
         end
       end

api/spec/requests/spree/api/stock_items_spec.rb

@@ -86,7 +86,7 @@ module Spree::Api
 
       it 'requires a stock_location_id to be passed as a parameter' do
         get spree.api_stock_items_path
-        expect(json_response['exception']).to eq('param is missing or the value is empty: stock_location_id')
+        expect(json_response['exception']).to match(/param is missing or the value is empty( or invalid)?: stock_location_id/)
         expect(response.status).to eq(422)
       end
 

core/app/models/spree/taxon.rb

@@ -4,6 +4,9 @@
 
 module Spree
   class Taxon < Spree::Base
+    extend FriendlyId
+    friendly_id :permalink, use: :history, slug_column: :permalink
+
     acts_as_nested_set dependent: :destroy
 
     belongs_to :taxonomy, class_name: 'Spree::Taxonomy', inverse_of: :taxons
@@ -13,8 +16,7 @@ class Taxon < Spree::Base
     has_many :promotion_rule_taxons
     has_many :promotion_rules, through: :promotion_rule_taxons
 
-    before_create :set_permalink
-    before_update :set_permalink
+    before_save :set_permalink
     after_update :update_child_permalinks, if: :saved_change_to_permalink?
 
     validates :name, presence: true
@@ -121,6 +123,24 @@ def permalink_part=(value)
       end
     end
 
+    # override for {FriendlyId::Slugged#should_generate_new_friendly_id?} method,
+    # to control exactly when new friendly ids are set or updated
+    def should_generate_new_friendly_id?
+      permalink_changed? || super
+    end
+
+    # override for {FriendlyId::Slugged#normalize_friendly_id} method,
+    # to control over the slug format
+    def normalize_friendly_id(value)
+      return '' if value.blank?
+
+      parts = value.to_s.split('/')
+      last_word = parts.pop
+      corrected_last_word = Spree::Config.taxon_url_parametizer_class.parameterize(last_word)
+
+      (parts << corrected_last_word).join('/')
+    end
+
     private
 
     def touch_ancestors_and_taxonomy

core/solidus_core.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
     actionmailer actionpack actionview activejob activemodel activerecord
     activestorage activesupport railties
   ].each do |rails_dep|
-    s.add_dependency rails_dep, ['>= 7.0', '< 8.0.0.beta1']
+    s.add_dependency rails_dep, ['>= 7.0', '< 8.1.0.beta1']
   end
 
   s.add_dependency 'activemerchant', '~> 1.66'

core/spec/models/spree/taxon_spec.rb

@@ -269,4 +269,28 @@
       end
     end
   end
+
+  context 'stores history of permalinks' do
+    let(:taxonomy) { create(:taxonomy, name: 'brands') }
+    let(:root) { taxonomy.root }
+    let(:taxon_name) { "ruby on rails" }
+    let(:new_permalink) { "rails for ruby" }
+    let(:expected_initial_slug) { "brands/ruby-on-rails" }
+    let(:expected_updated_slug) { "brands/rails-for-ruby" }
+
+    let!(:taxon) { create(:taxon, name: taxon_name, parent: root) }
+
+    it 'should store the previous slug when permalink is updated' do
+      expect(taxon.slugs.count).to eq(1)
+      expect(expected_initial_slug).to eq(taxon.slugs.last.slug)
+
+      taxon.update(permalink: new_permalink)
+
+      expect(expected_updated_slug).to eq(taxon.permalink)
+      expect(taxon.slugs.count).to eq(2)
+
+      expect(taxon.slugs.pluck(:slug)).to include(expected_initial_slug)
+      expect(taxon.slugs.pluck(:slug)).to include(expected_updated_slug)
+    end
+  end
 end