spree_core 4.1.1 → 4.5.0

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

@@ -83,6 +83,11 @@ module Spree
                     order.process_payments!
                   end
                 end
+
+                before_transition to: :complete do |order|
+                  order.create_digital_links if order.some_digital?
+                end
+
                 after_transition to: :complete, do: :persist_user_credit_card
                 before_transition to: :payment, do: :set_shipments_cost
                 before_transition to: :payment, do: :create_tax_charge!
@@ -107,6 +112,7 @@ module Spree
 
               before_transition to: :resumed, do: :ensure_line_item_variants_are_not_discontinued
               before_transition to: :resumed, do: :ensure_line_items_are_in_stock
+              before_transition to: :resumed, do: proc { |order| order.state_machine_resumed = true }
 
               after_transition to: :complete, do: :finalize!
               after_transition to: :resumed, do: :after_resume
@@ -220,7 +226,7 @@ module Spree
             @updating_params = params
             run_callbacks :updating_from_params do
               # Set existing card after setting permitted parameters because
-              # rails would slice parameters containg ruby objects, apparently
+              # rails would slice parameters containing ruby objects, apparently
               existing_card_id = @updating_params[:order] ? @updating_params[:order].delete(:existing_card) : nil
 
               attributes = if @updating_params[:order]

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

@@ -1,7 +1,7 @@
 module Spree
   class Order < Spree::Base
     module CurrencyUpdater
-      extend ActiveSupport::Concern
+      extend ActiveSupport::Concern # FIXME: this module is not required to be a concern
 
       included do
         def homogenize_line_item_currencies

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

@@ -0,0 +1,33 @@
+module Spree
+  class Order < Spree::Base
+    module Digital
+      def digital?
+        if line_items.empty?
+          false
+        else
+          line_items.all?(&:digital?)
+        end
+      end
+
+      def some_digital?
+        line_items.any?(&:digital?)
+      end
+
+      def digital_line_items
+        line_items.select(&:digital?)
+      end
+
+      def digital_links
+        digital_line_items.map(&:digital_links).flatten
+      end
+
+      def create_digital_links
+        digital_line_items.each do |line_item|
+          line_item.variant.digitals.each do |digital|
+            line_item.digital_links.create!(digital: digital)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Spree
+  class Order < Spree::Base
+    module Emails
+      extend ActiveSupport::Concern
+
+      def deliver_order_confirmation_email
+        # you can overwrite this method in your application / extension to send out the confirmation email
+        # or use `spree_emails` gem
+        # YourEmailVendor.deliver_order_confirmation_email(id) # `id` = ID of the Order being sent, you can also pass the entire Order object using `self`
+        # update_column(:confirmation_delivered, true) # if you would like to mark that the email was sent
+      end
+
+      # If you would like to also send confirmation email to store owner(s)
+      def deliver_store_owner_order_notification_email?
+        false
+      end
+
+      def deliver_store_owner_order_notification_email
+        # you can overwrite this method in your application / extension to send out the confirmation email
+        # or use `spree_emails` gem
+        # YourEmailVendor.deliver_store_owner_notification_email(id) # `id` = ID of the Order being sent, you can also pass the entire Order object using `self`
+        # update_column(:store_owner_notification_delivered, true) # if you would like to mark that the email was sent
+      end
+
+      def send_cancel_email
+        # you can overwrite this method in your application / extension to send out the confirmation email
+        # or use `spree_emails` gem
+        # YourEmailVendor.deliver_cancel_email(id) # `id` = ID of the Order being sent, you can also pass the entire Order object using `self`
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module Spree
   class Order < Spree::Base
     module Payments
-      extend ActiveSupport::Concern
+      extend ActiveSupport::Concern # FIXME: this module is not required to be a concern
       included do
         # processes any pending payments and must return a boolean as it's
         # return value is used by the checkout state_machine to determine
@@ -32,7 +32,7 @@ module Spree
         end
 
         def pending_payments
-          payments.select(&:pending?)
+          payments.pending
         end
 
         def unprocessed_payments
@@ -52,7 +52,7 @@ module Spree
 
             payment.public_send(method)
 
