solidus_core 4.6.2 → 4.7.0

data/app/models/spree/line_item.rb

@@ -43,15 +43,15 @@ module Spree
 
     attr_accessor :target_shipment, :price_currency
 
-    self.allowed_ransackable_associations = ['variant']
-    self.allowed_ransackable_attributes = ['variant_id']
+    self.allowed_ransackable_associations = ["variant"]
+    self.allowed_ransackable_attributes = ["variant_id"]
 
     # @return [BigDecimal] the amount of this line item, which is the line
     #   item's price multiplied by its quantity.
     def amount
       price * quantity
     end
-    alias subtotal amount
+    alias_method :subtotal, :amount
 
     # @return [BigDecimal] the amount of this line item, taking into
     #   consideration all its adjustments.
@@ -72,17 +72,18 @@ module Spree
     end
 
     extend Spree::DisplayMoney
+
     money_methods :amount, :price,
-                  :included_tax_total, :additional_tax_total,
-                  :total, :total_before_tax, :total_excluding_vat
+      :included_tax_total, :additional_tax_total,
+      :total, :total_before_tax, :total_excluding_vat
 
     # @return [Spree::Money] the price of this line item
-    alias money_price display_price
-    alias single_display_amount display_price
-    alias single_money display_price
+    alias_method :money_price, :display_price
+    alias_method :single_display_amount, :display_price
+    alias_method :single_money, :display_price
 
     # @return [Spree::Money] the amount of this line item
-    alias money display_amount
+    alias_method :money, :display_amount
 
     # Sets price from a `Spree::Money` object
     #
@@ -99,7 +100,7 @@ module Spree
     # @return [Boolean] true when it is possible to supply the required
     #   quantity of stock of this line item's variant
     def sufficient_stock?
-      Stock::Quantifier.new(variant).can_supply? quantity
+      Spree::Config.stock.quantifier_class.new(variant).can_supply? quantity
     end
 
     # @return [Boolean] true when it is not possible to supply the required
@@ -122,11 +123,20 @@ module Spree
       # it from the variant. Please note that this always allows to set
       # a price for this line item, even if there is no existing price
       # for the associated line item in the order currency.
-      unless options.key?(:price) || options.key?('price')
+      unless options.key?(:price) || options.key?("price")
         self.money_price = variant.price_for_options(pricing_options)&.money
       end
     end
 
+    # Recalculate the price using the pricing options for this line item.
+    # Useful for making sure carts are up-to-date when prices change.
+    # Will not make changes to completed orders.
+    #
+    def recalculate_price
+      return if order.completed?
+      self.money_price = variant.price_for_options(pricing_options)&.money
+    end
+
     def pricing_options
       Spree::Config.pricing_options_class.from_line_item(self)
     end

data/app/models/spree/log_entry.rb

@@ -69,7 +69,7 @@ module Spree
         @details ||= YAML.safe_load(
           details,
           permitted_classes: self.class.permitted_classes,
-          aliases: Spree::Config.log_entry_allow_aliases,
+          aliases: Spree::Config.log_entry_allow_aliases
         )
       end
     end
@@ -79,7 +79,7 @@ module Spree
         self.details = YAML.safe_dump(
           value,
           permitted_classes: self.class.permitted_classes,
-          aliases: Spree::Config.log_entry_allow_aliases,
+          aliases: Spree::Config.log_entry_allow_aliases
         )
       end
     end
@@ -91,7 +91,7 @@ module Spree
       self.parsed_details = ActiveMerchant::Billing::Response.new(
         response.success?,
         "[WARNING: An error occurred while trying to serialize the payment response] #{response.message}",
-        { 'data' => response.inspect, 'error' => e.message.to_s },
+        {"data" => response.inspect, "error" => e.message.to_s}
       )
     end
 

