solidus_core 2.0.3 → 2.1.0.beta1

data/app/models/spree/calculator/shipping/price_sack.rb

@@ -8,10 +8,6 @@ module Spree
       preference :discount_amount, :decimal, default: 0
       preference :currency, :string, default: ->{ Spree::Config[:currency] }
 
-      def self.description
-        Spree.t(:shipping_price_sack)
-      end
-
       def compute_package(package)
         compute_from_price(total(package.contents))
       end

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

@@ -14,10 +14,6 @@ module Spree
 
     validate :preferred_tiers_content
 
-    def self.description
-      Spree.t(:tiered_flat_rate)
-    end
-
     def compute(object)
       _base, amount = preferred_tiers.sort.reverse.detect{ |b, _| object.amount >= b }
       amount || preferred_base_amount

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

@@ -18,10 +18,6 @@ module Spree
     }
     validate :preferred_tiers_content
 
-    def self.description
-      Spree.t(:tiered_percent)
-    end
-
     def compute(object)
       order = object.is_a?(Order) ? object : object.order
       _base, percent = preferred_tiers.sort.reverse.detect{ |b, _| order.item_total >= b }

data/app/models/spree/credit_card.rb

@@ -1,4 +1,6 @@
 module Spree
+  # The default `source` of a `Spree::Payment`.
+  #
   class CreditCard < Spree::Base
     belongs_to :payment_method
     belongs_to :user, class_name: Spree.user_class, foreign_key: 'user_id'
@@ -11,10 +13,8 @@ module Spree
 
     accepts_nested_attributes_for :address
 
-    attr_reader :number
-    attr_accessor :encrypted_data,
-                    :imported,
-                    :verification_value
+    attr_reader :number, :verification_value
+    attr_accessor :encrypted_data, :imported
 
     validates :month, :year, numericality: { only_integer: true }, if: :require_card_numbers?, on: :create
     validates :number, presence: true, if: :require_card_numbers?, on: :create, unless: :imported
@@ -27,14 +27,22 @@ module Spree
     # needed for some of the ActiveMerchant gateways (eg. SagePay)
     alias_attribute :brand, :cc_type
 
+    # Taken from ActiveMerchant
+    # https://github.com/activemerchant/active_merchant/blob/2f2acd4696e8de76057b5ed670b9aa022abc1187/lib/active_merchant/billing/credit_card_methods.rb#L5
     CARD_TYPES = {
-      visa: /^4[0-9]{12}(?:[0-9]{3})?$/,
-      master: /(^5[1-5][0-9]{14}$)|(^6759[0-9]{2}([0-9]{10})$)|(^6759[0-9]{2}([0-9]{12})$)|(^6759[0-9]{2}([0-9]{13})$)/,
-      diners_club: /^3(?:0[0-5]|[68][0-9])[0-9]{11}$/,
-      american_express: /^3[47][0-9]{13}$/,
-      discover: /^6(?:011|5[0-9]{2})[0-9]{12}$/,
-      jcb: /^(?:2131|1800|35\d{3})\d{11}$/
-    }
+      'visa'               => /^4\d{12}(\d{3})?(\d{3})?$/,
+      'master'             => /^(5[1-5]\d{4}|677189|222[1-9]\d{2}|22[3-9]\d{3}|2[3-6]\d{4}|27[01]\d{3}|2720\d{2})\d{10}$/,
+      'discover'           => /^(6011|65\d{2}|64[4-9]\d)\d{12}|(62\d{14})$/,
+      'american_express'   => /^3[47]\d{13}$/,
+      'diners_club'        => /^3(0[0-5]|[68]\d)\d{11}$/,
+      'jcb'                => /^35(28|29|[3-8]\d)\d{12}$/,
+      'switch'             => /^6759\d{12}(\d{2,3})?$/,
+      'solo'               => /^6767\d{12}(\d{2,3})?$/,
+      'dankort'            => /^5019\d{12}$/,
+      'maestro'            => /^(5[06-8]|6\d)\d{10,17}$/,
+      'forbrugsforeningen' => /^600722\d{10}$/,
+      'laser'              => /^(6304|6706|6709|6771(?!89))\d{8}(\d{4}|\d{6,7})?$/
+    }.freeze
 
     def address_attributes=(attributes)
       self.address = Address.immutable_merge(address, attributes)
