solidus_core 2.2.2 → 2.3.0.beta1

data/app/models/spree/payment_method.rb

@@ -1,12 +1,23 @@
 module Spree
-  # An abstract class which is implemented most commonly as a `Spree::Gateway`.
+  # A base class which is used for implementing payment methods.
+  #
+  # See https://github.com/solidusio/solidus_gateway/ for
+  # offically supported payment method implementations.
+  #
+  # Uses STI (single table inheritance) to store all implemented payment methods
+  # in one table (+spree_payment_methods+).
+  #
+  # This class is not meant to be instantiated. Please create instances of concrete payment methods.
   #
   class PaymentMethod < Spree::Base
+    preference :server, :string, default: 'test'
+    preference :test_mode, :boolean, default: true
+
     acts_as_paranoid
     acts_as_list
     DISPLAY = [:both, :front_end, :back_end]
 
-    validates :name, presence: true
+    validates :name, :type, presence: true
 
     has_many :payments, class_name: "Spree::Payment", inverse_of: :payment_method
     has_many :credit_cards, class_name: "Spree::CreditCard"
@@ -22,19 +33,85 @@ module Spree
       store.payment_methods.empty? ? all : where(id: store.payment_method_ids)
     end
 
+    delegate :authorize, :purchase, :capture, :void, :credit, to: :gateway
+
     include Spree::Preferences::StaticallyConfigurable
 
-    def self.providers
-      Rails.application.config.spree.payment_methods
+    class << self
+      def providers
+        Spree::Deprecation.warn 'Spree::PaymentMethod.providers is deprecated and will be deleted in Solidus 3.0. ' \
+          'Please use Rails.application.config.spree.payment_methods instead'
+        Rails.application.config.spree.payment_methods
+      end
+
+      def available(display_on = nil, store: nil)
+        Spree::Deprecation.warn "Spree::PaymentMethod.available is deprecated."\
+          "Please use .active, .available_to_users, and .available_to_admin scopes instead."\
+          "For payment methods associated with a specific store, use Spree::PaymentMethod.available_to_store(your_store)"\
+          " as the base applying any further filtering"
+
+        display_on = display_on.to_s
+
+        available_payment_methods =
+          case display_on
+          when 'front_end'
+            active.available_to_users
+          when 'back_end'
+            active.available_to_admin
+          else
+            active.available_to_users.available_to_admin
+          end
+        available_payment_methods.select do |p|
+          store.nil? || store.payment_methods.empty? || store.payment_methods.include?(p)
+        end
+      end
+
+      def active?
+        where(type: to_s, active: true).count > 0
+      end
+
+      def find_with_destroyed(*args)
+        unscoped { find(*args) }
+      end
+    end
+
+    # Represents the gateway of this payment method
+    #
+    # The gateway is responsible for communicating with the providers API.
+    #
+    # It implements methods for:
+    #
+    #     - authorize
+    #     - purchase
+    #     - capture
+    #     - void
+    #     - credit
+    #
+    def gateway
+      gateway_options = options
+      gateway_options.delete :login if gateway_options.key?(:login) && gateway_options[:login].nil?
+      if gateway_options[:server]
+        ActiveMerchant::Billing::Base.mode = gateway_options[:server].to_sym
+      end
+      @gateway ||= gateway_class.new(gateway_options)
     end
+    alias_method :provider, :gateway
+    deprecate provider: :gateway, deprecator: Spree::Deprecation
 
-    def provider_class
-      raise ::NotImplementedError, "You must implement provider_class method for #{self.class}."
+    # Represents all preferences as a Hash
+    #
+    # Each preference is a key holding the value(s) and gets passed to the gateway via +gateway_options+
+    #
+    # @return Hash
+    def options
+      preferences.to_hash
     end
 
-    # The class that will process payments for this payment type, used for @payment.source
-    # e.g. CreditCard in the case of a the Gateway payment type
-    # nil means the payment method doesn't require a source e.g. check
+    # The class that will store payment sources (re)usable with this payment method
+    #
+    # Used by Spree::Payment as source (e.g. Spree::CreditCard in the case of a credit card payment method).
+    #
+    # Returning nil means the payment method doesn't support storing sources (e.g. Spree::PaymentMethod::Check)
     def payment_source_class
       raise ::NotImplementedError, "You must implement payment_source_class method for #{self.class}."
     end
