spree_core 3.0.9 → 3.2.0

data/app/models/spree/order.rb

@@ -3,8 +3,8 @@ require 'spree/order/checkout'
 
 module Spree
   class Order < Spree::Base
-    PAYMENT_STATES = %w(balance_due checkout completed credit_owed failed paid pending processing void).freeze
-    SHIPMENT_STATES = %w(backorder canceled partial pending ready shipped).freeze
+    PAYMENT_STATES = %w(balance_due credit_owed failed paid void)
+    SHIPMENT_STATES = %w(backorder canceled partial pending ready shipped)
 
     extend FriendlyId
     friendly_id :number, slug_column: :number, use: :slugged
@@ -12,14 +12,10 @@ module Spree
     include Spree::Order::Checkout
     include Spree::Order::CurrencyUpdater
     include Spree::Order::Payments
-    include Spree::NumberGenerator
+    include Spree::Order::StoreCredit
+    include Spree::Core::NumberGenerator.new(prefix: 'R')
     include Spree::Core::TokenGenerator
 
-    def generate_number(options = {})
-      options[:prefix] ||= 'R'
-      super(options)
-    end
-
     extend Spree::DisplayMoney
     money_methods :outstanding_balance, :item_total,           :adjustment_total,
                   :included_tax_total,  :additional_tax_total, :tax_total,
@@ -28,6 +24,25 @@ module Spree
     alias :display_ship_total :display_shipment_total
     alias_attribute :ship_total, :shipment_total
 
+    MONEY_THRESHOLD  = 100_000_000
+    MONEY_VALIDATION = {
+      presence:     true,
+      numericality: {
+        greater_than: -MONEY_THRESHOLD,
+        less_than:     MONEY_THRESHOLD,
+        allow_blank:   true
+      },
+      format:       { with: /\A-?\d+(?:\.\d{1,2})?\z/, allow_blank: true }
+    }.freeze
+
+    POSITIVE_MONEY_VALIDATION = MONEY_VALIDATION.deep_dup.tap do |validation|
+      validation.fetch(:numericality)[:greater_than_or_equal_to] = 0
+    end.freeze
+
+    NEGATIVE_MONEY_VALIDATION = MONEY_VALIDATION.deep_dup.tap do |validation|
+      validation.fetch(:numericality)[:less_than_or_equal_to] = 0
+    end.freeze
+
     checkout_flow do
       go_to_state :address
       go_to_state :delivery
@@ -38,7 +53,7 @@ module Spree
     end
 
     self.whitelisted_ransackable_associations = %w[shipments user promotions bill_address ship_address line_items]
-    self.whitelisted_ransackable_attributes =  %w[completed_at created_at email number state payment_state shipment_state total considered_risky]
+    self.whitelisted_ransackable_attributes = %w[completed_at email number state payment_state shipment_state total considered_risky]
 
     attr_reader :coupon_code
     attr_accessor :temporary_address, :temporary_credit_card
@@ -62,12 +77,15 @@ module Spree
     alias_attribute :shipping_address, :ship_address
 
     belongs_to :store, class_name: 'Spree::Store'
-    has_many :state_changes, as: :stateful, dependent: :destroy
-    has_many :line_items, -> { order("#{LineItem.table_name}.created_at ASC") }, dependent: :destroy, inverse_of: :order
-    has_many :payments, dependent: :destroy
-    has_many :return_authorizations, dependent: :destroy, inverse_of: :order
+
+    with_options dependent: :destroy do
+      has_many :state_changes, as: :stateful
+      has_many :line_items, -> { order(:created_at) }, inverse_of: :order
+      has_many :payments
+      has_many :return_authorizations, inverse_of: :order
+      has_many :adjustments, -> { order(:created_at) }, as: :adjustable
+    end
     has_many :reimbursements, inverse_of: :order
-    has_many :adjustments, -> { order("#{Adjustment.table_name}.created_at ASC") }, as: :adjustable, dependent: :destroy
     has_many :line_item_adjustments, through: :line_items, source: :adjustments
     has_many :shipment_adjustments, through: :shipments, source: :adjustments
     has_many :inventory_units, inverse_of: :order