-            if payment.completed? && payment_total != total
+            if payment.completed? && payment_total != total_without_pending_store_credits
               self.payment_total += payment.amount
             end
           end
@@ -60,6 +60,14 @@ module Spree
           result = !!Spree::Config[:allow_checkout_on_gateway_error]
           errors.add(:base, e.message) && (return result)
         end
+
+        # Pending store credits are not added to `self.payment_total`.
+        # It can cause a situation where the amount of the credit card payment reduced with store credits
+        # may be added twice to `self.payment_total` causing wrong `order.outstanding_balance`
+        # calculations and thus an incorrect payment state.
+        def total_without_pending_store_credits
+          total - payments.map { |p| p.amount if p.source.is_a?(Spree::StoreCredit) && p.pending? }.sum(&:to_f)
+        end
       end
     end
   end

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

@@ -11,7 +11,7 @@ module Spree
       def total_available_store_credit
         return 0.0 unless user
 
-        user.total_available_store_credit
+        user.total_available_store_credit(currency, store)
       end
 
       def could_use_store_credit?

data/app/models/spree/order.rb

@@ -1,7 +1,9 @@
 require_dependency 'spree/order/checkout'
 require_dependency 'spree/order/currency_updater'
+require_dependency 'spree/order/digital'
 require_dependency 'spree/order/payments'
 require_dependency 'spree/order/store_credit'
+require_dependency 'spree/order/emails'
 
 module Spree
   class Order < Spree::Base
@@ -10,19 +12,36 @@ module Spree
 
     include Spree::Order::Checkout
     include Spree::Order::CurrencyUpdater
+    include Spree::Order::Digital
     include Spree::Order::Payments
     include Spree::Order::StoreCredit
     include Spree::Order::AddressBook
+    include Spree::Order::Emails
     include Spree::Core::NumberGenerator.new(prefix: 'R')
     include Spree::Core::TokenGenerator
 
+    include NumberIdentifier
     include NumberAsParam
+    include SingleStoreResource
+    include MemoizedData
+    include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::Security::Orders)
+      include Spree::Security::Orders
+    end
+    if defined?(Spree::VendorConcern)
+      include Spree::VendorConcern
+    end
+
+    MEMOIZED_METHODS = %w(tax_zone)
 
     extend Spree::DisplayMoney
     money_methods :outstanding_balance, :item_total,           :adjustment_total,
                   :included_tax_total,  :additional_tax_total, :tax_total,
                   :shipment_total,      :promo_total,          :total,
-                  :cart_promo_total
+                  :cart_promo_total,    :pre_tax_item_amount,  :pre_tax_total
 
     alias display_ship_total display_shipment_total
     alias_attribute :ship_total, :shipment_total
@@ -48,26 +67,34 @@ module Spree
 
     checkout_flow do
       go_to_state :address
-      go_to_state :delivery
+      go_to_state :delivery, if: ->(order) { order.delivery_required? }
       go_to_state :payment, if: ->(order) { order.payment? || order.payment_required? }
       go_to_state :confirm, if: ->(order) { order.confirmation_required? }
       go_to_state :complete
       remove_transition from: :delivery, to: :confirm, unless: ->(order) { order.confirmation_required? }
     end
 
-    self.whitelisted_ransackable_associations = %w[shipments user promotions bill_address ship_address line_items store]
-    self.whitelisted_ransackable_attributes = %w[completed_at email number state payment_state shipment_state total considered_risky channel]
+    self.whitelisted_ransackable_associations = %w[shipments user created_by approver canceler promotions bill_address ship_address line_items store]
+    self.whitelisted_ransackable_attributes = %w[
+      completed_at email number state payment_state shipment_state
+      total item_total considered_risky channel
+    ]
 
     attr_reader :coupon_code
     attr_accessor :temporary_address, :temporary_credit_card
 
+    attribute :state_machine_resumed, :boolean
+
     if Spree.user_class
-      belongs_to :user, class_name: Spree.user_class.to_s, optional: true
-      belongs_to :created_by, class_name: Spree.user_class.to_s, optional: true
-      belongs_to :approver, class_name: Spree.user_class.to_s, optional: true
-      belongs_to :canceler, class_name: Spree.user_class.to_s, optional: true
+      belongs_to :user, class_name: "::#{Spree.user_class}", optional: true
     else
       belongs_to :user, optional: true
