spree_core 3.6.6 → 3.7.0.rc1

data/app/models/spree/gateway/bogus.rb

@@ -19,6 +19,7 @@ module Spree
 
     def create_profile(payment)
       return if payment.source.has_payment_profile?
+
       # simulate the storage of credit card profile using remote service
       if success = VALID_CCS.include?(payment.source.number)
         payment.source.update_attributes(gateway_customer_profile_id: generate_profile_id(success))
@@ -27,7 +28,7 @@ module Spree
 
     def authorize(_money, credit_card, _options = {})
       profile_id = credit_card.gateway_customer_profile_id
-      if VALID_CCS.include?(credit_card.number) || (profile_id && profile_id.starts_with?('BGS-'))
+      if VALID_CCS.include?(credit_card.number) || (profile_id&.starts_with?('BGS-'))
         ActiveMerchant::Billing::Response.new(true, 'Bogus Gateway: Forced success', {}, test: true, authorization: '12345', avs_result: { code: 'D' })
       else
         ActiveMerchant::Billing::Response.new(false, 'Bogus Gateway: Forced failure', { message: 'Bogus Gateway: Forced failure' }, test: true)
@@ -36,7 +37,7 @@ module Spree
 
     def purchase(_money, credit_card, _options = {})
       profile_id = credit_card.gateway_customer_profile_id
-      if VALID_CCS.include?(credit_card.number) || (profile_id && profile_id.starts_with?('BGS-'))
+      if VALID_CCS.include?(credit_card.number) || (profile_id&.starts_with?('BGS-'))
         ActiveMerchant::Billing::Response.new(true, 'Bogus Gateway: Forced success', {}, test: true, authorization: '12345', avs_result: { code: 'M' })
       else
         ActiveMerchant::Billing::Response.new(false, 'Bogus Gateway: Forced failure', message: 'Bogus Gateway: Forced failure', test: true)

data/app/models/spree/image.rb

@@ -1,5 +1,18 @@
 module Spree
   class Image < Asset
     include Rails.application.config.use_paperclip ? Configuration::Paperclip : Configuration::ActiveStorage
+    include Rails.application.routes.url_helpers
+
+    def styles
+      self.class.styles.map do |_, size|
+        width, height = size[/(\d+)x(\d+)/].split('x')
+
+        {
+          url: polymorphic_path(attachment.variant(resize: size), only_path: true),
+          width: width,
+          height: height
+        }
+      end
+    end
   end
 end

data/app/models/spree/image/configuration/active_storage.rb

@@ -12,10 +12,10 @@ module Spree
 
           def self.styles
             @styles ||= {
-              mini:    '48x48>',
-              small:   '100x100>',
+              mini: '48x48>',
+              small: '100x100>',
               product: '240x240>',
-              large:   '600x600>'
+              large: '600x600>'
             }
           end
 

data/app/models/spree/inventory_unit.rb

@@ -127,7 +127,7 @@ module Spree
     end
 
     def percentage_of_line_item
-      quantity / BigDecimal.new(line_item.quantity)
+      quantity / BigDecimal(line_item.quantity)
     end
 
     def current_return_item

data/app/models/spree/line_item.rb

@@ -32,7 +32,7 @@ module Spree
 
     after_create :update_tax_charge
 
-    delegate :name, :description, :sku, :should_track_inventory?, :product, :options_text, to: :variant
+    delegate :name, :description, :sku, :should_track_inventory?, :product, :options_text, :slug, to: :variant
     delegate :brand, :category, to: :product
     delegate :tax_zone, to: :order
 
@@ -58,7 +58,8 @@ module Spree
     end
 
     extend DisplayMoney
-    money_methods :amount, :subtotal, :discounted_amount, :final_amount, :total, :price
+    money_methods :amount, :subtotal, :discounted_amount, :final_amount, :total, :price,
+                  :adjustment_total, :additional_tax_total, :promo_total, :included_tax_total
 
     alias single_money display_price
     alias single_display_amount display_price

data/app/models/spree/order.rb

@@ -22,15 +22,39 @@ module Spree
     alias display_ship_total display_shipment_total
     alias_attribute :ship_total, :shipment_total
 
