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.

Move #ensure_current_store to core based controller helper (#11261)

Matthew Kennedydf153a75e674
diff --git a/api/spec/serializers/spree/api/v2/platform/store_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/store_serializer_spec.rb
index 3367ecf6d6..378825428a 100644
--- a/api/spec/serializers/spree/api/v2/platform/store_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/platform/store_serializer_spec.rb
@@ -3,7 +3,8 @@ require 'spec_helper'
describe Spree::Api::V2::Platform::StoreSerializer do
subject { described_class.new(store) }
- let(:store) { create(:store, menus: [create(:menu), create(:menu, location: 'Footer')]) }
+ let!(:store) { Spree::Store.default }
+ let!(:menus) { [create(:menu, store: store), create(:menu, location: 'Footer', store: store)] }
it { expect(subject.serializable_hash).to be_kind_of(Hash) }
diff --git a/backend/app/controllers/spree/admin/payment_methods_controller.rb b/backend/app/controllers/spree/admin/payment_methods_controller.rb
index bb679ddcb1..038431c3a0 100644
--- a/backend/app/controllers/spree/admin/payment_methods_controller.rb
+++ b/backend/app/controllers/spree/admin/payment_methods_controller.rb
@@ -10,7 +10,7 @@ module Spree
def create
@payment_method = params[:payment_method].delete(:type).constantize.new(payment_method_params)
@object = @payment_method
- ensure_current_store
+ set_current_store
invoke_callbacks(:create, :before)
if @payment_method.save
invoke_callbacks(:create, :after)
@@ -39,7 +39,7 @@ module Spree
end
if @payment_method.update(attributes)
- ensure_current_store
+ set_current_store
invoke_callbacks(:update, :after)
flash[:success] = Spree.t(:successfully_updated, resource: Spree.t(:payment_method))
redirect_to spree.edit_admin_payment_method_path(@payment_method)
diff --git a/backend/app/controllers/spree/admin/products_controller.rb b/backend/app/controllers/spree/admin/products_controller.rb
index d4bbe485c7..09b961ff7e 100644
--- a/backend/app/controllers/spree/admin/products_controller.rb
+++ b/backend/app/controllers/spree/admin/products_controller.rb
@@ -30,7 +30,7 @@ module Spree
end
invoke_callbacks(:update, :before)
if @object.update(permitted_resource_params)
- ensure_current_store
+ set_current_store
invoke_callbacks(:update, :after)
flash[:success] = flash_message_for(@object, :successfully_updated)
respond_with(@object) do |format|
diff --git a/backend/app/controllers/spree/admin/resource_controller.rb b/backend/app/controllers/spree/admin/resource_controller.rb
index da519831f5..1a6a9dddf9 100644
--- a/backend/app/controllers/spree/admin/resource_controller.rb
+++ b/backend/app/controllers/spree/admin/resource_controller.rb
@@ -3,7 +3,8 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
helper_method :new_object_url, :edit_object_url, :object_url, :collection_url
before_action :load_resource, except: :update_positions
- before_action :set_currency, :ensure_current_store, only: [:new, :create]
+ before_action :set_currency, :set_current_store, only: [:new, :create]
+
rescue_from ActiveRecord::RecordNotFound, with: :resource_not_found
respond_to :html
@@ -26,7 +27,7 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
def update
invoke_callbacks(:update, :before)
if @object.update(permitted_resource_params)
- ensure_current_store
+ set_current_store
invoke_callbacks(:update, :after)
respond_with(@object) do |format|
format.html do
@@ -207,21 +208,17 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
collection_url
end
- def set_currency
+ def set_current_store
return if @object.nil?
- @object.currency = current_currency if model_class.method_defined?(:currency=)
- @object.cost_currency = current_currency if model_class.method_defined?(:cost_currency=)
+ ensure_current_store(@object)
end
- def ensure_current_store
+ def set_currency
return if @object.nil?
- if @object.has_attribute?(:store_id)
- @object.store = current_store
- elsif model_class.method_defined?(:stores) && @object.stores.exclude?(current_store)
- @object.stores << current_store
- end
+ @object.currency = current_currency if model_class.method_defined?(:currency=)
+ @object.cost_currency = current_currency if model_class.method_defined?(:cost_currency=)
end
# URL helpers
diff --git a/core/app/models/concerns/spree/single_store_resource.rb b/core/app/models/concerns/spree/single_store_resource.rb
index c1fdeb5955..22da264c77 100644
--- a/core/app/models/concerns/spree/single_store_resource.rb
+++ b/core/app/models/concerns/spree/single_store_resource.rb
@@ -3,7 +3,17 @@ module Spree
extend ActiveSupport::Concern
included do
+ validate :ensure_store_association_is_not_changed
+
scope :for_store, ->(store) { where(store_id: store.id) }
end
+
+ protected
+
+ def ensure_store_association_is_not_changed
+ if store_id_changed? && persisted?
+ errors.add(:store, Spree.t('errors.messages.store_association_can_not_be_changed'))
+ end
+ end
end
end
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index 66b1f9769d..9d45513d29 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -970,6 +970,8 @@ en:
error: error
errors:
messages:
+ store_association_can_not_be_changed: The store association can not be changed
+ store_is_already_set: Store is already set
blank: can't be blank
could_not_create_taxon: Could not create taxon
no_shipping_methods_available: No shipping methods available for selected location, please change your address and try again.
diff --git a/core/lib/spree/core/controller_helpers/store.rb b/core/lib/spree/core/controller_helpers/store.rb
index 08835d264e..f5a2d54321 100644
--- a/core/lib/spree/core/controller_helpers/store.rb
+++ b/core/lib/spree/core/controller_helpers/store.rb
@@ -22,6 +22,20 @@ module Spree
current_store.default_locale
end
+ def ensure_current_store(object)
+ return if object.nil?
+
+ if object.has_attribute?(:store_id)
+ if object.store.present? && object.store != current_store
+ raise Spree.t('errors.messages.store_is_already_set')
+ else
+ object.store = current_store
+ end
+ elsif object.class.method_defined?(:stores) && object.stores.exclude?(current_store)
+ object.stores << current_store
+ end
+ end
+
# Return a Hash of things that influence the prices displayed in your shop.
#
# By default, the only thing that influences prices that is the current order's +tax_zone+
diff --git a/core/spec/lib/spree/core/controller_helpers/store_spec.rb b/core/spec/lib/spree/core/controller_helpers/store_spec.rb
index 3d372896aa..52b2c312e7 100644
--- a/core/spec/lib/spree/core/controller_helpers/store_spec.rb
+++ b/core/spec/lib/spree/core/controller_helpers/store_spec.rb
@@ -45,6 +45,103 @@ describe Spree::Core::ControllerHelpers::Store, type: :controller do
end
end
+ describe '#ensure_current_store' do
+ let!(:store) { create :store, default: true }
+ let!(:store_2) { create :store }
+
+ context 'on an object that accepts multiple stores' do
+ before { allow(controller).to receive(:current_store).and_return(store) }
+
+ context 'when the object has no stores associated' do
+ object = Spree::Product.new
+
+ it 'associates the object with the current_store' do
+ controller.ensure_current_store(object)
+ expect(object.stores).to contain_exactly(store)
+ expect(object.stores).not_to contain_exactly(store_2)
+ end
+ end
+
+ context 'when the object has a store pre assigned' do
+ object = Spree::Product.new
+
+ it 'adds the new store without removing the orgional store' do
+ object.stores << store_2
+ object.save
+
+ controller.ensure_current_store(object)
+ expect(object.stores).to contain_exactly(store, store_2)
+ end
+ end
+
+ context 'when the object has a store and the same store is attempted to be added' do
+ object = Spree::Product.new
+
+ it 'object is not changed' do
+ object.stores << store
+ object.save
+
+ controller.ensure_current_store(object)
+ expect(object.stores).to contain_exactly(store)
+ end
+ end
+ end
+
+ context 'on a object that accepts a single store' do
+ before { allow(controller).to receive(:current_store).and_return(store) }
+
+ context 'when no store is present' do
+ object = Spree::Menu.new
+
+ it 'sets the current_store' do
+ controller.ensure_current_store(object)
+ expect(object.store).to eql(store)
+ expect(object.store).not_to eql(store_2)
+ end
+ end
+
+ context 'when an object already has a store assigned' do
+ object = Spree::Menu.new
+
+ it 'raises an exception' do
+ object.store = store_2
+ object.save
+
+ expect { controller.ensure_current_store(object) }.to raise_error('Store is already set')
+ end
+ end
+
+ context 'when an object already has a store assigned and the same store is re-assigned' do
+ object = Spree::Menu.new
+
+ it 'no exception is raised' do
+ object.store = store
+ object.save
+
+ expect { controller.ensure_current_store(object) }.not_to raise_error
+ end
+ end
+ end
+
+ context 'when an object that does not have store association is passed in' do
+ object = Spree::CmsSection.new
+
+ it 'returns nil' do
+ expect(controller.ensure_current_store(object)).to be_nil
+ end
+ end
+
+ context 'when object is nil' do
+ before { allow(controller).to receive(:current_store).and_return(store) }
+
+ object = nil
+
+ it 'returns nil' do
+ expect(controller.ensure_current_store(object)).to be_nil
+ end
+ end
+ end
+
describe '#current_price_options' do
subject(:current_price_options) { controller.current_price_options }
diff --git a/core/spec/models/spree/concerns/single_store_spec.rb b/core/spec/models/spree/concerns/single_store_spec.rb
new file mode 100644
index 0000000000..97ab5e538f
--- /dev/null
+++ b/core/spec/models/spree/concerns/single_store_spec.rb
@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module Spree
+ describe Spree::SingleStoreResource do
+ let(:store) { Spree::Store.default }
+ let(:store_2) { create :store }
+
+ describe '.ensure_store_association_is_not_changed' do
+ let(:menu) { create :menu }
+ let(:menu_b) { create :menu, location: 'footer' }
+
+ it 'allows creation of a new instance, update the store then save witout triggering validation error' do
+ object = Spree::CmsPage.new(title: 'Got Name', locale: 'de')
+ object.update(store: store)
+
+ expect(object.save!).to be true
+ end
+
+ context 'when an attempt to change the associated store' do
+ it 'raises an ActiveRecord::RecordInvalid' do
+ expect { menu.update!(store: store_2) }.to raise_error(ActiveRecord::RecordInvalid)
+ end
+ end
+
+ context 'when update is made and store is same as existing store' do
+ it 'does not raise an error' do
+ expect { menu.update!(name:'Jones', store: store) }.not_to raise_error
+ end
+ end
+
+ context 'when destroy a an item with store association' do
+ it 'validation does not raise an error' do
+ expect { menu_b.reload }.not_to raise_error
+
+ menu_b.destroy
+
+ expect { menu_b.reload }.to raise_error(ActiveRecord::RecordNotFound)
+ end
+ end
+ end
+ end
+end
diff --git a/core/spec/models/spree/order_spec.rb b/core/spec/models/spree/order_spec.rb
index 1019494440..db9b71d70a 100644
--- a/core/spec/models/spree/order_spec.rb
+++ b/core/spec/models/spree/order_spec.rb
@@ -1094,8 +1094,10 @@ describe Spree::Order, type: :model do
end
describe '#promo_code' do
+ let(:new_order_x) { create(:order) }
+
context 'without promo_code applied' do
- it { expect(order.promo_code).to eq nil }
+ it { expect(new_order_x.promo_code).to eq nil }
end
context 'with_promo_code applied' do
@@ -1103,11 +1105,11 @@ describe Spree::Order, type: :model do
let(:promotion) { create :promotion, code: promo_code }
before do
- promotion.orders << order
+ promotion.orders << new_order_x
end
it 'returns applied promo_code' do
- expect(order.promo_code).to eq promo_code
+ expect(new_order_x.promo_code).to eq promo_code
end
end
end