solidus_core 2.11.10 → 3.3.1

data/app/models/spree/order.rb

@@ -38,9 +38,21 @@ module Spree
     class CannotRebuildShipments < StandardError; end
 
     extend Spree::DisplayMoney
-    money_methods :outstanding_balance, :item_total, :adjustment_total,
-      :included_tax_total, :additional_tax_total, :tax_total,
-      :shipment_total, :total, :order_total_after_store_credit, :total_available_store_credit
+    money_methods(
+      :outstanding_balance,
+      :item_total,
+      :adjustment_total,
+      :included_tax_total,
+      :additional_tax_total,
+      :tax_total,
+      :shipment_total,
+      :total,
+      :order_total_after_store_credit,
+      :total_available_store_credit,
+      :item_total_before_tax,
+      :shipment_total_before_tax,
+      :item_total_excluding_vat
+    )
     alias :display_ship_total :display_shipment_total
 
     checkout_flow do
@@ -50,18 +62,13 @@ 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[bill_address_firstname_or_lastname completed_at created_at email number state payment_state shipment_state total store_id]
+    self.allowed_ransackable_associations = %w[shipments user order_promotions promotions bill_address ship_address line_items]
+    self.allowed_ransackable_attributes = %w[completed_at created_at email number state payment_state shipment_state total store_id]
 
     attr_reader :coupon_code
     attr_accessor :temporary_address
 
     attr_accessor :temporary_payment_source
-    alias_method :temporary_credit_card, :temporary_payment_source
-    alias_method :temporary_credit_card=, :temporary_payment_source=
-    deprecate temporary_credit_card: :temporary_payment_source, deprecator: Spree::Deprecation
-    deprecate :temporary_credit_card= => :temporary_payment_source=, deprecator: Spree::Deprecation
 
     # Customer info
     belongs_to :user, class_name: Spree::UserClassHandle.new, optional: true
@@ -107,7 +114,7 @@ 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 :customer_returns, -> { distinct }, through: :return_items
     has_many :reimbursements, inverse_of: :order
     has_many :refunds, through: :payments
 
@@ -133,7 +140,7 @@ module Spree
     before_create :create_token
     before_create :link_by_email
 
-    validates :email, presence: true, if: :require_email
+    validates :email, presence: true, if: :email_required?
     validates :email, 'spree/email' => true, allow_blank: true
     validates :guest_token, presence: { allow_nil: true }
     validates :number, presence: true, uniqueness: { allow_blank: true, case_sensitive: true }
@@ -147,14 +154,9 @@ module Spree
       find_by! number: value
     end
 
-    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
+    delegate :name, to: :bill_address, prefix: true, allow_nil: true
     alias_method :billing_name, :bill_address_name
 
-    class_attribute :update_hooks
-    self.update_hooks = Set.new
-
     class_attribute :line_item_comparison_hooks
     self.line_item_comparison_hooks = Set.new
 
@@ -190,15 +192,6 @@ module Spree
       where.not(state: 'canceled')
     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)
-      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
-
     # Use this method in other gems that wish to register their own custom logic
     # that should be called when determining if two line items are equal.
     def self.register_line_item_comparison_hook(hook)
@@ -210,22 +203,18 @@ module Spree
       line_items.sum(&: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
 
+    def shipment_total_before_tax
+      shipments.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]
@@ -256,11 +245,6 @@ module Spree
       total > 0
     end
 
-    def confirmation_required?
-      true
-    end
-    deprecate :confirmation_required?, deprecator: Spree::Deprecation
-
     def backordered?
       shipments.any?(&:backordered?)
     end
@@ -271,7 +255,7 @@ module Spree
         ship_address
       else
         bill_address
-      end || store.default_cart_tax_location
+      end || store&.default_cart_tax_location
     end
 
     def updater
@@ -282,15 +266,6 @@ module Spree
       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
@@ -310,15 +285,15 @@ module Spree
     end
 
     def contents
-      @contents ||= Spree::OrderContents.new(self)
+      @contents ||= Spree::Config.order_contents_class.new(self)
     end
 
     def shipping
-      @shipping ||= Spree::OrderShipping.new(self)
+      @shipping ||= Spree::Config.order_shipping_class.new(self)
     end
 
     def cancellations
