solidus_core 2.9.6 → 2.11.0

data/app/models/spree/option_values_variant.rb

@@ -2,7 +2,7 @@
 
 module Spree
   class OptionValuesVariant < Spree::Base
-    belongs_to :variant
-    belongs_to :option_value
+    belongs_to :variant, optional: true
+    belongs_to :option_value, optional: true
   end
 end

data/app/models/spree/order.rb

@@ -23,10 +23,18 @@ module Spree
     ORDER_NUMBER_LETTERS = false
     ORDER_NUMBER_PREFIX  = 'R'
 
-    include Spree::Order::Checkout
+    include ::Spree::Config.state_machines.order
+
     include Spree::Order::Payments
 
-    class InsufficientStock < StandardError; end
+    class InsufficientStock < StandardError
+      attr_reader :items
+
+      def initialize(message = nil, items: {})
+        @items = items
+        super message
+      end
+    end
     class CannotRebuildShipments < StandardError; end
 
     extend Spree::DisplayMoney
@@ -42,8 +50,9 @@ module Spree
       go_to_state :confirm
     end
 
+    ransack_alias :bill_address_firstname_or_lastname, :bill_address_firstname_or_bill_address_lastname
     self.whitelisted_ransackable_associations = %w[shipments user order_promotions promotions bill_address ship_address line_items]
-    self.whitelisted_ransackable_attributes = %w[completed_at created_at email number state payment_state shipment_state total store_id]
+    self.whitelisted_ransackable_attributes = %w[bill_address_firstname_or_lastname completed_at created_at email number state payment_state shipment_state total store_id]
 
     attr_reader :coupon_code
     attr_accessor :temporary_address
@@ -55,15 +64,15 @@ module Spree
     deprecate :temporary_credit_card= => :temporary_payment_source=, deprecator: Spree::Deprecation
 
     # Customer info
-    belongs_to :user, class_name: Spree::UserClassHandle.new
-    belongs_to :bill_address, foreign_key: :bill_address_id, class_name: 'Spree::Address'
+    belongs_to :user, class_name: Spree::UserClassHandle.new, optional: true
+    belongs_to :bill_address, foreign_key: :bill_address_id, class_name: 'Spree::Address', optional: true
     alias_attribute :billing_address, :bill_address
 
-    belongs_to :ship_address, foreign_key: :ship_address_id, class_name: 'Spree::Address'
+    belongs_to :ship_address, foreign_key: :ship_address_id, class_name: 'Spree::Address', optional: true
     alias_attribute :shipping_address, :ship_address
     alias_attribute :ship_total, :shipment_total
 
-    belongs_to :store, class_name: 'Spree::Store'
+    belongs_to :store, class_name: 'Spree::Store', optional: true
 
     # Items
     has_many :line_items, -> { order(:created_at, :id) }, dependent: :destroy, inverse_of: :order
@@ -93,17 +102,20 @@ module Spree
 
     # Payments
     has_many :payments, dependent: :destroy, inverse_of: :order
+    has_many :valid_store_credit_payments, -> { store_credits.valid }, inverse_of: :order, class_name: 'Spree::Payment', foreign_key: :order_id
 
     # Returns
     has_many :return_authorizations, dependent: :destroy, inverse_of: :order
+    has_many :return_items, through: :inventory_units
+    has_many :customer_returns, through: :return_items
     has_many :reimbursements, inverse_of: :order
     has_many :refunds, through: :payments
 
     # Logging
     has_many :state_changes, as: :stateful
-    belongs_to :created_by, class_name: Spree::UserClassHandle.new
-    belongs_to :approver, class_name: Spree::UserClassHandle.new
-    belongs_to :canceler, class_name: Spree::UserClassHandle.new
+    belongs_to :created_by, class_name: Spree::UserClassHandle.new, optional: true
+    belongs_to :approver, class_name: Spree::UserClassHandle.new, optional: true
+    belongs_to :canceler, class_name: Spree::UserClassHandle.new, optional: true
 
     accepts_nested_attributes_for :line_items
     accepts_nested_attributes_for :bill_address
@@ -124,7 +136,7 @@ module Spree
     validates :email, presence: true, if: :require_email
     validates :email, 'spree/email' => true, allow_blank: true
     validates :guest_token, presence: { allow_nil: true }
-    validates :number, presence: true, uniqueness: { allow_blank: true }
+    validates :number, presence: true, uniqueness: { allow_blank: true, case_sensitive: true }
     validates :store_id, presence: true
 
     def self.find_by_param(value)
