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.

Add helper methods for tracking preference changes (#12772)

Łukasz Adamczyk5558a268b11c
diff --git a/core/lib/spree/core/preferences/preferable.rb b/core/lib/spree/core/preferences/preferable.rb
index 35b93922b4..3c1d19a90c 100644
--- a/core/lib/spree/core/preferences/preferable.rb
+++ b/core/lib/spree/core/preferences/preferable.rb
@@ -108,6 +108,16 @@ module Spree::Preferences::Preferable
preference_keys.each { |pref| preferences[pref] = preference_default(pref) }
end
+ def preference_change(name, changes_or_previous_changes)
+ preference_changes = changes_or_previous_changes.with_indifferent_access.fetch('preferences', [{}, {}])
+ before_preferences = preference_changes[0] || {}
+ after_preferences = preference_changes[1] || {}
+
+ return if before_preferences[name] == after_preferences[name]
+
+ [before_preferences[name], after_preferences[name]]
+ end
+
private
def convert_preference_value(value, type, nullable: false)
diff --git a/core/lib/spree/core/preferences/preferable_class_methods.rb b/core/lib/spree/core/preferences/preferable_class_methods.rb
index 601dcb3503..e453b1ab39 100644
--- a/core/lib/spree/core/preferences/preferable_class_methods.rb
+++ b/core/lib/spree/core/preferences/preferable_class_methods.rb
@@ -43,6 +43,34 @@ module Spree::Preferences
define_method prefers_query_method(name) do
preferences.fetch(name).to_b
end
+
+ define_method preference_change_method(name) do
+ preference_change(name, changes) if respond_to?(:changes)
+ end
+
+ define_method preference_was_method(name) do
+ return unless respond_to?(:changes)
+
+ preference_change(name, changes)&.first || get_preference(name)
+ end
+
+ define_method preference_changed_method(name) do
+ respond_to?(:changes) && preference_change(name, changes).present?
+ end
+
+ define_method preference_previous_change_method(name) do
+ preference_change(name, previous_changes) if respond_to?(:previous_changes)
+ end
+
+ define_method preference_previous_was_method(name) do
+ return unless respond_to?(:previous_changes)
+
+ preference_change(name, previous_changes)&.first
+ end
+
+ define_method preference_previous_changed_method(name) do
+ respond_to?(:previous_changes) && preference_change(name, previous_changes).present?
+ end
end
def preference_getter_method(name)
@@ -68,5 +96,29 @@ module Spree::Preferences
def prefers_query_method(name)
"prefers_#{name}?".to_sym
end
+
+ def preference_change_method(name)
+ "preferred_#{name}_change".to_sym
+ end
+
+ def preference_was_method(name)
+ "preferred_#{name}_was".to_sym
+ end
+
+ def preference_changed_method(name)
+ "preferred_#{name}_changed?".to_sym
+ end
+
+ def preference_previous_change_method(name)
+ "preferred_#{name}_previous_change".to_sym
+ end
+
+ def preference_previous_was_method(name)
+ "preferred_#{name}_previously_was".to_sym
+ end
+
+ def preference_previous_changed_method(name)
+ "preferred_#{name}_previously_changed?".to_sym
+ end
end
end
diff --git a/core/spec/models/spree/preferences/preferable_spec.rb b/core/spec/models/spree/preferences/preferable_spec.rb
index 38ab599a5c..6d2a3e4d9f 100644
--- a/core/spec/models/spree/preferences/preferable_spec.rb
+++ b/core/spec/models/spree/preferences/preferable_spec.rb
@@ -344,5 +344,36 @@ describe Spree::Preferences::Preferable, type: :model do
@pt1.save!
expect(@pt1.get_preference(:pref_test_pref)).to eq('abc')
end
+
+ describe 'preference change tracking methods' do
+ it 'tracks changes to preferences' do
+ @pt.preferred_pref_test_pref = 'xyz'
+ expect(@pt.preferred_pref_test_pref_changed?).to be true
+ expect(@pt.preferred_pref_test_pref_change).to eq(['abc', 'xyz'])
+ expect(@pt.preferred_pref_test_pref_was).to eq('abc')
+ end
+
+ it 'tracks previous changes after save' do
+ @pt.preferred_pref_test_pref = 'xyz'
+ @pt.save!
+
+ expect(@pt.preferred_pref_test_pref_previously_changed?).to be true
+ expect(@pt.preferred_pref_test_pref_previous_change).to eq(['abc', 'xyz'])
+ expect(@pt.preferred_pref_test_pref_previously_was).to eq('abc')
+ end
+
+ it 'reports no changes when preference is set to same value' do
+ @pt.preferred_pref_test_pref = 'abc'
+ expect(@pt.preferred_pref_test_pref_changed?).to be false
+ expect(@pt.preferred_pref_test_pref_change).to be_nil
+ end
+
+ it 'tracks changes to array preferences' do
+ @pt.preferred_pref_test_any = [1, 2, 3]
+ expect(@pt.preferred_pref_test_any_changed?).to be true
+ expect(@pt.preferred_pref_test_any_change).to eq([[], [1, 2, 3]])
+ expect(@pt.preferred_pref_test_any_was).to eq([])
+ end
+ end
end
end