@@ -80,7 +98,8 @@ module Spree
              dependent: :destroy,
              inverse_of: :order
 
-    has_and_belongs_to_many :promotions, join_table: 'spree_orders_promotions'
+    has_many :order_promotions, class_name: 'Spree::OrderPromotion'
+    has_many :promotions, through: :order_promotions, class_name: 'Spree::Promotion'
 
     has_many :shipments, dependent: :destroy, inverse_of: :order do
       def states
@@ -103,12 +122,25 @@ module Spree
     before_create :link_by_email
     before_update :homogenize_line_item_currencies, if: :currency_changed?
 
-    validates :email, presence: true, if: :require_email
-    validates :email, email: true, if: :require_email, allow_blank: true
-    validate :has_available_shipment
-
-    delegate :update_totals, :persist_totals, :to => :updater
+    with_options presence: true do
+      validates :number, length: { maximum: 32, allow_blank: true }, uniqueness: { allow_blank: true }
+      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 }
+    end
+    validates :payment_state,        inclusion:    { in: PAYMENT_STATES, allow_blank: true }
+    validates :shipment_state,       inclusion:    { in: SHIPMENT_STATES, allow_blank: true }
+    validates :item_total,           POSITIVE_MONEY_VALIDATION
+    validates :adjustment_total,     MONEY_VALIDATION
+    validates :included_tax_total,   POSITIVE_MONEY_VALIDATION
+    validates :additional_tax_total, POSITIVE_MONEY_VALIDATION
+    validates :payment_total,        MONEY_VALIDATION
+    validates :shipment_total,       MONEY_VALIDATION
+    validates :promo_total,          NEGATIVE_MONEY_VALIDATION
+    validates :total,                MONEY_VALIDATION
+
+    delegate :update_totals, :persist_totals, to: :updater
     delegate :merge!, to: :merger
+    delegate :firstname, :lastname, to: :bill_address, prefix: true, allow_nil: true
 
     class_attribute :update_hooks
     self.update_hooks = Set.new
@@ -118,18 +150,12 @@ module Spree
 
     scope :created_between, ->(start_date, end_date) { where(created_at: start_date..end_date) }
     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) }
 
     # shows completed orders first, by their completed_at date, then uncompleted orders by their created_at
     scope :reverse_chronological, -> { order('spree_orders.completed_at IS NULL', completed_at: :desc, created_at: :desc) }
 
-    def self.complete
-      where.not(completed_at: nil)
-    end
-
-    def self.incomplete
-      where(completed_at: nil)
-    end
-
     # 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)
@@ -184,7 +210,7 @@ module Spree
         # Little hacky fix for #4117
         # If this wasn't here, order would transition to address state on confirm failure
         # because there would be no valid payments any more.
-        state == 'confirm'
+        confirm?
     end
 
     def backordered?
@@ -206,7 +232,7 @@ module Spree
       @updater ||= OrderUpdater.new(self)
     end
 
-    def update!
+    def update_with_updater!
       updater.update
     end
 
@@ -224,7 +250,7 @@ module Spree
     end
 
     def allow_cancel?
-      return false unless completed? and state != 'canceled'
+      return false if !completed? || canceled?
       shipment_state.nil? || %w{ready backorder pending}.include?(shipment_state)
     end
 
@@ -287,8 +313,15 @@ module Spree
       Spree::TaxRate.adjust(self, shipments) if shipments.any?
     end
 
+    def update_line_item_prices!
+      transaction do
+        line_items.each(&:update_price)
+        save!
+      end
+    end
+
     def outstanding_balance
-      if state == 'canceled'
+      if canceled?
         -1 * payment_total
       elsif reimbursements.includes(:refunds).size > 0
         reimbursed = reimbursements.includes(:refunds).inject(0) do |sum, reimbursement|
@@ -308,7 +341,7 @@ module Spree
 
     def name
       if (address = bill_address || ship_address)