-      @cancellations ||= Spree::OrderCancellations.new(self)
+      @cancellations ||= Spree::Config.order_cancellations_class.new(self)
     end
 
     # Associates the specified user with the order.
@@ -336,14 +311,7 @@ module Spree
       assign_attributes(attrs_to_set)
     end
 
-    def generate_order_number(options = nil)
-      if options
-        Spree::Deprecation.warn \
-          "Passing options to Order#generate_order_number is deprecated. " \
-          "Please add your own instance of the order number generator " \
-          "with your options (#{options.inspect}) and store it as " \
-          "Spree::Config.order_number_generator in your stores config."
-      end
+    def generate_order_number
       self.number ||= Spree::Config.order_number_generator.generate
     end
 
@@ -384,14 +352,6 @@ module Spree
       }
     end
 
-    # Creates new tax charges if there are any applicable rates. If prices already
-    # include taxes then price adjustments are created instead.
-    # @deprecated This now happens during #recalculate
-    def create_tax_charge!
-      recalculate
-    end
-    deprecate create_tax_charge!: :recalculate, deprecator: Spree::Deprecation
-
     def reimbursement_total
       reimbursements.sum(:total)
     end
@@ -435,33 +395,16 @@ module Spree
       Spree::CreditCard.where(id: credit_card_ids)
     end
 
-    # Finalizes an in progress order after checkout is complete.
-    # Called after transition to complete state when payments will have been processed
+    # TODO: Remove on Solidus 4.0
+    # @api private
     def finalize!
-      # lock all adjustments (coupon promotions, etc.)
-      all_adjustments.each(&:finalize!)
-
-      # update payment and shipment(s) states, and save
-      updater.update_payment_state
-      shipments.each do |shipment|
-        shipment.update_state
-        shipment.finalize!
-      end
-
-      updater.update_shipment_state
-      save!
-      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
+      Spree::Deprecation.warn <<~MSG
+        Calling `Spree::Order#finalize!` is discouraged. Instead, use
+        `Spree::Order#complete!`, which goes through all the needed safety
+        checks before finalizing an order. This method will be removed
+        altogether on Solidus 4.0.
+      MSG
+      finalize
     end
 
     def fulfill!
@@ -470,16 +413,6 @@ 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)
@@ -523,26 +456,6 @@ module Spree
       recalculate
     end
 
-    alias_method :has_step?, :has_checkout_step?
-    deprecate has_step?: :has_checkout_step?, deprecator: Spree::Deprecation
-
-    def state_changed(name)
-      state = "#{name}_state"
-      if persisted?
-        old_state = send("#{state}_was")
-        new_state = send(state)
-        unless old_state == new_state
-          state_changes.create(
-            previous_state: old_state,
-            next_state:     new_state,
-            name:           name,
-            user_id:        user_id
-          )
-        end
-      end
-    end
-    deprecate :state_changed, deprecator: Spree::Deprecation
-
     def coupon_code=(code)
       @coupon_code = begin
                        code.strip.downcase
@@ -584,12 +497,13 @@ module Spree
         raise CannotRebuildShipments.new(I18n.t('spree.cannot_rebuild_shipments_shipments_not_pending'))
       else
         shipments.destroy_all
-        self.shipments = Spree::Config.stock.coordinator_class.new(self).shipments
+        shipments.push(*Spree::Config.stock.coordinator_class.new(self).shipments)
       end
     end
 
     def create_shipments_for_line_item(line_item)
-      units = Spree::Stock::InventoryUnitBuilder.new(self).missing_units_for_line_item(line_item)
+      units = Spree::Config.stock.inventory_unit_builder_class.new(self).missing_units_for_line_item(line_item)
+
       Spree::Config.stock.coordinator_class.new(self, units).shipments.each do |shipment|
         shipments << shipment
       end
@@ -599,8 +513,6 @@ module Spree
       Spree::PromotionHandler::Shipping.new(self).activate
       recalculate
     end
-    alias_method :apply_free_shipping_promotions, :apply_shipping_promotions
-    deprecate apply_free_shipping_promotions: :apply_shipping_promotions, deprecator: Spree::Deprecation
 
     # Clean shipments and make order back to address state
     #
@@ -622,7 +534,7 @@ module Spree
         state: 'cart',
         updated_at: Time.current
       )