+    end
+    if Spree.admin_user_class
+      belongs_to :created_by, class_name: Spree.admin_user_class.to_s, optional: true
+      belongs_to :approver, class_name: Spree.admin_user_class.to_s, optional: true
+      belongs_to :canceler, class_name: Spree.admin_user_class.to_s, optional: true
+    else
       belongs_to :created_by, optional: true
       belongs_to :approver, optional: true
       belongs_to :canceler, optional: true
@@ -93,6 +120,7 @@ module Spree
     has_many :reimbursements, inverse_of: :order, class_name: 'Spree::Reimbursement'
     has_many :line_item_adjustments, through: :line_items, source: :adjustments
     has_many :inventory_units, inverse_of: :order, class_name: 'Spree::InventoryUnit'
+    has_many :return_items, through: :inventory_units, class_name: 'Spree::ReturnItem'
     has_many :variants, through: :line_items
     has_many :products, through: :variants
     has_many :refunds, through: :payments
@@ -121,15 +149,17 @@ module Spree
     # Needs to happen before save_permalink is called
     before_validation :ensure_store_presence
     before_validation :ensure_currency_presence
+
     before_validation :clone_billing_address, if: :use_billing?
     attr_accessor :use_billing
 
     before_create :create_token
     before_create :link_by_email
-    before_update :homogenize_line_item_currencies, if: :currency_changed?
+    before_update :ensure_updated_shipments, :homogenize_line_item_currencies, if: :currency_changed?
 
     with_options presence: true do
-      validates :number, length: { maximum: 32, allow_blank: true }, uniqueness: { allow_blank: true, case_sensitive: false }
+      # we want to have this case_sentive: true as changing it to false causes all SQL to use LOWER(slug)
+      # which is very costly and slow on large set of records
       validates :email, length: { maximum: 254, allow_blank: true }, email: { allow_blank: true }, if: :require_email
       validates :item_count, numericality: { greater_than_or_equal_to: 0, less_than: 2**31, only_integer: true, allow_blank: true }
       validates :store
@@ -157,6 +187,9 @@ module Spree
     scope :completed_between, ->(start_date, end_date) { where(completed_at: start_date..end_date) }
     scope :complete, -> { where.not(completed_at: nil) }
     scope :incomplete, -> { where(completed_at: nil) }
+    scope :not_canceled, -> { where.not(state: 'canceled') }
+    scope :with_deleted_bill_address, -> { joins(:bill_address).where.not(Address.table_name => { deleted_at: nil }) }
+    scope :with_deleted_ship_address, -> { joins(:ship_address).where.not(Address.table_name => { deleted_at: nil }) }
 
     # shows completed orders first, by their completed_at date, then uncompleted orders by their created_at
     scope :reverse_chronological, -> { order(Arel.sql('spree_orders.completed_at IS NULL'), completed_at: :desc, created_at: :desc) }
@@ -167,14 +200,19 @@ module Spree
       update_hooks.add(hook)
     end
 
-    # For compatiblity with Calculator::PriceSack
+    # For compatibility with Calculator::PriceSack
     def amount
       line_items.inject(0.0) { |sum, li| sum + li.amount }
     end
 
     # Sum of all line item amounts pre-tax
     def pre_tax_item_amount
-      line_items.to_a.sum(&:pre_tax_amount)
+      line_items.sum(:pre_tax_amount)
+    end
+
+    # Sum of all line item and shipment pre-tax
+    def pre_tax_total
+      pre_tax_item_amount + shipments.sum(:pre_tax_amount)
     end
 
     def shipping_discount
@@ -193,6 +231,11 @@ module Spree
       line_items.exists?
     end
 
+    # Does this order require a physical delivery.
+    def delivery_required?
+      !digital?
+    end
+
     # Is this a free order in which case the payment step should be skipped
     def payment_required?
       total.to_f > 0.0
@@ -297,15 +340,15 @@ module Spree
     def outstanding_balance
       if canceled?
         -1 * payment_total
