[Spree Upgrade] Subs - Extend Order cleanly for subscriptions

app/models/extensions/order_subscriptions_extensions.rb

@@ -0,0 +1,14 @@
+# Used to prevent payments on subscriptions from being processed in the normal way.
+# Payments are skipped until after the order cycle has closed.
+module OrderSubscriptionsExtensions
+  # Override Spree method.
+  def payment_required?
+    super && !skip_payment_for_subscription?
+  end
+
+  private
+
+  def skip_payment_for_subscription?
+    subscription.present? && order_cycle.orders_close_at.andand > Time.zone.now
+  end
+end

app/models/spree/order_decorator.rb

@@ -1,3 +1,4 @@
+require 'extensions/order_subscriptions_extensions'
 require 'open_food_network/enterprise_fee_calculator'
 require 'open_food_network/distribution_change_validator'
 require 'open_food_network/feature_toggle'
@@ -8,6 +9,8 @@
 end
 
 Spree::Order.class_eval do
+  prepend OrderSubscriptionsExtensions
+
   belongs_to :order_cycle
   belongs_to :distributor, class_name: 'Enterprise'
   belongs_to :customer
@@ -347,13 +350,6 @@ def process_payments!
     errors.add(:base, e.message) and return result
   end
 
-  # Override or Spree method. Used to prevent payments on subscriptions from being processed in the normal way.
-  # ie. they are 'hidden' from processing logic until after the order cycle has closed.
-  def pending_payments
-    return [] if subscription.present? && order_cycle.orders_close_at.andand > Time.zone.now
-    payments.select {|p| p.state == "checkout"} # Original definition
-  end
-
   private
 
   def shipping_address_from_distributor

spec/jobs/subscription_confirm_job_spec.rb

@@ -127,6 +127,7 @@
       before do
         allow(order).to receive(:payment_total) { 0 }
         allow(order).to receive(:total) { 10 }
+        allow(order).to receive(:payment_required?) { true }
         allow(order).to receive(:pending_payments) { [payment] }
       end
 

spec/models/spree/order_spec.rb

@@ -818,13 +818,22 @@
     end
   end
 
-  describe "finding pending_payments" do
-    let!(:order) { create(:order ) }
-    let!(:payment) { create(:payment, order: order, state: 'checkout') }
+  describe "payments" do
+    let(:payment_method) { create(:payment_method) }
+    let(:shipping_method) { create(:shipping_method) }
+    let(:order) { create(:order_with_totals) }
 
     context "when the order is not a subscription" do
-      it "returns the payments on the order" do
-        expect(order.reload.pending_payments).to eq [payment]
+      it "it requires a payment" do
+        expect(order.payment_required?).to be true
+      end
+
+      it "advances to payment state" do
+        advance_to_delivery_state(order)
+
+        order.next!
+
+        expect(order.state).to eq "payment"
       end
     end
 
@@ -835,27 +844,45 @@
       context "and order_cycle has no order_close_at set" do
         before { order.order_cycle.update_attributes(orders_close_at: nil) }
 
-        it "returns the payments on the order" do
-          expect(order.reload.pending_payments).to eq [payment]
+        it "requires a payment" do
+          expect(order.payment_required?).to be true
         end
       end
 
       context "and the order_cycle has closed" do
         before { order.order_cycle.update_attributes(orders_close_at: 5.minutes.ago) }
 
         it "returns the payments on the order" do
-          expect(order.reload.pending_payments).to eq [payment]
+          expect(order.payment_required?).to be true
         end
       end
 
       context "and the order_cycle has not yet closed" do
         before { order.order_cycle.update_attributes(orders_close_at: 5.minutes.from_now) }
 
         it "returns an empty array" do
-          expect(order.reload.pending_payments).to eq []
+          expect(order.payment_required?).to be false
+        end
+
+        it "skips the payment state" do
+          advance_to_delivery_state(order)
+
+          order.next!
+
+          expect(order.state).to eq "complete"
         end
       end
     end
+
+    def advance_to_delivery_state(order)
+      # advance to address state
+      order.shipping_method = shipping_method
+      order.next!
+
+      # advance to delivery state
+      create(:payment, order: order, payment_method: payment_method)
+      order.next!
+    end
   end
 
   describe '#restart_checkout!' do