@@ -135,9 +147,10 @@ module Spree
       find_by! number: value
     end
 
-    delegate :firstname, :lastname, to: :bill_address, prefix: true, allow_nil: true
+    delegate :name, :firstname, :lastname, to: :bill_address, prefix: true, allow_nil: true
     alias_method :billing_firstname, :bill_address_firstname
     alias_method :billing_lastname, :bill_address_lastname
+    alias_method :billing_name, :bill_address_name
 
     class_attribute :update_hooks
     self.update_hooks = Set.new
@@ -180,6 +193,9 @@ module Spree
     # Use this method in other gems that wish to register their own custom logic
     # that should be called after Order#update
     def self.register_update_hook(hook)
+      Spree::Deprecation.warn \
+        "Spree::Order::update_hooks are deprecated. Please remove them " \
+        "and subscribe to `order_recalculated` and/or `order_finalized` event instead", caller(1)
       update_hooks.add(hook)
     end
 
@@ -191,7 +207,7 @@ module Spree
 
     # For compatiblity with Calculator::PriceSack
     def amount
-      line_items.map(&:amount).sum
+      line_items.sum(&:amount)
     end
 
     # Sum of all line item amounts after promotions, before added tax
@@ -216,7 +232,7 @@ module Spree
     end
 
     def shipping_discount
-      shipment_adjustments.eligible.sum(:amount) * - 1
+      shipment_adjustments.credit.eligible.sum(:amount) * - 1
     end
 
     def to_param
@@ -286,7 +302,11 @@ module Spree
     end
 
     def all_inventory_units_returned?
-      inventory_units.all?(&:returned?)
+      # Inventory units are transitioned to the "return" state through CustomerReturn and
+      # ReturnItem instead of using Order#inventory_units, thus making the latter method
+      # potentially return stale data. This situation requires to *reload* `inventory_units`
+      # in order to pick-up the latest changes and make the check on `returned?` reliable.
+      inventory_units.reload.all?(&:returned?)
     end
 
     def contents
@@ -397,7 +417,7 @@ module Spree
 
     def name
       if (address = bill_address || ship_address)
-        "#{address.firstname} #{address.lastname}"
+        address.name
       end
     end
 
@@ -430,7 +450,7 @@ module Spree
 
       updater.update_shipment_state
       save!
-      updater.run_hooks
+      updater.run_hooks if update_hooks.any?
 
       touch :completed_at
 
@@ -545,10 +565,22 @@ module Spree
       end
     end
 
+    def ensure_billing_address
+      return unless billing_address_required?
+      return if bill_address&.valid?
+
+      errors.add(:base, I18n.t('spree.bill_address_required'))
+      false
+    end
+
+    def billing_address_required?
+      Spree::Config.billing_address_required
+    end
+
     def create_proposed_shipments
       if completed?
         raise CannotRebuildShipments.new(I18n.t('spree.cannot_rebuild_shipments_order_completed'))
-      elsif shipments.any? { |s| !s.pending? }
+      elsif shipments.any? { |shipment| !shipment.pending? }
         raise CannotRebuildShipments.new(I18n.t('spree.cannot_rebuild_shipments_shipments_not_pending'))
       else
         shipments.destroy_all
@@ -556,6 +588,13 @@ module Spree
       end
     end
 
+    def create_shipments_for_line_item(line_item)
+      units = Spree::Stock::InventoryUnitBuilder.new(self).missing_units_for_line_item(line_item)
+      Spree::Config.stock.coordinator_class.new(self, units).shipments.each do |shipment|
+        shipments << shipment
+      end
+    end
+
     def apply_shipping_promotions
       Spree::PromotionHandler::Shipping.new(self).activate
       recalculate
@@ -607,10 +646,9 @@ module Spree
     def canceled_by(user)
       transaction do
         cancel!
-        update_columns(
-          canceler_id: user.id,
-          canceled_at: Time.current
-        )
+        # rubocop:disable Rails/SkipsModelValidations
+        update_column(:canceler_id, user.id)
+        # rubocop:enable Rails/SkipsModelValidations
       end
     end
 
@@ -676,7 +714,7 @@ module Spree
       if remaining_total.zero?
         other_payments.each(&:invalidate!)
       elsif other_payments.size == 1
-        other_payments.first.update_attributes!(amount: remaining_total)
+        other_payments.first.update!(amount: remaining_total)
       end
 
       payments.reset
