solidus_core 3.0.2 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca6d8d275b71868fa0cbcfd87ea5c540ed14c4db6908e90192012889adc936b9
-  data.tar.gz: b9333bbde0b2634d590a9021d2b4c4a2cb398a25099254947b870f94ff0d5992
+  metadata.gz: 25d076da4eef33c845f1da39a5bb6e7b6164c98372bc59f1d9cd441fc182576a
+  data.tar.gz: f4b6369b678db721bd71e67323468e376e6ab59bfb67cb766cbc05927a42cc7c
 SHA512:
-  metadata.gz: c56f0af4fbd26a4d486aaeb170d6554d256a7265a33a0a515150822dc8aefa1369e7e4ce8b3e3b60ea2a32318b9f03d9f214d18c6014ff248649d3867cc83a0b
-  data.tar.gz: acc8a07396946a959ebda8e0c7953eb7cb6ac656a7e91debd6e0159d0c7a6e896f0406d226fd3e28d6776999fc9797938010cdb952bea32ae819cdd64f435b4e
+  metadata.gz: 5eec6a669e66e4fb3c2a492844ff0e73c60e06b14b959f9ea868995e2f5e766f1a6493da85ef3494e726e0ddbbc483dc93b524d4a07be31305edde61fe917d24
+  data.tar.gz: aae29e7ece97dde8df64e368e2bddf5c9bd95cc5118a345d343d8625234355e15b9edf055f9aac7bca2d048235cff6b77de4cfcbd7ae81b544769924d7aa4c89

data/app/helpers/spree/base_helper.rb

@@ -130,7 +130,7 @@ module Spree
     end
 
     def display_price(product_or_variant)
-      product_or_variant.price_for(current_pricing_options).to_html
+      product_or_variant.price_for_options(current_pricing_options)&.money&.to_html
     end
 
     def pretty_time(time, format = :long)

data/app/helpers/spree/products_helper.rb

@@ -38,7 +38,7 @@ module Spree
                   .with_prices(current_pricing_options)
                   .all? { |variant_with_prices| variant_with_prices.price_same_as_master?(current_pricing_options) }
 
-      variant.price_for(current_pricing_options).to_html
+      variant.price_for_options(current_pricing_options)&.money&.to_html
     end
 
     # Converts line breaks in product description into <p> tags.

data/app/models/concerns/spree/default_price.rb

@@ -5,23 +5,76 @@ module Spree
     extend ActiveSupport::Concern
 
     included do
-      has_one :default_price,
-        -> { with_discarded.currently_valid.with_default_attributes },
-        class_name: 'Spree::Price',
-        inverse_of: :variant,
-        dependent: :destroy,
-        autosave: true
+      delegate :display_price, :display_amount, :price, to: :default_price, allow_nil: true
+      delegate :price=, to: :default_price_or_build
+
+      # @see Spree::Variant::PricingOptions.default_price_attributes
+      def self.default_price_attributes
+        Spree::Config.default_pricing_options.desired_attributes
+      end
     end
 
-    def find_or_build_default_price
-      default_price || build_default_price(Spree::Config.default_pricing_options.desired_attributes)
+    # Returns `#prices` prioritized for being considered as default price
+    #
+    # @return [ActiveRecord::Relation<Spree::Price>]
+    def currently_valid_prices
+      prices.currently_valid
     end
 
-    delegate :display_price, :display_amount, :price, to: :find_or_build_default_price
-    delegate :price=, to: :find_or_build_default_price
+    # Returns {#default_price} or builds it from {Spree::Variant.default_price_attributes}
+    #
+    # @return [Spree::Price, nil]
+    # @see Spree::Variant.default_price_attributes
+    def default_price_or_build
+      default_price ||
+        prices.build(self.class.default_price_attributes)
+    end
+
+    # Select from {#prices} the one to be considered as the default
+    #
+    # This method works with the in-memory association, so non-persisted prices
+    # are taken into account. Discarded prices are also considered.
+    #
+    # A price is a candidate to be considered as the default when it meets
+    # {Spree::Variant.default_price_attributes} criteria. When more than one candidate is
+    # found, non-persisted records take preference. When more than one persisted
+    # candidate exists, the one most recently updated is taken or, in case of
+    # race condition, the one with higher id.
+    #
+    # @return [Spree::Price, nil]
+    # @see Spree::Variant.default_price_attributes
+    def default_price
+      prioritized_default(
+        prices_meeting_criteria_to_be_default(
+          (prices + prices.with_discarded).uniq
+        )
+      )
+    end
 
     def has_default_price?
       default_price.present? && !default_price.discarded?
     end