@@ -62,39 +139,27 @@ module Spree
       end
     end
 
-    def self.available(display_on=nil, store: nil)
-      Spree::Deprecation.warn "Spree::PaymentMethod.available is deprecated."\
-        "Please use .active, .available_to_users, and .available_to_admin scopes instead."\
-        "For payment methods associated with a specific store, use Spree::PaymentMethod.available_to_store(your_store)"\
-        " as the base applying any further filtering"
-
-      display_on = display_on.to_s
-
-      available_payment_methods =
-        case display_on
-        when 'front_end'
-          active.available_to_users
-        when 'back_end'
-          active.available_to_admin
-        else
-          active.available_to_users.available_to_admin
-        end
-      available_payment_methods.select do |p|
-        store.nil? || store.payment_methods.empty? || store.payment_methods.include?(p)
-      end
-    end
-
-    def self.active?
-      where(type: to_s, active: true).count > 0
-    end
-
-    def method_type
+    # Used as partial name for your payment method
+    #
+    # Currently your payment method needs to provide these partials:
+    #
+    #     1. app/views/spree/checkout/payment/_{partial_name}.html.erb
+    #     The form your customer enters the payment information in during checkout
+    #
+    #     2. app/views/spree/checkout/existing_payment/_{partial_name}.html.erb
+    #     The payment information of your customers reusable sources during checkout
+    #
+    #     3. app/views/spree/admin/payments/source_forms/_{partial_name}.html.erb
+    #     The form an admin enters payment information in when creating orders in the backend
+    #
+    #     4. app/views/spree/admin/payments/source_views/_{partial_name}.html.erb
+    #     The view that represents your payment method on orders in the backend
+    #
+    def partial_name
       type.demodulize.downcase
     end
-
-    def self.find_with_destroyed(*args)
-      unscoped { find(*args) }
-    end
+    alias_method :method_type, :partial_name
+    deprecate method_type: :partial_name, deprecator: Spree::Deprecation
 
     def payment_profiles_supported?
       false
@@ -114,6 +179,11 @@ module Spree
       auto_capture.nil? ? Spree::Config[:auto_capture] : auto_capture
     end
 
+    # Check if given source is supported by this payment method
+    #
+    # Please implement validation logic in your payment method implementation
+    #
+    # @see Spree::PaymentMethod::CreditCard#supports?
     def supports?(_source)
       true
     end
@@ -125,5 +195,21 @@ module Spree
     def store_credit?
       is_a? Spree::PaymentMethod::StoreCredit
     end
+
+    protected
+
+    # Represents the gateway class of this payment method
+    #
+    def gateway_class
+      if respond_to? :provider_class
+        Spree::Deprecation.warn \
+          "provider_class is deprecated and will be removed from Solidus 3.0 " \
+          "(use gateway_class instead)"
+        public_send :provider_class
+      else
+        raise ::NotImplementedError, "You must implement gateway_class method for #{self.class}."
+      end
+    end
+    deprecate provider_class: :gateway_class, deprecator: Spree::Deprecation
   end
 end

data/app/models/spree/preferences/preferable.rb

@@ -104,7 +104,11 @@ module Spree::Preferences::Preferable
     when :password
       value.to_s
     when :decimal
-      BigDecimal.new(value.to_s)
+      begin
+        value.to_s.to_d
+      rescue ArgumentError
+        BigDecimal.new(0)
+      end
     when :integer
       value.to_i
     when :boolean

data/app/models/spree/preferences/store.rb

@@ -33,7 +33,7 @@ module Spree::Preferences
         # has been cleared from the cache
 
         # does it exist in the database?
-        if preference = Spree::Preference.find_by_key(key)
+        if preference = Spree::Preference.find_by(key: key)
           # it does exist
           val = preference.value
         else
@@ -74,7 +74,7 @@ module Spree::Preferences
     def destroy(cache_key)
       return unless should_persist?
 
-      preference = Spree::Preference.find_by_key(cache_key)
+      preference = Spree::Preference.find_by(key: cache_key)
       preference.destroy if preference
     end
 

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

