solidus_core 2.11.10 → 3.3.1

data/app/models/spree/stock/availability.rb

@@ -19,7 +19,7 @@ module Spree
       # Get the on_hand stock quantities
       # @return [Hash<Integer=>Spree::StockQuantities>] A map of stock_location_ids to the stock quantities available in that location
       def on_hand_by_stock_location_id
-        counts_on_hand.to_a.group_by do |(_, stock_location_id), _|
+        quantities_by_location_id = counts_on_hand.to_a.group_by do |(_, stock_location_id), _|
           stock_location_id
         end.transform_values do |values|
           Spree::StockQuantities.new(
@@ -31,12 +31,13 @@ module Spree
             end.to_h
           )
         end
+        restore_location_order(quantities_by_location_id)
       end
 
-      # Get the on_hand stock quantities
+      # Get the backorderable stock quantities
       # @return [Hash<Integer=>Spree::StockQuantities>] A map of stock_location_ids to the stock quantities available in that location
       def backorderable_by_stock_location_id
-        backorderables.group_by(&:second).transform_values do |variant_ids|
+        quantities_by_location_id = backorderables.group_by(&:second).transform_values do |variant_ids|
           Spree::StockQuantities.new(
             variant_ids.map do |variant_id, _|
               variant = @variant_map[variant_id]
@@ -44,6 +45,7 @@ module Spree
             end.to_h
           )
         end
+        restore_location_order(quantities_by_location_id)
       end
 
       private
@@ -67,6 +69,12 @@ module Spree
           where(variant_id: @variants).
           where(stock_location_id: @stock_locations)
       end
+
+      def restore_location_order(quantities_by_location_id)
+        sorted_location_ids = @stock_locations.map(&:id)
+
+        quantities_by_location_id.sort_by { |key, _value| sorted_location_ids.index(key) }.to_h
+      end
     end
   end
 end

data/app/models/spree/stock/quantifier.rb

@@ -6,14 +6,18 @@ module Spree
       attr_reader :stock_items
 
       # @param [Variant] variant The variant to check inventory for.
-      # @param [StockLocation, Integer] stock_location The stock_location to check inventory in. If unspecified it will check inventory in all available StockLocations
-      def initialize(variant, stock_location = nil)
+      # @param [StockLocation, Integer] stock_location_or_id
+      #        The stock_location or stock location ID to check inventory in.
+      #        If unspecified it will check inventory in all available StockLocations
+      def initialize(variant, stock_location_or_id = nil)
         @variant = variant
-        @stock_items = Spree::StockItem.where(variant_id: variant)
-        if stock_location
-          @stock_items.where!(stock_location: stock_location)
-        else
-          @stock_items.joins!(:stock_location).merge!(Spree::StockLocation.active)
+        @stock_items = variant.stock_items.select do |stock_item|
+          if stock_location_or_id
+            stock_item.stock_location == stock_location_or_id ||
+              stock_item.stock_location_id == stock_location_or_id
+          else
+            stock_item.stock_location.active?
+          end
         end
       end
 
@@ -23,7 +27,7 @@ module Spree
       #   inventory is not tracked on the variant.
       def total_on_hand
         if @variant.should_track_inventory?
-          stock_items.sum(:count_on_hand)
+          stock_items.sum(&:count_on_hand)
         else
           Float::INFINITY
         end

data/app/models/spree/stock/simple_coordinator.rb

@@ -24,7 +24,8 @@ module Spree
 
       def initialize(order, inventory_units = nil)
         @order = order
-        @inventory_units = inventory_units || InventoryUnitBuilder.new(order).units
+        @inventory_units =
+          inventory_units || Spree::Config.stock.inventory_unit_builder_class.new(order).units
         @splitters = Spree::Config.environment.stock_splitters
 
         filtered_stock_locations = Spree::Config.stock.location_filter_class.new(Spree::StockLocation.all, @order).filter
@@ -73,11 +74,16 @@ module Spree
         packages = split_packages(packages)
 
         # Turn the Stock::Packages into a Shipment with rates
