solidus_core 2.3.1 → 2.4.0.beta1

data/app/models/spree/order/checkout.rb

@@ -98,7 +98,7 @@ module Spree
               before_transition to: :delivery, do: :ensure_shipping_address
               before_transition to: :delivery, do: :create_proposed_shipments
               before_transition to: :delivery, do: :ensure_available_shipping_rates
-              before_transition from: :delivery, do: :apply_free_shipping_promotions
+              before_transition from: :delivery, do: :apply_shipping_promotions
             end
 
             before_transition to: :resumed, do: :ensure_line_item_variants_are_not_deleted
@@ -120,7 +120,7 @@ module Spree
             after_transition to: :canceled, do: :after_cancel
 
             after_transition from: any - :cart, to: any - [:confirm, :complete] do |order|
-              order.update!
+              order.recalculate
             end
 
             after_transition do |order, transition|

data/app/models/spree/order.rb

@@ -185,15 +185,22 @@ module Spree
       line_items.map(&:amount).sum
     end
 
-    # Sum of all line item amounts pre-tax
-    def pre_tax_item_amount
-      line_items.to_a.sum(&:pre_tax_amount)
-    end
-
     # Sum of all line item amounts after promotions, before added tax
     def discounted_item_amount
       line_items.to_a.sum(&:discounted_amount)
     end
+    deprecate discounted_item_amount: :item_total_before_tax, deprecator: Spree::Deprecation
+
+    def item_total_before_tax
+      line_items.to_a.sum(&:total_before_tax)
+    end
+
+    # Sum of all line item amounts pre-tax
+    def item_total_excluding_vat
+      line_items.to_a.sum(&:total_excluding_vat)
+    end
+    alias pre_tax_item_amount item_total_excluding_vat
+    deprecate pre_tax_item_amount: :item_total_excluding_vat, deprecator: Spree::Deprecation
 
     def currency
       self[:currency] || Spree::Config[:currency]
@@ -233,14 +240,6 @@ module Spree
       shipments.any?(&:backordered?)
     end
 
-    # Returns the relevant zone (if any) to be used for taxation purposes.
-    # Uses default tax zone unless there is a specific match
-    def tax_zone
-      Spree::Zone.match(tax_address) || Spree::Zone.default_tax
-    end
-    deprecate tax_zone: "Please use Spree::Order#tax_address instead.",
-              deprecator: Spree::Deprecation
-
     # Returns the address for taxation based on configuration
     def tax_address
       if Spree::Config[:tax_using_ship_address]
@@ -254,10 +253,19 @@ module Spree
       @updater ||= Spree::OrderUpdater.new(self)
     end
 
-    def update!
+    def recalculate
       updater.update
     end
 
+    def update!(*args)
+      if args.empty?
+        Spree::Deprecation.warn "Calling order.update! with no arguments as a way to invoke the OrderUpdater is deprecated, since it conflicts with AR::Base#update! Please use order.recalculate instead"
+        recalculate
+      else
+        super
+      end
+    end
+
     def assign_billing_to_shipping_address
       self.ship_address = bill_address if bill_address
       true
@@ -407,7 +415,7 @@ module Spree
       # update payment and shipment(s) states, and save
       updater.update_payment_state
       shipments.each do |shipment|
-        shipment.update!(self)
+        shipment.update_state
         shipment.finalize!
       end
 
@@ -421,7 +429,7 @@ module Spree
     end
 
     def fulfill!
-      shipments.each { |shipment| shipment.update!(self) if shipment.persisted? }
+      shipments.each { |shipment| shipment.update_state if shipment.persisted? }
       updater.update_shipment_state
       save!
     end
@@ -471,7 +479,7 @@ module Spree
       shipments.destroy_all
       order_promotions.destroy_all
 
-      update!
+      recalculate
     end
 
     alias_method :has_step?, :has_checkout_step?
@@ -527,10 +535,11 @@ module Spree
       end
     end
 