@@ -70,6 +78,10 @@ module Spree
         end
     end
 
+    def verification_value=(value)
+      @verification_value = value.to_s.gsub(/\s/, '')
+    end
+
     # Sets the credit card type, converting it to the preferred internal
     # representation from jquery.payment's representation when appropriate.
     #
@@ -88,15 +100,16 @@ module Spree
 
     # Sets the last digits field based on the assigned credit card number.
     def set_last_digits
-      verification_value.to_s.gsub!(/\s/, '')
       self.last_digits ||= number.to_s.length <= 4 ? number : number.to_s.slice(-4..-1)
     end
 
     # @return [String] the credit card type if it can be determined from the
     #   number, otherwise the empty string
     def try_type_from_number
-      numbers = number.delete(' ') if number
-      CARD_TYPES.find{ |type, pattern| return type.to_s if numbers =~ pattern }.to_s
+      CARD_TYPES.each do |type, pattern|
+        return type if number =~ pattern
+      end
+      ''
     end
 
     # @return [Boolean] true when a verification value is present

data/app/models/spree/gateway.rb

@@ -1,4 +1,8 @@
 module Spree
+  # A concrete implementation of `Spree::PaymentMethod` intended to provide a
+  # base for extension. See https://github.com/solidusio/solidus_gateway/ for
+  # offically supported payment gateway implementations.
+  #
   class Gateway < PaymentMethod
     delegate :authorize, :purchase, :capture, :void, :credit, to: :provider
 

data/app/models/spree/inventory_unit.rb

@@ -1,4 +1,6 @@
 module Spree
+  # Tracks the state of line items' fulfillment.
+  #
   class InventoryUnit < Spree::Base
     PRE_SHIPMENT_STATES = %w(backordered on_hand)
     POST_SHIPMENT_STATES = %w(returned)

data/app/models/spree/line_item.rb

@@ -1,5 +1,15 @@
 module Spree
+  # Variants placed in the Order at a particular price.
+  #
+  # `Spree::LineItem` is an ActiveRecord model which records which `Spree::Variant`
+  # a customer has chosen to place in their order. It also acts as the permenent
+  # record of the customer's order by recording relevant price, taxation, and inventory
+  # concerns. Line items can also have adjustments placed on them as part of the
+  # promotion system.
+  #
   class LineItem < Spree::Base
+    class CurrencyMismatch < StandardError; end
+
     belongs_to :order, class_name: "Spree::Order", inverse_of: :line_items, touch: true
     belongs_to :variant, -> { with_deleted }, class_name: "Spree::Variant", inverse_of: :line_items
     belongs_to :tax_category, class_name: "Spree::TaxCategory"
@@ -21,9 +31,6 @@ module Spree
       greater_than: -1
     }
     validates :price, numericality: true
-    validate :ensure_proper_currency
-
-    after_create :update_tax_charge
 
     after_save :update_inventory
 
@@ -31,10 +38,7 @@ module Spree
     before_destroy :destroy_inventory_units
 
     delegate :name, :description, :sku, :should_track_inventory?, to: :variant
-    # @note This will return the product even if it has been deleted.
-    # @return [Spree::Product, nil] the product associated with this line
-    #   item, if there is one
-    delegate :product, to: :variant
+    delegate :currency, to: :order, allow_nil: true
 
     attr_accessor :target_shipment
 
@@ -80,13 +84,19 @@ 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 and currency from a `Spree::Money` object
+    # Sets price from a `Spree::Money` object
     #
-    # @param [Spree::Money] money - the money object to obtain price and currency from
+    # @param [Spree::Money] money - the money object to obtain price from
     def money_price=(money)
-      self.price = money.to_d
-      self.currency = money.currency.iso_code
+      if !money
+        self.price = nil
+      elsif money.currency.iso_code != currency
+        raise CurrencyMismatch, "Line item price currency must match order currency!"
+      else
+        self.price = money.to_d
+      end
     end
 
     # @return [Boolean] true when it is possible to supply the required
@@ -111,7 +121,10 @@ module Spree
 
       assign_attributes options
 
