solidus_core 2.10.5 → 3.0.8

data/app/models/spree/line_item.rb

@@ -10,10 +10,8 @@ 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_deleted }, class_name: "Spree::Variant", inverse_of: :line_items, 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
 
     has_one :product, through: :variant
@@ -33,6 +31,7 @@ module Spree
       greater_than: -1
     }
     validates :price, numericality: true
+    validate :price_match_order_currency
 
     after_save :update_inventory
 
@@ -42,7 +41,7 @@ module Spree
     delegate :name, :description, :sku, :should_track_inventory?, to: :variant
     delegate :currency, to: :order, allow_nil: true
 
-    attr_accessor :target_shipment
+    attr_accessor :target_shipment, :price_currency
 
     self.whitelisted_ransackable_associations = ['variant']
     self.whitelisted_ransackable_attributes = ['variant_id']
@@ -54,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.
@@ -80,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
@@ -102,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
     #
@@ -111,9 +90,8 @@ module Spree
     def money_price=(money)
       if !money
         self.price = nil
-      elsif money.currency.iso_code != currency
-        raise CurrencyMismatch, "Line item price currency must match order currency!"
       else
+        self.price_currency = money.currency.iso_code
         self.price = money.to_d
       end
     end
@@ -153,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.
@@ -174,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?
       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)
@@ -202,5 +162,11 @@ module Spree
     def destroy_inventory_units
       inventory_units.destroy_all
     end
+
+    def price_match_order_currency
+      return if price_currency.blank? || price_currency == currency
+
+      errors.add(:price, :does_not_match_order_currency)
+    end
   end
 end

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

@@ -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 }
+    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

@@ -8,13 +8,13 @@ module Spree
     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 }
+    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?
     after_touch :touch_all_variants
 
-    delegate :name, :presentation, to: :option_type, prefix: :option_type
+    delegate :name, :presentation, to: :option_type, prefix: :option_type, allow_nil: true
 
     self.whitelisted_ransackable_attributes = %w[name presentation]
 

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

@@ -37,14 +37,14 @@ module Spree
 
       private
 
-      def process_payments_with(method)
+      def process_payments_with(method_name)
         # Don't run if there is nothing to pay.
         return true if payment_total >= total
 
         unprocessed_payments.each do |payment|
           break if payment_total >= total
 
-          payment.public_send(method)
+          payment.public_send(method_name)
         end
       rescue Core::GatewayError => error
         result = !!Spree::Config[:allow_checkout_on_gateway_error]

data/app/models/spree/order.rb

@@ -23,10 +23,18 @@ module Spree
     ORDER_NUMBER_LETTERS = false
     ORDER_NUMBER_PREFIX  = 'R'
 
-    include Spree::Order::Checkout
+    include ::Spree::Config.state_machines.order
+
     include Spree::Order::Payments
 
-    class InsufficientStock < StandardError; end
+    class InsufficientStock < StandardError
+      attr_reader :items
+
+      def initialize(message = nil, items: {})
+        @items = items
+        super message
+      end
+    end
     class CannotRebuildShipments < StandardError; end
 
     extend Spree::DisplayMoney
@@ -49,10 +57,6 @@ module Spree
     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
@@ -97,6 +101,8 @@ 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 :reimbursements, inverse_of: :order
     has_many :refunds, through: :payments
 
@@ -125,7 +131,7 @@ module Spree
     validates :email, presence: true, if: :require_email
     validates :email, 'spree/email' => true, allow_blank: true
     validates :guest_token, presence: { allow_nil: true }
-    validates :number, presence: true, uniqueness: { allow_blank: true }
+    validates :number, presence: true, uniqueness: { allow_blank: true, case_sensitive: true }
     validates :store_id, presence: true
 
     def self.find_by_param(value)
@@ -136,12 +142,8 @@ module Spree
       find_by! number: value
     end
 
-    delegate :firstname, :lastname, to: :bill_address, prefix: true, allow_nil: true
-    alias_method :billing_firstname, :bill_address_firstname
-    alias_method :billing_lastname, :bill_address_lastname
-
-    class_attribute :update_hooks
-    self.update_hooks = Set.new
+    delegate :name, to: :bill_address, prefix: true, allow_nil: true
+    alias_method :billing_name, :bill_address_name
 
     class_attribute :line_item_comparison_hooks
     self.line_item_comparison_hooks = Set.new
@@ -178,12 +180,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)
-      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)
@@ -192,14 +188,8 @@ module Spree
 
     # For compatiblity with Calculator::PriceSack
     def amount
-      line_items.map(&:amount).sum
-    end
-
-    # Sum of all line item amounts after promotions, before added tax
-    def discounted_item_amount
-      line_items.to_a.sum(&:discounted_amount)
+      line_items.sum(&: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)
@@ -209,15 +199,13 @@ module Spree
     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]
     end
 
     def shipping_discount
