solidus_core 2.11.10 → 3.3.1

data/app/models/spree/line_item.rb

@@ -10,8 +10,6 @@ module Spree
   # promotion system.
   #
   class LineItem < Spree::Base
-    class CurrencyMismatch < StandardError; end
-
     belongs_to :order, class_name: "Spree::Order", inverse_of: :line_items, touch: true, optional: true
     belongs_to :variant, -> { with_discarded }, class_name: "Spree::Variant", inverse_of: :line_items, optional: true
     belongs_to :tax_category, class_name: "Spree::TaxCategory", optional: true
@@ -45,8 +43,8 @@ module Spree
 
     attr_accessor :target_shipment, :price_currency
 
-    self.whitelisted_ransackable_associations = ['variant']
-    self.whitelisted_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.
@@ -55,20 +53,11 @@ module Spree
     end
     alias subtotal amount
 
-    # @return [BigDecimal] the amount of this line item, taking into
-    #   consideration line item promotions.
-    def discounted_amount
-      amount + promo_total
-    end
-    deprecate discounted_amount: :total_before_tax, deprecator: Spree::Deprecation
-
     # @return [BigDecimal] the amount of this line item, taking into
     #   consideration all its adjustments.
     def total
       amount + adjustment_total
     end
-    alias final_amount total
-    deprecate final_amount: :total, deprecator: Spree::Deprecation
 
     # @return [BigDecimal] the amount of this item, taking into consideration
     #   all non-tax adjustments.
@@ -81,20 +70,11 @@ module Spree
     def total_excluding_vat
       total_before_tax - included_tax_total
     end
-    alias pre_tax_amount total_excluding_vat
-    deprecate pre_tax_amount: :total_excluding_vat, deprecator: Spree::Deprecation
 
     extend Spree::DisplayMoney
-    money_methods :amount, :discounted_amount, :price,
+    money_methods :amount, :price,
                   :included_tax_total, :additional_tax_total,
                   :total, :total_before_tax, :total_excluding_vat
-    deprecate display_discounted_amount: :display_total_before_tax, deprecator: Spree::Deprecation
-    alias display_final_amount display_total
-    deprecate display_final_amount: :display_total, deprecator: Spree::Deprecation
-    alias display_pre_tax_amount display_total_excluding_vat
-    deprecate display_pre_tax_amount: :display_total_excluding_vat, deprecator: Spree::Deprecation
-    alias discounted_money display_discounted_amount
-    deprecate discounted_money: :display_total_before_tax, deprecator: Spree::Deprecation
 
     # @return [Spree::Money] the price of this line item
     alias money_price display_price
@@ -103,8 +83,6 @@ module Spree
 
     # @return [Spree::Money] the amount of this line item
     alias money display_amount
-    alias display_total display_amount
-    deprecate display_total: :display_amount, deprecator: Spree::Deprecation
 
     # Sets price from a `Spree::Money` object
     #
@@ -112,9 +90,6 @@ module Spree
     def money_price=(money)
       if !money
         self.price = nil
-      elsif money.currency.iso_code != currency && Spree::Config.raise_with_invalid_currency
-        line_item_errors = ActiveModel::Errors.new(self)
-        raise CurrencyMismatch, line_item_errors.generate_message(:price, :does_not_match_order_currency, locale: :en)
       else
         self.price_currency = money.currency.iso_code
         self.price = money.to_d
@@ -148,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
 
@@ -156,12 +131,6 @@ module Spree
       Spree::Config.pricing_options_class.from_line_item(self)
     end
 
-    def currency=(_currency)
-      Spree::Deprecation.warn 'Spree::LineItem#currency= is deprecated ' \
-        'and will take no effect.',
-        caller
-    end
-
     private
 
     # Sets the quantity to zero if it is nil or less than zero.
@@ -177,25 +146,13 @@ module Spree
       set_pricing_attributes
     end
 
-    # Set price, cost_price and currency. This method used to be called #copy_price, but actually
-    # did more than just setting the price, hence renamed to #set_pricing_attributes
+    # Set price, cost_price and currency.
     def set_pricing_attributes
-      # If the legacy method #copy_price has been overridden, handle that gracefully
-      return handle_copy_price_override if respond_to?(:copy_price)
-
       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
 
-    def handle_copy_price_override
-      copy_price
-      Spree::Deprecation.warn 'You have overridden Spree::LineItem#copy_price. ' \
-        'This method is now called Spree::LineItem#set_pricing_attributes. ' \
-        'Please adjust your override.',
-        caller
-    end
-
     def update_inventory
       if (saved_changes? || target_shipment.present?) && order.has_checkout_step?("delivery")
         Spree::OrderInventory.new(order, self).verify(target_shipment)