-    def apply_free_shipping_promotions
-      Spree::PromotionHandler::FreeShipping.new(self).activate
-      update!
+    def apply_shipping_promotions
+      Spree::PromotionHandler::Shipping.new(self).activate
+      recalculate
     end
+    deprecate apply_free_shipping_promotions: :apply_shipping_promotions, deprecator: Spree::Deprecation
 
     # Clean shipments and make order back to address state
     #
@@ -565,7 +574,7 @@ module Spree
 
     def set_shipments_cost
       shipments.each(&:update_amounts)
-      update!
+      recalculate
     end
     deprecate set_shipments_cost: :update!, deprecator: Spree::Deprecation
 
@@ -611,7 +620,7 @@ module Spree
 
     def add_store_credit_payments
       return if user.nil?
-      return if payments.store_credits.checkout.empty? && user.total_available_store_credit.zero?
+      return if payments.store_credits.checkout.empty? && user.available_store_credit_total(currency: currency).zero?
 
       payments.store_credits.checkout.each(&:invalidate!)
 
@@ -622,10 +631,12 @@ module Spree
 
       remaining_total = outstanding_balance - authorized_total
 
-      if user.store_credits.any?
+      matching_store_credits = user.store_credits.where(currency: currency)
+
+      if matching_store_credits.any?
         payment_method = Spree::PaymentMethod::StoreCredit.first
 
-        user.store_credits.order_by_priority.each do |credit|
+        matching_store_credits.order_by_priority.each do |credit|
           break if remaining_total.zero?
           next if credit.amount_remaining.zero?
 
@@ -648,20 +659,20 @@ module Spree
 
       payments.reset
 
-      if payments.where(state: %w(checkout pending)).sum(:amount) != total
+      if payments.where(state: %w(checkout pending completed)).sum(:amount) != total
         errors.add(:base, Spree.t("store_credit.errors.unable_to_fund")) && (return false)
       end
     end
 
     def covered_by_store_credit?
       return false unless user
-      user.total_available_store_credit >= total
+      user.available_store_credit_total(currency: currency) >= total
     end
     alias_method :covered_by_store_credit, :covered_by_store_credit?
 
     def total_available_store_credit
       return 0.0 unless user
-      user.total_available_store_credit
+      user.available_store_credit_total(currency: currency)
     end
 
     def order_total_after_store_credit
@@ -672,7 +683,7 @@ module Spree
       if can_complete? || complete?
         payments.store_credits.valid.sum(:amount)
       else
-        [total, (user.try(:total_available_store_credit) || 0.0)].min
+        [total, (user.try(:available_store_credit_total, currency: currency) || 0.0)].min
       end
     end
 
@@ -748,23 +759,6 @@ module Spree
       end
     end
 
-    def payments_attributes=(attributes)
-      validate_payments_attributes(attributes)
-      super(attributes)
-    end
-
-    def validate_payments_attributes(attributes)
-      attributes = Array(attributes)
-      # Ensure the payment methods specified are allowed for this user
-      payment_methods = Spree::PaymentMethod.where(id: available_payment_methods)
-      attributes.each do |payment_attributes|
-        payment_method_id = payment_attributes[:payment_method_id]
-
-        # raise RecordNotFound unless it is an allowed payment method
-        payment_methods.find(payment_method_id) if payment_method_id
-      end
-    end
-
     private
 
     def process_payments_before_complete
@@ -800,6 +794,7 @@ module Spree
         @updating_params[:order][:payments_attributes].first[:amount] = total
       end
     end
+    deprecate update_params_payment_source: :set_payment_parameters_amount, deprecator: Spree::Deprecation
 
     def associate_store
       self.store ||= Spree::Store.default
@@ -829,7 +824,7 @@ module Spree
       end
       if adjustment_changed
         restart_checkout_flow
-        update!
+        recalculate
         errors.add(:base, Spree.t(:promotion_total_changed_before_complete))
       end
       errors.empty?
@@ -861,7 +856,7 @@ module Spree
       payments.store_credits.pending.each(&:void_transaction!)
 
       send_cancel_email
-      update!
+      recalculate
     end
 
     def send_cancel_email