-      # There's no need to call a pricer if we'll set the price directly.
+      # When price is part of the options we are not going to fetch
+      # it from the variant. Please note that this always allows to set
+      # 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)
       end
@@ -121,6 +134,12 @@ 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.
@@ -142,7 +161,6 @@ module Spree
       # If the legacy method #copy_price has been overridden, handle that gracefully
       return handle_copy_price_override if respond_to?(:copy_price)
 
-      self.currency ||= order.currency
       self.cost_price ||= variant.cost_price
       self.money_price = variant.price_for(pricing_options) if price.nil?
       true
@@ -165,18 +183,5 @@ module Spree
     def destroy_inventory_units
       inventory_units.destroy_all
     end
-
-    def update_tax_charge
-      Spree::Tax::ItemAdjuster.new(self).adjust!
-    end
-
-    def ensure_proper_currency
-      if currency != order.currency
-        Spree::Deprecation.warn "The line items currency is different from it's order currency. " \
-                                "This behavior is not supported anymore and will be deleted soon.",
-                                caller
-        errors.add(:currency, :must_match_order_currency)
-      end
-    end
   end
 end

data/app/models/spree/option_type.rb

@@ -13,9 +13,6 @@ module Spree
     has_many :product_option_types, dependent: :destroy, inverse_of: :option_type
     has_many :products, through: :product_option_types
 
-    has_many :option_type_prototypes
-    has_many :prototypes, through: :option_type_prototypes
-
     validates :name, presence: true, uniqueness: { allow_blank: true }
     validates :presentation, presence: true
 

data/app/models/spree/order.rb

@@ -2,6 +2,23 @@ require 'spree/core/validators/email'
 require 'spree/order/checkout'
 
 module Spree
+  # The customers cart until completed, then acts as permenent record of the transaction.
+  #
+  # `Spree::Order` is the heart of the Solidus system, as it acts as the customer's
+  # cart as they shop. Once an order is complete, it serves as the
+  # permenent record of their purchase. It has many responsibilities:
+  #
+  # * Records and validates attributes like `total` and relationships like
+  # `Spree::LineItem` as an ActiveRecord model.
+  #
+  # * Implements a customizable state machine to manage the lifecycle of an order.
+  #
+  # * Implements business logic to provide a single interface for quesitons like
+  # `checkout_allowed?` or `payment_required?`.
+  #
+  #  * Implements an interface for mutating the order with methods like
+  # `empty!` and `fulfill!`.
+  #
   class Order < Spree::Base
     ORDER_NUMBER_LENGTH  = 9
     ORDER_NUMBER_LETTERS = false
@@ -93,7 +110,7 @@ module Spree
     before_create :link_by_email
 
     validates :email, presence: true, if: :require_email
-    validates :email, email: true, if: :require_email, allow_blank: true
+    validates :email, email: true, allow_blank: true
     validates :number, presence: true, uniqueness: { allow_blank: true }
     validates :store_id, presence: true
 
@@ -210,8 +227,10 @@ module Spree
     # Returns the relevant zone (if any) to be used for taxation purposes.
     # Uses default tax zone unless there is a specific match
     def tax_zone
-      @tax_zone ||= Zone.match(tax_address) || Zone.default_tax
+      Zone.match(tax_address) || Zone.default_tax
     end
+    deprecate tax_zone: "Please use Spree::Order#tax_address instead.",
+              deprecator: Spree::Deprecation
 
     # Returns the address for taxation based on configuration
     def tax_address
@@ -331,9 +350,11 @@ module Spree
 
     # 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 #update!
     def create_tax_charge!
-      Spree::Tax::OrderAdjuster.new(self).adjust!
+      Spree::Config.tax_adjuster_class.new(self).adjust!
     end
+    deprecate create_tax_charge!: :update!, deprecator: Spree::Deprecation
 
     def outstanding_balance
       # If reimbursement has happened add it back to total to prevent balance_due payment state
@@ -414,12 +435,10 @@ module Spree
     end
 
     def available_payment_methods
-      @available_payment_methods ||= (
-        PaymentMethod.available(:front_end, store: store) +
-        PaymentMethod.available(:both, store: store)
-      ).
-      uniq.
-      sort_by(&:position)
+      @available_payment_methods ||= Spree::PaymentMethod
+        .available_to_store(store)
+        .available_to_users
+        .sort_by(&:position)
     end
 
     def insufficient_stock_lines