+    def guest_token
+      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+        Order#guest_token is deprecated and will be removed in Spree 4.0. Please use Order#token instead
+      DEPRECATION
+
+      token
+    end
+
+    def guest_token?
+      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+        Order#guest_token? is deprecated and will be removed in Spree 4.0. Please use Order#token? instead
+      DEPRECATION
+
+      token?
+    end
+
+    def guest_token=(value)
+      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+        Order#guest_token= is deprecated and will be removed in Spree 4.0. Please use Order#token= instead
+      DEPRECATION
+
+      self.token = value
+    end
+
     MONEY_THRESHOLD  = 100_000_000
     MONEY_VALIDATION = {
-      presence:     true,
+      presence: true,
       numericality: {
         greater_than: -MONEY_THRESHOLD,
-        less_than:     MONEY_THRESHOLD,
-        allow_blank:   true
+        less_than: MONEY_THRESHOLD,
+        allow_blank: true
       },
-      format:       { with: /\A-?\d+(?:\.\d{1,2})?\z/, allow_blank: true }
+      format: { with: /\A-?\d+(?:\.\d{1,2})?\z/, allow_blank: true }
     }.freeze
 
     POSITIVE_MONEY_VALIDATION = MONEY_VALIDATION.deep_dup.tap do |validation|
@@ -51,7 +75,7 @@ module Spree
     end
 
     self.whitelisted_ransackable_associations = %w[shipments user promotions bill_address ship_address line_items store]
-    self.whitelisted_ransackable_attributes = %w[completed_at email number state payment_state shipment_state total considered_risky]
+    self.whitelisted_ransackable_attributes = %w[completed_at email number state payment_state shipment_state total considered_risky channel]
 
     attr_reader :coupon_code
     attr_accessor :temporary_address, :temporary_credit_card
@@ -114,7 +138,8 @@ module Spree
     accepts_nested_attributes_for :shipments
 
     # Needs to happen before save_permalink is called
-    before_validation :set_currency
+    before_validation :ensure_store_presence
+    before_validation :ensure_currency_presence
     before_validation :clone_billing_address, if: :use_billing?
     attr_accessor :use_billing
 
@@ -126,6 +151,8 @@ module Spree
       validates :number, length: { maximum: 32, allow_blank: true }, uniqueness: { allow_blank: true }
       validates :email, length: { maximum: 254, allow_blank: true }, email: { allow_blank: true }, if: :require_email
       validates :item_count, numericality: { greater_than_or_equal_to: 0, less_than: 2**31, only_integer: true, allow_blank: true }
+      validates :store
+      validates :currency
     end
     validates :payment_state,        inclusion:    { in: PAYMENT_STATES, allow_blank: true }
     validates :shipment_state,       inclusion:    { in: SHIPMENT_STATES, allow_blank: true }
@@ -145,9 +172,6 @@ module Spree
     class_attribute :update_hooks
     self.update_hooks = Set.new
 
-    class_attribute :line_item_comparison_hooks
-    self.line_item_comparison_hooks = Set.new
-
     scope :created_between, ->(start_date, end_date) { where(created_at: start_date..end_date) }
     scope :completed_between, ->(start_date, end_date) { where(completed_at: start_date..end_date) }
     scope :complete, -> { where.not(completed_at: nil) }
@@ -165,7 +189,12 @@ module Spree
     # 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)
-      line_item_comparison_hooks.add(hook)
+      ActiveSupport::Deprecation.warn(<<-EOS, caller)
+        Order.register_line_item_comparison_hook is deprecated and will be removed in Spree 4.0. Please use
+        `Rails.application.config.spree.line_item_comparison_hooks << hook` instead.
+      EOS
+
+      Rails.application.config.spree.line_item_comparison_hooks << hook
     end
 
     # For compatiblity with Calculator::PriceSack
@@ -178,10 +207,6 @@ module Spree
       line_items.to_a.sum(&:pre_tax_amount)
     end
 
-    def currency
-      self[:currency] || Spree::Config[:currency]
-    end
-
     def shipping_discount
       shipment_adjustments.non_tax.eligible.sum(:amount) * - 1
     end
@@ -249,8 +274,13 @@ module Spree
       true
     end
 
+    def ensure_store_presence
+      self.store ||= Spree::Store.default
+    end
+
     def allow_cancel?
       return false if !completed? || canceled?
+
       shipment_state.nil? || %w{ready backorder pending}.include?(shipment_state)
     end
 