-      elsif refunds.exists?
-        # If refund has happened add it back to total to prevent balance_due payment state
-        # See: https://github.com/spree/spree/issues/6229 & https://github.com/spree/spree/issues/8136
-        total - (payment_total + refunds.sum(:amount))
       else
-        total - payment_total
+        total - (payment_total + reimbursement_paid_total)
       end
     end
 
+    def reimbursement_paid_total
+      reimbursements.sum(&:paid_amount)
+    end
+
     def outstanding_balance?
       outstanding_balance != 0
     end
@@ -320,6 +363,10 @@ module Spree
       complete? || resumed? || awaiting_return? || returned?
     end
 
+    def uneditable?
+      complete? || canceled? || returned?
+    end
+
     def credit_cards
       credit_card_ids = payments.from_credit_card.pluck(:source_id).uniq
       CreditCard.where(id: credit_card_ids)
@@ -350,6 +397,7 @@ module Spree
       touch :completed_at
 
       deliver_order_confirmation_email unless confirmation_delivered?
+      deliver_store_owner_order_notification_email if deliver_store_owner_order_notification_email?
 
       consider_risk
     end
@@ -360,17 +408,16 @@ module Spree
       save!
     end
 
-    def deliver_order_confirmation_email
-      OrderMailer.confirm_email(id).deliver_later
-      update_column(:confirmation_delivered, true)
-    end
-
     # Helper methods for checkout steps
     def paid?
-      payment_state == 'paid' || payment_state == 'credit_owed'
+      payments.valid.completed.size == payments.valid.size && payments.valid.sum(:amount) >= total
     end
 
     def available_payment_methods(store = nil)
+      if store.present?
+        ActiveSupport::Deprecation.warn('The `store` parameter is deprecated and will be removed in Spree 5. Order is already associated with Store')
+      end
+
       @available_payment_methods ||= collect_payment_methods(store)
     end
 
@@ -402,21 +449,15 @@ module Spree
     end
 
     def empty!
-      if completed?
-        raise Spree.t(:cannot_empty_completed_order)
-      else
-        line_items.destroy_all
-        updater.update_item_count
-        adjustments.destroy_all
-        shipments.destroy_all
-        state_changes.destroy_all
-        order_promotions.destroy_all
+      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+        `Order#empty!` is deprecated and will be removed in Spree 5.0.
+        Please use `Spree::Cart::Empty.call(order: order)` instead.
+      DEPRECATION
 
-        update_totals
-        persist_totals
-        restart_checkout_flow
-        self
-      end
+      raise Spree.t(:cannot_empty_completed_order) if completed?
+
+      result = Spree::Dependencies.cart_empty_service.constantize.call(order: self)
+      result.value
     end
 
     def has_step?(step)
@@ -459,6 +500,10 @@ module Spree
       %w(partial shipped).include?(shipment_state)
     end
 
+    def fully_shipped?
+      shipments.shipped.size == shipments.size
+    end
+
     def create_proposed_shipments
       all_adjustments.shipping.delete_all
 
@@ -554,6 +599,10 @@ module Spree
       !approved?
     end
 
+    def can_be_destroyed?
+      !completed? && payments.completed.empty?
+    end
+
     def consider_risk
       considered_risky! if is_risky? && !approved?
     end
@@ -566,11 +615,6 @@ module Spree
       update_column(:considered_risky, false)
     end
 
-    def reload(options = nil)
-      remove_instance_variable(:@tax_zone) if defined?(@tax_zone)
-      super
-    end
-
     def tax_total
       included_tax_total + additional_tax_total
     end
@@ -602,19 +646,16 @@ module Spree
       promotions.pluck(:code).compact.first
     end
 
-    def payments_attributes=(attributes)
-      validate_payments_attributes(attributes)
-      super(attributes)
-    end
-
     def validate_payments_attributes(attributes)
+      ActiveSupport::Deprecation.warn('`Order#validate_payments_attributes` is deprecated and will be removed in Spree 5')
+
       # Ensure the payment methods specified are allowed for this user
