Rename method that recalculates shipment state

Update implies that we are persisting the change in Rails, which this
method does not do.

Co-authored-by: Adam Mueller <[email protected]>
Co-authored-by: Senem Soy <[email protected]>
Co-authored-by: Andrew Stewart <[email protected]>
Co-authored-by: Kendra Riga <[email protected]>
Co-authored-by: Sofia Besenski <[email protected]>
Co-authored-by: benjamin wil <[email protected]>

Author: 7 people

core/app/models/spree/order.rb

@@ -418,7 +418,7 @@ def valid_credit_cards
 
     def fulfill!
       shipments.each { |shipment| shipment.update_state if shipment.persisted? }
-      recalculator.update_shipment_state
+      recalculator.recalculate_shipment_state
       save!
     end
 
@@ -764,7 +764,7 @@ def finalize
         shipment.finalize!
       end
 
-      recalculator.update_shipment_state
+      recalculator.recalculate_shipment_state
       save!
 
       touch :completed_at

core/app/models/spree/order_updater.rb

@@ -24,7 +24,7 @@ def recalculate
         if order.completed?
           update_payment_state
           update_shipments
-          update_shipment_state
+          recalculate_shipment_state
         end
         Spree::Bus.publish(:order_recalculated, order:)
         persist_totals
@@ -43,13 +43,15 @@ def recalculate
     # pending   when all Shipments are in the "pending" state
     #
     # The +shipment_state+ value helps with reporting, etc. since it provides a quick and easy way to locate Orders needing attention.
-    def update_shipment_state
+    def recalculate_shipment_state
       log_state_change('shipment') do
         order.shipment_state = determine_shipment_state
       end
 
       order.shipment_state
     end
+    alias_method :update_shipment_state, :recalculate_shipment_state
+    deprecate update_shipment_state: :recalculate_shipment_state, deprecator: Spree.deprecator
 
     # Updates the +payment_state+ attribute according to the following logic:
     #

core/spec/models/spree/order_updater_spec.rb

@@ -268,7 +268,7 @@ module Spree
       it "logs a state change for the shipment" do
         create :shipment, order:, state: "pending"
 
-        expect { updater.update_shipment_state }
+        expect { updater.recalculate_shipment_state }
           .to enqueue_job(Spree::StateChangeTrackingJob)
           .with(order, nil, "pending", a_kind_of(Time), "shipment")
           .once
@@ -280,28 +280,28 @@ module Spree
 
       it "is backordered" do
         allow(order).to receive_messages backordered?: true
-        updater.update_shipment_state
+        updater.recalculate_shipment_state
 
         expect(order.shipment_state).to eq('backorder')
       end
 
       it "is nil" do
-        updater.update_shipment_state
+        updater.recalculate_shipment_state
         expect(order.shipment_state).to be_nil
       end
 
       ["shipped", "ready", "pending"].each do |state|
         it "is #{state}" do
           create(:shipment, order:, state:)
-          updater.update_shipment_state
+          updater.recalculate_shipment_state
           expect(order.shipment_state).to eq(state)
         end
       end
 
       it "is partial" do
         create(:shipment, order:, state: 'pending')
         create(:shipment, order:, state: 'ready')
-        updater.update_shipment_state
+        updater.recalculate_shipment_state
         expect(order.shipment_state).to eq('partial')
       end
     end
@@ -427,7 +427,7 @@ module Spree
       end
 
       it "updates shipment state" do
-        expect(updater).to receive(:update_shipment_state)
+        expect(updater).to receive(:recalculate_shipment_state)
         updater.recalculate
       end
 
@@ -456,7 +456,7 @@ module Spree
       end
 
       it "doesnt update shipment state" do
-        expect(updater).not_to receive(:update_shipment_state)
+        expect(updater).not_to receive(:recalculate_shipment_state)
         updater.recalculate
       end
 

core/spec/models/spree/payment_spec.rb

@@ -745,7 +745,7 @@
 
       it "updates payment_state and shipments" do
         expect(order.recalculator).to receive(:update_payment_state)
-        expect(order.recalculator).to receive(:update_shipment_state)
+        expect(order.recalculator).to receive(:recalculate_shipment_state)
         Spree::Payment.create!(amount: 100, order:, payment_method:)
       end
     end