Merge pull request #6170 from SuperGoodSoft/new-order-events

Add new order events

Author: kennyadsl

core/app/models/spree/order.rb

@@ -848,6 +848,8 @@ def after_cancel
       send_cancel_email
       update_column(:canceled_at, Time.current)
       recalculate
+
+      Spree::Bus.publish :order_canceled, order: self
     end
 
     def cancel_shipments!

core/app/models/spree/order_cancellations.rb

@@ -50,6 +50,7 @@ def short_ship(inventory_units, created_by: nil)
       end
     end
 
+    Spree::Bus.publish(:order_short_shipped, order: @order, inventory_units:)
     unit_cancels
   end
 

core/app/models/spree/order_shipping.rb

@@ -72,6 +72,7 @@ def ship(inventory_units:, stock_location:, address:, shipping_method:,
     @order.shipments.reload
     @order.recalculate
 
+    Spree::Bus.publish(:carton_shipped, carton:)
     carton
   end
 

core/lib/spree/core/engine.rb

@@ -61,9 +61,12 @@ class Engine < ::Rails::Engine
           Spree::Bus.clear
 
           %i[
+            carton_shipped
+            order_canceled
             order_emptied
             order_finalized
             order_recalculated
+            order_short_shipped
             reimbursement_reimbursed
             reimbursement_errored
           ].each { |event_name| Spree::Bus.register(event_name) }

core/spec/models/spree/order_cancellations_spec.rb

@@ -94,6 +94,15 @@
       expect { subject }.to change { order.shipment_state }.from('ready').to('shipped')
     end
 
+    it "publishes an 'order_short_shipped' event" do
+      stub_spree_bus
+
+      subject
+
+      expect(:order_short_shipped)
+        .to have_been_published.with(order:, inventory_units: [inventory_unit])
+    end
+
     it "adjusts the order" do
       expect { subject }.to change { order.reload.total }.by(-10.0)
     end

core/spec/models/spree/order_shipping_spec.rb

@@ -85,6 +85,12 @@ def emails
       it "sets the external_number" do
         expect(subject.external_number).to eq 'some-external-number'
       end
+
+      it "publishes a 'carton_shipped' event" do
+        stub_spree_bus
+
+        expect(:carton_shipped).to have_been_published.with(carton: subject)
+      end
     end
 
     context "with a tracking number" do

core/spec/models/spree/order_spec.rb

@@ -82,9 +82,18 @@
   end
 
   describe "#cancel!" do
-    let!(:order) { create(:completed_order_with_totals) }
     subject { order.cancel! }
 
+    let!(:order) { create(:completed_order_with_totals) }
+
+    it "publishes a 'order_canceled' event" do
+      stub_spree_bus
+
+      subject
+
+      expect(:order_canceled).to have_been_published.with(order:)
+    end
+
     it "sends a cancel email" do
       perform_enqueued_jobs { subject }
 

core/spec/rails_helper.rb

@@ -16,6 +16,7 @@
 
 Dir["./spec/support/**/*.rb"].sort.each { |f| require f }
 
+require 'spree/testing_support/bus_helpers'
 require 'spree/testing_support/factory_bot'
 require 'spree/testing_support/preferences'
 require 'spree/testing_support/rake'
@@ -45,6 +46,7 @@
     Rails.cache.clear
   end
 
+  config.include Spree::TestingSupport::BusHelpers
   config.include Spree::TestingSupport::JobHelpers
 
   config.include FactoryBot::Syntax::Methods