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.

Re-organize Address services to be use outside of Account context (#11453)

Damian Legawiec211e44325b68
diff --git a/api/app/controllers/spree/api/v2/storefront/account/addresses_controller.rb b/api/app/controllers/spree/api/v2/storefront/account/addresses_controller.rb
index d8f103c183..879ce13e76 100644
--- a/api/app/controllers/spree/api/v2/storefront/account/addresses_controller.rb
+++ b/api/app/controllers/spree/api/v2/storefront/account/addresses_controller.rb
@@ -59,11 +59,11 @@ module Spree
end
def create_service
- Spree::Api::Dependencies.storefront_account_create_address_service.constantize
+ Spree::Api::Dependencies.storefront_address_create_service.constantize
end
def update_service
- Spree::Api::Dependencies.storefront_account_update_address_service.constantize
+ Spree::Api::Dependencies.storefront_address_update_service.constantize
end
def address_params
diff --git a/api/lib/spree/api/api_dependencies.rb b/api/lib/spree/api/api_dependencies.rb
index a94288bbde..36ffbe779b 100644
--- a/api/lib/spree/api/api_dependencies.rb
+++ b/api/lib/spree/api/api_dependencies.rb
@@ -21,7 +21,7 @@ module Spree
:storefront_account_create_service, :storefront_account_update_service, :storefront_collection_sorter, :error_handler,
:storefront_cart_empty_service, :storefront_cart_destroy_service, :storefront_credit_cards_destroy_service, :platform_products_sorter,
:storefront_cart_change_currency_service, :storefront_payment_serializer,
- :storefront_payment_create_service,
+ :storefront_payment_create_service, :storefront_address_create_service, :storefront_address_update_service,
:platform_admin_user_serializer, :platform_coupon_handler, :platform_order_update_service,
:platform_order_use_store_credit_service, :platform_order_remove_store_credit_service,
@@ -72,8 +72,10 @@ module Spree
# account services
@storefront_account_create_service = Spree::Dependencies.account_create_service
@storefront_account_update_service = Spree::Dependencies.account_update_service
- @storefront_account_create_address_service = Spree::Dependencies.account_create_address_service
- @storefront_account_update_address_service = Spree::Dependencies.account_update_address_service
+
+ # address services
+ @storefront_address_create_service = Spree::Dependencies.address_create_service
+ @storefront_address_update_service = Spree::Dependencies.address_update_service
# credit card services
@storefront_credit_cards_destroy_service = Spree::Dependencies.credit_cards_destroy_service
diff --git a/core/app/services/spree/account/addresses/create.rb b/core/app/services/spree/account/addresses/create.rb
index a1bec3c01d..fae56aa2f0 100644
--- a/core/app/services/spree/account/addresses/create.rb
+++ b/core/app/services/spree/account/addresses/create.rb
@@ -1,23 +1,7 @@
module Spree
module Account
module Addresses
- class Create
- prepend Spree::ServiceModule::Base
- include Spree::Account::Addresses::Helper
-
- attr_accessor :country
-
- def call(user:, address_params:)
- fill_country_and_state_ids(address_params)
-
- address = user.addresses.new(address_params)
- if address.save
- assign_to_user_as_default(user: user, address_id: address.id)
- success(address)
- else
- failure(address)
- end
- end
+ class Create < Spree::Addresses::Create
end
end
end
diff --git a/core/app/services/spree/account/addresses/helper.rb b/core/app/services/spree/account/addresses/helper.rb
deleted file mode 100644
index 83e24383ba..0000000000
--- a/core/app/services/spree/account/addresses/helper.rb
+++ /dev/null
@@ -1,43 +0,0 @@
-module Spree
- module Account
- module Addresses
- module Helper
- private
-
- attr_accessor :country
-
- def fill_country_and_state_ids(params)
- replace_country_iso_with_id(params)
- fill_state_id(params)
- end
-
- def replace_country_iso_with_id(params)
- iso = params[:country_iso]
- return params unless iso.present?
-
- country = Spree::Country.by_iso(iso)
- params[:country_id] = country&.id
- params.delete(:country_iso)
- params
- end
-
- def fill_state_id(params)
- state_name = params[:state_name]
- return params unless state_name.present?
-
- country ||= Spree::Country.find(params[:country_id]) if params[:country_id].present?
- return params unless country
-
- params[:state_id] = country.states.find_by(name: state_name)&.id
- params
- end
-
- def assign_to_user_as_default(user:, address_id:)
- if user.addresses.pluck(:id) == [address_id] # check if it's user first address
- user.update(bill_address_id: address_id, ship_address_id: address_id)
- end
- end
- end
- end
- end
-end
diff --git a/core/app/services/spree/account/addresses/update.rb b/core/app/services/spree/account/addresses/update.rb
index a404bb9cd4..b553aabd69 100644
--- a/core/app/services/spree/account/addresses/update.rb
+++ b/core/app/services/spree/account/addresses/update.rb
@@ -1,28 +1,7 @@
module Spree
module Account
module Addresses
- class Update
- prepend Spree::ServiceModule::Base
- include Spree::Account::Addresses::Helper
-
- attr_accessor :country
-
- def call(address:, address_params:)
- address_params[:country_id] ||= address.country_id
- fill_country_and_state_ids(address_params)
-
- if address&.editable?
- address.update(address_params) ? success(address) : failure(address)
- else
- new_address(address_params).valid? ? address.destroy && success(new_address) : failure(new_address)
- end
- end
-
- private
-
- def new_address(address_params = {})
- @new_address ||= ::Spree::Address.find_or_create_by(address_params.except(:id, :updated_at, :created_at))
- end
+ class Update < Spree::Addresses::Update
end
end
end
diff --git a/core/app/services/spree/addresses/create.rb b/core/app/services/spree/addresses/create.rb
new file mode 100644
index 0000000000..c5a8eeb173
--- /dev/null
+++ b/core/app/services/spree/addresses/create.rb
@@ -0,0 +1,24 @@
+module Spree
+ module Addresses
+ class Create
+ prepend Spree::ServiceModule::Base
+ include Spree::Addresses::Helper
+
+ attr_accessor :country
+
+ def call(address_params: {}, user: nil)
+ fill_country_and_state_ids(address_params)
+
+ address = Spree::Address.new(address_params)
+ address.user = user if user.present?
+
+ if address.save
+ assign_to_user_as_default(user: user, address_id: address.id) if user.present?
+ success(address)
+ else
+ failure(address)
+ end
+ end
+ end
+ end
+end
diff --git a/core/app/services/spree/addresses/helper.rb b/core/app/services/spree/addresses/helper.rb
new file mode 100644
index 0000000000..061c5ba2b7
--- /dev/null
+++ b/core/app/services/spree/addresses/helper.rb
@@ -0,0 +1,41 @@
+module Spree
+ module Addresses
+ module Helper
+ private
+
+ attr_accessor :country
+
+ def fill_country_and_state_ids(params)
+ replace_country_iso_with_id(params)
+ fill_state_id(params)
+ end
+
+ def replace_country_iso_with_id(params)
+ iso = params[:country_iso]
+ return params unless iso.present?
+
+ country = Spree::Country.by_iso(iso)
+ params[:country_id] = country&.id
+ params.delete(:country_iso)
+ params
+ end
+
+ def fill_state_id(params)
+ state_name = params[:state_name]
+ return params unless state_name.present?
+
+ country ||= Spree::Country.find(params[:country_id]) if params[:country_id].present?
+ return params unless country
+
+ params[:state_id] = country.states.find_by(name: state_name)&.id
+ params
+ end
+
+ def assign_to_user_as_default(user:, address_id:)
+ if user.addresses.pluck(:id) == [address_id] # check if it's user first address
+ user.update(bill_address_id: address_id, ship_address_id: address_id)
+ end
+ end
+ end
+ end
+end
diff --git a/core/app/services/spree/addresses/update.rb b/core/app/services/spree/addresses/update.rb
new file mode 100644
index 0000000000..bbf5a3b664
--- /dev/null
+++ b/core/app/services/spree/addresses/update.rb
@@ -0,0 +1,27 @@
+module Spree
+ module Addresses
+ class Update
+ prepend Spree::ServiceModule::Base
+ include Spree::Addresses::Helper
+
+ attr_accessor :country
+
+ def call(address:, address_params:)
+ address_params[:country_id] ||= address.country_id
+ fill_country_and_state_ids(address_params)
+
+ if address&.editable?
+ address.update(address_params) ? success(address) : failure(address)
+ else
+ new_address(address_params).valid? ? address.destroy && success(new_address) : failure(new_address)
+ end
+ end
+
+ private
+
+ def new_address(address_params = {})
+ @new_address ||= ::Spree::Address.find_or_create_by(address_params.except(:id, :updated_at, :created_at))
+ end
+ end
+ end
+end
diff --git a/core/app/services/spree/checkout/update.rb b/core/app/services/spree/checkout/update.rb
index 4bc42439cf..346330eb91 100644
--- a/core/app/services/spree/checkout/update.rb
+++ b/core/app/services/spree/checkout/update.rb
@@ -2,12 +2,13 @@ module Spree
module Checkout
class Update
prepend Spree::ServiceModule::Base
+ include Spree::Addresses::Helper
def call(order:, params:, permitted_attributes:, request_env:)
ship_changed = address_with_country_iso_present?(params, 'ship')
bill_changed = address_with_country_iso_present?(params, 'bill')
- params = replace_country_iso_with_id(params, 'ship') if ship_changed
- params = replace_country_iso_with_id(params, 'bill') if bill_changed
+ params[:order][:ship_address_attributes] = replace_country_iso_with_id(params[:order][:ship_address_attributes]) if ship_changed
+ params[:order][:bill_address_attributes] = replace_country_iso_with_id(params[:order][:bill_address_attributes]) if bill_changed
order.state = 'address' if (ship_changed || bill_changed) && order.has_checkout_step?('address')
order.state = 'delivery' if selected_shipping_rate_present?(params) && order.has_checkout_step?('delivery')
return success(order) if order.update_from_params(params, permitted_attributes, request_env)
@@ -30,14 +31,6 @@ module Spree
shipments_attributes.any? { |s| s.dig(:selected_shipping_rate_id) }
end
-
- def replace_country_iso_with_id(params, address_kind = 'ship')
- country_id = Spree::Country.by_iso(params[:order]["#{address_kind}_address_attributes"].fetch(:country_iso))&.id
-
- params[:order]["#{address_kind}_address_attributes"]['country_id'] = country_id
- params[:order]["#{address_kind}_address_attributes"].delete(:country_iso)
- params
- end
end
end
end
diff --git a/core/lib/spree/core/app_dependencies.rb b/core/lib/spree/core/app_dependencies.rb
index a8fb514f91..f3289c00ad 100644
--- a/core/lib/spree/core/app_dependencies.rb
+++ b/core/lib/spree/core/app_dependencies.rb
@@ -16,7 +16,7 @@ module Spree
:classification_reposition_service, :credit_cards_destroy_service, :cart_associate_service, :cart_change_currency_service,
:line_item_create_service, :line_item_update_service, :line_item_destroy_service,
:order_approve_service, :order_cancel_service, :shipment_change_state_service, :shipment_update_service,
- :payment_create_service
+ :payment_create_service, :address_create_service, :address_update_service
].freeze
attr_accessor *INJECTION_POINTS
@@ -81,8 +81,10 @@ module Spree
# account
@account_create_service = 'Spree::Account::Create'
@account_update_service = 'Spree::Account::Update'
- @account_create_address_service = 'Spree::Account::Addresses::Create'
- @account_update_address_service = 'Spree::Account::Addresses::Update'
+
+ # addresses
+ @address_create_service = 'Spree::Addresses::Create'
+ @address_update_service = 'Spree::Addresses::Update'
# credit cards
@credit_cards_destroy_service = 'Spree::CreditCards::Destroy'
diff --git a/core/spec/services/spree/account/addresses/create_spec.rb b/core/spec/services/spree/account/addresses/create_spec.rb
index d9c3c22636..e4ef4f2e40 100644
--- a/core/spec/services/spree/account/addresses/create_spec.rb
+++ b/core/spec/services/spree/account/addresses/create_spec.rb
@@ -34,6 +34,10 @@ module Spree
expect(value.state).to eq(state)
end
+ context 'without user' do
+ it { expect(subject.call(address_params: address_params).success?).to eq(true) }
+ end
+
context 'user default address' do
context 'when created address is first user address' do
before { result }
diff --git a/core/spec/services/spree/checkout/update_spec.rb b/core/spec/services/spree/checkout/update_spec.rb
index b8254cc717..5aef3d61f2 100644
--- a/core/spec/services/spree/checkout/update_spec.rb
+++ b/core/spec/services/spree/checkout/update_spec.rb
@@ -26,16 +26,16 @@ describe Spree::Checkout::Update, type: :service do
}
)
end
- let(:result) { replace_country.send(:replace_country_iso_with_id, order_params, 'ship') }
+ let(:result) { replace_country.send(:replace_country_iso_with_id, order_params[:order][:ship_address_attributes]) }
before { result }
it 'will return hash contain country_id' do
- expect(result[:order][:ship_address_attributes][:country_id]).to eq country.id
+ expect(result[:country_id]).to eq country.id
end
it 'will return hash without country_iso' do
- expect(result[:order][:ship_address_attributes]).not_to include(:country_iso)
+ expect(result).not_to include(:country_iso)
end
end
@@ -47,16 +47,16 @@ describe Spree::Checkout::Update, type: :service do
}
)
end
- let(:result) { replace_country.send(:replace_country_iso_with_id, order_params, 'bill') }
+ let(:result) { replace_country.send(:replace_country_iso_with_id, order_params[:order][:bill_address_attributes]) }
before { result }
it 'will return hash contain country_id' do
- expect(result[:order][:bill_address_attributes][:country_id]).to eq country.id
+ expect(result[:country_id]).to eq country.id
end
it 'will return hash without country_iso' do
- expect(result[:order][:bill_address_attributes]).not_to include(:country_iso)
+ expect(result).not_to include(:country_iso)
end
end
end