-      next! if !line_items.empty?
+      self.next
     end
 
     def refresh_shipment_rates
@@ -633,12 +545,6 @@ module Spree
       bill_address == ship_address
     end
 
-    # @deprecated This now happens during #recalculate
-    def set_shipments_cost
-      recalculate
-    end
-    deprecate set_shipments_cost: :recalculate, deprecator: Spree::Deprecation
-
     def is_risky?
       payments.risky.count > 0
     end
@@ -669,11 +575,6 @@ module Spree
         payments.offset_payment.exists? # how old versions of spree stored refunds
     end
 
-    def token
-      Spree::Deprecation.warn("Spree::Order#token is DEPRECATED, please use #guest_token instead.", caller)
-      guest_token
-    end
-
     def tax_total
       additional_tax_total + included_tax_total
     end
@@ -695,8 +596,9 @@ module Spree
 
       if matching_store_credits.any?
         payment_method = Spree::PaymentMethod::StoreCredit.first
+        sorter = Spree::Config.store_credit_prioritizer_class.new(matching_store_credits, self)
 
-        matching_store_credits.order_by_priority.each do |credit|
+        sorter.call.each do |credit|
           break if remaining_total.zero?
           next if credit.amount_remaining.zero?
 
@@ -778,11 +680,6 @@ module Spree
       end
     end
 
-    alias_method :assign_default_user_addresses!, :assign_default_user_addresses
-    deprecate assign_default_user_addresses!: :assign_default_user_addresses, deprecator: Spree::Deprecation
-    alias_method :assign_default_addresses!, :assign_default_user_addresses
-    deprecate assign_default_addresses!: :assign_default_user_addresses, deprecator: Spree::Deprecation
-
     def persist_user_address!
       if !temporary_address && user && user.respond_to?(:persist_order_address) && bill_address_id
         user.persist_order_address(self)
@@ -794,8 +691,6 @@ module Spree
         add_payment_sources_to_wallet_class.new(self).
         add_to_wallet
     end
-    alias_method :persist_user_credit_card, :add_payment_sources_to_wallet
-    deprecate persist_user_credit_card: :add_payment_sources_to_wallet, deprecator: Spree::Deprecation
 
     def add_default_payment_from_wallet
       builder = Spree::Config.default_payment_builder_class.new(self)
@@ -810,8 +705,6 @@ module Spree
         end
       end
     end
-    alias_method :assign_default_credit_card, :add_default_payment_from_wallet
-    deprecate assign_default_credit_card: :add_default_payment_from_wallet, deprecator: Spree::Deprecation
 
     def record_ip_address(ip_address)
       if new_record?
@@ -857,21 +750,25 @@ module Spree
       end
     end
 
-    # In case a existing credit card is provided it needs to build the payment
-    # attributes from scratch so we can set the amount. example payload:
-    #
-    #   {
-    #     "order": {
-    #       "existing_card": "2"
-    #     }
-    #   }
-    #
-    def update_params_payment_source
-      Spree::Deprecation.warn('update_params_payment_source is deprecated. Please use set_payment_parameters_amount instead.', caller)
-      if @updating_params[:order] && (@updating_params[:order][:payments_attributes] || @updating_params[:order][:existing_card])
-        @updating_params[:order][:payments_attributes] ||= [{}]
-        @updating_params[:order][:payments_attributes].first[:amount] = total
+    # Finalizes an in progress order after checkout is complete.
+    # Called after transition to complete state when payments will have been processed
+    def finalize
+      # lock all adjustments (coupon promotions, etc.)
+      all_adjustments.each(&:finalize!)
+
+      # update payment and shipment(s) states, and save
+      updater.update_payment_state
+      shipments.each do |shipment|
+        shipment.update_state
+        shipment.finalize!
       end
+
+      updater.update_shipment_state
+      save!
+
+      touch :completed_at
+
+      Spree::Bus.publish :order_finalized, order: self
     end
 
     def associate_store
@@ -883,15 +780,23 @@ module Spree
     end
 
     # Determine if email is required (we don't want validation errors before we hit the checkout)
-    def require_email
+    def email_required?
       true unless new_record? || ['cart', 'address'].include?(state)
     end
 