-        packages.map do |package|
+        shipments = packages.map do |package|
           shipment = package.shipment = package.to_shipment
           shipment.shipping_rates = Spree::Config.stock.estimator_class.new.shipping_rates(package)
           shipment
         end
+
+        # Make sure we don't add the proposed shipments to the order
+        order.shipments = order.shipments - shipments
+
+        shipments
       end
 
       def split_packages(initial_packages)
@@ -87,30 +93,6 @@ module Spree
         end
       end
 
-      def allocate_inventory(availability_by_location)
-        sorted_availability = sort_availability(availability_by_location)
-
-        sorted_availability.transform_values do |available|
-          # Find the desired inventory which is available at this location
-          packaged = available & @desired
-          # Remove found inventory from desired
-          @desired -= packaged
-          packaged
-        end
-      end
-      deprecate allocate_inventory: 'allocate_inventory is deprecated. Please write your own allocator defining' \
-        'a Spree::Stock::Allocator::Base subclass', deprecator: Spree::Deprecation
-
-      def sort_availability(availability)
-        sorted_availability = availability.sort_by do |stock_location_id, _|
-          @stock_locations.find_index do |stock_location|
-            stock_location.id == stock_location_id
-          end
-        end
-
-        Hash[sorted_availability]
-      end
-
       def get_units(quantities)
         # Change our raw quantities back into inventory units
         quantities.flat_map do |variant, quantity|

data/app/models/spree/stock/splitter/base.rb

@@ -6,13 +6,8 @@ module Spree
       class Base
         attr_reader :stock_location, :next_splitter
 
-        def initialize(stock_location_or_packer, next_splitter = nil)
-          if stock_location_or_packer.is_a?(Spree::StockLocation)
-            @stock_location = stock_location_or_packer
-          else
-            Spree::Deprecation.warn("Initializing Splitters with a Packer is DEPRECATED. Pass a StockLocation instead.")
-            @stock_location = stock_location_or_packer.stock_location
-          end
+        def initialize(stock_location, next_splitter = nil)
+          @stock_location = stock_location
           @next_splitter = next_splitter
         end
 

data/app/models/spree/stock_item.rb

@@ -20,7 +20,7 @@ module Spree
     after_save :conditional_variant_touch, if: :saved_changes?
     after_touch { variant.touch }
 
-    self.whitelisted_ransackable_attributes = ['count_on_hand', 'stock_location_id']
+    self.allowed_ransackable_attributes = ['count_on_hand', 'stock_location_id']
 
     # @return [Array<Spree::InventoryUnit>] the backordered inventory units
     #   associated with this stock item
@@ -110,13 +110,7 @@ module Spree
     end
 
     def inventory_cache_threshold
-      # only warn if store is setting binary_inventory_cache (default = false)
-      @cache_threshold ||= if Spree::Config.binary_inventory_cache
-        Spree::Deprecation.warn "Spree::Config.binary_inventory_cache=true is DEPRECATED. Instead use Spree::Config.inventory_cache_threshold=1"
-        1
-      else
-        Spree::Config.inventory_cache_threshold
-      end
+      @cache_threshold ||= Spree::Config.inventory_cache_threshold
     end
   end
 end

data/app/models/spree/stock_location.rb

@@ -26,12 +26,12 @@ module Spree
     validates_uniqueness_of :code, allow_blank: true, case_sensitive: false
 
     scope :active, -> { where(active: true) }
-    scope :order_default, -> { order(default: :desc, name: :asc) }
+    scope :order_default, -> { order(default: :desc, position: :asc) }
 
     after_create :create_stock_items, if: :propagate_all_variants?
     after_save :ensure_one_default
 
-    self.whitelisted_ransackable_attributes = %w[name]
+    self.allowed_ransackable_attributes = %w[name]
 
     def state_text
       state.try(:abbr) || state.try(:name) || state_name

data/app/models/spree/stock_movement.rb

@@ -13,8 +13,8 @@ module Spree
 
     scope :recent, -> { order(created_at: :desc) }
 
