solidus_core 2.10.0 → 2.11.0

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
@@ -97,6 +106,8 @@ module Spree
 
     # 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
 
@@ -125,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)
@@ -136,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
@@ -181,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
 
@@ -192,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
@@ -217,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
@@ -287,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
@@ -398,7 +417,7 @@ module Spree
 
     def name
       if (address = bill_address || ship_address)
-        "#{address.firstname} #{address.lastname}"
+        address.name
       end
     end
 
@@ -431,11 +450,18 @@ module Spree
 
       updater.update_shipment_state
       save!
-      updater.run_hooks
+      updater.run_hooks if update_hooks.any?
 
       touch :completed_at
 
       Spree::Event.fire 'order_finalized', order: self
+
+      if method(:deliver_order_confirmation_email).owner != self.class
+        Spree::Deprecation.warn \
+          "deliver_order_confirmation_email has been deprecated and moved to " \
+          "Spree::MailerSubscriber#order_finalized, please move there any customizations.",
+          caller(1)
+      end
     end
 
     def fulfill!
@@ -444,6 +470,16 @@ module Spree
       save!
     end
 
+    def deliver_order_confirmation_email
+      Spree::Deprecation.warn \
+        "deliver_order_confirmation_email has been deprecated and moved to " \
+        "Spree::MailerSubscriber#order_finalized.",
+        caller(1)
+
+      Spree::Config.order_mailer_class.confirm_email(order).deliver_later
+      order.update_column(:confirmation_delivered, true)
+    end
+
     # Helper methods for checkout steps
     def paid?
       %w(paid credit_owed).include?(payment_state)
@@ -529,6 +565,18 @@ 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'))
@@ -540,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
@@ -591,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
 
@@ -714,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
@@ -760,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
@@ -873,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_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_promotion.rb

@@ -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_updater.rb

@@ -17,7 +17,7 @@ module Spree
     # object with callbacks (otherwise you will end up in an infinite recursion as the
     # associations try to save and then in turn try to call +update!+ again.)
     def update
-      @order.transaction do
+      order.transaction do
         update_item_count
         update_shipment_amounts
         update_totals
@@ -26,12 +26,17 @@ module Spree
           update_shipments
           update_shipment_state
         end
-        run_hooks
+        run_hooks if update_hooks.any?
+        Spree::Event.fire 'order_recalculated', order: order
         persist_totals
       end
     end
 
     def run_hooks
+      Spree::Deprecation.warn \
+        "This method is deprecated. Please run your hooks by subscribing " \
+        "to `order_recalculated` and/or `order_finalized` events instead, depending " \
+        " on when OrderUpdater#run_hooks was called.", caller(1)
       update_hooks.each { |hook| order.send hook }
     end
 
@@ -136,20 +141,16 @@ module Spree
     end
 
     def update_shipment_amounts
-      shipments.each do |shipment|
-        shipment.update_amounts
-      end
+      shipments.each(&:update_amounts)
     end
 
     # give each of the shipments a chance to update themselves
     def update_shipments
-      shipments.each do |shipment|
-        shipment.update_state
-      end
+      shipments.each(&:update_state)
     end
 
     def update_payment_total
-      order.payment_total = payments.completed.includes(:refunds).map { |payment| payment.amount - payment.refunds.sum(:amount) }.sum
+      order.payment_total = payments.completed.includes(:refunds).sum { |payment| payment.amount - payment.refunds.sum(:amount) }
     end
 
     def update_shipment_total
@@ -185,7 +186,7 @@ module Spree
     end
 
     def persist_totals
-      order.save!(validate: false)
+      order.save!(validate: Spree::Config.run_order_validations_on_order_updater)
     end
 
     def log_state_change(name)

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

@@ -29,9 +29,9 @@ module Spree
         # 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)
+            payment.handle_void_response(response)
           else
-            payment.refunds.create!(amount: payment.credit_allowed, reason: refund_reason)
+            payment.refunds.create!(amount: payment.credit_allowed, reason: refund_reason, perform_after_create: false).perform!
           end
         else
           # For payment methods not yet implemeting `try_void`
@@ -55,7 +55,7 @@ module Spree
           '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)
+        payment.handle_void_response(response)
       end
     end
   end

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

@@ -46,18 +46,20 @@ module Spree
       # Takes the amount in cents to capture.
       # Can be used to capture partial amounts of a payment, and will create
       # a new pending payment record for the remaining amount to capture later.
-      def capture!(amount = nil)
+      def capture!(capture_amount = nil)
         return true if completed?
-        amount ||= money.money.cents
+        return false unless amount.positive?
+
+        capture_amount ||= money.money.cents
         started_processing!
         protect_from_connection_error do
           # Standard ActiveMerchant capture usage
           response = payment_method.capture(
-            amount,
+            capture_amount,
             response_code,
             gateway_options
           )