@@ -572,11 +591,6 @@ module Spree
       !approved?
     end
 
-    def reload(options = nil)
-      remove_instance_variable(:@tax_zone) if defined?(@tax_zone)
-      super
-    end
-
     def quantity
       line_items.sum(:quantity)
     end
@@ -689,23 +703,6 @@ module Spree
       Spree::Money.new(total_available_store_credit - total_applicable_store_credit, { currency: currency })
     end
 
-    def payments_attributes=(attributes)
-      validate_payments_attributes(attributes)
-      super(attributes)
-    end
-
-    def validate_payments_attributes(attributes)
-      attributes = Array.wrap(attributes)
-      # Ensure the payment methods specified are allowed for this user
-      payment_methods = Spree::PaymentMethod.where(id: available_payment_methods)
-      attributes.each do |payment_attributes|
-        payment_method_id = payment_attributes[:payment_method_id]
-
-        # raise RecordNotFound unless it is an allowed payment method
-        payment_methods.find(payment_method_id) if payment_method_id
-      end
-    end
-
     private
 
     def associate_store

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

@@ -78,7 +78,6 @@ module Spree
 
                 after_transition to: :complete, do: :add_payment_sources_to_wallet
                 before_transition to: :payment, do: :set_shipments_cost
-                before_transition to: :payment, do: :create_tax_charge!
                 before_transition to: :payment, do: :assign_default_credit_card
 
                 before_transition to: :confirm, do: :add_store_credit_payments
@@ -90,7 +89,6 @@ module Spree
               before_transition from: :cart, do: :ensure_line_items_present
 
               if states[:address]
-                before_transition from: :address, do: :create_tax_charge!
                 before_transition to: :address, do: :assign_default_addresses!
                 before_transition from: :address, do: :persist_user_address!
               end

data/app/models/spree/order_contents.rb

@@ -35,21 +35,7 @@ module Spree
     end
 
     def update_cart(params)
-      # We need old_tax_address / new_tax_address because we can't rely on methods
-      # offered by ActiveRecord::Dirty to determine if tax_address was updated
-      # because if we update the address, a new record will be created
-      # by the Address.factory instead of the old record being updated
-
-      old_tax_address = order.tax_address
-
       if order.update_attributes(params)
-
-        new_tax_address = order.tax_address
-
-        if should_recalculate_taxes?(old_tax_address, new_tax_address)
-          order.create_tax_charge!
-        end
-
         unless order.completed?
           order.line_items = order.line_items.select { |li| li.quantity > 0 }
           # Update totals, then check if the order is eligible for any cart promotions.
@@ -84,36 +70,6 @@ module Spree
 
     private
 
-    def should_recalculate_taxes?(old_address, new_address)
-      # Related to Solidus issue #894
-      # This is needed because if you update the shipping_address
-      # from the backend on an order that completed checkout,
-      # Taxes were not being recalculated if the Order tax zone
-      # was updated
-      #
-      # Possible cases:
-      #
-      # Case 1:
-      #
-      # If old_address is a TaxLocation it means that the order has not passed
-      # the address checkout state so taxes will be computed by the Order
-      # state machine, so we do not calculate taxes here.
-      #
-      # Case 2 :
-      # If new_address is a TaxLocation, but old_address is not, it means that
-      # an order has somehow lost his TaxAddress. Since it's not supposed to happen,
-      # we do not compute taxes.
-      #
-      # Case 3
-      # Both old_address and new_address are Spree::Address so the order
-      # has completed the checkout or that a registered user has updated his
-      # default addresses. We need to recalculate the taxes.
-
-      return if old_address.is_a?(Spree::Tax::TaxLocation) || new_address.is_a?(Spree::Tax::TaxLocation)
-
-      old_address.try!(:taxation_attributes) != new_address.try!(:taxation_attributes)
-    end
-
     def after_add_or_remove(line_item, options = {})
       reload_totals
       shipment = options[:shipment]
@@ -137,7 +93,6 @@ module Spree
       line_item ||= order.line_items.new(
         quantity: 0,
         variant: variant,
-        currency: order.currency
       )
 
       line_item.quantity += quantity.to_i