@@ -299,11 +329,13 @@ module Spree
     #
     # def product_customizations_match
     def line_item_options_match(line_item, options)
+      ActiveSupport::Deprecation.warn(<<-EOS, caller)
+        Order#add is deprecated and will be removed in Spree 4.0. Please use
+        Spree::CompareLineItems service instead.
+      EOS
       return true unless options
 
-      line_item_comparison_hooks.all? do |hook|
-        send(hook, line_item, options)
-      end
+      CompareLineItems.new.call(order: self, line_item: line_item, options: options).value
     end
 
     # Creates new tax charges if there are any applicable rates. If prices already
@@ -319,7 +351,7 @@ module Spree
 
     def update_line_item_prices!
       transaction do
-        line_items.each(&:update_price)
+        line_items.reload.each(&:update_price)
         save!
       end
     end
@@ -459,20 +491,24 @@ module Spree
         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
-          )
+          log_state_changes(state_name: name, old_state: old_state, new_state: new_state)
         end
       end
     end
 
+    def log_state_changes(state_name:, old_state:, new_state:)
+      state_changes.create(
+        previous_state: old_state,
+        next_state: new_state,
+        name: state_name,
+        user_id: user_id
+      )
+    end
+
     def coupon_code=(code)
       @coupon_code = begin
                        code.strip.downcase
-                     rescue
+                     rescue StandardError
                        nil
                      end
     end
@@ -533,7 +569,7 @@ module Spree
     end
 
     def shipping_eq_billing_address?
-      (bill_address.empty? && ship_address.empty?) || bill_address.same_as?(ship_address)
+      bill_address == ship_address
     end
 
     def set_shipments_cost
@@ -688,12 +724,20 @@ module Spree
       use_billing.in?([true, 'true', '1'])
     end
 
+    def ensure_currency_presence
+      self.currency ||= store.default_currency || Spree::Config[:currency]
+    end
+
     def set_currency
-      self.currency = Spree::Config[:currency] if self[:currency].nil?
+      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+         Spree::Order#set_currency was renamed to Spree::Order#ensure_currency_presence
+         and will be removed in Spree 4.0. Please update your code to avoid problems after update
+      DEPRECATION
+      ensure_currency_presence
     end
 
     def create_token
-      self.guest_token ||= generate_guest_token
+      self.token ||= generate_token
     end
 
     def collect_payment_methods

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

@@ -16,6 +16,7 @@ module Spree
 
           def self.checkout_flow(&block)
             return @checkout_flow unless block_given?
+
             @checkout_flow = block
             define_state_machine!
           end
@@ -124,6 +125,7 @@ module Spree
             self.checkout_steps[name] = options
             self.previous_states.each { |state| add_transition({ from: state, to: name }.merge(options)) }
             return self.previous_states << name if options[:if]
+
             self.previous_states = [name]
           end
 
@@ -166,6 +168,7 @@ module Spree
 
           def self.find_transition(options = {})
             return nil if options.nil? || !options.include?(:from) || !options.include?(:to)
+
             self.next_event_transitions.detect do |transition|
               transition[options[:from].to_sym] == options[:to].to_sym
             end
@@ -182,6 +185,7 @@ module Spree
           def checkout_steps
             steps = (self.class.checkout_steps.each_with_object([]) do |(step, options), checkout_steps|
               next if options.include?(:if) && !options[:if].call(self)
+
               checkout_steps << step
             end).map(&:to_s)
             # Ensure there is always a complete step
@@ -203,6 +207,7 @@ module Spree
 
           def can_go_to_state?(state)
             return false unless has_checkout_step?(self.state) && has_checkout_step?(state)
+
             checkout_step_index(state) > checkout_step_index(self.state)
           end
 
@@ -260,26 +265,31 @@ module Spree
 
           def clone_billing
             return unless !bill_address_id && user.bill_address.try(:valid?)
+
             self.bill_address = user.bill_address.try(:clone)
           end
 
           def clone_shipping
             return unless !ship_address_id && user.ship_address.try(:valid?)
+
             self.ship_address = user.ship_address.try(:clone)
           end
 
           def persist_user_address!
             return unless !temporary_address && user && user.respond_to?(:persist_order_address) && bill_address_id
+
             user.persist_order_address(self)
           end
 
           def persist_user_credit_card
             return unless !temporary_credit_card && user_id && valid_credit_cards.present?