+    def require_email
+      Spree::Deprecation.warn "Use email_required? instead", caller(1)
+      email_required?
+    end
+
     def ensure_inventory_units
       if has_checkout_step?("delivery")
-        inventory_validator = Spree::Stock::InventoryValidator.new
+        inventory_validator = Spree::Config.stock.inventory_validator_class.new
+
+        errors = line_items.map { |line_item|
+          inventory_validator.validate(line_item)
+        }.compact
 
-        errors = line_items.map { |line_item| inventory_validator.validate(line_item) }.compact
         raise InsufficientStock if errors.any?
       end
     end
@@ -909,8 +814,15 @@ module Spree
     end
 
     def validate_line_item_availability
-      availability_validator = Spree::Stock::AvailabilityValidator.new
-      raise InsufficientStock unless line_items.all? { |line_item| availability_validator.validate(line_item) }
+      availability_validator = Spree::Config.stock.availability_validator_class.new
+
+      # NOTE: This code assumes that the availability validator will return
+      # true for success and false for failure. This is not normally the
+      # behaviour of validators, as the framework only cares about the
+      # population of the errors, not the return value of the validate method.
+      raise InsufficientStock unless line_items.all? { |line_item|
+        availability_validator.validate(line_item)
+      }
     end
 
     def ensure_line_items_present

data/app/models/spree/order_cancellations.rb

@@ -23,16 +23,10 @@ class Spree::OrderCancellations
   # @api public
   #
   # @param [Array<InventoryUnit>] inventory_units the inventory units to be short shipped
-  # @param [Spree.user_class] whodunnit (deprecated) the system or person that is short shipping the inventory unit
   # @param [Spree.user_class] created_by the system or person that is short shipping the inventory unit
   #
   # @return [Array<UnitCancel>] the units that have been canceled due to short shipping
-  def short_ship(inventory_units, whodunnit: nil, created_by: nil)
-    if whodunnit
-      created_by ||= whodunnit
-      Spree::Deprecation.warn("Calling #short_ship on #{self} with whodunnit is deprecated, use created_by instead")
-    end
-
+  def short_ship(inventory_units, created_by: nil)
     if inventory_units.map(&:order_id).uniq != [@order.id]
       raise ArgumentError, "Not all inventory units belong to this order"
     end
@@ -65,16 +59,10 @@ class Spree::OrderCancellations
   #
   # @param [InventoryUnit] inventory_unit the inventory unit to be canceled
   # @param [String] reason the reason that you are canceling the inventory unit
-  # @param [Spree.user_class] whodunnit (deprecated) the system or person that is canceling the inventory unit
   # @param [Spree.user_class] created_by the system or person that is canceling the inventory unit
   #
   # @return [UnitCancel] the unit that has been canceled
-  def cancel_unit(inventory_unit, reason: Spree::UnitCancel::DEFAULT_REASON, whodunnit: nil, created_by: nil)
-    if whodunnit
-      created_by ||= whodunnit
-      Spree::Deprecation.warn("Calling #cancel_unit on #{self} with whodunnit is deprecated, use created_by instead")
-    end
-
+  def cancel_unit(inventory_unit, reason: Spree::UnitCancel::DEFAULT_REASON, created_by: nil)
     unit_cancel = nil
 
     Spree::OrderMutex.with_lock!(@order) do
@@ -96,10 +84,7 @@ class Spree::OrderCancellations
   # @param [Array<InventoryUnit>] inventory_units the inventory units to be reimbursed
   # @param [Spree.user_class] created_by the user that is performing this action
   # @return [Reimbursement] the reimbursement for inventory being canceled
-  def reimburse_units(inventory_units, created_by: nil)
-    unless created_by
-      Spree::Deprecation.warn("Calling #reimburse_units on #{self} without created_by is deprecated")
-    end
+  def reimburse_units(inventory_units, created_by:)
     reimbursement = nil
 
     Spree::OrderMutex.with_lock!(@order) do
@@ -113,12 +98,7 @@ class Spree::OrderCancellations
 
   private
 