data/app/models/spree/mergeable_orders_finder.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Spree
+  # Finds orders to merge when a user logs in.
+  #
+  # Configurable via {Spree::Config#mergeable_orders_finder_class}.
+  # Default behavior finds all incomplete orders from the same store.
+  #
+  # @example Custom finder for recent orders only
+  #   class RecentOrdersFinder
+  #     def initialize(context:)
+  #       @user = context.spree_current_user
+  #       @store = context.current_store
+  #       @current_order = context.current_order
+  #     end
+  #
+  #     def call
+  #       @user.orders.by_store(@store).incomplete
+  #            .where.not(id: @current_order.id)
+  #            .where('created_at > ?', 7.days.ago)
+  #     end
+  #   end
+  #
+  #   Spree::Config.mergeable_orders_finder_class = RecentOrdersFinder
+  class MergeableOrdersFinder
+    # @param context [Object] an object that responds to spree_current_user,
+    #   current_store, and current_order (typically a controller)
+    def initialize(context:)
+      @user = context.spree_current_user
+      @store = context.current_store
+      @current_order = context.current_order
+    end
+
+    # Returns orders that should be merged into the current order
+    #
+    # @return [ActiveRecord::Relation<Spree::Order>] incomplete orders from the
+    # same store
+    def call
+      return Spree::Order.none unless @user && @current_order
+
+      @user.orders.by_store(@store).incomplete.where(frontend_viewable: true).where.not(id: @current_order.id)
+    end
+  end
+end

data/app/models/spree/money.rb

@@ -5,6 +5,7 @@ module Spree
   # formatting via Spree::Config.
   class Money
     include Comparable
+
     DifferentCurrencyError = Class.new(StandardError)
 
     class << self
@@ -69,7 +70,7 @@ module Spree
     # @param options [Hash] additional formatting options
     # @return [String] the value of this money object formatted according to
     #   its options and any additional options, by default with html_wrap.
-    def to_html(options = { html_wrap: true })
+    def to_html(options = {html_wrap: true})
       output = format(options)
       # Maintain compatibility by checking html option renamed to html_wrap.
       if options[:html_wrap]

data/app/models/spree/null_promotion_adjuster.rb

@@ -6,7 +6,7 @@ module Spree
       @order = order
     end
 
-    def call
+    def call(persist: true) # rubocop:disable Lint/UnusedMethodArgument
       @order
     end
   end

data/app/models/spree/option_type.rb

@@ -15,7 +15,7 @@ module Spree
     has_many :product_option_types, dependent: :destroy, inverse_of: :option_type
     has_many :products, through: :product_option_types
 
-    validates :name, presence: true, uniqueness: { allow_blank: true, case_sensitive: true }
+    validates :name, presence: true, uniqueness: {allow_blank: true, case_sensitive: true}
     validates :presentation, presence: true
 
     default_scope -> { order(:position) }

data/app/models/spree/option_value.rb

@@ -2,13 +2,13 @@
 
 module Spree
   class OptionValue < Spree::Base
-    belongs_to :option_type, class_name: 'Spree::OptionType', inverse_of: :option_values
+    belongs_to :option_type, class_name: "Spree::OptionType", inverse_of: :option_values
     acts_as_list scope: :option_type
 
     has_many :option_values_variants, dependent: :destroy
     has_many :variants, through: :option_values_variants
 
-    validates :name, presence: true, uniqueness: { scope: :option_type_id, allow_blank: true, case_sensitive: true }
+    validates :name, presence: true, uniqueness: {scope: :option_type_id, allow_blank: true, case_sensitive: true}
     validates :presentation, presence: true
 
     after_save :touch, if: :saved_changes?

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

@@ -27,7 +27,7 @@ module Spree
 
     def generate
       possible = (0..9).to_a
-      possible += ('A'..'Z').to_a if letters
+      possible += ("A".."Z").to_a if letters
 
       loop do
         # Make a random number.

data/app/models/spree/order.rb

@@ -19,9 +19,9 @@ module Spree
   # `empty!` and `fulfill!`.
   #
   class Order < Spree::Base