+
+    private
+
+    def prices_meeting_criteria_to_be_default(prices)
+      criteria = self.class.default_price_attributes.transform_keys(&:to_s)
+      prices.select do |price|
+        contender = price.attributes.slice(*criteria.keys)
+        criteria == contender
+      end
+    end
+
+    def prioritized_default(prices)
+      prices.min do |prev, succ|
+        contender_one, contender_two = [succ, prev].map do |item|
+          [
+            item.updated_at || Time.zone.now,
+            item.id || Float::INFINITY
+          ]
+        end
+        contender_one <=> contender_two
+      end
+    end
   end
 end

data/app/models/spree/adjustment.rb

@@ -55,11 +55,12 @@ module Spree
     #
     # @param excluded_orders [Array<Spree::Order>] Orders to exclude from query
     # @return [ActiveRecord::Relation] Scoped Adjustments
-    def self.in_completed_orders(excluded_orders: [])
-      joins(:order).
-      merge(Spree::Order.complete).
-      where.not(spree_orders: { id: excluded_orders }).
-      distinct
+    def self.in_completed_orders(excluded_orders: [], exclude_canceled: false)
+      result = joins(:order)
+               .merge(Spree::Order.complete)
+               .where.not(spree_orders: { id: excluded_orders })
+               .distinct
+      exclude_canceled ? result.merge(Spree::Order.not_canceled) : result
     end
 
     def finalize!

data/app/models/spree/customer_return.rb

@@ -40,7 +40,8 @@ module Spree
     # Temporarily tie a customer_return to one order
     def order
       return nil if return_items.blank?
-      return_items.first.inventory_unit.order
+
+      return_items.first.inventory_unit&.order
     end
 
     def fully_reimbursed?
@@ -65,7 +66,7 @@ module Spree
     end
 
     def return_items_belong_to_same_order
-      if return_items.reject{ |return_item| return_item.inventory_unit.order_id == order_id }.any?
+      if return_items.reject{ |return_item| return_item.inventory_unit&.order_id == order_id }.any?
         errors.add(:base, I18n.t('spree.return_items_cannot_be_associated_with_multiple_orders'))
       end
     end

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

@@ -12,13 +12,8 @@ module Spree::Image::ActiveStorageAttachment
     validate :supported_content_type
 
     has_attachment :attachment,
-                   styles: {
-                   mini: '48x48>',
-                   small: '400x400>',
-                   product: '680x680>',
-                   large: '1200x1200>'
-                 },
-                 default_style: :product
+                   styles: Spree::Config.product_image_styles,
+                   default_style: Spree::Config.product_image_style_default
 
     def supported_content_type
       unless attachment.content_type.in?(Spree::Config.allowed_image_mime_types)

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

@@ -7,8 +7,8 @@ module Spree::Image::PaperclipAttachment
     validate :no_attachment_errors
 
     has_attached_file :attachment,
-                      styles: { mini: '48x48>', small: '400x400>', product: '680x680>', large: '1200x1200>' },
-                      default_style: :product,
+                      styles: Spree::Config.product_image_styles,
+                      default_style: Spree::Config.product_image_style_default,
                       default_url: 'noimage/:style.png',
                       url: '/spree/products/:id/:style/:basename.:extension',
                       path: ':rails_root/public/spree/products/:id/:style/:basename.:extension',

data/app/models/spree/line_item.rb

@@ -123,7 +123,7 @@ module Spree
       # 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')
-        self.money_price = variant.price_for(pricing_options)
+        self.money_price = variant.price_for_options(pricing_options)&.money
       end
     end
 
@@ -149,7 +149,7 @@ module Spree
     # Set price, cost_price and currency.
     def set_pricing_attributes
       self.cost_price ||= variant.cost_price
-      self.money_price = variant.price_for(pricing_options) if price.nil?
+      self.money_price = variant.price_for_options(pricing_options)&.money if price.nil?
       true
     end
 

data/app/models/spree/order.rb

@@ -51,7 +51,7 @@ module Spree
     end
 
     self.whitelisted_ransackable_associations = %w[shipments user order_promotions promotions bill_address ship_address line_items]
-    self.whitelisted_ransackable_attributes = %w[bill_address_name completed_at created_at email number state payment_state shipment_state total store_id]
+    self.whitelisted_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
@@ -128,7 +128,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 }
@@ -269,15 +269,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.
@@ -750,10 +750,15 @@ 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