+
             valid_credit_cards.first.update(user_id: user_id, default: true)
           end
 
           def assign_default_credit_card
             return unless payments.from_credit_card.size.empty? && user_has_valid_default_card? && payment_required?
+
             cc = user.default_credit_card
             payments.create!(payment_method_id: cc.payment_method_id, source: cc, amount: total)
           end

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

@@ -1,39 +1,34 @@
 module Spree
   class Order < Spree::Base
     module StoreCredit
-      def add_store_credit_payments
-        payments.store_credits.where(state: :checkout).map(&:invalidate!)
+      def add_store_credit_payments(amount = nil)
+        ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+          Spree::Order#add_store_credit_payments method is deprecated and will be removed in Spree 4.0.
+          Please use Spree::Checkout::AddStoreCredit service to add Store Credit to Order.
+        DEPRECATION
 
-        remaining_total = outstanding_balance
-
-        if user && user.store_credits.any?
-          payment_method = Spree::PaymentMethod::StoreCredit.available.first
-          raise 'Store credit payment method could not be found' unless payment_method
-
-          user.store_credits.order_by_priority.each do |credit|
-            break if remaining_total.zero?
-            next if credit.amount_remaining.zero?
-
-            amount_to_take = store_credit_amount(credit, remaining_total)
-            create_store_credit_payment(payment_method, credit, amount_to_take)
-            remaining_total -= amount_to_take
-          end
-          payments.store_credits.checkout
-        end
+        Spree::Checkout::AddStoreCredit.call(order: self, amount: amount)
       end
 
       def remove_store_credit_payments
-        payments.checkout.store_credits.map(&:invalidate!) unless completed?
+        ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+          Spree::Order#remove_store_credit_payments method is deprecated and will be removed in Spree 4.0.
+          Please use Spree::Checkout::RemoveStoreCredit service to remove Store Credit from Order.
+        DEPRECATION
+
+        Spree::Checkout::RemoveStoreCredit.call(order: self)
       end
 
       def covered_by_store_credit?
         return false unless user
+
         user.total_available_store_credit >= total
       end
       alias covered_by_store_credit covered_by_store_credit?
 
       def total_available_store_credit
         return 0.0 unless user
+
         user.total_available_store_credit
       end
 
@@ -80,22 +75,6 @@ module Spree
       def display_store_credit_remaining_after_capture
         Spree::Money.new(total_available_store_credit - total_applicable_store_credit, currency: currency)
       end
-
-      private
-
-      def create_store_credit_payment(payment_method, credit, amount)
-        payments.create!(
-          source: credit,
-          payment_method: payment_method,
-          amount: amount,
-          state: 'checkout',
-          response_code: credit.generate_authorization_code
-        )
-      end
-
-      def store_credit_amount(credit, total)
-        [credit.amount_remaining, total].min
-      end
     end
   end
 end

data/app/models/spree/order_contents.rb

@@ -7,134 +7,38 @@ module Spree
     end
 
     def add(variant, quantity = 1, options = {})
-      timestamp = Time.current
-      ActiveRecord::Base.transaction do
-        line_item = add_to_line_item(variant, quantity, options)
-        options[:line_item_created] = true if timestamp <= line_item.created_at
-        after_add_or_remove(line_item, options)
-      end
-    end
+      ActiveSupport::Deprecation.warn(<<-EOS, caller)
+        OrderContents#add method is deprecated and will be removed in Spree 4.0. Please use Spree::Cart::AddItem service
+        to add items to cart.
+      EOS
 
-    def remove(variant, quantity = 1, options = {})
-      ActiveRecord::Base.transaction do
-        line_item = remove_from_line_item(variant, quantity, options)
-        after_add_or_remove(line_item, options)
-      end
+      Spree::Cart::AddItem.call(order: order, variant: variant, quantity: quantity, options: options).value
     end
 