@@ -171,9 +171,13 @@ module Spree
       where("#{Spree::Product.quoted_table_name}.deleted_at IS NULL or #{Spree::Product.quoted_table_name}.deleted_at >= ?", Time.current)
     end
 
+    scope :with_master_price, -> do
+      joins(:master).where(Spree::Price.where(Spree::Variant.arel_table[:id].eq(Spree::Price.arel_table[:variant_id])).exists)
+    end
+
     # Can't use add_search_scope for this as it needs a default argument
     def self.available(available_on = nil)
-      joins(master: :prices).where("#{Spree::Product.quoted_table_name}.available_on <= ?", available_on || Time.current)
+      with_master_price.where("#{Spree::Product.quoted_table_name}.available_on <= ?", available_on || Time.current)
     end
     search_scopes << :available
 
@@ -181,7 +185,16 @@ module Spree
       group("spree_products.id").joins(:taxons).where(Spree::Taxon.arel_table[:name].eq(name))
     end
 
+    def self.with_variant_sku_cont(sku)
+      sku_match = "%#{sku}%"
+      variant_table = Spree::Variant.arel_table
+      subquery = Spree::Variant.where(variant_table[:sku].matches(sku_match).and(variant_table[:product_id].eq(arel_table[:id])))
+      where(subquery.exists)
+    end
+
     def self.distinct_by_product_ids(sort_order = nil)
+      Spree::Deprecation.warn "Product.distinct_by_product_ids is deprecated and should not be used"
+
       sort_column = sort_order.split(" ").first
 
       # Postgres will complain when using ordering by expressions not present in

data/app/models/spree/product.rb

@@ -80,7 +80,7 @@ module Spree
 
     after_initialize :ensure_master
 
-    after_save :run_touch_callbacks, if: :changed?
+    after_save :run_touch_callbacks, if: :saved_changes?
     after_touch :touch_taxons
 
     before_validation :normalize_slug, on: :update
@@ -103,6 +103,10 @@ module Spree
     self.whitelisted_ransackable_associations = %w[stores variants_including_master master variants]
     self.whitelisted_ransackable_attributes = %w[slug]
 
+    def self.ransackable_scopes(_auth_object = nil)
+      %i(with_deleted with_variant_sku_cont)
+    end
+
     # @return [Boolean] true if there are any variants
     def has_variants?
       variants.any?
@@ -339,10 +343,12 @@ module Spree
     # Iterate through this products taxons and taxonomies and touch their timestamps in a batch
     def touch_taxons
       taxons_to_touch = taxons.map(&:self_and_ancestors).flatten.uniq
-      Spree::Taxon.where(id: taxons_to_touch.map(&:id)).update_all(updated_at: Time.current)
+      unless taxons_to_touch.empty?
+        Spree::Taxon.where(id: taxons_to_touch.map(&:id)).update_all(updated_at: Time.current)
 
-      taxonomy_ids_to_touch = taxons_to_touch.map(&:taxonomy_id).flatten.uniq
-      Spree::Taxonomy.where(id: taxonomy_ids_to_touch).update_all(updated_at: Time.current)
+        taxonomy_ids_to_touch = taxons_to_touch.map(&:taxonomy_id).flatten.uniq
+        Spree::Taxonomy.where(id: taxonomy_ids_to_touch).update_all(updated_at: Time.current)
+      end
     end
 
     def remove_taxon(taxon)

data/app/models/spree/promotion_action.rb

@@ -36,5 +36,9 @@ module Spree
         end
       end
     end
+
+    def to_partial_path
+      "spree/admin/promotions/actions/#{model_name.element}"
+    end
   end
 end

data/app/models/spree/promotion_code/batch_builder.rb

@@ -2,10 +2,11 @@ class ::Spree::PromotionCode::BatchBuilder
   attr_reader :promotion_code_batch
   delegate :promotion, :number_of_codes, :base_code, to: :promotion_code_batch
 
-  class_attribute :random_code_length, :batch_size, :sample_characters
+  class_attribute :random_code_length, :batch_size, :sample_characters, :join_characters
   self.random_code_length = 6
   self.batch_size = 1_000
   self.sample_characters = ('a'..'z').to_a + (2..9).to_a.map(&:to_s)