-        "#{address.firstname} #{address.lastname}"
+        address.full_name
       end
     end
 
@@ -367,15 +400,7 @@ module Spree
     end
 
     def available_payment_methods
-      @available_payment_methods ||= (PaymentMethod.available(:front_end) + PaymentMethod.available(:both)).uniq
-    end
-
-    def billing_firstname
-      bill_address.try(:firstname)
-    end
-
-    def billing_lastname
-      bill_address.try(:lastname)
+      @available_payment_methods ||= collect_payment_methods
     end
 
     def insufficient_stock_lines
@@ -383,12 +408,12 @@ module Spree
     end
 
     ##
-    # Check to see if any line item variants are soft deleted.
+    # Check to see if any line item variants are discontinued.
     # If so add error and restart checkout.
-    def ensure_line_item_variants_are_not_deleted
-      if line_items.any?{ |li| !li.variant || li.variant.paranoia_destroyed? }
-        errors.add(:base, Spree.t(:deleted_variants_present))
+    def ensure_line_item_variants_are_not_discontinued
+      if line_items.any?{ |li| !li.variant || li.variant.discontinued? }
         restart_checkout_flow
+        errors.add(:base, Spree.t(:discontinued_variants_present))
         false
       else
         true
@@ -397,8 +422,8 @@ module Spree
 
     def ensure_line_items_are_in_stock
       if insufficient_stock_lines.present?
-        errors.add(:base, Spree.t(:insufficient_stock_lines_present))
         restart_checkout_flow
+        errors.add(:base, Spree.t(:insufficient_stock_lines_present))
         false
       else
         true
@@ -406,14 +431,21 @@ module Spree
     end
 
     def empty!
-      line_items.destroy_all
-      updater.update_item_count
-      adjustments.destroy_all
-      shipments.destroy_all
-      state_changes.destroy_all
+      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
 
-      update_totals
-      persist_totals
+        update_totals
+        persist_totals
+        restart_checkout_flow
+        self
+      end
     end
 
     def has_step?(step)
@@ -444,7 +476,6 @@ module Spree
       Spree::Promotion.order_activatable?(self)
     end
 
-
     def shipped?
       %w(partial shipped).include?(shipment_state)
     end
@@ -452,6 +483,11 @@ module Spree
     def create_proposed_shipments
       all_adjustments.shipping.delete_all
       shipments.destroy_all
+
+      # Inventory Units which are not associated to any shipment (unshippable)
+      # and are not returned or shipped should be deleted
+      inventory_units.on_hand_or_backordered.delete_all
+
       self.shipments = Spree::Stock::Coordinator.new(self).shipments
     end
 
@@ -478,7 +514,7 @@ module Spree
     def restart_checkout_flow
       self.update_columns(
         state: 'cart',
-        updated_at: Time.now,
+        updated_at: Time.current,
       )
       self.next! if self.line_items.size > 0
     end
@@ -498,7 +534,7 @@ module Spree
     end
 
     def is_risky?
-      self.payments.risky.count > 0
+      payments.risky.size > 0
     end
 
     def canceled_by(user)
@@ -506,7 +542,7 @@ module Spree
         cancel!
         self.update_columns(
           canceler_id: user.id,
-          canceled_at: Time.now,
+          canceled_at: Time.current,
         )
       end
     end
@@ -516,7 +552,7 @@ module Spree
         approve!
         self.update_columns(
           approver_id: user.id,
-          approved_at: Time.now,
+          approved_at: Time.current,
         )
       end
     end
@@ -588,13 +624,6 @@ module Spree
       end
     end
 
-    def has_available_shipment
-      return unless has_step?("delivery")
-      return unless has_step?(:address) && address?
-      return unless ship_address && ship_address.valid?
-      # errors.add(:base, :no_shipping_methods_available) if available_shipping_methods.empty?
-    end
-
     def ensure_available_shipping_rates
       if shipments.empty? || shipments.any? { |shipment| shipment.shipping_rates.blank? }
         # After this point, order redirects back to 'address' state and asks user to pick a proper address