-          money = ::Money.new(amount, currency)
+          money = ::Money.new(capture_amount, currency)
           capture_events.create!(amount: money.to_d)
           update!(amount: captured_amount)
           handle_response(response, :complete, :failure)
@@ -66,6 +68,8 @@ module Spree
 
       def void_transaction!
         return true if void?
+        return false unless amount.positive?
+
         protect_from_connection_error do
           if payment_method.payment_profiles_supported?
             # Gateways supporting payment profiles will need access to credit card object because this stores the payment profile information
@@ -117,6 +121,22 @@ module Spree
         options
       end
 
+      # The unique identifier to be passed in to the payment gateway
+      def gateway_order_id
+        "#{order.number}-#{number}"
+      end
+
+      def handle_void_response(response)
+        record_response(response)
+
+        if response.success?
+          self.response_code = response.authorization
+          void
+        else
+          gateway_error(response)
+        end
+      end
+
       private
 
       def process_authorization
@@ -182,17 +202,6 @@ module Spree
         end
       end
 
-      def handle_void_response(response)
-        record_response(response)
-
-        if response.success?
-          self.response_code = response.authorization
-          void
-        else
-          gateway_error(response)
-        end
-      end
-
       def record_response(response)
         log_entries.create!(details: response.to_yaml)
       end
@@ -204,21 +213,36 @@ module Spree
       end
 
       def gateway_error(error)
-        if error.is_a? ActiveMerchant::Billing::Response
-          text = error.params['message'] || error.params['response_reason_text'] || error.message
-        elsif error.is_a? ActiveMerchant::ConnectionError
-          text = I18n.t('spree.unable_to_connect_to_gateway')
-        else
-          text = error.to_s
-        end
-        logger.error(I18n.t('spree.gateway_error'))
-        logger.error("  #{error.to_yaml}")
-        raise Core::GatewayError.new(text)
-      end
-
-      # The unique identifier to be passed in to the payment gateway
-      def gateway_order_id
-        "#{order.number}-#{number}"
+        message, log = case error
+                       when ActiveMerchant::Billing::Response
+                          [
+                            error.params['message'] || error.params['response_reason_text'] || error.message,
+                            basic_response_info(error)
+                          ]
+                        when ActiveMerchant::ConnectionError
+                          [I18n.t('spree.unable_to_connect_to_gateway')] * 2
+                        else
+                          [error.to_s, error]
+                        end
+
+        logger.error("#{I18n.t('spree.gateway_error')}: #{log}")
+        raise Core::GatewayError.new(message)
+      end
+
+      # The gateway response information without the params since the params
+      # can contain PII.
+      def basic_response_info(response)
+        {
+          message: response.message,
+          test: response.test,
+          authorization: response.authorization,
+          avs_result: response.avs_result,
+          cvv_result: response.cvv_result,
+          error_code: response.error_code,
+          emv_authorization: response.emv_authorization,
+          gateway_order_id: gateway_order_id,
+          order_number: order.number
+        }
       end
     end
   end

data/app/models/spree/payment.rb

@@ -17,7 +17,7 @@ module Spree
 
     belongs_to :order, class_name: 'Spree::Order', touch: true, inverse_of: :payments, optional: true
     belongs_to :source, polymorphic: true, optional: true
-    belongs_to :payment_method, -> { with_deleted }, class_name: 'Spree::PaymentMethod', inverse_of: :payments, optional: true
+    belongs_to :payment_method, -> { with_discarded }, class_name: 'Spree::PaymentMethod', inverse_of: :payments, optional: true
 
     has_many :offsets, -> { offset_payment }, class_name: "Spree::Payment", foreign_key: :source_id
     has_many :log_entries, as: :source
@@ -179,11 +179,11 @@ module Spree
     end
 
     def source_required?
-      payment_method.present? && payment_method.source_required?
+      !!payment_method&.source_required?
     end
 
     def profiles_supported?
-      payment_method.respond_to?(:payment_profiles_supported?) && payment_method.payment_profiles_supported?
+      !!payment_method.try(:payment_profiles_supported?)
     end
 
     def create_payment_profile

data/app/models/spree/payment_method.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'discard'
 require 'spree/preferences/statically_configurable'
 
 module Spree
@@ -15,17 +14,17 @@ module Spree
     preference :server, :string, default: 'test'
     preference :test_mode, :boolean, default: true
 
-    acts_as_paranoid
-    include Spree::ParanoiaDeprecations
-
-    include Discard::Model
-    self.discard_column = :deleted_at
+    include Spree::SoftDeletable
 
     acts_as_list
 
     # @private
     def self.const_missing(name)
       if name == :DISPLAY