-  def short_ship_unit(inventory_unit, whodunnit: nil, created_by: nil)
-    if whodunnit
-      created_by ||= whodunnit
-      Spree::Deprecation.warn("Calling #short_ship_unit on #{self} with whodunnit is deprecated, use created_by instead")
-    end
-
+  def short_ship_unit(inventory_unit, created_by: nil)
     unit_cancel = Spree::UnitCancel.create!(
       inventory_unit: inventory_unit,
       reason: Spree::UnitCancel::SHORT_SHIP,

data/app/models/spree/order_contents.rb

@@ -42,8 +42,8 @@ module Spree
           # If we do not update first, then the item total will be wrong and ItemTotal
           # promotion rules would not be triggered.
           reload_totals
-          PromotionHandler::Cart.new(order).activate
           order.ensure_updated_shipments
+          PromotionHandler::Cart.new(order).activate
         end
         reload_totals
         true
@@ -89,6 +89,7 @@ module Spree
       line_item ||= order.line_items.new(
         quantity: 0,
         variant: variant,
+        adjustments: [],
       )
 
       line_item.quantity += quantity.to_i

data/app/models/spree/order_inventory.rb

@@ -62,7 +62,7 @@ module Spree
       potential_shipments.detect do |shipment|
         shipment.include?(variant)
       end || potential_shipments.detect do |shipment|
-        stock_item = shipment.stock_location.stock_item(variant.id)
+        stock_item = variant.stock_items.detect { |stock_item| stock_item.stock_location == shipment.stock_location }
         if stock_item
           stock_item.backorderable? || stock_item.count_on_hand >= quantity
         end

data/app/models/spree/order_merger.rb

@@ -115,8 +115,8 @@ module Spree
         current_line_item.quantity += other_order_line_item.quantity
         handle_error(current_line_item) unless current_line_item.save
       else
-        order.line_items << other_order_line_item
-        handle_error(other_order_line_item) unless other_order_line_item.save
+        new_line_item = order.line_items.build(other_order_line_item.attributes.except("id"))
+        handle_error(new_line_item) unless new_line_item.save
       end
     end
 

data/app/models/spree/order_promotion.rb

@@ -16,7 +16,7 @@ module Spree
     validates :promotion, presence: true
     validates :promotion_code, presence: true, if: :require_promotion_code?
 
-    self.whitelisted_ransackable_associations = %w[promotion_code]
+    self.allowed_ransackable_associations = %w[promotion_code]
 
     private
 

data/app/models/spree/order_shipping.rb

@@ -62,18 +62,15 @@ class Spree::OrderShipping
     end
 
     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!(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
-      # having Shipment#ship! call OrderShipping#ship_shipment. We only really
-      # need this `update_columns` for the specs, until we make that change.
-      shipment.update_columns(state: 'shipped', shipped_at: Time.current)
+      if shipment.inventory_units.reload.all? { |iu| iu.shipped? || iu.canceled? }
+        shipment.update!(state: "shipped", shipped_at: Time.current, tracking: tracking_number)
+      else
+        shipment.update!(tracking: tracking_number)
+      end
     end
 
     send_shipment_emails(carton) if stock_location.fulfillable? && !suppress_mailer # e.g. digital gift cards that aren't actually shipped
+    @order.shipments.reload
     @order.recalculate
 
     carton

data/app/models/spree/order_taxation.rb

@@ -17,13 +17,15 @@ module Spree
 
     # Apply taxes to the order.
     #
-    # This method will create or update adjustments on all line items and
-    # shipments in the order to reflect the appropriate taxes passed in. It
-    # will also remove any now inapplicable tax adjustments.
+    # This method will create or update adjustments on the order and all line
+    # items and shipments in the order to reflect the appropriate taxes passed
+    # in. It will also remove any now inapplicable tax adjustments.
     #
     # @param [Spree::Tax::OrderTax] taxes the taxes to apply to the order
     # @return [void]
     def apply(taxes)
+      update_adjustments(@order, taxes.order_taxes) if taxes.order_taxes
+
       @order.line_items.each do |item|
         taxed_items = taxes.line_item_taxes.select { |element| element.item_id == item.id }
         update_adjustments(item, taxed_items)
@@ -70,7 +72,7 @@ module Spree
 
       tax_adjustment ||= item.adjustments.new(
         source: tax_item.tax_rate,
-        order_id: item.order_id,
+        order_id: item.is_a?(Spree::Order) ? item.id : item.order_id,
         label: tax_item.label,
         included: tax_item.included_in_price
       )