Rename method that recalculates payment 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: Andrew Stewart <[email protected]>
Co-authored-by: benjamin wil <[email protected]>
Co-authored-by: Senem Soy <[email protected]>
Co-authored-by: Sofia Besenski <[email protected]>
Co-authored-by: Kendra Riga <[email protected]>

Author: 7 people

core/app/models/spree/order.rb

@@ -758,7 +758,7 @@ def finalize
       all_adjustments.each(&:finalize!)
 
       # update payment and shipment(s) states, and save
-      recalculator.update_payment_state
+      recalculator.recalculate_payment_state
       shipments.each do |shipment|
         shipment.update_state
         shipment.finalize!

core/app/models/spree/order_updater.rb

@@ -22,7 +22,7 @@ def recalculate
         update_shipment_amounts
         update_totals
         if order.completed?
-          update_payment_state
+          recalculate_payment_state
           update_shipments
           recalculate_shipment_state
         end
@@ -53,7 +53,7 @@ def recalculate_shipment_state
     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:
+    # Recalculates the +payment_state+ attribute according to the following logic:
     #
     # paid          when +payment_total+ is equal to +total+
     # balance_due   when +payment_total+ is less than +total+
@@ -62,13 +62,15 @@ def recalculate_shipment_state
     # void          when the order has been canceled and the payment total is 0
     #
     # The +payment_state+ value helps with reporting, etc. since it provides a quick and easy way to locate Orders needing attention.
-    def update_payment_state
+    def recalculate_payment_state
       log_state_change('payment') do
         order.payment_state = determine_payment_state
       end
 
       order.payment_state
     end
+    alias_method :update_payment_state, :recalculate_payment_state
+    deprecate update_payment_state: :recalculate_payment_state, deprecator: Spree.deprecator
 
     private
 

core/spec/models/spree/order/payment_spec.rb

@@ -28,7 +28,7 @@ module Spree
 
         it 'processes only new payments' do
           order.process_payments!
-          updater.update_payment_state
+          updater.recalculate_payment_state
 
           expect(order.payment_state).to eq('balance_due')
           expect(order.payment_total).to eq(50)
@@ -43,7 +43,7 @@ module Spree
 
         it 'processes all checkout payments' do
           order.process_payments!
-          updater.update_payment_state
+          updater.recalculate_payment_state
 
           expect(order.payment_state).to eq('paid')
           expect(order.payment_total).to eq(100)
@@ -57,7 +57,7 @@ module Spree
 
           it 'does not go over total for order' do
             order.process_payments!
-            updater.update_payment_state
+            updater.recalculate_payment_state
 
             expect(order.payment_state).to eq('paid')
             expect(order.payment_total).to eq(100)

core/spec/models/spree/order_updater_spec.rb

@@ -314,7 +314,7 @@ module Spree
       it "logs a state change for the payment" do
         create :payment, order:, state: "processing"
 
-        expect { updater.update_payment_state }
+        expect { updater.recalculate_payment_state }
           .to enqueue_job(Spree::StateChangeTrackingJob)
           .with(order, nil, "paid", a_kind_of(Time), "payment")
           .once
@@ -330,7 +330,7 @@ module Spree
           order.total = 1
           order.payment_total = 0
 
-          updater.update_payment_state
+          updater.recalculate_payment_state
           expect(order.payment_state).to eq('failed')
         end
       end
@@ -342,7 +342,7 @@ module Spree
           order.payment_total = 0
 
           expect {
-            updater.update_payment_state
+            updater.recalculate_payment_state
           }.to change { order.payment_state }.to 'paid'
         end
       end
@@ -353,7 +353,7 @@ module Spree
           order.total = 1
 
           expect {
-            updater.update_payment_state
+            updater.recalculate_payment_state
           }.to change { order.payment_state }.to 'credit_owed'
         end
       end
@@ -364,7 +364,7 @@ module Spree
           order.total = 2
 
           expect {
-            updater.update_payment_state
+            updater.recalculate_payment_state
           }.to change { order.payment_state }.to 'balance_due'
         end
       end
@@ -375,7 +375,7 @@ module Spree
           order.total = 30
 
           expect {
-            updater.update_payment_state
+            updater.recalculate_payment_state
           }.to change { order.payment_state }.to 'paid'
         end
       end
@@ -390,7 +390,7 @@ module Spree
             order.payment_total = 0
             order.total = 30
             expect {
-              updater.update_payment_state
+              updater.recalculate_payment_state
             }.to change { order.payment_state }.to 'void'
           end
         end
@@ -401,7 +401,7 @@ module Spree
             order.total = 30
             create(:payment, order:, state: 'completed', amount: 30)
             expect {
-              updater.update_payment_state
+              updater.recalculate_payment_state
             }.to change { order.payment_state }.to 'credit_owed'
           end
         end
@@ -411,7 +411,7 @@ module Spree
             order.payment_total = 0
             order.total = 30
             expect {
-              updater.update_payment_state
+              updater.recalculate_payment_state
             }.to change { order.payment_state }.to 'void'
           end
         end
@@ -422,7 +422,7 @@ module Spree
       before { allow(order).to receive_messages completed?: true }
 
       it "updates payment state" do
-        expect(updater).to receive(:update_payment_state)
+        expect(updater).to receive(:recalculate_payment_state)
         updater.recalculate
       end
 
@@ -451,7 +451,7 @@ module Spree
       before { allow(order).to receive_messages completed?: false }
 
       it "doesnt update payment state" do
-        expect(updater).not_to receive(:update_payment_state)
+        expect(updater).not_to receive(:recalculate_payment_state)
         updater.recalculate
       end
 

core/spec/models/spree/payment_spec.rb

@@ -744,7 +744,7 @@
       before { allow(order).to receive_messages completed?: true }
 
       it "updates payment_state and shipments" do
-        expect(order.recalculator).to receive(:update_payment_state)
+        expect(order.recalculator).to receive(:recalculate_payment_state)
         expect(order.recalculator).to receive(:recalculate_shipment_state)
         Spree::Payment.create!(amount: 100, order:, payment_method:)
       end