data/app/models/spree/order_cancellations.rb

@@ -41,7 +41,7 @@ class Spree::OrderCancellations
         Spree::OrderMailer.inventory_cancellation_email(@order, inventory_units.to_a).deliver_later if Spree::OrderCancellations.send_cancellation_mailer
       end
 
-      @order.update!
+      @order.recalculate
 
       if short_ship_tax_notifier
         short_ship_tax_notifier.call(unit_cancels)

data/app/models/spree/order_capturing.rb

@@ -11,6 +11,8 @@ class Spree::OrderCapturing
   self.failure_handler = ->(failures) { raise Spree::OrderCapturingFailures.new(failures.to_json) }
 
   def initialize(order, sorted_payment_method_classes = nil)
+    Spree::Deprecation.warn "Spree::OrderCapturing is deprecated and will be removed without replacement. " \
+      "Please implement your own automated capturing logic in your store."
     @order = order
     @sorted_payment_method_classes = sorted_payment_method_classes || Spree::OrderCapturing.sorted_payment_method_classes
   end

data/app/models/spree/order_shipping.rb

@@ -73,7 +73,7 @@ class Spree::OrderShipping
 
     send_shipment_emails(carton) if stock_location.fulfillable? && !suppress_mailer # e.g. digital gift cards that aren't actually shipped
     fulfill_order_stock_locations(stock_location)
-    @order.update!
+    @order.recalculate
 
     carton
   end

data/app/models/spree/order_update_attributes.rb

@@ -14,8 +14,6 @@ module Spree
     # Assign the attributes to the order and save the order
     # @return true if saved, otherwise false and errors will be set on the order
     def apply
-      order.validate_payments_attributes(@payments_attributes)
-
       assign_order_attributes
       assign_payments_attributes
 

data/app/models/spree/order_updater.rb

@@ -141,7 +141,7 @@ module Spree
     # give each of the shipments a chance to update themselves
     def update_shipments
       shipments.each do |shipment|
-        shipment.update!(order)
+        shipment.update_state
       end
     end
 
@@ -208,7 +208,7 @@ module Spree
       [*line_items, *shipments].each do |item|
         promotion_adjustments = item.adjustments.select(&:promotion?)
 
-        promotion_adjustments.each(&:update!)
+        promotion_adjustments.each(&:recalculate)
         Spree::Config.promotion_chooser_class.new(promotion_adjustments).update
 
         item.promo_total = promotion_adjustments.select(&:eligible?).sum(&:amount)
@@ -221,7 +221,7 @@ module Spree
     # line items and/or shipments.
     def update_order_promotions
       promotion_adjustments = order.adjustments.select(&:promotion?)
-      promotion_adjustments.each(&:update!)
+      promotion_adjustments.each(&:recalculate)
       Spree::Config.promotion_chooser_class.new(promotion_adjustments).update
     end
 
@@ -244,7 +244,7 @@ module Spree
 
     def update_cancellations
       line_items.each do |line_item|
-        line_item.adjustments.select(&:cancellation?).each(&:update!)
+        line_item.adjustments.select(&:cancellation?).each(&:recalculate)
       end
     end
 

data/app/models/spree/payment/cancellation.rb