-    ORDER_NUMBER_LENGTH  = 9
+    ORDER_NUMBER_LENGTH = 9
     ORDER_NUMBER_LETTERS = false
-    ORDER_NUMBER_PREFIX  = 'R'
+    ORDER_NUMBER_PREFIX = "R"
 
     include ::Spree::Config.state_machines.order
 
@@ -33,12 +33,14 @@ module Spree
 
       def initialize(message = nil, items: {})
         @items = items
-        super message
+        super(message)
       end
     end
+
     class CannotRebuildShipments < StandardError; end
 
     extend Spree::DisplayMoney
+
     money_methods(
       :outstanding_balance,
       :item_total,
@@ -55,7 +57,7 @@ module Spree
       :item_total_excluding_vat,
       :promo_total
     )
-    alias :display_ship_total :display_shipment_total
+    alias_method :display_ship_total, :display_shipment_total
 
     checkout_flow do
       go_to_state :address
@@ -75,17 +77,17 @@ module Spree
     # Customer info
     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
+    belongs_to :bill_address, foreign_key: :bill_address_id, class_name: "Spree::Address", optional: true
     alias_method :billing_address, :bill_address
     alias_method :billing_address=, :bill_address=
 
-    belongs_to :ship_address, foreign_key: :ship_address_id, class_name: 'Spree::Address', optional: true
+    belongs_to :ship_address, foreign_key: :ship_address_id, class_name: "Spree::Address", optional: true
     alias_method :shipping_address, :ship_address
     alias_method :shipping_address=, :ship_address=
 
     alias_attribute :ship_total, :shipment_total
 
-    belongs_to :store, class_name: 'Spree::Store', optional: true
+    belongs_to :store, class_name: "Spree::Store", optional: true
 
     # Items
     has_many :line_items, -> { order(:created_at, :id) }, dependent: :destroy, inverse_of: :order
@@ -106,14 +108,14 @@ module Spree
     has_many :line_item_adjustments, through: :line_items, source: :adjustments
     has_many :shipment_adjustments, through: :shipments, source: :adjustments
     has_many :all_adjustments,
-             class_name: 'Spree::Adjustment',
-             foreign_key: :order_id,
-             dependent: :destroy,
-             inverse_of: :order
+      class_name: "Spree::Adjustment",
+      foreign_key: :order_id,
+      dependent: :destroy,
+      inverse_of: :order
 
     # 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
+    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
@@ -147,9 +149,9 @@ module Spree
     before_create :link_by_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 }
+    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}
     validates :store_id, presence: true
 
     def self.find_by_param(value)
@@ -190,7 +192,7 @@ module Spree
     scope :by_store, ->(store) { where(store_id: store.id) }
 
     # 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) }
+    scope :reverse_chronological, -> { order(Arel.sql("spree_orders.completed_at IS NULL"), completed_at: :desc, created_at: :desc) }
 
     def self.by_customer(customer)
       joins(:user).where("#{Spree.user_class.table_name}.email" => customer)
@@ -209,11 +211,11 @@ module Spree
     end
 
     def self.canceled
-      where(state: 'canceled')
+      where(state: "canceled")
     end
 
     def self.not_canceled
-      where.not(state: 'canceled')
+      where.not(state: "canceled")
     end
 
     # For compatiblity with Calculator::PriceSack
@@ -293,8 +295,8 @@ module Spree
     end
 
     def allow_cancel?
-      return false unless completed? && state != 'canceled'
-      shipment_state.nil? || %w{ready backorder pending}.include?(shipment_state)
+      return false unless completed? && state != "canceled"
+      shipment_state.nil? || %w[ready backorder pending].include?(shipment_state)
     end
 
     def all_inventory_units_returned?
@@ -320,7 +322,7 @@ module Spree
     # Associates the specified user with the order.
     def associate_user!(user, override_email = true)
       self.user = user
-      attrs_to_set = { user_id: user.try(:id) }
+      attrs_to_set = {user_id: user.try(:id)}
       attrs_to_set[:email] = user.try(:email) if override_email
       attrs_to_set[:created_by_id] = user.try(:id) if created_by.blank?
 