data/app/models/spree/price.rb

@@ -13,7 +13,7 @@ module Spree
     delegate :tax_rates, to: :variant
 
     validate :check_price
-    validates :amount, allow_nil: true, numericality: {
+    validates :amount, numericality: {
       greater_than_or_equal_to: 0,
       less_than_or_equal_to: MAXIMUM_AMOUNT
     }

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

@@ -29,25 +29,25 @@ module Spree
           scope :descend_by_name, -> { order(name: :desc) }
 
           add_search_scope :ascend_by_master_price do
-            joins(master: :default_price).select('spree_products.* , spree_prices.amount')
+            joins(master: :prices).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).select('spree_products.* , spree_prices.amount')
+            joins(master: :prices).select('spree_products.* , spree_prices.amount')
                                          .order(Spree::Price.arel_table[:amount].desc)
           end
 
           add_search_scope :price_between do |low, high|
-            joins(master: :default_price).where(Price.table_name => { amount: low..high })
+            joins(master: :prices).where(Price.table_name => { amount: low..high })
           end
 
           add_search_scope :master_price_lte do |price|
-            joins(master: :default_price).where("#{price_table_name}.amount <= ?", price)
+            joins(master: :prices).where("#{price_table_name}.amount <= ?", price)
           end
 
           add_search_scope :master_price_gte do |price|
-            joins(master: :default_price).where("#{price_table_name}.amount >= ?", price)
+            joins(master: :prices).where("#{price_table_name}.amount >= ?", price)
           end
 
           # This scope selects products in taxon AND all its descendants

data/app/models/spree/product.rb

@@ -60,6 +60,17 @@ module Spree
     has_many :line_items, through: :variants_including_master
     has_many :orders, through: :line_items
 
+    scope :sort_by_master_default_price_amount_asc, -> {
+      with_default_price.order('spree_prices.amount ASC')
+    }
+    scope :sort_by_master_default_price_amount_desc, -> {
+      with_default_price.order('spree_prices.amount DESC')
+    }
+    scope :with_default_price, -> {
+      left_joins(master: :prices)
+        .where(master: { spree_prices: Spree::Config.default_pricing_options.desired_attributes })
+    }
+
     def find_or_build_master
       master || build_master
     end
@@ -84,6 +95,7 @@ module Spree
              :has_default_price?,
              :images,
              :price_for,
+             :price_for_options,
              :rebuild_vat_prices=,
              to: :find_or_build_master
 

data/app/models/spree/promotion/rules/item_total.rb

@@ -5,12 +5,38 @@ module Spree
     module Rules
       # A rule to apply to an order greater than (or greater than or equal to)
       # a specific amount
+      #
+      # To add extra operators please override `self.operators_map` or any other helper method.
+      # To customize the error message you can also override `ineligible_message`.
       class ItemTotal < PromotionRule
+        include ActiveSupport::Deprecation::DeprecatedConstantAccessor
+
         preference :amount, :decimal, default: 100.00
         preference :currency, :string, default: ->{ Spree::Config[:currency] }
-        preference :operator, :string, default: '>'
+        preference :operator, :string, default: 'gt'
+
+        # The list of allowed operators names mapped to their symbols.
+        def self.operators_map
+          {
+            gte: :>=,
+            gt: :>,
+          }
+        end
+
+        def self.operator_options
+          operators_map.map do |name, _method|
+            [I18n.t(name, scope: 'spree.item_total_rule.operators'), name]
+          end
+        end
 
-        OPERATORS = ['gt', 'gte']
+        # @deprecated
+        OPERATORS = operators_map.keys.map(&:to_s)
+        deprecate_constant(
+          :OPERATORS,
+          :operators_map,
+          message: "OPERATORS is deprecated! Use `operators_map.keys.map(&:to_s)` instead.",
+          deprecator: Spree::Deprecation,
+        )
 
         def applicable?(promotable)
           promotable.is_a?(Spree::Order)
@@ -18,8 +44,8 @@ module Spree
 
         def eligible?(order, _options = {})
           return false unless order.currency == preferred_currency
-          item_total = order.item_total
-          unless item_total.send(preferred_operator == 'gte' ? :>= : :>, BigDecimal(preferred_amount.to_s))
+
+          unless total_for_order(order).send(operator, threshold)
             eligibility_errors.add(:base, ineligible_message, error_code: ineligible_error_code)
           end
 