@@ -703,7 +741,7 @@ module Spree
 
     def total_applicable_store_credit
       if can_complete? || complete?
-        payments.store_credits.valid.sum(:amount)
+        valid_store_credit_payments.to_a.sum(&:amount)
       else
         [total, (user.try(:available_store_credit_total, currency: currency) || 0.0)].min
       end
@@ -730,8 +768,8 @@ module Spree
     # @note This doesn't persist the change bill_address or ship_address
     def assign_default_user_addresses
       if user
-        bill_address = (user.bill_address || user.default_address)
-        ship_address = (user.ship_address || user.default_address)
+        bill_address = user.bill_address
+        ship_address = user.ship_address
         # this is one of 2 places still using User#bill_address
         self.bill_address ||= bill_address if bill_address.try!(:valid?)
         # Skip setting ship address if order doesn't have a delivery checkout step
@@ -776,7 +814,9 @@ module Spree
     deprecate assign_default_credit_card: :add_default_payment_from_wallet, deprecator: Spree::Deprecation
 
     def record_ip_address(ip_address)
-      if last_ip_address != ip_address
+      if new_record?
+        self.last_ip_address = ip_address
+      elsif last_ip_address != ip_address
         update_column(:last_ip_address, ip_address)
       end
     end
@@ -889,14 +929,29 @@ module Spree
     end
 
     def after_cancel
-      shipments.each(&:cancel!)
-      payments.completed.each { |payment| payment.cancel! unless payment.fully_refunded? }
-      payments.store_credits.pending.each(&:void_transaction!)
+      cancel_shipments!
+      cancel_payments!
 
       send_cancel_email
+      # rubocop:disable Rails/SkipsModelValidations
+      update_column(:canceled_at, Time.current)
+      # rubocop:enable Rails/SkipsModelValidations
       recalculate
     end
 
+    def cancel_shipments!
+      shipments.each(&:cancel!)
+    end
+
+    def cancel_payments!
+      payments.each do |payment|
+        next if payment.fully_refunded?
+        next unless payment.pending? || payment.completed?
+
+        payment.cancel!
+      end
+    end
+
     def send_cancel_email
       Spree::Config.order_mailer_class.cancel_email(self).deliver_later
     end

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

@@ -41,7 +41,7 @@ module Spree
           # On first definition, state_machines will not be defined
           state_machines.clear if respond_to?(:state_machines)
           state_machine :state, initial: :cart, use_transactions: false do
-            klass.next_event_transitions.each { |t| transition(t.merge(on: :next)) }
+            klass.next_event_transitions.each { |state| transition(state.merge(on: :next)) }
 
             # Persist the state on the order
             after_transition do |order, transition|
@@ -82,6 +82,7 @@ module Spree
 
               after_transition to: :complete, do: :add_payment_sources_to_wallet
               before_transition to: :payment, do: :add_default_payment_from_wallet
+              before_transition to: :payment, do: :ensure_billing_address
 
               before_transition to: :confirm, do: :add_store_credit_payments
 

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

@@ -46,9 +46,9 @@ module Spree
 
           payment.public_send(method)
         end
-      rescue Core::GatewayError => e
+      rescue Core::GatewayError => error
         result = !!Spree::Config[:allow_checkout_on_gateway_error]
-        errors.add(:base, e.message) && (return result)
+        errors.add(:base, error.message) && (return result)
       end
     end
   end

data/app/models/spree/order_cancellations.rb

@@ -139,7 +139,7 @@ class Spree::OrderCancellations
 
     shipments.each do |shipment|
       if shipment.inventory_units.all? { |iu| iu.shipped? || iu.canceled? }
-        shipment.update_attributes!(state: 'shipped', shipped_at: Time.current)
+        shipment.update!(state: 'shipped', shipped_at: Time.current)
       end
     end
   end

data/app/models/spree/order_capturing.rb

@@ -41,8 +41,8 @@ class Spree::OrderCapturing
   private
 
   def sorted_payments(order)
-    order.payments.pending.sort_by do |p|
-      [@sorted_payment_method_classes.index(p.payment_method.class), p.id]
+    order.payments.pending.sort_by do |payment|
+      [@sorted_payment_method_classes.index(payment.payment_method.class), payment.id]
     end
   end
 end

data/app/models/spree/order_contents.rb

@@ -35,7 +35,7 @@ module Spree
     end
 
     def update_cart(params)