-    def remove_line_item(line_item, options = {})
-      ActiveRecord::Base.transaction do
-        line_item.destroy!
-        after_add_or_remove(line_item, options)
-      end
-    end
-
-    def update_cart(params)
-      if order.update_attributes(filter_order_items(params))
-        order.line_items = order.line_items.select { |li| li.quantity > 0 }
-        # Update totals, then check if the order is eligible for any cart promotions.
-        # If we do not update first, then the item total will be wrong and ItemTotal
-        # promotion rules would not be triggered.
-        ActiveRecord::Base.transaction do
-          persist_totals
-          PromotionHandler::Cart.new(order).activate
-          order.ensure_updated_shipments
-          order.payments.store_credits.checkout.destroy_all
-          persist_totals
-        end
-        true
-      else
-        false
-      end
-    end
-
-    private
-
-    def after_add_or_remove(line_item, options = {})
-      order.payments.store_credits.checkout.destroy_all
-      persist_totals
-      shipment = options[:shipment]
-      if shipment.present?
-        # ADMIN END SHIPMENT RATE FIX
-        # refresh shipments to ensure correct shipment amount is calculated when using price sack calculator
-        # for calculating shipment rates.
-        # Currently shipment rate is calculated on previous order total instead of current order total when updating a shipment from admin end.
-        order.refresh_shipment_rates(ShippingMethod::DISPLAY_ON_BACK_END)
-        shipment.update_amounts
-      else
-        order.ensure_updated_shipments
-      end
-      PromotionHandler::Cart.new(order, line_item).activate
-      Adjustable::AdjustmentsUpdater.update(line_item)
-      TaxRate.adjust(order, [line_item]) if options[:line_item_created]
-      persist_totals
-      line_item
-    end
-
-    def filter_order_items(params)
-      return params if params[:line_items_attributes].nil? || params[:line_items_attributes][:id]
-
-      line_item_ids = order.line_items.pluck(:id)
-
-      params[:line_items_attributes].each_pair do |id, value|
-        unless line_item_ids.include?(value[:id].to_i) || value[:variant_id].present?
-          params[:line_items_attributes].delete(id)
-        end
-      end
-      params
-    end
-
-    def order_updater
-      @updater ||= OrderUpdater.new(order)
-    end
-
-    def persist_totals
-      order_updater.update
-    end
-
-    def add_to_line_item(variant, quantity, options = {})
-      line_item = grab_line_item_by_variant(variant, false, options)
-
-      if line_item
-        line_item.quantity += quantity.to_i
-        line_item.currency = currency unless currency.nil?
-      else
-        options_params = options.is_a?(ActionController::Parameters) ? options : ActionController::Parameters.new(options.to_h)
-        opts = options_params.
-               permit(PermittedAttributes.line_item_attributes).to_h.
-               merge(currency: order.currency)
+    def remove(variant, quantity = 1, options = {})
+      ActiveSupport::Deprecation.warn(<<-EOS, caller)
+        OrderContents#remove method is deprecated and will be removed in Spree 4.0. Please use Spree::Cart::RemoveItem
+        service to remove item from cart.
+      EOS
 
-        line_item = order.line_items.new(quantity: quantity,
-                                         variant: variant,
-                                         options: opts)
-      end
-      line_item.target_shipment = options[:shipment] if options.key? :shipment
-      line_item.save!
-      line_item
+      Spree::Cart::RemoveItem.call(order: order, variant: variant, quantity: quantity, options: options).value
     end
 
-    def remove_from_line_item(variant, quantity, options = {})
-      line_item = grab_line_item_by_variant(variant, true, options)
-      line_item.quantity -= quantity
-      line_item.target_shipment = options[:shipment]
-
-      if line_item.quantity.zero?
-        order.line_items.destroy(line_item)
-      else
-        line_item.save!
-      end
+    def remove_line_item(line_item, options = {})
+      ActiveSupport::Deprecation.warn(<<-EOS, caller)
+        OrderContents#remove_line_item method is deprecated and will be removed in Spree 4.0.
+      EOS
 
-      line_item
+      Spree::Cart::RemoveLineItem.call(order: @order, line_item: line_item, options: options).value
     end
 
-    def grab_line_item_by_variant(variant, raise_error = false, options = {})
-      line_item = order.find_line_item_by_variant(variant, options)
-
-      if !line_item.present? && raise_error
-        raise ActiveRecord::RecordNotFound, "Line item not found for variant #{variant.sku}"
-      end
+    def update_cart(params)
+      ActiveSupport::Deprecation.warn(<<-EOS, caller)
+        OrderContents#update_cart method is deprecated and will be removed in Spree 4.0. Please use Spree::Cart::Update
+        service to update cart.
+      EOS
 
-      line_item
+      Spree::Cart::Update.call(order: order, params: params).value
     end
   end
 end