-    self.whitelisted_ransackable_associations = %w[variant]
-    self.whitelisted_ransackable_attributes = ['quantity']
+    self.allowed_ransackable_associations = %w[variant]
+    self.allowed_ransackable_attributes = ['quantity']
 
     def readonly?
       !new_record?

data/app/models/spree/store.rb

@@ -25,12 +25,6 @@ module Spree
     before_save :ensure_default_exists_and_is_unique
     before_destroy :validate_not_default
 
-    scope :by_url, lambda { |url| where("url like ?", "%#{url}%") }
-
-    class << self
-      deprecate by_url: "Spree::Store.by_url is DEPRECATED", deprecator: Spree::Deprecation
-    end
-
     def available_locales
       locales = super()
       if locales
@@ -49,12 +43,6 @@ module Spree
       end
     end
 
-    def self.current(store_key)
-      Spree::Deprecation.warn "Spree::Store.current is DEPRECATED"
-      current_store = Store.find_by(code: store_key) || Store.by_url(store_key).first if store_key
-      current_store || Store.default
-    end
-
     def self.default
       where(default: true).first || new
     end

data/app/models/spree/store_credit.rb

@@ -40,6 +40,14 @@ class Spree::StoreCredit < Spree::PaymentSource
   extend Spree::DisplayMoney
   money_methods :amount, :amount_used, :amount_authorized
 
+  # Sets this store credit's amount to a new value,
+  # parsing it as a localized number if the new value is a string.
+  #
+  # @param number [String, #to_d] a new amount
+  def amount=(number)
+    self[:amount] = Spree::LocalizedNumber.parse(number)
+  end
+
   def amount_remaining
     return 0.0.to_d if invalidated?
     amount - amount_used - amount_authorized
@@ -150,7 +158,12 @@ class Spree::StoreCredit < Spree::PaymentSource
   end
 
   def generate_authorization_code
-    "#{id}-SC-#{Time.current.utc.strftime('%Y%m%d%H%M%S%6N')}"
+    [
+      id,
+      'SC',
+      Time.current.utc.strftime('%Y%m%d%H%M%S%6N'),
+      SecureRandom.uuid
+    ].join('-')
   end
 
   def editable?

data/app/models/spree/store_credit_category.rb

@@ -7,39 +7,7 @@ class Spree::StoreCreditCategory < Spree::Base
   class_attribute :non_expiring_credit_types
   self.non_expiring_credit_types = [Spree::StoreCreditType::NON_EXPIRING]
 
-  # @deprecated
-  class_attribute :reimbursement_category_name
-  self.reimbursement_category_name = I18n.t('spree.store_credit_category.default')
-
-  # @deprecated
-  def self.reimbursement_category(reimbursement)
-    reimbursement.store_credit_category
-  end
-
   def non_expiring?
     self.class.non_expiring_credit_types.include? name
   end
-
-  public_instance_methods.grep(/^reimbursement_category_name/).each do |method|
-    deprecate(
-      method => 'Use Spree::Reimbursement#store_credit_category.name instead',
-      deprecator: Spree::Deprecation
-    )
-  end
-
-  class << self
-    public_instance_methods.grep(/^reimbursement_category_name/).each do |method|
-      deprecate(
-        method => 'Use Spree::Reimbursement.store_credit_category.name instead',
-        deprecator: Spree::Deprecation
-      )
-    end
-
-    public_instance_methods.grep(/^reimbursement_category$/).each do |method|
-      deprecate(
-        method => 'Use Spree::Reimbursement.store_credit_category instead',
-        deprecator: Spree::Deprecation
-      )
-    end
-  end
 end

data/app/models/spree/store_credit_prioritizer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Spree
+  class StoreCreditPrioritizer
+    def initialize(credits, _order)
+      @credits = credits
+    end
+
+    def call
+      credits.order_by_priority
+    end
+
+    private
+
+    attr_reader :credits
+  end
+end

data/app/models/spree/tax/item_tax.rb

@@ -5,9 +5,10 @@ module Spree
     # Simple object used to hold tax data for an item.
     #
     # This generic object will hold the amount of tax that should be applied to
-    # an item. (Either a {Spree::LineItem} or a {Spree::Shipment}.)
+    # an item. (Either a {Spree::Order}, a {Spree::LineItem} or a {Spree::Shipment}.)
     #