@@ -351,8 +353,8 @@ module Spree
 
     def find_line_item_by_variant(variant, options = {})
       line_items.detect { |line_item|
-                    line_item.variant_id == variant.id &&
-                      line_item_options_match(line_item, options)
+        line_item.variant_id == variant.id &&
+          line_item_options_match(line_item, options)
       }
     end
 
@@ -381,7 +383,7 @@ module Spree
       # If reimbursement has happened add it back to total to prevent balance_due payment state
       # See: https://github.com/spree/spree/issues/6229
 
-      if state == 'canceled'
+      if state == "canceled"
         -1 * payment_total
       else
         total - reimbursement_total - payment_total
@@ -418,13 +420,13 @@ module Spree
 
     def fulfill!
       shipments.each { |shipment| shipment.update_state if shipment.persisted? }
-      recalculator.update_shipment_state
+      recalculator.recalculate_shipment_state
       save!
     end
 
     # Helper methods for checkout steps
     def paid?
-      %w(paid credit_owed).include?(payment_state)
+      %w[paid credit_owed].include?(payment_state)
     end
 
     def available_payment_methods
@@ -444,7 +446,7 @@ module Spree
     # If so add error and restart checkout.
     def ensure_line_item_variants_are_not_deleted
       if line_items.any? { |li| li.variant.discarded? }
-        errors.add(:base, I18n.t('spree.deleted_variants_present'))
+        errors.add(:base, I18n.t("spree.deleted_variants_present"))
         restart_checkout_flow
         false
       else
@@ -467,10 +469,10 @@ module Spree
 
     def coupon_code=(code)
       @coupon_code = begin
-                       code.strip.downcase
-                     rescue StandardError
-                       nil
-                     end
+        code.strip.downcase
+      rescue
+        nil
+      end
     end
 
     def can_add_coupon?
@@ -478,12 +480,12 @@ module Spree
     end
 
     def shipped?
-      %w(partial shipped).include?(shipment_state)
+      %w[partial shipped].include?(shipment_state)
     end
 
     def ensure_shipping_address
-      unless ship_address && ship_address.valid?
-        errors.add(:base, I18n.t('spree.ship_address_required')) && (return false)
+      unless ship_address&.valid?
+        errors.add(:base, I18n.t("spree.ship_address_required")) && (return false)
       end
     end
 
@@ -491,7 +493,7 @@ module Spree
       return unless billing_address_required?
       return if bill_address&.valid?
 
-      errors.add(:base, I18n.t('spree.bill_address_required'))
+      errors.add(:base, I18n.t("spree.bill_address_required"))
       false
     end
 
@@ -501,9 +503,9 @@ module Spree
 
     def create_proposed_shipments
       if completed?
-        raise CannotRebuildShipments.new(I18n.t('spree.cannot_rebuild_shipments_order_completed'))
+        raise CannotRebuildShipments.new(I18n.t("spree.cannot_rebuild_shipments_order_completed"))
       elsif shipments.any? { |shipment| !shipment.pending? }
-        raise CannotRebuildShipments.new(I18n.t('spree.cannot_rebuild_shipments_shipments_not_pending'))
+        raise CannotRebuildShipments.new(I18n.t("spree.cannot_rebuild_shipments_shipments_not_pending"))
       else
         shipments.destroy_all
         shipments.push(*Spree::Config.stock.coordinator_class.new(self).shipments)
@@ -532,10 +534,10 @@ module Spree
     deprecate ensure_updated_shipments: :check_shipments_and_restart_checkout, deprecator: Spree.deprecator
 
     def restart_checkout_flow
-      return if state == 'cart'
+      return if state == "cart"
 
       update_columns(
-        state: 'cart',
+        state: "cart",
         updated_at: Time.current
       )
       self.next if line_items.any?