-      shipment_adjustments.eligible.sum(:amount) * - 1
+      shipment_adjustments.credit.eligible.sum(:amount) * - 1
     end
 
     def to_param
@@ -241,11 +229,6 @@ module Spree
       total > 0
     end
 
-    def confirmation_required?
-      true
-    end
-    deprecate :confirmation_required?, deprecator: Spree::Deprecation
-
     def backordered?
       shipments.any?(&:backordered?)
     end
@@ -267,15 +250,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
@@ -287,7 +261,11 @@ module Spree
     end
 
     def all_inventory_units_returned?
-      inventory_units.all?(&:returned?)
+      # Inventory units are transitioned to the "return" state through CustomerReturn and
+      # ReturnItem instead of using Order#inventory_units, thus making the latter method
+      # potentially return stale data. This situation requires to *reload* `inventory_units`
+      # in order to pick-up the latest changes and make the check on `returned?` reliable.
+      inventory_units.reload.all?(&:returned?)
     end
 
     def contents
@@ -317,14 +295,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
 
@@ -365,14 +336,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
@@ -398,7 +361,7 @@ module Spree
 
     def name
       if (address = bill_address || ship_address)
-        "#{address.firstname} #{address.lastname}"
+        address.name
       end
     end
 
@@ -431,7 +394,6 @@ module Spree
 
       updater.update_shipment_state
       save!
-      updater.run_hooks
 
       touch :completed_at
 
@@ -487,26 +449,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
@@ -529,6 +471,18 @@ module Spree
       end
     end
 
+    def ensure_billing_address
+      return unless billing_address_required?
+      return if bill_address&.valid?
+
+      errors.add(:base, I18n.t('spree.bill_address_required'))
+      false
+    end
+
+    def billing_address_required?
+      Spree::Config.billing_address_required
+    end
+
     def create_proposed_shipments
       if completed?
         raise CannotRebuildShipments.new(I18n.t('spree.cannot_rebuild_shipments_order_completed'))
@@ -536,7 +490,14 @@ 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)
+      Spree::Config.stock.coordinator_class.new(self, units).shipments.each do |shipment|
+        shipments << shipment
       end
     end
 
@@ -544,8 +505,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
     #
@@ -578,12 +537,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
@@ -591,10 +544,9 @@ module Spree
     def canceled_by(user)
       transaction do
         cancel!
-        update_columns(
-          canceler_id: user.id,
-          canceled_at: Time.current
-        )
+        # rubocop:disable Rails/SkipsModelValidations
+        update_column(:canceler_id, user.id)
+        # rubocop:enable Rails/SkipsModelValidations
       end
     end
 
@@ -615,11 +567,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
@@ -714,8 +661,8 @@ module Spree
     # @note This doesn't persist the change bill_address or ship_address
     def assign_default_user_addresses
       if user
-        bill_address = (user.bill_address || user.default_address)
-        ship_address = (user.ship_address || user.default_address)
+        bill_address = user.bill_address
+        ship_address = user.ship_address
         # this is one of 2 places still using User#bill_address
         self.bill_address ||= bill_address if bill_address.try!(:valid?)
         # Skip setting ship address if order doesn't have a delivery checkout step
@@ -724,11 +671,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)
@@ -740,8 +682,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)
@@ -756,11 +696,11 @@ 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 last_ip_address != ip_address
+      if new_record?
+        self.last_ip_address = ip_address
+      elsif last_ip_address != ip_address
         update_column(:last_ip_address, ip_address)
       end
     end
@@ -801,23 +741,6 @@ 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
-      end
-    end
-
     def associate_store
       self.store ||= Spree::Store.default
     end
@@ -873,14 +796,29 @@ module Spree
     end
 
     def after_cancel
-      shipments.each(&:cancel!)
-      payments.completed.each { |payment| payment.cancel! unless payment.fully_refunded? }
-      payments.store_credits.pending.each(&:void_transaction!)
+      cancel_shipments!
+      cancel_payments!
 
       send_cancel_email
+      # rubocop:disable Rails/SkipsModelValidations
+      update_column(:canceled_at, Time.current)
+      # rubocop:enable Rails/SkipsModelValidations
       recalculate
     end
 
+    def cancel_shipments!
+      shipments.each(&:cancel!)
+    end
+
+    def cancel_payments!
+      payments.each do |payment|
+        next if payment.fully_refunded?
+        next unless payment.pending? || payment.completed?
+
+        payment.cancel!
+      end
+    end
+
     def send_cancel_email
       Spree::Config.order_mailer_class.cancel_email(self).deliver_later
     end