@@ -607,8 +636,12 @@ module Spree
     def after_cancel
       shipments.each { |shipment| shipment.cancel! }
       payments.completed.each { |payment| payment.cancel! }
+
+      # Free up authorized store credits
+      payments.store_credits.pending.each(&:void!)
+
       send_cancel_email
-      self.update!
+      self.update_with_updater!
     end
 
     def send_cancel_email
@@ -621,7 +654,7 @@ module Spree
     end
 
     def use_billing?
-      @use_billing == true || @use_billing == 'true' || @use_billing == '1'
+      use_billing.in?([true, 'true', '1'])
     end
 
     def set_currency
@@ -631,5 +664,9 @@ module Spree
     def create_token
       self.guest_token ||= generate_guest_token
     end
+
+    def collect_payment_methods
+      PaymentMethod.available_on_front_end.select { |pm| pm.available_for_order?(self) }
+    end
   end
 end

data/app/models/spree/order_contents.rb

@@ -7,7 +7,7 @@ module Spree
     end
 
     def add(variant, quantity = 1, options = {})
-      timestamp = Time.now
+      timestamp = Time.current
       line_item = add_to_line_item(variant, quantity, options)
       options[:line_item_created] = true if timestamp <= line_item.created_at
       after_add_or_remove(line_item, options)
@@ -18,6 +18,11 @@ module Spree
       after_add_or_remove(line_item, options)
     end
 
+    def remove_line_item(line_item, options = {})
+      line_item.destroy!
+      after_add_or_remove(line_item, options)
+    end
+
     def update_cart(params)
       if order.update_attributes(filter_order_items(params))
         order.line_items = order.line_items.select { |li| li.quantity > 0 }
@@ -48,17 +53,16 @@ module Spree
     end
 
     def filter_order_items(params)
-      filtered_params = params.symbolize_keys
-      return filtered_params if filtered_params[:line_items_attributes].nil? || filtered_params[:line_items_attributes][:id]
+      return params if params[:line_items_attributes].nil? || params[:line_items_attributes][:id]
 
       line_item_ids = order.line_items.pluck(:id)
 
       params[:line_items_attributes].each_pair do |id, value|
         unless line_item_ids.include?(value[:id].to_i) || value[:variant_id].present?
-          filtered_params[:line_items_attributes].delete(id)
+          params[:line_items_attributes].delete(id)
         end
       end
-      filtered_params
+      params
     end
 
     def order_updater
@@ -77,8 +81,10 @@ module Spree
         line_item.quantity += quantity.to_i
         line_item.currency = currency unless currency.nil?
       else
-        opts = { currency: order.currency }.merge ActionController::Parameters.new(options).
-                                            permit(PermittedAttributes.line_item_attributes)
+        opts = ActionController::Parameters.new(options.to_h).
+               permit(PermittedAttributes.line_item_attributes).to_h.
+               merge( { currency: order.currency } )
+
         line_item = order.line_items.new(quantity: quantity,
                                           variant: variant,
                                           options: opts)

data/app/models/spree/order_inventory.rb

@@ -8,6 +8,8 @@ module Spree
       @variant = line_item.variant
     end
 
+    delegate :inventory_units, to: :line_item
+
     # Only verify inventory for completed orders (as orders in frontend checkout
     # have inventory assigned via +order.create_proposed_shipment+) or when
     # shipment is explicitly passed
@@ -23,19 +25,18 @@ module Spree
 
           shipment = determine_target_shipment unless shipment
           add_to_shipment(shipment, quantity)
+        elsif inventory_units.size == line_item.quantity && !line_item.changed?
+          remove(inventory_units, shipment)
         elsif inventory_units.size > line_item.quantity
           remove(inventory_units, shipment)
         end
       end
     end
 
-    def inventory_units
-      line_item.inventory_units
-    end
-
     private
+
       def remove(item_units, shipment = nil)
-        quantity = item_units.size - line_item.quantity
+        quantity = set_quantity_to_remove(item_units)
 
         if shipment.present?
           remove_from_shipment(shipment, quantity)