@@ -605,10 +607,10 @@ module Spree
 
           amount_to_take = [credit.amount_remaining, remaining_total].min
           payments.create!(source: credit,
-                           payment_method:,
-                           amount: amount_to_take,
-                           state: 'checkout',
-                           response_code: credit.generate_authorization_code)
+            payment_method:,
+            amount: amount_to_take,
+            state: "checkout",
+            response_code: credit.generate_authorization_code)
           remaining_total -= amount_to_take
         end
       end
@@ -622,8 +624,8 @@ module Spree
 
       payments.reset
 
-      if payments.where(state: %w(checkout pending completed)).sum(:amount) != total
-        errors.add(:base, I18n.t('spree.store_credit.errors.unable_to_fund')) && (return false)
+      if payments.where(state: %w[checkout pending completed]).sum(:amount) != total
+        errors.add(:base, I18n.t("spree.store_credit.errors.unable_to_fund")) && (return false)
       end
     end
 
@@ -651,11 +653,11 @@ module Spree
     end
 
     def display_total_applicable_store_credit
-      Spree::Money.new(-total_applicable_store_credit, { currency: })
+      Spree::Money.new(-total_applicable_store_credit, {currency:})
     end
 
     def display_store_credit_remaining_after_capture
-      Spree::Money.new(total_available_store_credit - total_applicable_store_credit, { currency: })
+      Spree::Money.new(total_available_store_credit - total_applicable_store_credit, {currency:})
     end
 
     def bill_address_attributes=(attributes)
@@ -682,27 +684,27 @@ module Spree
     end
 
     def persist_user_address!
-      if !temporary_address && user && user.respond_to?(:persist_order_address) && bill_address_id
+      if !temporary_address && user&.respond_to?(:persist_order_address) && bill_address_id
         user.persist_order_address(self)
       end
     end
 
     def add_payment_sources_to_wallet
-      Spree::Config.
-        add_payment_sources_to_wallet_class.new(self).
-        add_to_wallet
+      Spree::Config
+        .add_payment_sources_to_wallet_class.new(self)
+        .add_to_wallet
     end
 
     def add_default_payment_from_wallet
       builder = Spree::Config.default_payment_builder_class.new(self)
 
-      if payment = builder.build
+      if (payment = builder.build)
         payments << payment
 
         if bill_address.nil?
           # this is one of 2 places still using User#bill_address
           self.bill_address = payment.source.try(:address) ||
-                              user.bill_address
+            user.bill_address
         end
       end
     end
@@ -717,7 +719,7 @@ module Spree
 
     def payments_attributes=(attributes)
       validate_payments_attributes(attributes)
-      super(attributes)
+      super
     end
 
     def validate_payments_attributes(attributes)
@@ -737,7 +739,7 @@ module Spree
       return if !payment_required?
 
       if payments.valid.empty?
-        errors.add(:base, I18n.t('spree.no_payment_found'))
+        errors.add(:base, I18n.t("spree.no_payment_found"))
         return false
       end
 
@@ -758,13 +760,13 @@ module Spree
       all_adjustments.each(&:finalize!)
 
       # update payment and shipment(s) states, and save
-      recalculator.update_payment_state
+      recalculator.recalculate_payment_state
       shipments.each do |shipment|
         shipment.update_state
         shipment.finalize!
       end
 
-      recalculator.update_shipment_state
+      recalculator.recalculate_shipment_state
       save!
 
       touch :completed_at
@@ -788,7 +790,7 @@ module Spree
     # @return [Boolean] true if the email is required
     # @note This method was called require_email before.
     def email_required?
-      true unless new_record? || ['cart', 'address'].include?(state)
+      true unless new_record? || ["cart", "address"].include?(state)
     end
 
     def ensure_inventory_units
@@ -804,12 +806,12 @@ module Spree
     end
 
     def ensure_promotions_eligible
-      Spree::Config.promotions.order_adjuster_class.new(self).call
+      Spree::Config.promotions.order_adjuster_class.new(self).call(persist: false)
 
       if promo_total_changed?
         restart_checkout_flow
         recalculate