-    # @attr_reader [Integer] item_id the {Spree::LineItem} or {Spree::Shipment} ID
+    # @attr_reader [Integer] item_id the {Spree::LineItem} or {Spree::Shipment} ID.
+    #   Or blank if an order-level tax.
     # @attr_reader [String] label information about the taxes
     # @attr_reader [Spree::TaxRate] tax_rate will be used as the source for tax
     #   adjustments

data/app/models/spree/tax/order_tax.rb

@@ -8,13 +8,15 @@ module Spree
     # adjustments on an order.
     #
     # @attr_reader [Integer] order_id the {Spree::Order} these taxes apply to
+    # @attr_reader [Array<Spree::Tax::ItemTax>] order_taxes an array of tax
+    #   data for the order
     # @attr_reader [Array<Spree::Tax::ItemTax>] line_item_taxes an array of
     #   tax data for order's line items
     # @attr_reader [Array<Spree::Tax::ItemTax>] shipment_taxes an array of
     #   tax data for the order's shipments
     class OrderTax
       include ActiveModel::Model
-      attr_accessor :order_id, :line_item_taxes, :shipment_taxes
+      attr_accessor :order_id, :order_taxes, :line_item_taxes, :shipment_taxes
     end
   end
 end

data/app/models/spree/tax/tax_helpers.rb

@@ -6,9 +6,9 @@ module Spree
       private
 
       def rates_for_item(item)
-        @rates_for_order ||= Spree::TaxRate.for_address(item.order.tax_address)
+        @rates_for_item ||= Spree::TaxRate.item_level.for_address(item.order.tax_address)
 
-        @rates_for_order.select do |rate|
+        @rates_for_item.select do |rate|
           rate.active? && rate.tax_categories.map(&:id).include?(item.tax_category_id)
         end
       end

data/app/models/spree/tax/tax_location.rb

@@ -8,7 +8,7 @@ module Spree
     # @attr_reader [Integer] country_id the ID of a Spree::Country object
     # @attr_reader [Integer] state_id the ID of a Spree::State object
     class TaxLocation
-      attr_reader :country_id, :state_id
+      attr_reader :country, :state
 
       # Create a new TaxLocation object
       #
@@ -19,18 +19,15 @@ module Spree
       #
       # @return [Spree::Tax::TaxLocation] a Spree::Tax::TaxLocation object
       def initialize(country: nil, state: nil)
-        @country_id = country && country.id
-        @state_id = state && state.id
+        @country, @state = country, state
       end
+      delegate :id, to: :state, prefix: true, allow_nil: true
+      delegate :id, to: :country, prefix: true, allow_nil: true
 
       def ==(other)
         state_id == other.state_id && country_id == other.country_id
       end
 
-      def country
-        Spree::Country.find_by(id: country_id)
-      end
-
       def empty?
         country_id.nil? && state_id.nil?
       end

data/app/models/spree/tax_calculator/default.rb

@@ -25,6 +25,7 @@ module Spree
       def calculate
         Spree::Tax::OrderTax.new(
           order_id: order.id,
+          order_taxes: order_rates,
           line_item_taxes: line_item_rates,
           shipment_taxes: shipment_rates
         )
@@ -34,6 +35,23 @@ module Spree
 
       attr_reader :order
 
+      # Calculate the order-level taxes.
+      #
+      # @private
+      # @return [Array<Spree::Tax::ItemTax>] calculated taxes for the order
+      def order_rates
+        rates_for_order.map do |rate|
+          amount = rate.compute_amount(order)
+
+          Spree::Tax::ItemTax.new(
+            label: rate.adjustment_label(amount),
+            tax_rate: rate,
+            amount: amount,
+            included_in_price: rate.included_in_price
+          )
+        end
+      end
+
       # Calculate the taxes for line items.
       #
       # @private
@@ -76,6 +94,19 @@ module Spree
           )
         end
       end