+  self.join_characters = "_"
 
   def initialize(promotion_code_batch)
     @promotion_code_batch = promotion_code_batch
@@ -54,7 +55,7 @@ class ::Spree::PromotionCode::BatchBuilder
       sample_characters.sample
     end.join
 
-    "#{base_code}_#{suffix}"
+    "#{base_code}#{join_characters}#{suffix}"
   end
 
   def get_unique_codes(code_set)

data/app/models/spree/promotion_rule.rb

@@ -30,6 +30,10 @@ module Spree
       @eligibility_errors ||= ActiveModel::Errors.new(self)
     end
 
+    def to_partial_path
+      "spree/admin/promotions/rules/#{model_name.element}"
+    end
+
     private
 
     def unique_per_promotion

data/app/models/spree/role.rb

@@ -3,6 +3,8 @@ module Spree
     has_many :role_users, class_name: "Spree::RoleUser", dependent: :destroy
     has_many :users, through: :role_users
 
+    validates_uniqueness_of :name
+
     def admin?
       name == "admin"
     end

data/app/models/spree/role_user.rb

@@ -6,6 +6,8 @@ module Spree
 
     after_create :auto_generate_spree_api_key
 
+    validates_uniqueness_of :role_id, scope: :user_id
+
     private
 
     def auto_generate_spree_api_key

data/app/models/spree/shipment.rb

@@ -95,6 +95,7 @@ module Spree
     def add_shipping_method(shipping_method, selected = false)
       shipping_rates.create(shipping_method: shipping_method, selected: selected, cost: cost)
     end
+    deprecate :add_shipping_method, deprecator: Spree::Deprecation
 
     def after_cancel
       manifest.each { |item| manifest_restock(item) }
@@ -171,7 +172,7 @@ module Spree
     end
 
     def refresh_rates
-      return shipping_rates if shipped? || order.completed?
+      return shipping_rates if shipped?
       return [] unless can_get_rates?
 
       # StockEstimator.new assigment below will replace the current shipping_method
@@ -250,7 +251,7 @@ module Spree
     end
 
     def shipping_method
-      selected_shipping_rate.try(:shipping_method) || shipping_rates.first.try(:shipping_method)
+      selected_shipping_rate.try(:shipping_method)
     end
 
     # Only one of either included_tax_total or additional_tax_total is set
@@ -332,6 +333,7 @@ module Spree
         order.contents.add(variant, quantity, { shipment: new_shipment })
 
         refresh_rates
+        new_shipment.refresh_rates
         save!
         new_shipment.save!
       end

data/app/models/spree/shipping_method.rb

@@ -36,10 +36,12 @@ module Spree
       # cause this to return incorrect results.
       join_table = Spree::ShippingMethodCategory.arel_table
       having = join_table[:id].count(true).eq(shipping_category_ids.count)
-      joins(:shipping_method_categories).
+      subquery = joins(:shipping_method_categories).
         where(spree_shipping_method_categories: { shipping_category_id: shipping_category_ids }).
         group('spree_shipping_methods.id').
         having(having)
+
+      where(id: subquery.select(:id))
     end
 
     # @param stock_location [Spree::StockLocation] stock location

data/app/models/spree/shipping_rate.rb

@@ -3,7 +3,7 @@ module Spree
   # method has been selected to deliver the shipment.
   #
   class ShippingRate < Spree::Base
-    belongs_to :shipment, class_name: 'Spree::Shipment'
+    belongs_to :shipment, class_name: 'Spree::Shipment', touch: true
     belongs_to :shipping_method, -> { with_deleted }, class_name: 'Spree::ShippingMethod', inverse_of: :shipping_rates
 
     has_many :taxes,

data/app/models/spree/state.rb

@@ -5,8 +5,16 @@ module Spree
 
     validates :country, :name, presence: true
 
-    def self.find_all_by_name_or_abbr(name_or_abbr)
-      where('name = ? OR abbr = ?', name_or_abbr, name_or_abbr)
+    scope :with_name_or_abbr, ->(name_or_abbr) do
+      where(
+        arel_table[:name].matches(name_or_abbr).or(
+          arel_table[:abbr].matches(name_or_abbr)
+        )
+      )
+    end
+    class << self
+      alias_method :find_all_by_name_or_abbr, :with_name_or_abbr
+      deprecate find_all_by_name_or_abbr: :with_name_or_abbr, deprecator: Spree::Deprecation
     end
 
     # table of { country.id => [ state.id , state.name ] }, arrays sorted by name