@@ -28,15 +54,33 @@ module Spree
 
         private
 
+        def operator
+          self.class.operators_map.fetch(
+            preferred_operator.to_sym,
+            preferred_operator_default,
+          )
+        end
+
+        def total_for_order(order)
+          order.item_total
+        end
+
+        def threshold
+          BigDecimal(preferred_amount.to_s)
+        end
+
         def formatted_amount
           Spree::Money.new(preferred_amount, currency: preferred_currency).to_s
         end
 
         def ineligible_message
-          if preferred_operator == 'gte'
+          case preferred_operator.to_s
+          when 'gte'
             eligibility_error_message(:item_total_less_than, amount: formatted_amount)
-          else
+          when 'gt'
             eligibility_error_message(:item_total_less_than_or_equal, amount: formatted_amount)
+          else
+            eligibility_error_message(:item_total_doesnt_match_with_operator, amount: formatted_amount, operator: preferred_operator)
           end
         end
 

data/app/models/spree/promotion.rb

@@ -47,7 +47,7 @@ module Spree
         where(table[:expires_at].eq(nil).or(table[:expires_at].gt(time)))
     end
     scope :has_actions, -> do
-      joins(:promotion_actions)
+      joins(:promotion_actions).distinct
     end
     scope :applied, -> { joins(:order_promotions).distinct }
 
@@ -192,7 +192,7 @@ module Spree
     def usage_count(excluded_orders: [])
       Spree::Adjustment.promotion.
         eligible.
-        in_completed_orders(excluded_orders: excluded_orders).
+        in_completed_orders(excluded_orders: excluded_orders, exclude_canceled: true).
         where(source_id: actions).
         count(:order_id)
     end

data/app/models/spree/promotion_code.rb

@@ -30,7 +30,7 @@ class Spree::PromotionCode < Spree::Base
   def usage_count(excluded_orders: [])
     adjustments.
     eligible.
-    in_completed_orders(excluded_orders: excluded_orders).
+    in_completed_orders(excluded_orders: excluded_orders, exclude_canceled: true).
     count(:order_id)
   end
 

data/app/models/spree/shipping_rate_tax.rb

@@ -5,7 +5,7 @@ module Spree
   # @attr [Spree::ShippingRate] shipping_rate The shipping rate to be taxed
   # @attr [Spree::TaxRate] tax_rate The tax rate used to calculate the tax amount
   # @since 1.3.0
-  # @see Spree::Tax::ShippingRateTaxer
+  # @see Spree::Stock::Estimator
   class ShippingRateTax < Spree::Base
     belongs_to :shipping_rate, class_name: "Spree::ShippingRate", optional: true
     belongs_to :tax_rate, class_name: "Spree::TaxRate", optional: true

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/simple_coordinator.rb

@@ -92,16 +92,6 @@ module Spree
         end
       end
 
-      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_location.rb

@@ -26,7 +26,7 @@ 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

data/app/models/spree/store_credit.rb

@@ -150,7 +150,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/tax_calculator/shipping_rate.rb

@@ -9,7 +9,7 @@ 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
 

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

@@ -6,8 +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
 end

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

@@ -5,14 +5,14 @@ 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?

data/app/models/spree/variant/price_selector.rb

@@ -26,11 +26,24 @@ module Spree
       # @param [Spree::Variant::PricingOptions] price_options Pricing Options to abide by
       # @return [Spree::Money, nil] The most specific price for this set of pricing options.
       def price_for(price_options)
+        Spree::Deprecation.warn(
+          "price_for is deprecated and will be removed. The price_for method
+          should return a Spree::Price as described. Please use
+          #price_for_options and adjust your frontend code to explicitly call
+          &.money where required"
+        )
+        price_for_options(price_options)&.money
+      end
+
+      # The variant's Spree::Price record, given a set of pricing options
+      # @param [Spree::Variant::PricingOptions] price_options Pricing Options to abide by
+      # @return [Spree::Price, nil] The most specific price for this set of pricing options.
+      def price_for_options(price_options)
         variant.currently_valid_prices.detect do |price|
-          ( price.country_iso == price_options.desired_attributes[:country_iso] ||
-            price.country_iso.nil?
+          (price.country_iso == price_options.desired_attributes[:country_iso] ||
+           price.country_iso.nil?
           ) && price.currency == price_options.desired_attributes[:currency]
-        end.try!(:money)
+        end
       end
     end
   end