+
+      # @private
+      # @return [Array<Spree::TaxRate>] rates that apply to an order
+      def rates_for_order
+        tax_category_ids = Set[
+          *@order.line_items.map(&:tax_category_id),
+          *@order.shipments.map(&:tax_category_id)
+        ]
+        rates = Spree::TaxRate.active.order_level.for_address(@order.tax_address)
+        rates.select do |rate|
+          tax_category_ids.intersect?(rate.tax_category_ids.to_set)
+        end
+      end
     end
   end
 end

data/app/models/spree/tax_calculator/shipping_rate.rb

@@ -9,26 +9,16 @@ module Spree
     # looking to provide their own calculator should adhere to the API of this
     # class.
     #
-    # @see Spree::Tax::ShippingRateTaxer
+    # @see Spree::Stock::Estimator
     class ShippingRate
       include Spree::Tax::TaxHelpers
 
-      attr_reader :shipping_rate
-
       # Create a new tax calculator.
       #
       # @param [Spree::Order] order the order to calculate taxes on
       # @return [Spree::TaxCalculator::ShippingRate]
       def initialize(order)
-        if order.is_a?(::Spree::ShippingRate)
-          Spree::Deprecation.warn "passing a single shipping rate to Spree::TaxCalculator::ShippingRate is DEPRECATED. It now expects an order"
-          shipping_rate = order
-          @order = shipping_rate.order
-          @shipping_rate = shipping_rate
-        else
-          @order = order
-          @shipping_rate = nil
-        end
+        @order = order
       end
 
       # Calculate taxes for a shipping rate.
@@ -38,7 +28,6 @@ module Spree
       # @return [Array<Spree::Tax::ItemTax>] the calculated taxes for the
       #   shipping rate
       def calculate(shipping_rate)
-        shipping_rate ||= @shipping_rate
         rates_for_item(shipping_rate).map do |rate|
           amount = rate.compute_amount(shipping_rate)
 

data/app/models/spree/tax_rate.rb

@@ -11,6 +11,11 @@ module Spree
     include Spree::CalculatedAdjustments
     include Spree::AdjustmentSource
 
+    enum level: {
+      item: 0,
+      order: 1
+    }, _suffix: true
+
     belongs_to :zone, class_name: "Spree::Zone", inverse_of: :tax_rates, optional: true
 
     has_many :tax_rate_tax_categories,
@@ -27,6 +32,8 @@ module Spree
 
     validates :amount, presence: true, numericality: true
 
+    self.allowed_ransackable_associations = %w[tax_categories zone]
+
     # Finds all tax rates whose zones match a given address
     scope :for_address, ->(address) { joins(:zone).merge(Spree::Zone.for_address(address)) }
     scope :for_country,
@@ -87,23 +94,6 @@ module Spree
     end
     scope :included_in_price, -> { where(included_in_price: true) }
 
-    # Creates necessary tax adjustments for the order.
-    #
-    # @deprecated Please use `Spree::Tax::OrderAdjuster#adjust!` instead
-    def adjust(_order_tax_zone, item)
-      Spree::Deprecation.warn("`Spree::TaxRate#adjust` is deprecated. Please use `Spree::Tax::OrderAdjuster#adjust!` instead.", caller)
-
-      amount = compute_amount(item)
-
-      item.adjustments.create!(
-        source: self,
-        amount: amount,
-        order_id: item.order_id,
-        label: adjustment_label(amount),
-        included: included_in_price
-      )
-    end
-
     # This method is used by Adjustment#update to recalculate the cost.
     def compute_amount(item)
       calculator.compute(item)
@@ -123,16 +113,6 @@ module Spree
       )
     end
 
-    def tax_category=(category)
-      self.tax_categories = [category]
-    end
-
-    def tax_category
-      tax_categories[0]
-    end
-
-    deprecate :tax_category => :tax_categories, :tax_category= => :tax_categories=, deprecator: Spree::Deprecation
-
     private
 
     def amount_for_adjustment_label
@@ -143,6 +123,8 @@ module Spree
     end
 
     def translation_key(_amount)
+      return "flat_fee" if calculator.is_a?(Spree::Calculator::FlatFee)
+
       key = included_in_price? ? "vat" : "sales_tax"
       key += "_with_rate" if show_rate_in_label?
       key.to_sym