data/app/models/spree/stock_item.rb

@@ -15,7 +15,7 @@ module Spree
     # @return [String] the name of this stock item's variant
     delegate :name, to: :variant, prefix: true
 
-    after_save :conditional_variant_touch, if: :changed?
+    after_save :conditional_variant_touch, if: :saved_changes?
     after_touch { variant.touch }
 
     self.whitelisted_ransackable_attributes = ['count_on_hand', 'stock_location_id']
@@ -103,8 +103,8 @@ module Spree
     def should_touch_variant?
       # the variant_id changes from nil when a new stock location is added
       inventory_cache_threshold &&
-        (count_on_hand_changed? && count_on_hand_change.any? { |c| c < inventory_cache_threshold }) ||
-        variant_id_changed?
+        (saved_change_to_count_on_hand && saved_change_to_count_on_hand.any? { |c| c < inventory_cache_threshold }) ||
+        saved_change_to_variant_id?
     end
 
     def inventory_cache_threshold

data/app/models/spree/store.rb

@@ -21,7 +21,12 @@ module Spree
 
     scope :by_url, lambda { |url| where("url like ?", "%#{url}%") }
 
+    class << self
+      deprecate :by_url, "Spree::Store.by_url is DEPRECATED", deprecator: Spree::Deprecation
+    end
+
     def self.current(store_key)
+      Spree::Deprecation.warn "Spree::Store.current is DEPRECATED"
       current_store = Store.find_by(code: store_key) || Store.by_url(store_key).first if store_key
       current_store || Store.default
     end

data/app/models/spree/store_credit.rb

@@ -239,7 +239,7 @@ class Spree::StoreCredit < Spree::PaymentSource
   end
 
   def store_event
-    return unless amount_changed? || amount_used_changed? || amount_authorized_changed? || [ELIGIBLE_ACTION, INVALIDATE_ACTION].include?(action)
+    return unless saved_change_to_amount? || saved_change_to_amount_used? || saved_change_to_amount_authorized? || [ELIGIBLE_ACTION, INVALIDATE_ACTION].include?(action)
 
     event = if action
       store_credit_events.build(action: action)
@@ -285,7 +285,7 @@ class Spree::StoreCredit < Spree::PaymentSource
   def associate_credit_type
     unless type_id
       credit_type_name = category.try(:non_expiring?) ? Spree.t("store_credit.non_expiring") : Spree.t("store_credit.expiring")
-      self.credit_type = Spree::StoreCreditType.find_by_name(credit_type_name)
+      self.credit_type = Spree::StoreCreditType.find_by(name: credit_type_name)
     end
   end
 end

data/app/models/spree/store_credit_event.rb

@@ -48,7 +48,7 @@ module Spree
     end
 
     def order
-      Spree::Payment.find_by_response_code(authorization_code).try(:order)
+      Spree::Payment.find_by(response_code: authorization_code).try(:order)
     end
   end
 end

data/app/models/spree/store_selector/by_server_name.rb

@@ -0,0 +1,30 @@
+# Default implementation for finding the current store is given an HTTP request
+#
+# This is the new default behaviour, starting in Solidus 2.3.0. For the old
+# behaviour see Spree::StoreSelector::Legacy.
+#
+# This attempts to find a Spree::Store with a URL matching the domain name of
+# the request exactly. Failing that it will return the store marked as default.
+module Spree
+  module StoreSelector
+    class ByServerName
+      def initialize(request)
+        @request = request
+      end
+
+      # Chooses the current store based on a request.
+      # @return [Spree::Store]
+      def store
+        server_name = @request.env['SERVER_NAME']
+
+        # We select a store which either matches our server name, or is default.
+        # We sort by `default ASC` so that a store matching SERVER_NAME will come
+        # first, and we will find that instead of the default.
+        store = Spree::Store.where(url: server_name).or(Store.where(default: true)).order(default: :asc).first
+
+        # Provide a fallback, mostly for legacy/testing purposes
+        store || Spree::Store.new
+      end
+    end
+  end
+end