-        errors.add(:base, I18n.t('spree.promotion_total_changed_before_complete'))
+        errors.add(:base, I18n.t("spree.promotion_total_changed_before_complete"))
       end
       errors.empty?
     end
@@ -828,7 +830,7 @@ module Spree
 
     def ensure_line_items_present
       unless line_items.present?
-        errors.add(:base, I18n.t('spree.there_are_no_items_for_this_order')) && (return false)
+        errors.add(:base, I18n.t("spree.there_are_no_items_for_this_order")) && (return false)
       end
     end
 
@@ -837,7 +839,7 @@ module Spree
         # After this point, order redirects back to 'address' state and asks user to pick a proper address
         # Therefore, shipments are not necessary at this point.
         shipments.destroy_all
-        errors.add(:base, I18n.t('spree.items_cannot_be_shipped')) && (return false)
+        errors.add(:base, I18n.t("spree.items_cannot_be_shipped")) && (return false)
       end
     end
 
@@ -869,11 +871,11 @@ module Spree
     end
 
     def use_billing?
-      use_billing.in?([true, 'true', '1'])
+      use_billing.in?([true, "true", "1"])
     end
 
     def use_shipping?
-      use_shipping.in?([true, 'true', '1'])
+      use_shipping.in?([true, "true", "1"])
     end
 
     def set_currency

data/app/models/spree/order_cancellations.rb

@@ -55,9 +55,7 @@ class Spree::OrderCancellations
 
       @order.recalculate
 
-      if short_ship_tax_notifier
-        short_ship_tax_notifier.call(unit_cancels)
-      end
+      short_ship_tax_notifier&.call(unit_cancels)
     end
 
     Spree::Bus.publish(:order_short_shipped, order: @order, inventory_units:)

data/app/models/spree/order_inventory.rb

@@ -62,11 +62,8 @@ module Spree
       potential_shipments.detect do |shipment|
         shipment.include?(variant)
       end || begin
-        stock_items = variant.stock_items.sort_by(&:id) # cache stock items to avoid N+1
-
         potential_shipments.detect do |shipment|
-          stock_item = stock_items.detect { |stock_item| stock_item.stock_location == shipment.stock_location }
-          stock_item.backorderable? || stock_item.count_on_hand >= quantity if stock_item
+          Spree::Config.stock.quantifier_class.new(variant, shipment.stock_location).can_supply?(quantity)
         end
       end || potential_shipments.detect do |shipment|
         variant.stock_location_ids.include?(shipment.stock_location_id)
@@ -78,10 +75,10 @@ module Spree
       if variant.should_track_inventory?
         on_hand, back_order = shipment.stock_location.fill_status(variant, quantity)
 
-        on_hand.times { pending_units << shipment.set_up_inventory('on_hand', variant, order, line_item) }
-        back_order.times { pending_units << shipment.set_up_inventory('backordered', variant, order, line_item) }
+        on_hand.times { pending_units << shipment.set_up_inventory("on_hand", variant, order, line_item) }
+        back_order.times { pending_units << shipment.set_up_inventory("backordered", variant, order, line_item) }
       else
-        quantity.times { pending_units << shipment.set_up_inventory('on_hand', variant, order, line_item) }
+        quantity.times { pending_units << shipment.set_up_inventory("on_hand", variant, order, line_item) }
       end
 
       # adding to this shipment, and removing from stock_location
@@ -104,7 +101,7 @@ module Spree
 
       shipment_units = shipment.inventory_units_for_item(line_item, variant).reject do |variant_unit|
         # TODO: exclude all 'shipped' states
-        variant_unit.state == 'shipped'
+        variant_unit.state == "shipped"
       end.sort_by(&:state)
 
       removed_quantity = 0

data/app/models/spree/order_mutex.rb

@@ -28,7 +28,7 @@ module Spree
 
         yield
       ensure
-        order_mutex.destroy if order_mutex
+        order_mutex&.destroy
       end
     end
   end