data/app/models/spree/log_entry.rb

@@ -2,10 +2,83 @@
 
 module Spree
   class LogEntry < Spree::Base
+    # Classes used in core that can be present in serialized details
+    #
+    # Users can add their own classes in
+    # `Spree::Config#log_entry_permitted_classes`.
+    #
+    # @see Spree::AppConfiguration#log_entry_permitted_classes
+    CORE_PERMITTED_CLASSES = [
+      ActiveMerchant::Billing::Response,
+      ActiveSupport::TimeWithZone,
+      Time,
+      ActiveSupport::TimeZone
+    ].freeze
+
+    # Raised when a disallowed class is tried to be loaded
+    class DisallowedClass < RuntimeError
+      attr_reader :psych_exception
+
+      def initialize(psych_exception:)
+        @psych_exception = psych_exception
+        super(default_message)
+      end
+
+      private
+
+      def default_message
+        <<~MSG
+          #{psych_exception.message}
+
+          You can specify custom classes to be loaded in config/initializers/spree.rb. E.g:
+
+          Spree.config do |config|
+            config.log_entry_permitted_classes = ['MyClass']
+          end
+        MSG
+      end
+    end
+
+    # Raised when YAML contains aliases and they're not enabled
+    class BadAlias < RuntimeError
+      attr_reader :psych_exception
+
+      def initialize(psych_exception:)
+        @psych_exception = psych_exception
+        super(default_message)
+      end
+
+      private
+
+      def default_message
+        <<~MSG
+          #{psych_exception.message}
+
+          You can explicitly enable aliases in config/initializers/spree.rb. E.g:
+
+          Spree.config do |config|
+            config.log_entry_allow_aliases = true
+          end
+        MSG
+      end
+    end
+
+    def self.permitted_classes
+      CORE_PERMITTED_CLASSES + Spree::Config.log_entry_permitted_classes.map(&:constantize)
+    end
+
     belongs_to :source, polymorphic: true, optional: true
 
     def parsed_details
-      @details ||= YAML.load(details)
+      @details ||= YAML.safe_load(
+        details,
+        permitted_classes: self.class.permitted_classes,
+        aliases: Spree::Config.log_entry_allow_aliases
+      )
+    rescue Psych::DisallowedClass => e
+      raise DisallowedClass.new(psych_exception: e)
+    rescue Psych::BadAlias => e
+      raise BadAlias.new(psych_exception: e)
     end
   end
 end

data/app/models/spree/option_type.rb

@@ -25,7 +25,7 @@ module Spree
     after_touch :touch_all_products
     after_save :touch_all_products
 
-    self.whitelisted_ransackable_attributes = %w[name]
+    self.allowed_ransackable_attributes = %w[name]
 
     def touch_all_products
       products.find_each(&:touch)

data/app/models/spree/option_value.rb

@@ -2,6 +2,8 @@
 
 module Spree
   class OptionValue < Spree::Base
+    # TODO: Remove optional on Solidus v4.0. Don't forget adding a migration to
+    # enforce at the database layer
     belongs_to :option_type, class_name: 'Spree::OptionType', inverse_of: :option_values, optional: true
     acts_as_list scope: :option_type
 
@@ -13,10 +15,17 @@ module Spree
 
     after_save :touch, if: :saved_changes?
     after_touch :touch_all_variants
+    after_save do
+      Spree::Deprecation.warn <<~MSG if option_type.nil?
+        Having an option_value with no associated option_type will be deprecated
+        on Solidus v4.0
+      MSG
+    end
 
+    # TODO: Remove allow_nil once option_type is required on Solidus v4.0
     delegate :name, :presentation, to: :option_type, prefix: :option_type, allow_nil: true
 
-    self.whitelisted_ransackable_attributes = %w[name presentation]
+    self.allowed_ransackable_attributes = %w[name presentation]
 
     # Updates the updated_at column on all the variants associated with this
     # option value.

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

@@ -35,11 +35,17 @@ module Spree
         # Use the random number if no other order exists with it.
         if Spree::Order.exists?(number: random)
           # If over half of all possible options are taken add another digit.
-          @length += 1 if Spree::Order.count > (10**@length / 2)
+          @length += 1 if order_count > (10**@length / 2)
         else
           break random
         end
       end
     end
+
+    private
+
+    def order_count
+      @order_count ||= Spree::Order.count
+    end
   end
 end