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 Store to StoreCredit association

Szymon Iwacz3c21a4cd22e1
diff --git a/api/spec/requests/spree/api/v2/storefront/checkout_spec.rb b/api/spec/requests/spree/api/v2/storefront/checkout_spec.rb
index 1349a65b25..073c49aa9d 100644
--- a/api/spec/requests/spree/api/v2/storefront/checkout_spec.rb
+++ b/api/spec/requests/spree/api/v2/storefront/checkout_spec.rb
@@ -460,7 +460,7 @@ describe 'API V2 Storefront Checkout Spec', type: :request do
end
context 'for user with store credits' do
- let!(:store_credit) { create(:store_credit, amount: order_total) }
+ let!(:store_credit) { create(:store_credit, amount: order_total, store: store) }
let!(:order) { create(:order, user: store_credit.user, total: order_total, store: store) }
shared_examples 'valid payload' do |amount|
diff --git a/backend/app/controllers/spree/admin/store_credits_controller.rb b/backend/app/controllers/spree/admin/store_credits_controller.rb
index 2817e1e88f..82ff262faa 100644
--- a/backend/app/controllers/spree/admin/store_credits_controller.rb
+++ b/backend/app/controllers/spree/admin/store_credits_controller.rb
@@ -16,7 +16,8 @@ module Spree
@store_credit = @user.store_credits.build(
permitted_store_credit_params.merge(
created_by: try_spree_current_user,
- action_originator: try_spree_current_user
+ action_originator: try_spree_current_user,
+ store: current_store
)
)
diff --git a/backend/spec/features/admin/orders/payments_spec.rb b/backend/spec/features/admin/orders/payments_spec.rb
index 4a330f1f7b..7085e26d90 100644
--- a/backend/spec/features/admin/orders/payments_spec.rb
+++ b/backend/spec/features/admin/orders/payments_spec.rb
@@ -225,7 +225,7 @@ describe 'Payments', type: :feature, js: true do
let!(:category) { create(:store_credit_category, name: 'Default') }
before do
- create(:store_credit, user: order.user, category: category, amount: 500)
+ create(:store_credit, user: order.user, category: category, amount: 500, store: order.store)
visit spree.new_admin_order_payment_path(order.reload)
choose("payment_payment_method_id_#{payment_method.id}")
click_button 'Continue'
diff --git a/backend/spec/features/admin/store_credits_spec.rb b/backend/spec/features/admin/store_credits_spec.rb
index 39a7abb887..4f800122a2 100644
--- a/backend/spec/features/admin/store_credits_spec.rb
+++ b/backend/spec/features/admin/store_credits_spec.rb
@@ -40,7 +40,13 @@ describe 'Store credits admin', type: :feature do
end
describe 'with default currency' do
- it 'creates store credit and associate it with the user' do
+ let!(:store) { create(:store) }
+
+ before do
+ allow_any_instance_of(Spree::Admin::StoreCreditsController).to receive(:current_store).and_return(store)
+ end
+
+ it 'creates store credit and associate it with the user and store' do
within find('#contentHeader') do
click_link 'Add Store Credit'
end
@@ -54,6 +60,7 @@ describe 'Store credits admin', type: :feature do
store_credit_table = page.find('table', match: :first)
expect(store_credit_table).to have_css('tr').twice
expect(Spree::StoreCredit.count).to eq 2
+ expect(Spree::StoreCredit.last.store).to eq(store)
end
end
@@ -62,7 +69,7 @@ describe 'Store credits admin', type: :feature do
within find('#contentHeader') do
click_link 'Add Store Credit'
end
-
+
page.fill_in 'store_credit_amount', with: '100.00'
select 'EUR', from: 'store_credit_currency'
select 'Exchange', from: 'store_credit_category_id'
diff --git a/core/app/models/concerns/spree/user_methods.rb b/core/app/models/concerns/spree/user_methods.rb
index d97af19575..7430b45370 100644
--- a/core/app/models/concerns/spree/user_methods.rb
+++ b/core/app/models/concerns/spree/user_methods.rb
@@ -59,9 +59,10 @@ module Spree
first
end
- def total_available_store_credit(currency = nil)
+ def total_available_store_credit(currency = nil, store = nil)
currency ||= Spree::Config[:currency]
- store_credits.where(currency: currency).reload.to_a.sum(&:amount_remaining)
+ store ||= Store.default
+ store_credits.for_store(store).where(currency: currency).reload.to_a.sum(&:amount_remaining)
end
private
diff --git a/core/app/models/spree/order/store_credit.rb b/core/app/models/spree/order/store_credit.rb
index e1e981b75c..92f0a701b4 100644
--- a/core/app/models/spree/order/store_credit.rb
+++ b/core/app/models/spree/order/store_credit.rb
@@ -11,7 +11,7 @@ module Spree
def total_available_store_credit
return 0.0 unless user
- user.total_available_store_credit
+ user.total_available_store_credit(currency, store)
end
def could_use_store_credit?
diff --git a/core/app/models/spree/reimbursement_type/reimbursement_helpers.rb b/core/app/models/spree/reimbursement_type/reimbursement_helpers.rb
index 732172707d..0c6d622ae9 100644
--- a/core/app/models/spree/reimbursement_type/reimbursement_helpers.rb
+++ b/core/app/models/spree/reimbursement_type/reimbursement_helpers.rb
@@ -51,7 +51,8 @@ module Spree
category: category,
created_by: Spree::StoreCredit.default_created_by,
memo: "Refund for uncreditable payments on order #{reimbursement.order.number}",
- currency: reimbursement.order.currency
+ currency: reimbursement.order.currency,
+ store: reimbursement.order.store
}
end
diff --git a/core/app/models/spree/store.rb b/core/app/models/spree/store.rb
index 93e9c9d0a0..d302edc1d7 100644
--- a/core/app/models/spree/store.rb
+++ b/core/app/models/spree/store.rb
@@ -15,6 +15,7 @@ module Spree
has_many :variants, through: :products, foreign_key: :prodyct, class_name: 'Spree::Variant',
source: :variants_including_master
has_many :stock_items, through: :variants, class_name: 'Spree::StockItem'
+ has_many :store_credits, class_name: 'Spree::StoreCredit'
belongs_to :default_country, class_name: 'Spree::Country'
belongs_to :checkout_zone, class_name: 'Spree::Zone'
diff --git a/core/app/models/spree/store_credit.rb b/core/app/models/spree/store_credit.rb
index 2009380d9d..3b7eaa1707 100644
--- a/core/app/models/spree/store_credit.rb
+++ b/core/app/models/spree/store_credit.rb
@@ -16,9 +16,10 @@ module Spree
belongs_to :category, class_name: 'Spree::StoreCreditCategory'
belongs_to :created_by, class_name: Spree.user_class.to_s, foreign_key: 'created_by_id'
belongs_to :credit_type, class_name: 'Spree::StoreCreditType', foreign_key: 'type_id'
+ belongs_to :store, class_name: 'Spree::Store'
has_many :store_credit_events
- validates :user, :category, :credit_type, :created_by, :currency, presence: true
+ validates :user, :category, :credit_type, :created_by, :currency, :store, presence: true
validates :amount, numericality: { greater_than: 0 }
validates :amount_used, numericality: { greater_than_or_equal_to: 0 }
validate :amount_used_less_than_or_equal_to_amount
@@ -188,7 +189,8 @@ module Spree
created_by_id: created_by_id,
currency: currency,
type_id: type_id,
- memo: credit_allocation_memo
+ memo: credit_allocation_memo,
+ store: store
}
end
diff --git a/core/app/services/spree/checkout/add_store_credit.rb b/core/app/services/spree/checkout/add_store_credit.rb
index d7de186bcb..f1a8844d82 100644
--- a/core/app/services/spree/checkout/add_store_credit.rb
+++ b/core/app/services/spree/checkout/add_store_credit.rb
@@ -23,7 +23,7 @@ module Spree
payment_method = Spree::PaymentMethod::StoreCredit.available.first
raise 'Store credit payment method could not be found' unless payment_method
- @order.user.store_credits.order_by_priority.each do |credit|
+ @order.user.store_credits.for_store(@order.store).order_by_priority.each do |credit|
break if remaining_total.zero?
next if credit.amount_remaining.zero?
diff --git a/core/db/migrate/20210715091956_add_store_id_to_spree_store_credits.rb b/core/db/migrate/20210715091956_add_store_id_to_spree_store_credits.rb
new file mode 100644
index 0000000000..021f37cdc5
--- /dev/null
+++ b/core/db/migrate/20210715091956_add_store_id_to_spree_store_credits.rb
@@ -0,0 +1,10 @@
+class AddStoreIdToSpreeStoreCredits < ActiveRecord::Migration[5.2]
+ def change
+ unless column_exists?(:spree_store_credits, :store_id)
+ add_column :spree_store_credits, :store_id, :bigint
+ add_index :spree_store_credits, :store_id
+ Spree::StoreCredit.reset_column_information
+ Spree::StoreCredit.update_all(store_id: Spree::Store.default.id)
+ end
+ end
+end
diff --git a/core/lib/spree/testing_support/factories/store_credit_factory.rb b/core/lib/spree/testing_support/factories/store_credit_factory.rb
index e6a782c016..f02fa807a0 100644
--- a/core/lib/spree/testing_support/factories/store_credit_factory.rb
+++ b/core/lib/spree/testing_support/factories/store_credit_factory.rb
@@ -8,6 +8,7 @@ FactoryBot.define do
amount { 150.00 }
currency { 'USD' }
credit_type { create(:primary_credit_type) }
+ store { create(:store) }
end
factory :store_credits_order_without_user, class: Spree::Order do
diff --git a/core/spec/models/spree/order/store_credit_spec.rb b/core/spec/models/spree/order/store_credit_spec.rb
index e4bfc1f88f..8732330415 100644
--- a/core/spec/models/spree/order/store_credit_spec.rb
+++ b/core/spec/models/spree/order/store_credit_spec.rb
@@ -85,6 +85,36 @@ describe 'Order' do
it "returns the user's available store credit" do
expect(subject.total_available_store_credit).to eq available_store_credit
end
+
+ context 'when store is provided' do
+ let!(:store) { create(:store) }
+ let!(:second_store) { create(:store) }
+ let!(:store_credit) { create(:store_credit, amount: '100', user: user, store: store) }
+
+ before do
+ allow(user).to receive(:total_available_store_credit).and_call_original
+ end
+
+ context 'and has store credits associated' do
+ before do
+ expect(subject).to receive(:store).and_return(store)
+ end
+
+ it "returns the user's available store credit" do
+ expect(subject.total_available_store_credit).to eq(100)
+ end
+ end
+
+ context 'and has no store credits associated' do
+ before do
+ expect(subject).to receive(:store).and_return(second_store)
+ end
+
+ it "returns the user's available store credit" do
+ expect(subject.total_available_store_credit).to eq(0)
+ end
+ end
+ end
end
end
diff --git a/core/spec/models/spree/payment_method/store_credit_spec.rb b/core/spec/models/spree/payment_method/store_credit_spec.rb
index 77ad57c641..fe21b20935 100644
--- a/core/spec/models/spree/payment_method/store_credit_spec.rb
+++ b/core/spec/models/spree/payment_method/store_credit_spec.rb
@@ -293,9 +293,10 @@ describe Spree::PaymentMethod::StoreCredit do
let!(:store_credit_payment_method) { create(:store_credit_payment_method, display_on: 'both') }
context 'when user have store credits' do
+ let(:store) { create(:store) }
let!(:user_with_store_credits) { create(:user) }
- let!(:store_credit) { create(:store_credit, user: user_with_store_credits) }
- let!(:order_with_store_credit) { create(:order, user: user_with_store_credits) }
+ let!(:store_credit) { create(:store_credit, user: user_with_store_credits, store: store) }
+ let!(:order_with_store_credit) { create(:order, user: user_with_store_credits, store: store) }
it { expect(store_credit_payment_method.available_for_order?(order_with_store_credit)).to be true }
end
diff --git a/core/spec/models/spree/store_credit_spec.rb b/core/spec/models/spree/store_credit_spec.rb
index 20eb9d5306..95a1efbc10 100644
--- a/core/spec/models/spree/store_credit_spec.rb
+++ b/core/spec/models/spree/store_credit_spec.rb
@@ -739,9 +739,11 @@ describe 'StoreCredit' do
end
describe '#store_events' do
+ let(:store) { create(:store) }
+
context 'create' do
context 'user has one store credit' do
- subject { create(:store_credit, amount: store_credit_amount) }
+ subject { create(:store_credit, amount: store_credit_amount, store: store) }
let(:store_credit_amount) { 100.0 }
@@ -759,13 +761,13 @@ describe 'StoreCredit' do
end
context 'user has multiple store credits' do
- subject { create(:store_credit, user: user, amount: additional_store_credit_amount) }
+ subject { create(:store_credit, user: user, amount: additional_store_credit_amount, store: store) }
let(:store_credit_amount) { 100.0 }
let(:additional_store_credit_amount) { 200.0 }
let(:user) { create(:user) }
- let!(:store_credit) { create(:store_credit, user: user, amount: store_credit_amount) }
+ let!(:store_credit) { create(:store_credit, user: user, amount: store_credit_amount, store: store) }
it "saves the user's total store credit in the event" do
amount = store_credit_amount + additional_store_credit_amount
diff --git a/core/spec/models/spree/user_spec.rb b/core/spec/models/spree/user_spec.rb
index 44d58052df..dad8198d39 100644
--- a/core/spec/models/spree/user_spec.rb
+++ b/core/spec/models/spree/user_spec.rb
@@ -157,7 +157,7 @@ describe Spree.user_class, type: :model do
let(:amount) { 120.25 }
let(:additional_amount) { 55.75 }
let(:store_credit) { create(:store_credit, user: user, amount: amount, amount_used: 0.0) }
- let!(:additional_store_credit) { create(:store_credit, user: user, amount: additional_amount, amount_used: 0.0) }
+ let!(:additional_store_credit) { create(:store_credit, user: user, amount: additional_amount, amount_used: 0.0, store: store_credit.store) }
context 'part of the store credit has been used' do
let(:amount_used) { 35.00 }
diff --git a/core/spec/services/spree/checkout/add_store_credit_spec.rb b/core/spec/services/spree/checkout/add_store_credit_spec.rb
index aa8feaad19..12c20306ee 100644
--- a/core/spec/services/spree/checkout/add_store_credit_spec.rb
+++ b/core/spec/services/spree/checkout/add_store_credit_spec.rb
@@ -26,8 +26,9 @@ describe Spree::Checkout::AddStoreCredit, type: :service do
end
context 'there is enough store credit to pay for the entire order' do
- let(:store_credit) { create(:store_credit, amount: order_total) }
- let(:order) { create(:order, user: store_credit.user, total: order_total) }
+ let(:store) { create(:store) }
+ let(:store_credit) { create(:store_credit, amount: order_total, store: store) }
+ let(:order) { create(:order, user: store_credit.user, total: order_total, store: store) }
context 'with no amount specified' do
before do
@@ -58,10 +59,12 @@ describe Spree::Checkout::AddStoreCredit, type: :service do
end
context 'the available store credit is not enough to pay for the entire order' do
+ let(:store) { create(:store) }
let(:expected_cc_total) { 100.0 }
let(:store_credit_total) { order_total - expected_cc_total }
- let(:store_credit) { create(:store_credit, amount: store_credit_total) }
- let(:order) { create(:order, user: store_credit.user, total: order_total) }
+ let(:store_credit) { create(:store_credit, amount: store_credit_total, store: store) }
+ let(:order) { create(:order, user: store_credit.user, total: order_total, store: store) }
+ let!(:store_credit_2) { create(:store_credit, amount: 10) }
before do
# callbacks recalculate total based on line items
@@ -80,13 +83,14 @@ describe Spree::Checkout::AddStoreCredit, type: :service do
context 'there are multiple store credits' do
context 'they have different credit type priorities' do
+ let(:store) { create(:store) }
let(:amount_difference) { 100 }
- let!(:primary_store_credit) { create(:store_credit, amount: (order_total - amount_difference)) }
+ let!(:primary_store_credit) { create(:store_credit, amount: (order_total - amount_difference), store: store) }
let!(:secondary_store_credit) do
create(:store_credit, amount: order_total, user: primary_store_credit.user,
- credit_type: create(:secondary_credit_type))
+ credit_type: create(:secondary_credit_type), store: store)
end
- let(:order) { create(:order, user: primary_store_credit.user, total: order_total) }
+ let(:order) { create(:order, user: primary_store_credit.user, total: order_total, store: store) }
before do
Timecop.scale(3600)
diff --git a/core/spec/services/spree/checkout/remove_store_credit_spec.rb b/core/spec/services/spree/checkout/remove_store_credit_spec.rb
index df5939b30c..2cd9a5700e 100644
--- a/core/spec/services/spree/checkout/remove_store_credit_spec.rb
+++ b/core/spec/services/spree/checkout/remove_store_credit_spec.rb
@@ -4,11 +4,12 @@ describe Spree::Checkout::RemoveStoreCredit, type: :service do
describe '#call' do
subject { described_class.call(order: order) }
+ let(:store) { create(:store) }
let(:order_total) { 500.00 }
- let(:order) { create(:order, user: store_credit.user, total: order_total) }
+ let(:order) { create(:order, user: store_credit.user, total: order_total, store: store) }
context 'when order is not complete' do
- let(:store_credit) { create(:store_credit, amount: order_total - 1) }
+ let(:store_credit) { create(:store_credit, amount: order_total - 1, store: store) }
before do
create(:store_credit_payment_method)
diff --git a/frontend/spec/controllers/spree/checkout_controller_spec.rb b/frontend/spec/controllers/spree/checkout_controller_spec.rb
index 9014f6f199..908a93064c 100644
--- a/frontend/spec/controllers/spree/checkout_controller_spec.rb
+++ b/frontend/spec/controllers/spree/checkout_controller_spec.rb
@@ -841,7 +841,7 @@ describe Spree::CheckoutController, type: :controller do
before do
create(:store_credit_payment_method)
- create(:store_credit, user: user, amount: credit_amount)
+ create(:store_credit, user: user, amount: credit_amount, store: order.store)
end
def expect_one_store_credit_payment(order, amount)
@@ -896,7 +896,7 @@ describe Spree::CheckoutController, type: :controller do
before do
create(:store_credit_payment_method)
- create(:store_credit, user: user, amount: credit_amount)
+ create(:store_credit, user: user, amount: credit_amount, store: order.store)
Spree::Checkout::AddStoreCredit.call(order: order)
end
diff --git a/frontend/spec/features/checkout_spec.rb b/frontend/spec/features/checkout_spec.rb
index 840442174f..ab472a6e28 100644
--- a/frontend/spec/features/checkout_spec.rb
+++ b/frontend/spec/features/checkout_spec.rb
@@ -728,8 +728,8 @@ describe 'Checkout', type: :feature, inaccessible: true, js: true do
end
context 'when not all Store Credits are used' do
- let!(:store_credit) { create(:store_credit, user: user) }
- let!(:additional_store_credit) { create(:store_credit, user: user, amount: 13) }
+ let!(:store_credit) { create(:store_credit, user: user, store: order.store) }
+ let!(:additional_store_credit) { create(:store_credit, user: user, amount: 13, store: order.store) }
before { prepare_checkout! }