solidus_core 2.3.1 → 2.4.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81d6032a716d2aa2fb21390574017b2837180df8
-  data.tar.gz: e7fa707fa0b92207c25f4c15fedc66cbadaf6e7d
+  metadata.gz: 780ddce063f4f0cb4182e2409c326a0c67af6d17
+  data.tar.gz: d07bc3bed5b865e1fa058457b1ea0a29450cdb33
 SHA512:
-  metadata.gz: 991ba48b8ae7d0b5f39654ee498f2a9b063908ea39b036e6698917928a434bb7978a66ec4eae443a70e51bff52b8789fd8621c2f30d4a2f2222ad3f2185bf8af
-  data.tar.gz: 9dd2388898217a51fe858f9258c860c3d3f41f79574dc91f87c5becec0eda3d3b603c823f14ff7a10d912bb0413d960c3a96c16b982959e0f73e30a9648cee0e
+  metadata.gz: 8ea1a5401f592da810efbba723f7766bf617c88e9a55803cc6b887374276dafbe798c367615b7f0bb42d6855e307de9f14cee9effe9596d44f0dc19916ec98cf
+  data.tar.gz: aad148fef039045c3c994ca4e32f5fb60b4793079d57e1c598b9f7791bcbe935aef9d70b407663c91b43414585d2bffbb366d4b44b7d0c937bd9027560df7a15

data/app/controllers/spree/base_controller.rb

@@ -3,7 +3,6 @@ require_dependency 'spree/core/controller_helpers/strong_parameters'
 
 class Spree::BaseController < ApplicationController
   include Spree::Core::ControllerHelpers::Auth
-  include Spree::Core::ControllerHelpers::RespondWith
   include Spree::Core::ControllerHelpers::Common
   include Spree::Core::ControllerHelpers::PaymentParameters
   include Spree::Core::ControllerHelpers::Search

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

@@ -10,6 +10,8 @@ module Spree
 
     class_methods do
       def calculators
+        Spree::Deprecation.warn("Calling .calculators is deprecated. Please access through Rails.application.config.spree.calculators")
+
         spree_calculators.send model_name_without_spree_namespace
       end
 

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

@@ -17,11 +17,13 @@ module Spree
       has_many :stock_locations, through: :user_stock_locations
 
       has_many :spree_orders, foreign_key: "user_id", class_name: "Spree::Order"
-      has_many :orders, foreign_key: "user_id", class_name: "Spree::Order"
+      has_many :orders, foreign_key: "user_id", class_name: "Spree::Order", dependent: :restrict_with_exception
 
       has_many :store_credits, -> { includes(:credit_type) }, foreign_key: "user_id", class_name: "Spree::StoreCredit"
       has_many :store_credit_events, through: :store_credits
+
       money_methods :total_available_store_credit
+      deprecate display_total_available_store_credit: :display_available_store_credit_total, deprecator: Spree::Deprecation
 
       has_many :credit_cards, class_name: "Spree::CreditCard", foreign_key: :user_id
       has_many :wallet_payment_sources, foreign_key: 'user_id', class_name: 'Spree::WalletPaymentSource', inverse_of: :user
@@ -30,8 +32,8 @@ module Spree
 
       include Spree::RansackableAttributes unless included_modules.include?(Spree::RansackableAttributes)
 
-      self.whitelisted_ransackable_associations = %w[addresses]
-      self.whitelisted_ransackable_attributes = %w[id email]
+      self.whitelisted_ransackable_associations = %w[addresses spree_roles]
+      self.whitelisted_ransackable_attributes = %w[id email created_at]
     end
 
     def wallet
@@ -66,5 +68,19 @@ module Spree
     def total_available_store_credit
       store_credits.reload.to_a.sum(&:amount_remaining)
     end
+    deprecate total_available_store_credit: :available_store_credit_total, deprecator: Spree::Deprecation
+
+    def available_store_credit_total(currency:)
+      store_credits.reload.to_a.
+        select { |c| c.currency == currency }.
+        sum(&:amount_remaining)
+    end
+
+    def display_available_store_credit_total(currency:)
+      Spree::Money.new(
+        available_store_credit_total(currency: currency),
+        currency: currency,
+      )
+    end
   end
 end

data/app/models/spree/address.rb

@@ -1,5 +1,3 @@
-require 'twitter_cldr'
-
 module Spree
   # `Spree::Address` provides the foundational ActiveRecord model for recording and
   # validating address information for `Spree::Order`, `Spree::Shipment`,