-      if order.update_attributes(params)
+      if order.update(params)
         unless order.completed?
           order.line_items = order.line_items.select { |li| li.quantity > 0 }
           # Update totals, then check if the order is eligible for any cart promotions.
@@ -61,7 +61,7 @@ module Spree
         raise ArgumentError, 'user or name must be specified'
       end
 
-      order.update_attributes!(
+      order.update!(
         approver: user,
         approver_name: name,
         approved_at: Time.current

data/app/models/spree/order_inventory.rb

@@ -23,8 +23,14 @@ module Spree
         existing_quantity = inventory_units.count
         desired_quantity = line_item.quantity - existing_quantity
         if desired_quantity > 0
-          shipment ||= determine_target_shipment
-          add_to_shipment(shipment, desired_quantity)
+          shipment ||= determine_target_shipment(desired_quantity)
+          if shipment
+            add_to_shipment(shipment, desired_quantity)
+          else
+            order.create_shipments_for_line_item(line_item).each do |new_shipment|
+              new_shipment.finalize!
+            end
+          end
         elsif desired_quantity < 0
           remove(-desired_quantity, shipment)
         end
@@ -48,12 +54,18 @@ module Spree
     # Returns either one of the shipment:
     #
     # first unshipped that already includes this variant
-    # first unshipped that's leaving from a stock_location that stocks this variant
-    def determine_target_shipment
+    # first unshipped that's leaving from a stock_location that stocks this variant, with availability check
+    # first unshipped that's leaving from a stock_location that stocks this variant, without availability check
+    def determine_target_shipment(quantity)
       potential_shipments = order.shipments.select(&:ready_or_pending?)
 
       potential_shipments.detect do |shipment|
         shipment.include?(variant)
+      end || potential_shipments.detect do |shipment|
+        stock_item = shipment.stock_location.stock_item(variant.id)
+        if stock_item
+          stock_item.backorderable? || stock_item.count_on_hand >= quantity
+        end
       end || potential_shipments.detect do |shipment|
         variant.stock_location_ids.include?(shipment.stock_location_id)
       end

data/app/models/spree/order_merger.rb

@@ -56,11 +56,13 @@ module Spree
       end
 
       set_user(user)
-      persist_merge
+      if order.valid?
+        persist_merge
 
-      # So that the destroy doesn't take out line items which may have been re-assigned
-      other_order.line_items.reload
-      other_order.destroy
+        # So that the destroy doesn't take out line items which may have been re-assigned
+        other_order.line_items.reload
+        other_order.destroy
+      end
     end
 
     private

data/app/models/spree/order_mutex.rb

@@ -4,7 +4,7 @@ module Spree
   class OrderMutex < Spree::Base
     class LockFailed < StandardError; end
 
-    belongs_to :order, class_name: "Spree::Order"
+    belongs_to :order, class_name: "Spree::Order", optional: true
 
     scope :expired, -> { where(arel_table[:created_at].lteq(Spree::Config[:order_mutex_max_age].seconds.ago)) }
 

data/app/models/spree/order_promotion.rb

@@ -8,9 +8,9 @@ module Spree
   class OrderPromotion < Spree::Base
     self.table_name = 'spree_orders_promotions'
 
-    belongs_to :order, class_name: 'Spree::Order'
-    belongs_to :promotion, class_name: 'Spree::Promotion'
-    belongs_to :promotion_code, class_name: 'Spree::PromotionCode'
+    belongs_to :order, class_name: 'Spree::Order', optional: true
+    belongs_to :promotion, class_name: 'Spree::Promotion', optional: true
+    belongs_to :promotion_code, class_name: 'Spree::PromotionCode', optional: true
 
     validates :order, presence: true
     validates :promotion, presence: true
@@ -21,7 +21,7 @@ module Spree
     private
 
     def require_promotion_code?
-      promotion && promotion.codes.any?
+      promotion && !promotion.apply_automatically && promotion.codes.any?
     end
   end
 end

data/app/models/spree/order_shipping.rb

@@ -64,7 +64,7 @@ class Spree::OrderShipping
     inventory_units.map(&:shipment).uniq.each do |shipment|
       # Temporarily propagate the tracking number to the shipment as well
       # TODO: Remove tracking numbers from shipments.
-      shipment.update_attributes!(tracking: tracking_number)
+      shipment.update!(tracking: tracking_number)
 
       next unless shipment.inventory_units.reload.all? { |iu| iu.shipped? || iu.canceled? }
       # TODO: make OrderShipping#ship_shipment call Shipment#ship! rather than