+        Spree::Deprecation.warn(
+          "#{self}::DISPLAY has been deprecated and will be removed in Solidus v3.",
+          caller
+        )
         const_set(:DISPLAY, [:both, :front_end, :back_end])
       else
         super
@@ -63,7 +62,7 @@ module Spree
           @human
         ].compact
         options = { scope: [:activerecord, :models], count: 1, default: defaults }.merge!(options.except(:default))
-        I18n.translate(defaults.shift, options)
+        I18n.translate(defaults.shift, **options)
       end
     end
 
@@ -108,9 +107,9 @@ module Spree
         where(type: to_s, active: true).count > 0
       end
 
-      # @deprecated Use .with_deleted.find instead
+      # @deprecated Use .with_discarded.find instead
       def find_with_destroyed(*args)
-        Spree::Deprecation.warn "#{self}.find_with_destroyed is deprecated. Use #{self}.with_deleted.find instead"
+        Spree::Deprecation.warn "#{self}.find_with_destroyed is deprecated. Use #{self}.with_discarded.find instead"
         unscoped { find(*args) }
       end
     end

data/app/models/spree/preference.rb

@@ -3,5 +3,5 @@
 class Spree::Preference < Spree::Base
   serialize :value
 
-  validates :key, presence: true, uniqueness: { allow_blank: true }
+  validates :key, presence: true, uniqueness: { allow_blank: true, case_sensitive: true }
 end

data/app/models/spree/price.rb

@@ -1,18 +1,12 @@
 # frozen_string_literal: true
 
-require 'discard'
-
 module Spree
   class Price < Spree::Base
-    acts_as_paranoid
-    include Spree::ParanoiaDeprecations
-
-    include Discard::Model
-    self.discard_column = :deleted_at
+    include Spree::SoftDeletable
 
     MAXIMUM_AMOUNT = BigDecimal('99_999_999.99')
 
-    belongs_to :variant, -> { with_deleted }, class_name: 'Spree::Variant', touch: true, optional: true
+    belongs_to :variant, -> { with_discarded }, class_name: 'Spree::Variant', touch: true, optional: true
     belongs_to :country, class_name: "Spree::Country", foreign_key: "country_iso", primary_key: "iso", optional: true
 
     delegate :product, to: :variant

data/app/models/spree/product/scopes.rb

@@ -29,11 +29,13 @@ module Spree
           scope :descend_by_name, -> { order(name: :desc) }
 
           add_search_scope :ascend_by_master_price do
-            joins(master: :default_price).order(Spree::Price.arel_table[:amount].asc)
+            joins(master: :default_price).select('spree_products.* , spree_prices.amount')
+                                         .order(Spree::Price.arel_table[:amount].asc)
           end
 
           add_search_scope :descend_by_master_price do
-            joins(master: :default_price).order(Spree::Price.arel_table[:amount].desc)
+            joins(master: :default_price).select('spree_products.* , spree_prices.amount')
+                                         .order(Spree::Price.arel_table[:amount].desc)
           end
 
           add_search_scope :price_between do |low, high|
@@ -182,7 +184,10 @@ module Spree
           end
           # Can't use add_search_scope for this as it needs a default argument
           def self.available(available_on = nil)
-            with_master_price.where("#{Spree::Product.quoted_table_name}.available_on <= ?", available_on || Time.current)
+            with_master_price
+              .where("#{Spree::Product.quoted_table_name}.available_on <= ?", available_on || Time.current)
+              .where("#{Spree::Product.quoted_table_name}.discontinue_on IS NULL OR" \
+                     "#{Spree::Product.quoted_table_name}.discontinue_on >= ?", Time.current)
           end
           search_scopes << :available
 
@@ -233,7 +238,7 @@ module Spree
 
             # specifically avoid having an order for taxon search (conflicts with main order)
             def prepare_taxon_conditions(taxons)
-              ids = taxons.map { |taxon| taxon.self_and_descendants.pluck(:id) }.flatten.uniq
+              ids = taxons.flat_map { |taxon| taxon.self_and_descendants.pluck(:id) }.uniq
               joins(:taxons).where("#{Spree::Taxon.table_name}.id" => ids)
             end
 
@@ -251,7 +256,7 @@ module Spree
               ids_or_records_or_names.flatten.map { |taxon|
                 case taxon
                 when Integer then Spree::Taxon.find_by(id: taxon)
-                when ActiveRecord::Base then t
+                when ActiveRecord::Base then taxon
                 when String
                   Spree::Taxon.find_by(name: taxon) ||
                     Spree::Taxon.where("#{taxons}.permalink LIKE ? OR #{taxons}.permalink = ?", "%/#{taxon}/", "#{taxon}/").first