data/app/models/spree/taxon/active_storage_attachment.rb

@@ -6,13 +6,8 @@ module Spree::Taxon::ActiveStorageAttachment
 
   included do
     has_attachment :icon,
-                   styles: { mini: '32x32>', normal: '128x128>' },
-                   default_style: :mini
+                   styles: Spree::Config.taxon_image_styles,
+                   default_style: Spree::Config.taxon_image_style_default
     validate :icon_is_an_image
   end
-
-  def attachment_partial_name
-    Spree::Deprecation.warn("calling #attachment_partial_name on Spree::Taxon is deprecated without replacement.")
-    'paperclip'
-  end
 end

data/app/models/spree/taxon/paperclip_attachment.rb

@@ -5,25 +5,20 @@ module Spree::Taxon::PaperclipAttachment
 
   included do
     has_attached_file :icon,
-      styles: { mini: '32x32>', normal: '128x128>' },
-      default_style: :mini,
+      styles: Spree::Config.taxon_image_styles,
+      default_style: Spree::Config.taxon_image_style_default,
       url: '/spree/taxons/:id/:style/:basename.:extension',
       path: ':rails_root/public/spree/taxons/:id/:style/:basename.:extension',
       default_url: '/assets/default_taxon.png'
 
     validates_attachment :icon,
-      content_type: { content_type: %w[image/jpg image/jpeg image/png image/gif] }
+      content_type: { content_type: Spree::Config.allowed_image_mime_types }
   end
 
   def icon_present?
     icon.present?
   end
 
-  def attachment_partial_name
-    Spree::Deprecation.warn("calling #attachment_partial_name on Spree::Taxon is deprecated without replacement.")
-    'paperclip'
-  end
-
   def destroy_attachment(definition)
     return false unless respond_to?(definition)
 

data/app/models/spree/taxon.rb

@@ -27,18 +27,7 @@ module Spree
 
     include ::Spree::Config.taxon_attachment_module
 
-    self.whitelisted_ransackable_attributes = %w[name]
-
-    # @note This method is meant to be overridden on a store by store basis.
-    # @return [Array] filters that should be used for a taxon
-    def applicable_filters
-      Spree::Deprecation.warn "Spree::Taxon#applicable_filters is deprecated, if you are using this functionality please move it into your own application."
-
-      fs = []
-      fs << Spree::Core::ProductFilters.price_filter if Spree::Core::ProductFilters.respond_to?(:price_filter)
-      fs << Spree::Core::ProductFilters.brand_filter if Spree::Core::ProductFilters.respond_to?(:brand_filter)
-      fs
-    end
+    self.allowed_ransackable_attributes = %w[name]
 
     # @return [String] meta_title if set otherwise a string containing the
     #   root name and taxon name

data/app/models/spree/taxonomy.rb

@@ -13,7 +13,7 @@ module Spree
 
     default_scope -> { order(position: :asc) }
 
-    self.whitelisted_ransackable_attributes = %w[name]
+    self.allowed_ransackable_attributes = %w[name]
 
     private
 

data/app/models/spree/user_address.rb

@@ -19,11 +19,6 @@ module Spree
     scope :default_billing, -> { where(default_billing: true) }
     scope :active, -> { where(archived: false) }
 
-    scope :default, -> do
-      Spree::Deprecation.warn "This scope is deprecated. Please start using ::default_shipping."
-      default_shipping
-    end
-
     default_scope -> { order([default: :desc, updated_at: :desc]) }
   end
 end

data/app/models/spree/user_last_url_storer/rules/authentication_rule.rb

@@ -4,7 +4,7 @@ module Spree
   class UserLastUrlStorer
     module Rules
       # This is the basic rule that ships with Solidus that avoids storing in
-      # session the current path for login/loout/signup routes, avoiding possibly
+      # session the current path for login/logout/signup routes, avoiding possibly
       # infinte redirects.
       module AuthenticationRule
         AUTHENTICATION_ROUTES = %w[spree_signup_path spree_login_path spree_logout_path]