@@ -15,7 +13,7 @@ module Spree
     validates :zipcode, presence: true, if: :require_zipcode?
     validates :phone, presence: true, if: :require_phone?
 
-    validate :state_validate, :postal_code_validate
+    validate :state_validate
 
     alias_attribute :first_name, :firstname
     alias_attribute :last_name, :lastname
@@ -171,6 +169,10 @@ module Spree
       self.country = Spree::Country.find_by!(iso: iso)
     end
 
+    def country_iso
+      country && country.iso
+    end
+
     private
 
     def state_validate
@@ -207,13 +209,5 @@ module Spree
       # ensure at least one state field is populated
       errors.add :state, :blank if state.blank? && state_name.blank?
     end
-
-    def postal_code_validate
-      return if country.blank? || country.iso.blank? || !require_zipcode?
-      return if !TwitterCldr::Shared::PostalCodes.territories.include?(country.iso.downcase.to_sym)
-
-      postal_code = TwitterCldr::Shared::PostalCodes.for_territory(country.iso)
-      errors.add(:zipcode, :invalid) if !postal_code.valid?(zipcode.to_s)
-    end
   end
 end

data/app/models/spree/adjustment.rb

@@ -96,7 +96,7 @@ module Spree
     # admin) or is closed, this is a noop.
     #
     # @return [BigDecimal] New amount of this adjustment
-    def update!
+    def recalculate
       if finalized? && !tax?
         return amount
       end
@@ -118,6 +118,15 @@ module Spree
       amount
     end
 
+    def update!(*args)
+      if args.empty?
+        Spree::Deprecation.warn "Calling adjustment.update! with no arguments to recalculate amounts and eligibility is deprecated, since it conflicts with AR::Base#update! Please use adjustment.recalculate instead"
+        recalculate
+      else
+        super
+      end
+    end
+
     # Calculates based on attached promotion (if this is a promotion
     # adjustment) whether this promotion is still eligible.
     # @api private

data/app/models/spree/base.rb

@@ -23,6 +23,10 @@ class Spree::Base < ActiveRecord::Base
 
   if Kaminari.config.page_method_name != :page
     def self.page(num)
+      Spree::Deprecation.warn \
+        "Redefining Spree::Base.page for a different kaminari page name is better done inside " \
+        "your own app. This will be removed from future versions of solidus."
+
       send Kaminari.config.page_method_name, num
     end
   end

data/app/models/spree/calculator/default_tax.rb

@@ -13,10 +13,9 @@ module Spree
         rate.tax_categories.include?(line_item.tax_category)
       end
 
-      line_items_total = matched_line_items.sum(&:discounted_amount)
+      line_items_total = matched_line_items.sum(&:total_before_tax)
       if rate.included_in_price
-        order_tax_amount = round_to_two_places(line_items_total - ( line_items_total / (1 + rate.amount) ) )
-        refund_if_necessary(order_tax_amount, order.tax_address)
+        round_to_two_places(line_items_total - ( line_items_total / (1 + rate.amount) ) )
       else
         round_to_two_places(line_items_total * rate.amount)
       end
@@ -28,7 +27,7 @@ module Spree
       if rate.included_in_price
         deduced_total_by_rate(item, rate)
       else
-        round_to_two_places(item.discounted_amount * rate.amount)
+        round_to_two_places(item.total_before_tax * rate.amount)
       end
     end
 
@@ -47,23 +46,13 @@ module Spree
     end
 
     def deduced_total_by_rate(item, rate)