-      payment_methods = Spree::PaymentMethod.where(id: available_payment_methods.map(&:id))
+      payment_method_ids = available_payment_methods.map(&:id).map(&:to_s)
+
       attributes.each do |payment_attributes|
-        payment_method_id = payment_attributes[:payment_method_id]
+        payment_method_id = payment_attributes[:payment_method_id].to_s
 
-        # raise RecordNotFound unless it is an allowed payment method
-        payment_methods.find(payment_method_id) if payment_method_id
+        raise ActiveRecord::RecordNotFound unless payment_method_ids.include?(payment_method_id)
       end
     end
 
@@ -641,6 +682,13 @@ module Spree
         sum(:amount)
     end
 
+    def has_free_shipping?
+      shipment_adjustments.
+        joins(:promotion_action).
+        where(spree_adjustments: { eligible: true, source_type: 'Spree::PromotionAction' },
+              spree_promotion_actions: { type: 'Spree::Promotion::Actions::FreeShipping' }).exists?
+    end
+
     private
 
     def link_by_email
@@ -678,10 +726,6 @@ module Spree
       update_with_updater!
     end
 
-    def send_cancel_email
-      OrderMailer.cancel_email(id).deliver_later
-    end
-
     def after_resume
       shipments.each(&:resume!)
       consider_risk
@@ -692,7 +736,7 @@ module Spree
     end
 
     def ensure_currency_presence
-      self.currency ||= store.default_currency || Spree::Config[:currency]
+      self.currency ||= store.default_currency
     end
 
     def create_token
@@ -700,7 +744,12 @@ module Spree
     end
 
     def collect_payment_methods(store = nil)
-      PaymentMethod.available_on_front_end.select { |pm| pm.available_for_order?(self) && pm.available_for_store?(store) }
+      if store.present?
+        ActiveSupport::Deprecation.warn('The `store` parameter is deprecated and will be removed in Spree 5. Order is already associated with Store')
+      end
+      store ||= self.store
+
+      store.payment_methods.available_on_front_end.select { |pm| pm.available_for_order?(self) }
     end
 
     def credit_card_nil_payment?(attributes)

data/app/models/spree/order_inventory.rb

@@ -120,7 +120,7 @@ module Spree
       if order.completed?
         current_on_hand = shipment.stock_location.count_on_hand(variant)
 
-        if current_on_hand.negative? && current_on_hand.abs < removed_backordered
+        if current_on_hand&.negative? && current_on_hand.abs < removed_backordered
           shipment.stock_location.restock_backordered variant, current_on_hand.abs, shipment
         else
           shipment.stock_location.restock_backordered variant, removed_backordered, shipment

data/app/models/spree/order_merger.rb

@@ -54,7 +54,7 @@ module Spree
 
     # Change the error messages as you choose.
     def handle_error(line_item)
-      order.errors[:base] << line_item.errors.full_messages
+      order.errors.add(:base, line_item.errors.full_messages)
     end
 
     def persist_merge

data/app/models/spree/order_promotion.rb

@@ -3,7 +3,7 @@ module Spree
     belongs_to :order, class_name: 'Spree::Order'
     belongs_to :promotion, class_name: 'Spree::Promotion'
 
-    delegate :name, :description, :code, to: :promotion
+    delegate :name, :description, :code, :public_metadata, to: :promotion
     delegate :currency, to: :order
 
     extend Spree::DisplayMoney

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

@@ -72,7 +72,7 @@ module Spree
       end
 
       def cancel!
-        response = payment_method.cancel(response_code)
+        response = payment_method.cancel(response_code, self)
         handle_response(response, :void, :failure)
       end
 
@@ -152,6 +152,7 @@ module Spree
       def protect_from_connection_error
         yield
       rescue ActiveMerchant::ConnectionError => e
+        failure!
         gateway_error(e)
       end
 
@@ -163,8 +164,8 @@ module Spree
                else
                  error.to_s
                end
-        logger.error(Spree.t(:gateway_error))
-        logger.error("  #{error.to_yaml}")
+        Rails.logger.error(Spree.t(:gateway_error))
+        Rails.logger.error("  #{error.to_yaml}")
         raise Core::GatewayError, text
       end