@@ -47,6 +48,14 @@ module Spree
         end
       end
 
+      def set_quantity_to_remove(item_units)
+        if (item_units.size - line_item.quantity).zero?
+          line_item.quantity
+        else
+          item_units.size - line_item.quantity
+        end
+      end
+
       # Returns either one of the shipment:
       #
       # first unshipped that already includes this variant
@@ -82,9 +91,7 @@ module Spree
       def remove_from_shipment(shipment, quantity)
         return 0 if quantity == 0 || shipment.shipped?
 
-        shipment_units = shipment.inventory_units_for_item(line_item, variant).reject do |variant_unit|
-          variant_unit.state == 'shipped'
-        end.sort_by(&:state)
+        shipment_units = shipment.inventory_units_for_item(line_item, variant).reject(&:shipped?).sort_by(&:state)
 
         removed_quantity = 0
 
@@ -94,7 +101,7 @@ module Spree
           removed_quantity += 1
         end
 
-        shipment.destroy if shipment.inventory_units.count == 0
+        shipment.destroy if shipment.inventory_units.count.zero?
 
         # removing this from shipment, and adding to stock_location
         if order.completed?

data/app/models/spree/order_promotion.rb

@@ -0,0 +1,6 @@
+module Spree
+  class OrderPromotion < Spree::Base
+    belongs_to :order, class_name: 'Spree::Order'
+    belongs_to :promotion, class_name: 'Spree::Promotion'
+  end
+end

data/app/models/spree/order_updater.rb

@@ -20,6 +20,7 @@ module Spree
         update_payment_state
         update_shipments
         update_shipment_state
+        update_shipment_total
       end
       run_hooks
       persist_totals
@@ -110,7 +111,7 @@ module Spree
         shipment_total: order.shipment_total,
         promo_total: order.promo_total,
         total: order.total,
-        updated_at: Time.now,
+        updated_at: Time.current,
       )
     end
 
@@ -137,7 +138,7 @@ module Spree
           # will return nil if no shipments are found
           order.shipment_state = shipment_states.first
           # TODO inventory unit states?
-          # if order.shipment_state && order.inventory_units.where(:shipment_id => nil).exists?
+          # if order.shipment_state && order.inventory_units.where(shipment_id: nil).exists?
           #   shipments exist but there are unassigned inventory units
           #   order.shipment_state = 'partial'
           # end
@@ -161,7 +162,7 @@ module Spree
       last_state = order.payment_state
       if payments.present? && payments.valid.size == 0
         order.payment_state = 'failed'
-      elsif order.state == 'canceled' && order.payment_total == 0
+      elsif order.canceled? && order.payment_total == 0
         order.payment_state = 'void'
       else
         order.payment_state = 'balance_due' if order.outstanding_balance > 0
@@ -171,10 +172,5 @@ module Spree
       order.state_changed('payment') if last_state != order.payment_state
       order.payment_state
     end
-
-    private
-      def round_money(n)
-        (n * 100).round / 100.0
-      end
   end
 end

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

@@ -26,19 +26,19 @@ module Spree
       end
 
       def shipping
-        order.ship_total * 100
+        order.ship_total * exchange_multiplier
       end
 
       def tax
-        order.additional_tax_total * 100
+        order.additional_tax_total * exchange_multiplier
       end
 
       def subtotal
-        order.item_total * 100
+        order.item_total * exchange_multiplier
       end
 
       def discount
-        order.promo_total * 100
+        order.promo_total * exchange_multiplier
       end
 
       def currency
@@ -81,6 +81,10 @@ module Spree
       def order
         @payment.order
       end
+
+      def exchange_multiplier
+        @payment.payment_method.try(:exchange_multiplier) || 1.0
+      end
     end
   end
 end

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

@@ -143,7 +143,7 @@ module Spree
       end
 
       def record_response(response)
-        log_entries.create!(:details => response.to_yaml)
+        log_entries.create!(details: response.to_yaml)
       end
 
       def protect_from_connection_error