data/app/models/spree/store_selector/legacy.rb

@@ -0,0 +1,48 @@
+# This class provides the old behaviour for finding a matching Spree::Store
+# based on a request.
+#
+# To enable this, somewhere inside config/initializers/ add
+#
+#     Spree::Config.current_store_selector_class = Spree::StoreSelector::Legacy
+#
+# This classes behaviour is somewhat complicated and has issues, which is why
+# it has been replaced with Spree::StoreSelector::ByServerName by default.
+#
+# It will:
+# * Find a "store_key"
+#   * from the HTTP_SPREE_STORE header, if it exists
+#   * or the server's domain name if HTTP_SPREE_STORE isn't set
+# * Find a store, using the first match of:
+#   * having a code matching the store_key exactly
+#   * having a url which contains the store_key anywhere as a substring
+#   * has default set to true
+#
+module Spree
+  module StoreSelector
+    class Legacy
+      def initialize(request)
+        @request = request
+      end
+
+      # Chooses the current store based on a request.
+      # Checks request headers for HTTP_SPREE_STORE and falls back to
+      # looking up by the requesting server's name.
+      # @return [Spree::Store]
+      def store
+        current_store =
+          if store_key
+            Spree::Store.find_by(code: store_key) ||
+              Store.where("url like ?", "%#{store_key}%").first
+          end
+
+        current_store || Spree::Store.default
+      end
+
+      private
+
+      def store_key
+        @request.headers['HTTP_SPREE_STORE'] || @request.env['SERVER_NAME']
+      end
+    end
+  end
+end

data/app/models/spree/tax/item_tax.rb

@@ -0,0 +1,20 @@
+module Spree
+  module Tax
+    # Simple object used to hold tax data for an item.
+    #
+    # This generic object will hold the amount of tax that should be applied to
+    # an item. (Either a {Spree::LineItem} or a {Spree::Shipment}.)
+    #
+    # @attr_reader [Integer] item_id the {Spree::LineItem} or {Spree::Shipment} ID
+    # @attr_reader [String] label information about the taxes
+    # @attr_reader [Spree::TaxRate] tax_rate will be used as the source for tax
+    #   adjustments
+    # @attr_reader [BigDecimal] amount the amount of tax applied to the item
+    # @attr_reader [Boolean] included_in_price whether the amount is included
+    #   in the items price, or additional tax.
+    class ItemTax
+      include ActiveModel::Model
+      attr_accessor :item_id, :label, :tax_rate, :amount, :included_in_price
+    end
+  end
+end

data/app/models/spree/tax/order_adjuster.rb

@@ -4,8 +4,6 @@ module Spree
     class OrderAdjuster
       attr_reader :order
 
-      include TaxHelpers
-
       # @param [Spree::Order] order to be adjusted
       def initialize(order)
         @order = order
@@ -14,18 +12,8 @@ module Spree
       # Creates tax adjustments for all taxable items (shipments and line items)
       # in the given order.
       def adjust!
-        (order.line_items + order.shipments).each do |item|
-          ItemAdjuster.new(item, order_wide_options).adjust!
-        end
-      end
-
-      private
-
-      def order_wide_options
-        {
-          rates_for_order: rates_for_order(order),
-          rates_for_default_zone: rates_for_default_zone
-        }
+        taxes = Spree::Config.tax_calculator_class.new(order).calculate
+        Spree::OrderTaxation.new(order).apply(taxes)
       end
     end
   end

data/app/models/spree/tax/order_tax.rb

@@ -0,0 +1,18 @@
+module Spree
+  module Tax
+    # Simple object to pass back tax data from a calculator.
+    #
+    # Will be used by {Spree::OrderTaxation} to create or update tax
+    # adjustments on an order.
+    #
+    # @attr_reader [Integer] order_id the {Spree::Order} these taxes apply to
+    # @attr_reader [Array<Spree::Tax::ItemTax>] line_item_taxes an array of
+    #   tax data for order's line items
+    # @attr_reader [Array<Spree::Tax::ItemTax>] shipment_taxes an array of
+    #   tax data for the order's shipments
+    class OrderTax
+      include ActiveModel::Model
+      attr_accessor :order_id, :line_item_taxes, :shipment_taxes
+    end
+  end
+end