-      unrounded_net_amount = item.discounted_amount / (1 + sum_of_included_tax_rates(item))
-      refund_if_necessary(
-        round_to_two_places(unrounded_net_amount * rate.amount),
-        item.order.tax_address
+      round_to_two_places(
+        rate.amount * item.total_before_tax / (1 + sum_of_included_tax_rates(item))
       )
     end
 
-    def refund_if_necessary(amount, order_tax_address)
-      if default_zone_or_zone_match?(order_tax_address)
-        amount
-      else
-        amount * -1
-      end
-    end
-
-    def default_zone_or_zone_match?(order_tax_address)
-      Zone.default_tax.try!(:include?, order_tax_address) || rate.zone.include?(order_tax_address)
+    def sum_of_included_tax_rates(item)
+      rates_for_item(item).map(&:amount).sum
     end
   end
 end

data/app/models/spree/calculator/returns/default_refund_amount.rb

@@ -16,12 +16,12 @@ module Spree
       end
 
       def weighted_line_item_amount(inventory_unit)
-        inventory_unit.line_item.discounted_amount * percentage_of_line_item(inventory_unit)
+        inventory_unit.line_item.total_before_tax * percentage_of_line_item(inventory_unit)
       end
 
       def percentage_of_order_total(inventory_unit)
-        return 0.0 if inventory_unit.order.discounted_item_amount.zero?
-        weighted_line_item_amount(inventory_unit) / inventory_unit.order.discounted_item_amount
+        return 0.0 if inventory_unit.order.item_total_before_tax.zero?
+        weighted_line_item_amount(inventory_unit) / inventory_unit.order.item_total_before_tax
       end
 
       def percentage_of_line_item(inventory_unit)

data/app/models/spree/calculator.rb

@@ -25,11 +25,10 @@ module Spree
 
     ###################################################################
 
-    def self.register(*_klasses)
-    end
-
     # Returns all calculators applicable for kind of work
     def self.calculators
+      Spree::Deprecation.warn("Calling .calculators is deprecated. Please access through Rails.application.config.spree.calculators")
+
       Rails.application.config.spree.calculators
     end
 

data/app/models/spree/customer_return.rb

@@ -16,7 +16,8 @@ module Spree
     accepts_nested_attributes_for :return_items
 
     extend DisplayMoney
-    money_methods :pre_tax_total, :total, :amount
+    money_methods :pre_tax_total, :total, :total_excluding_vat, :amount
+    deprecate display_pre_tax_total: :display_total_excluding_vat, deprecator: Spree::Deprecation
 
     delegate :currency, to: :order
     delegate :id, to: :order, prefix: true, allow_nil: true
@@ -25,9 +26,11 @@ module Spree
       return_items.map(&:total).sum
     end
 
-    def pre_tax_total
-      return_items.map(&:pre_tax_amount).sum
+    def total_excluding_vat
+      return_items.map(&:total_excluding_vat).sum
     end
+    alias pre_tax_total total_excluding_vat
+    deprecate pre_tax_total: :total_excluding_vat, deprecator: Spree::Deprecation
 
     def amount
       return_items.sum(:amount)

data/app/models/spree/exchange.rb

@@ -27,7 +27,7 @@ module Spree
       @order.shipments += shipments
       @order.save!
       shipments.each do |shipment|
-        shipment.update!(@order)
+        shipment.update_state
         shipment.finalize!
       end
     end

data/app/models/spree/fulfilment_changer.rb

@@ -0,0 +1,125 @@
+module Spree
+  # Service class to change fulfilment of inventory units of a particular variant
+  # to another shipment. The other shipment would typically have a different
+  # shipping method, stock location or delivery date, such that we actually change
+  # the planned fulfilment for the items in question.
+  #
+  # Can be used to merge shipments by moving all items to another shipment, because
+  # this class will delete any empty original shipment.
+  #
+  # @attr [Spree::Shipment] current_shipment The shipment we transfer units from
+  # @attr [Spree::Shipment] desired_shipment The shipment we want to move units onto
+  # @attr [Spree::StockLocation] current_stock_location The stock location of the current shipment
+  # @attr [Spree::StockLocation] desired_stock_location The stock location of the desired shipment
+  # @attr [Spree::Variant] variant We only move units that represent this variant
+  # @attr [Integer] quantity How many units we want to move
+  #
+  class FulfilmentChanger
+    include ActiveModel::Validations
+
+    attr_accessor :current_shipment, :desired_shipment
+    attr_reader :variant, :quantity, :current_stock_location, :desired_stock_location
+
+    def initialize(current_shipment:, desired_shipment:, variant:, quantity:)
+      @current_shipment = current_shipment
+      @desired_shipment = desired_shipment
+      @current_stock_location = current_shipment.stock_location
+      @desired_stock_location = desired_shipment.stock_location
+      @variant = variant
+      @quantity = quantity
+    end
+
+    validates :quantity, numericality: { greater_than: 0 }
+    validate :current_shipment_not_already_shipped
+    validate :desired_shipment_different_from_current
+    validates :desired_stock_location, presence: true
+    validate :enough_stock_at_desired_location, if: :handle_stock_counts?
+
+    # Performs the change of fulfilment
+    # @return [true, false] Whether the requested fulfilment change was successful
+    def run!
+      # Validations here are intended to catch all necessary prerequisites.
+      # We return early so all checks have happened already.
+      return false if invalid?
+      desired_shipment.save! if desired_shipment.new_record?
+
+      new_on_hand_quantity = [desired_shipment.stock_location.count_on_hand(variant), quantity].min
+
+      ActiveRecord::Base.transaction do
+        if handle_stock_counts?
+          # We only run this query if we need it.
+          current_on_hand_quantity = [current_shipment.inventory_units.on_hand.size, quantity].min
+
+          # Restock things we will not fulfil from the current shipment anymore
+          current_stock_location.restock(variant, current_on_hand_quantity, current_shipment)
+          # Unstock what we will fulfil with the new shipment
+          desired_stock_location.unstock(variant, new_on_hand_quantity, desired_shipment)
+        end
+
+        # These two statements are the heart of this class. We change the number
+        # of inventory units requested from one shipment to the other.
+        # We order by state, because `'backordered' < 'on_hand'`.
+        current_shipment.
+          inventory_units.
+          where(variant: variant).
+          order(state: :asc).
+          limit(new_on_hand_quantity).
+          update_all(shipment_id: desired_shipment.id, state: :on_hand)
+
+        current_shipment.
+          inventory_units.
+          where(variant: variant).
+          order(state: :asc).
+          limit(quantity - new_on_hand_quantity).
+          update_all(shipment_id: desired_shipment.id, state: :backordered)
+      end
+
+      # We modified the inventory units at the database level for speed reasons.
+      # The downside of that is that we need to reload the associations.
+      current_shipment.inventory_units.reload
+      desired_shipment.inventory_units.reload
+
+      # If the current shipment now has no inventory units left, we won't need it any longer.
+      if current_shipment.inventory_units.length.zero?
+        current_shipment.destroy!
+      else
+        # The current shipment has changed, so we need to make sure that shipping rates
+        # have the correct amount.
+        current_shipment.refresh_rates
+      end
+
+      # The desired shipment has also change, so we need to make sure shipping rates
+      # are up-to-date, too.
+      desired_shipment.refresh_rates
+
+      true
+    end
+
+    private
+
+    # We don't need to handle stock counts for incomplete orders. Also, if
+    # the new shipment and the desired shipment will ship from the same stock location,
+    # unstocking and restocking will not be necessary.
+    def handle_stock_counts?
+      current_shipment.order.completed? && current_stock_location != desired_stock_location
+    end
+
+    def current_shipment_not_already_shipped
+      if current_shipment.shipped?
+        errors.add(:current_shipment, :has_already_been_shipped)
+      end
+    end
+
+    def enough_stock_at_desired_location
+      unless Spree::Stock::Quantifier.new(variant, desired_stock_location).can_supply?(quantity)
+        errors.add(:desired_shipment, :not_enough_stock_at_desired_location)
+      end
+    end
+
+    def desired_shipment_different_from_current
+      if desired_shipment.id == current_shipment.id
+        errors.add(:desired_shipment, :can_not_transfer_within_same_shipment)
+      end
+    end
+  end
+end

data/app/models/spree/legacy_user.rb

@@ -8,19 +8,11 @@ module Spree
 
     self.table_name = 'spree_users'
 
-    before_destroy :check_completed_orders
-
     def self.model_name
       ActiveModel::Name.new Spree::LegacyUser, Spree, 'user'
     end
 
     attr_accessor :password
     attr_accessor :password_confirmation
-
-    private
-
-    def check_completed_orders
-      raise Spree::Core::DestroyWithOrdersError if orders.complete.present?
-    end
   end
 end

data/app/models/spree/line_item.rb

@@ -57,24 +57,41 @@ module Spree
     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 final_amount
+    def total
       amount + adjustment_total
     end
-    alias total final_amount
+    alias final_amount total
+    deprecate final_amount: :total, deprecator: Spree::Deprecation
 
-    # @return [BigDecimal] the amount of this line item before included tax
+    # @return [BigDecimal] the amount of this item, taking into consideration
+    #   all non-tax adjustments.
+    def total_before_tax
+      amount + adjustments.select { |a| !a.tax? && a.eligible? }.sum(&:amount)
+    end
+
+    # @return [BigDecimal] the amount of this line item before VAT tax
     # @note just like `amount`, this does not include any additional tax
-    def pre_tax_amount
-      discounted_amount - included_tax_total
+    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, :final_amount, :pre_tax_amount, :price,
-                  :included_tax_total, :additional_tax_total
+    money_methods :amount, :discounted_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