@@ -0,0 +1,60 @@
+module Spree
+  class Payment
+    # Payment cancellation handler
+    #
+    # Cancels a payment by trying to void first and if that fails
+    # creating a refund about the full amount instead.
+    #
+    class Cancellation
+      DEFAULT_REASON = 'Order canceled'.freeze
+
+      attr_reader :reason
+
+      # @param reason [String] (DEFAULT_REASON) -
+      #   The reason used to create the Spree::RefundReason
+      def initialize(reason: DEFAULT_REASON)
+        @reason = reason
+      end
+
+      # Cancels a payment
+      #
+      # Tries to void the payment by asking the payment method to try a void,
+      # if that fails create a refund about the allowed credit amount instead.
+      #
+      # @param payment [Spree::Payment] - the payment that should be canceled
+      #
+      def cancel(payment)
+        # For payment methods already implemeting `try_void`
+        if try_void_available?(payment.payment_method)
+          if response = payment.payment_method.try_void(payment)
+            payment.send(:handle_void_response, response)
+          else
+            payment.refunds.create!(amount: payment.credit_allowed, reason: refund_reason)
+          end
+        else
+          # For payment methods not yet implemeting `try_void`
+          deprecated_behavior(payment)
+        end
+      end
+
+      private
+
+      def refund_reason
+        Spree::RefundReason.where(name: reason).first_or_create
+      end
+
+      def try_void_available?(payment_method)
+        payment_method.respond_to?(:try_void) &&
+          payment_method.method(:try_void).owner != Spree::PaymentMethod
+      end
+
+      def deprecated_behavior(payment)
+        Spree::Deprecation.warn "#{payment.payment_method.class.name}#cancel is deprecated and will be removed. " \
+          'Please implement a `try_void` method instead that returns a response object if void succeeds ' \
+          'or `false|nil` if not. Solidus will refund the payment then.'
+        response = payment.payment_method.cancel(payment.response_code)
+        payment.send(:handle_void_response, response)
+      end
+    end
+  end
+end

data/app/models/spree/payment/processing.rb

@@ -79,8 +79,7 @@ module Spree
       end
 
       def cancel!
-        response = payment_method.cancel(response_code)
-        handle_void_response(response)
+        Spree::Config.payment_canceller.cancel(self)
       end
 
       def gateway_options

data/app/models/spree/payment.rb

@@ -40,7 +40,6 @@ module Spree
 
     validates :amount, numericality: true
     validates :source, presence: true, if: :source_required?
-    validates :payment_method, presence: true
 
     default_scope -> { order(:created_at) }
 
@@ -231,17 +230,15 @@ module Spree
 
     def invalidate_old_payments
       if !store_credit? && !['invalid', 'failed'].include?(state)
-        order.payments.select do |payment|
-          payment.state == 'checkout' &&
-            payment.payment_method_id == payment_method.try!(:id) &&
-            payment.id != id
-        end.each(&:invalidate!)
+        order.payments.select { |payment|
+          payment.state == 'checkout' && !payment.store_credit? && payment.id != id
+        }.each(&:invalidate!)
       end
     end
 
     def update_order
       if order.completed? || completed? || void?
-        order.update!
+        order.recalculate
       end
     end
 

data/app/models/spree/payment_method/bogus_credit_card.rb

@@ -55,7 +55,8 @@ module Spree
       ActiveMerchant::Billing::Response.new(true, 'Bogus Gateway: Forced success', {}, test: true, authorization: '12345')
     end
 
-    def cancel(_response_code)
+    # @see Spree::PaymentMethod#try_void
+    def try_void(_payment)
       ActiveMerchant::Billing::Response.new(true, 'Bogus Gateway: Forced success', {}, test: true, authorization: '12345')
     end
 

data/app/models/spree/payment_method/check.rb

@@ -18,11 +18,10 @@ module Spree
       simulated_successful_billing_response
     end
 
-    def cancel(*); end
-
     def void(*)
       simulated_successful_billing_response
     end
+    alias_method :try_void, :void
 
     def credit(*)
       simulated_successful_billing_response

data/app/models/spree/payment_method/store_credit.rb

@@ -64,15 +64,16 @@ module Spree
       handle_action(action, :credit, auth_code)
     end
 
-    def cancel(auth_code)
+    # @see Spree::PaymentMethod#try_void
+    def try_void(payment)
+      auth_code = payment.response_code
       store_credit_event = auth_or_capture_event(auth_code)
       store_credit = store_credit_event.try(:store_credit)
 
       if store_credit_event.nil? || store_credit.nil?
         ActiveMerchant::Billing::Response.new(false, '', {}, {})
       elsif store_credit_event.capture_action?
-        amount_in_cents = (store_credit_event.amount * 100).round
-        credit(amount_in_cents, auth_code)
+        false # payment#cancel! handles the refund
       elsif store_credit_event.authorization_action?
         void(auth_code)
       else