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.

Refactor Orders::Approve and Orders::Cancel to own business logic

Damian Legawiec08c3202bc4b2
diff --git a/spree/admin/app/controllers/spree/admin/orders_controller.rb b/spree/admin/app/controllers/spree/admin/orders_controller.rb
index 315c04b735..84a2562239 100644
--- a/spree/admin/app/controllers/spree/admin/orders_controller.rb
+++ b/spree/admin/app/controllers/spree/admin/orders_controller.rb
@@ -47,8 +47,12 @@ module Spree
# PUT /admin/orders/:id/cancel
def cancel
- @order.canceled_by(try_spree_current_user)
- flash[:success] = Spree.t(:order_canceled)
+ result = @order.canceled_by(try_spree_current_user)
+ if result.success?
+ flash[:success] = Spree.t(:order_canceled)
+ else
+ flash[:error] = result.error.to_s
+ end
redirect_back fallback_location: spree.edit_admin_order_url(@order)
end
diff --git a/spree/core/app/models/spree/order.rb b/spree/core/app/models/spree/order.rb
index 15f4ec72c5..31db3aed5c 100644
--- a/spree/core/app/models/spree/order.rb
+++ b/spree/core/app/models/spree/order.rb
@@ -786,30 +786,23 @@ module Spree
!payments.risky.empty?
end
+ # Cancels the order and records the canceler.
+ # Delegates to {Spree::Orders::Cancel} service.
+ #
+ # @param user [Spree.user_class, nil] the user who canceled the order
+ # @param canceled_at [Time, nil] the time of cancellation (defaults to current time)
+ # @return [Spree::ServiceModule::Result]
def canceled_by(user, canceled_at = nil)
- canceled_at ||= Time.current
- changes = { canceler_id: user.id, canceled_at: canceled_at }
-
- transaction do
- update_columns(changes)
- cancel!
- end
-
- # Manually publish update event since update_columns bypasses callbacks
- publish_event('order.canceled')
+ Spree.order_cancel_service.call(order: self, canceler: user, canceled_at: canceled_at)
end
- def approved_by(user)
- approved_at = Time.current
- changes = { approver_id: user.id, approved_at: approved_at }
-
- transaction do
- approve!
- update_columns(changes)
- end
-
- # Manually publish update event since update_columns bypasses callbacks
- publish_event('order.approved')
+ # Approves the order and records the approver.
+ # Delegates to {Spree::Orders::Approve} service.
+ #
+ # @param user [Spree.user_class, nil] the user who approved the order
+ # @return [Spree::ServiceModule::Result]
+ def approved_by(user = nil)
+ Spree.order_approve_service.call(order: self, approver: user)
end
def approved?
@@ -840,11 +833,12 @@ module Spree
publish_event('order.updated')
end
+ # Approves the order without recording an approver.
+ # Delegates to {Spree::Orders::Approve} service.
+ #
+ # @return [Spree::ServiceModule::Result]
def approve!
- update_column(:considered_risky, false)
-
- # Manually publish update event since update_column bypasses callbacks
- publish_event('order.approved')
+ Spree.order_approve_service.call(order: self)
end
def tax_total
diff --git a/spree/core/app/services/spree/orders/approve.rb b/spree/core/app/services/spree/orders/approve.rb
index 9e72332cbc..aa59e2469f 100644
--- a/spree/core/app/services/spree/orders/approve.rb
+++ b/spree/core/app/services/spree/orders/approve.rb
@@ -4,11 +4,13 @@ module Spree
prepend Spree::ServiceModule::Base
def call(order:, approver: nil)
+ changes = { considered_risky: false, approved_at: Time.current }
if approver.present?
- order.approved_by(approver)
- else
- order.approve!
+ changes[:approver_id] = approver.id
end
+ order.update_columns(changes)
+
+ order.publish_event('order.approved')
success(order.reload)
rescue ActiveRecord::Rollback, ActiveRecord::RecordInvalid, StateMachines::InvalidTransition
failure(order)
diff --git a/spree/core/app/services/spree/orders/cancel.rb b/spree/core/app/services/spree/orders/cancel.rb
index 38a20f05b9..f84bb5a51b 100644
--- a/spree/core/app/services/spree/orders/cancel.rb
+++ b/spree/core/app/services/spree/orders/cancel.rb
@@ -3,12 +3,17 @@ module Spree
class Cancel
prepend Spree::ServiceModule::Base
- def call(order:, canceler: nil)
- if canceler.present?
- order.canceled_by(canceler)
- else
+ def call(order:, canceler: nil, canceled_at: nil)
+ canceled_at ||= Time.current
+
+ order.transaction do
+ changes = { canceled_at: canceled_at }
+ changes[:canceler_id] = canceler.id if canceler.present?
+ order.update_columns(changes)
order.cancel!
end
+
+ order.publish_event('order.canceled')
success(order.reload)
rescue ActiveRecord::Rollback, ActiveRecord::RecordInvalid, StateMachines::InvalidTransition
failure(order)
diff --git a/spree/core/spec/models/spree/order/risk_assessment_spec.rb b/spree/core/spec/models/spree/order/risk_assessment_spec.rb
index ae17732b45..25709ccd6d 100644
--- a/spree/core/spec/models/spree/order/risk_assessment_spec.rb
+++ b/spree/core/spec/models/spree/order/risk_assessment_spec.rb
@@ -84,11 +84,12 @@ describe Spree::Order, type: :model do
end
it 'can be approved by a user' do
- expect(order).to receive(:approve!)
order.approved_by(user)
+ order.reload
expect(order.approver_id).to eq user.id
expect(order.approved_at).to be_present
expect(order.approved?).to be true
+ expect(order.considered_risky).to be false
end
end
end
diff --git a/spree/core/spec/models/spree/order_spec.rb b/spree/core/spec/models/spree/order_spec.rb
index b547292c9b..42b19ad3df 100644
--- a/spree/core/spec/models/spree/order_spec.rb
+++ b/spree/core/spec/models/spree/order_spec.rb
@@ -1036,9 +1036,10 @@ describe Spree::Order, type: :model do
end
end
- it 'calls approve!' do
- expect(order).to receive(:approve!)
+ it 'sets considered_risky to false' do
+ order.update_column(:considered_risky, true)
order.approved_by(admin_user)
+ expect(order.reload.considered_risky).to be false
end
context 'events', :events do
diff --git a/spree/core/spec/services/spree/orders/approve_spec.rb b/spree/core/spec/services/spree/orders/approve_spec.rb
index f7e534cbcf..8a6846152b 100644
--- a/spree/core/spec/services/spree/orders/approve_spec.rb
+++ b/spree/core/spec/services/spree/orders/approve_spec.rb
@@ -13,6 +13,7 @@ module Spree
it { expect(result).to be_success }
it { expect(result.value).to eq(order) }
it { expect { result }.to change(order, :considered_risky).to(false) }
+ it { expect { result }.to change { order.reload.approved_at }.from(nil) }
end
context 'with approver passed' do