solidus_core 1.3.0.beta1 → 1.3.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d35bbf151696ae5b75db7416fff2c8e284ca9b8
-  data.tar.gz: 8e522de0b131af298e20285e0538f9619f9f1319
+  metadata.gz: 9448c7bb96e59ed1cb4f56c29f66060c99a0abd5
+  data.tar.gz: e0cde0bf71c48efcaece95c384d457b4dd3c59ef
 SHA512:
-  metadata.gz: 0738f730422f1fab50ac319b097afb20c9839a67e9777fc4d2d8aa3eb36c5d5ea2c01e82858945e27e5f2f96d1eaf0525bad5a265d19ecfb4f5d214f268406c8
-  data.tar.gz: 841e663aa453b91bc9e7c2d01002c33270bbd628aaef244daf840e6410381eca2a0df8606a37c3bd45b690498c8706b673e609f85082773e0fe9047928ebe672
+  metadata.gz: a24c63de0a3f6303aa9099fff4340f75c488a830f5a6443eafa9ec3add8a85f7d14f11085d1d7bc567661cd390676fc13c0781514dbc3a7598d31484745a4aa5
+  data.tar.gz: de47427d22d7d72d347f79347074844cdf87d1e0f3e5f3d8afbb312077c6be5e422bc0733b4bbaf0c6ddf5d3d151f82e3667c8e748eadc66af2862e2c4f7fd0d

data/Gemfile

@@ -1,3 +1,3 @@
-eval_gemfile File.expand_path('../../common_spree_dependencies.rb', __FILE__)
+eval(File.read(File.dirname(__FILE__) + '/../common_spree_dependencies.rb'))
 
 gemspec

data/app/models/spree/app_configuration.rb

@@ -281,22 +281,22 @@ module Spree
     end
 
     # Allows implementing custom pricing for variants
-    # @!attribute [rw] variant_pricer_class
-    # @see Spree::Variant::Pricer
+    # @!attribute [rw] variant_price_selector_class
+    # @see Spree::Variant::PriceSelector
     # @return [Class] an object that conforms to the API of
-    #   the standard variant pricer class Spree::Variant::Pricer.
-    attr_writer :variant_pricer_class
-    def variant_pricer_class
-      @variant_pricer_class ||= Spree::Variant::Pricer
+    #   the standard variant price selector class Spree::Variant::PriceSelector.
+    attr_writer :variant_price_selector_class
+    def variant_price_selector_class
+      @variant_price_selector_class ||= Spree::Variant::PriceSelector
     end
 
-    # Shortcut for getting the variant pricer's pricing options class
+    # Shortcut for getting the variant price selector's pricing options class
     #
     # @return [Class] The pricing options class to be used
-    delegate :pricing_options_class, to: :variant_pricer_class
+    delegate :pricing_options_class, to: :variant_price_selector_class
 
     # Shortcut for the default pricing options
-    # @return [variant_pricer_class] An instance of the pricing options class with default desired
+    # @return [variant_price_selector_class] An instance of the pricing options class with default desired
     #   attributes
     def default_pricing_options
       @default_pricing_options ||= pricing_options_class.new

data/app/models/spree/country.rb

@@ -2,6 +2,7 @@ module Spree
   class Country < Spree::Base
     has_many :states, -> { order(:name) }, dependent: :destroy
     has_many :addresses, dependent: :nullify
+    has_many :prices, class_name: "Spree::Price", foreign_key: "country_iso", primary_key: "iso"
 
     validates :name, :iso_name, presence: true
 

data/app/models/spree/line_item.rb

@@ -102,14 +102,20 @@ module Spree
       !sufficient_stock?
     end
 
-    # Sets options on the line item.
+    # Sets options on the line item and updates the price.
     #
     # The options can be arbitrary attributes on the LineItem.
     #
     # @param options [Hash] options for this line item
     def options=(options = {})
       return unless options.present?
+
       assign_attributes options
+
+      # There's no need to call a pricer if we'll set the price directly.
+      unless options.key?(:price) || options.key?('price')
+        self.money_price = variant.price_for(pricing_options)
+      end
     end
 
     def pricing_options

data/app/models/spree/payment_method.rb

@@ -9,7 +9,7 @@ module Spree
     has_many :payments, class_name: "Spree::Payment", inverse_of: :payment_method
     has_many :credit_cards, class_name: "Spree::CreditCard"
     has_many :store_payment_methods, inverse_of: :payment_method
-    has_many :payment_methods, through: :store_payment_methods
+    has_many :stores, through: :store_payment_methods
 
     scope :ordered_by_position, -> { order(:position) }
 

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

@@ -97,6 +97,7 @@ module Spree::Preferences::Preferable
   private
 
   def convert_preference_value(value, type)
+    return nil if value.nil?
     case type
     when :string, :text
       value.to_s

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

@@ -22,14 +22,14 @@ module Spree
         if respond_to?(:preference_source) && preference_source
           self.class.preference_sources[preference_source] || {}
         else
-          super
+          self[:preferences]
         end
       end
 
       def preferences=(val)
         if respond_to?(:preference_source) && preference_source
         else
-          super
+          self[:preferences] = val
         end
       end
     end

data/app/models/spree/price.rb

@@ -5,14 +5,21 @@ module Spree
     MAXIMUM_AMOUNT = BigDecimal('99_999_999.99')
 
     belongs_to :variant, -> { with_deleted }, class_name: 'Spree::Variant', touch: true
+    belongs_to :country, class_name: "Spree::Country", foreign_key: "country_iso", primary_key: "iso"
+
+    delegate :product, to: :variant
+    delegate :tax_rates, to: :variant
 
     validate :check_price
     validates :amount, allow_nil: true, numericality: {
       greater_than_or_equal_to: 0,
       less_than_or_equal_to: MAXIMUM_AMOUNT
     }
+    validates :currency, inclusion: { in: ::Money::Currency.all.map(&:iso_code), message: :invalid_code }
+    validates :country, presence: true, unless: -> { for_any_country? }
 
-    scope :currently_valid, -> { where(is_default: true) }
+    scope :currently_valid, -> { where(is_default: true).order("country_iso IS NULL") }
+    scope :for_any_country, -> { where(country: nil) }
     scope :with_default_attributes, -> { where(Spree::Config.default_pricing_options.desired_attributes) }
     after_save :set_default_price
 
@@ -20,7 +27,7 @@ module Spree
     money_methods :amount, :price
     alias_method :money, :display_amount
 
-    self.whitelisted_ransackable_attributes = ['amount']
+    self.whitelisted_ransackable_attributes = %w( amount variant_id currency country_iso )
 
     # An alias for #amount
     def price
@@ -35,8 +42,29 @@ module Spree
       self[:amount] = Spree::LocalizedNumber.parse(price)
     end
 
+    def net_amount
+      amount / (1 + sum_of_vat_amounts)
+    end
+
+    def for_any_country?
+      country_iso.nil?
+    end
+
+    def display_country
+      if country_iso
+        "#{country_iso} (#{country.name})"
+      else
+        I18n.t(:any_country, scope: [:spree, :admin, :prices])
+      end
+    end
+
     private
 
+    def sum_of_vat_amounts
+      return 0 unless variant.tax_category
+      tax_rates.included_in_price.for_country(country).sum(:amount)
+    end
+
     def check_price
       self.currency ||= Spree::Config[:currency]
     end

data/app/models/spree/product.rb

@@ -59,7 +59,10 @@ module Spree
       master || build_master
     end
 
-    MASTER_ATTRIBUTES = [:sku, :price, :currency, :display_amount, :display_price, :weight, :height, :width, :depth, :cost_currency, :price_in, :price_for, :amount_in, :cost_price]
+    MASTER_ATTRIBUTES = [
+      :rebuild_vat_prices, :sku, :price, :currency, :display_amount, :display_price, :weight,
+      :height, :width, :depth, :cost_currency, :price_in, :price_for, :amount_in, :cost_price
+    ]
     MASTER_ATTRIBUTES.each do |attr|
       delegate :"#{attr}", :"#{attr}=", to: :find_or_build_master
     end

data/app/models/spree/stock/inventory_unit_builder.rb

@@ -7,8 +7,8 @@ module Spree
 
       def units
         @order.line_items.flat_map do |line_item|
-          Array.new(line_item.quantity) do |_i|
-            @order.inventory_units.build(
+          Array.new(line_item.quantity) do
+            Spree::InventoryUnit.new(
               pending: true,
               variant: line_item.variant,
               line_item: line_item,

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

@@ -25,6 +25,10 @@ module Spree
         state_id == other.state_id && country_id == other.country_id
       end
 
+      def country
+        Spree::Country.find_by(id: country_id)
+      end
+
       def empty?
         country_id.nil? && state_id.nil?
       end

data/app/models/spree/tax_rate.rb

@@ -1,13 +1,3 @@
-module Spree
-  class DefaultTaxZoneValidator < ActiveModel::Validator
-    def validate(record)
-      if record.included_in_price
-        record.errors.add(:included_in_price, Spree.t(:included_price_validation)) unless Zone.default_tax
-      end
-    end
-  end
-end
-
 module Spree
   class TaxRate < Spree::Base
     acts_as_paranoid
@@ -26,10 +16,11 @@ module Spree
 
     validates :amount, presence: true, numericality: true
     validates :tax_category_id, presence: true
-    validates_with DefaultTaxZoneValidator
 
     # Finds all tax rates whose zones match a given address
     scope :for_address, ->(address) { joins(:zone).merge(Spree::Zone.for_address(address)) }
+    scope :for_country,
+          ->(country) { for_address(Spree::Tax::TaxLocation.new(country: country)) }
 
     # Finds geographically matching tax rates for a tax zone.
     # We do not know if they are/aren't applicable until we attempt to apply these rates to

data/app/models/spree/variant/price_selector.rb

@@ -0,0 +1,35 @@
+module Spree
+  class Variant
+    # This class is responsible for selecting a price for a variant given certain pricing options.
+    # A variant can have multiple or even dynamic prices. The `price_for`
+    # method determines which price applies under the given circumstances.
+    #
+    class PriceSelector
+      # The pricing options represent "given circumstances" for a price: The currency
+      # we need and the country that the price applies to.
+      # Every price selector is designed to work with a particular set of pricing options
+      # embodied in it's pricing options class.
+      #
+      def self.pricing_options_class
+        Spree::Variant::PricingOptions
+      end
+
+      attr_reader :variant
+
+      def initialize(variant)
+        @variant = variant
+      end
+
+      # The variant's price, given a set of pricing options
+      # @param [Spree::Variant::PricingOptions] price_options Pricing Options to abide by
+      # @return [Spree::Money, nil] The most specific price for this set of pricing options.
+      def price_for(price_options)
+        variant.currently_valid_prices.detect do |price|
+          ( price.country_iso == price_options.desired_attributes[:country_iso] ||
+            price.country_iso.nil?
+          ) && price.currency == price_options.desired_attributes[:currency]
+        end.try!(:money)
+      end
+    end
+  end
+end

data/app/models/spree/variant/pricing_options.rb

@@ -1,30 +1,95 @@
 module Spree
   class Variant
+    # Instances of this class represent the set of circumstances that influence how expensive a
+    # variant is. For this particular pricing options class, country_iso and currency influence
+    # the price of a variant.
+    #
+    # Pricing options can be instantiated from a line item or from the view context:
+    # @see Spree::LineItem#pricing_options
+    # @see Spree::Core::ControllerHelpers::Pricing#current_pricing_options
+    #
     class PricingOptions
+      # When editing variants in the admin, this is the standard price the admin interacts with:
+      # The price in the admin's globally configured currency, for the admin's globally configured
+      # country. These options get merged with any options the user provides when instantiating
+      # new pricing options.
+      # @see Spree::Config.default_pricing_options
+      # @see #initialize
+      # @return [Hash] The attributes that admin prices usually have
+      #
       def self.default_price_attributes
-        { currency: Spree::Config.currency }
+        {
+          currency: Spree::Config.currency,
+          country_iso: Spree::Config.admin_vat_country_iso
+        }
       end
 
+      # This creates the correct pricing options for a line item, taking into account
+      # its currency and tax address country, if available.
+      # @see Spree::LineItem#set_pricing_attributes
+      # @see Spree::LineItem#pricing_options
+      # @return [Spree::Variant::PricingOptions] pricing options for pricing a line item
+      #
       def self.from_line_item(line_item)
-        new(currency: line_item.order.try(:currency) || line_item.currency || Spree::Config.currency )
+        tax_address = line_item.order.try!(:tax_address)
+        new(
+          currency: line_item.order.try(:currency) || line_item.currency || Spree::Config.currency,
+          country_iso: tax_address && tax_address.country.try!(:iso)
+        )
       end
 
+      # This creates the correct pricing options for a price, so that we can easily find other prices
+      # with the same pricing-relevant attributes and mark them as non-default.
+      # @see Spree::Price#set_default_price
+      # @return [Spree::Variant::PricingOptions] pricing options for pricing a line item
+      #
       def self.from_price(price)
-        new(currency: price.currency)
+        new(currency: price.currency, country_iso: price.country_iso)
       end
 
+      # @return [Hash] The hash of exact desired attributes
       attr_reader :desired_attributes
 
       def initialize(desired_attributes = {})
         @desired_attributes = self.class.default_price_attributes.merge(desired_attributes)
       end
 
+      # A slightly modified version of the `desired_attributes` Hash. Instead of
+      # having "nil" or an actual country ISO code under the `:country_iso` key,
+      # this creates an array under the country_iso key that includes both the actual
+      # country iso we want and nil as a shorthand for the fallback price.
+      # This is useful so that we can determine the availability of variants by price:
+      # @see Spree::Variant.with_prices
+      # @see Spree::Core::Search::Base#retrieve_products
+      # @return [Hash] arguments to be passed into ActiveRecord.where()
+      #
+      def search_arguments
+        search_arguments = desired_attributes
+        search_arguments[:country_iso] = [desired_attributes[:country_iso], nil].flatten.uniq
+        search_arguments
+      end
+
+      # Shorthand for accessing the currency part of the desired attributes
+      # @return [String,nil] three-digit currency code or nil
+      #
       def currency
         desired_attributes[:currency]
       end
 
+      # Shorthand for accessing the country part of the desired attributes
+      # @return [String,nil] two-digit country code or nil
+      #
+      def country_iso
+        desired_attributes[:country_iso]
+      end
+
+      # Since the current pricing options determine the price to be shown to users,
+      # product pages have to be cached and their caches invalidated using the data
+      # from this object. This method makes it easy to use with Rails `cache` helper.
+      # @return [String] cache key to be used in views
+      #
       def cache_key
-        desired_attributes.values.map(&:to_s).join("/")
+        desired_attributes.values.select(&:present?).map(&:to_s).join("/")
       end
     end
   end

data/app/models/spree/variant/vat_price_generator.rb

@@ -0,0 +1,58 @@
+module Spree
+  class Variant
+    # This class generates gross prices for all countries that have VAT configured.
+    # The prices will include their respective VAT rates. It will also generate an
+    # export (net) price for any country that doesn't have VAT.
+    # @example
+    #   The admin is configured to show German gross prices
+    #   (Spree::Config.admin_vat_country_iso == "DE")
+    #
+    #   There is VATs configured for Germany (19%) and Finland (24%).
+    #   The VAT price generator is run on a variant with a base (German) price of 10.00.
+    #   The Price Generator will generate:
+    #     - A price for Finland (country_id == "FI"): 10.42
+    #     - A price for any other country (country_id == nil): 8.40
+    #
+    class VatPriceGenerator
+      attr_reader :variant
+
+      def initialize(variant)
+        @variant = variant
+      end
+
+      def run
+        # Early return if there is no VAT rates in the current store.
+        return if !variant.tax_category || variant_vat_rates.empty?
+
+        country_isos_requiring_price.each do |country_iso|
+          # Don't re-create the default price
+          next if variant.default_price && variant.default_price.country_iso == country_iso
+
+          foreign_price = variant.prices.find_or_initialize_by(
+            country_iso: country_iso,
+            currency: variant.default_price.currency,
+          )
+
+          foreign_price.amount = variant.default_price.net_amount * (1 + vat_for_country_iso(country_iso))
+        end
+      end
+
+      private
+
+      # nil is added to the array so we always have an export price.
+      def country_isos_requiring_price
+        return [nil] unless variant.tax_category
+        [nil] + variant_vat_rates.map(&:zone).flat_map(&:countries).flat_map(&:iso)
+      end
+
+      def vat_for_country_iso(country_iso)
+        return 0 unless variant.tax_category
+        variant_vat_rates.for_country(Spree::Country.find_by(iso: country_iso)).sum(:amount)
+      end
+
+      def variant_vat_rates
+        @variant_vat_rates ||= variant.tax_category.tax_rates.where(included_in_price: true)
+      end
+    end
+  end
+end

data/app/models/spree/variant.rb

@@ -17,6 +17,7 @@ module Spree
     acts_as_paranoid
     acts_as_list scope: :product
 
+    attr_writer :rebuild_vat_prices
     include Spree::DefaultPrice
 
     belongs_to :product, -> { with_deleted }, touch: true, class_name: 'Spree::Product', inverse_of: :variants
@@ -26,6 +27,7 @@ module Spree
              :meta_description, :meta_keywords, :shipping_category,
              to: :product
     delegate :tax_category, to: :product, prefix: true
+    delegate :tax_rates, to: :tax_category
 
     has_many :inventory_units, inverse_of: :variant
     has_many :line_items, inverse_of: :variant
@@ -43,9 +45,19 @@ module Spree
     has_many :prices,
       class_name: 'Spree::Price',
       dependent: :destroy,
-      inverse_of: :variant
+      inverse_of: :variant,
+      autosave: true
+
+    has_many :currently_valid_prices,
+      -> { currently_valid },
+      class_name: 'Spree::Price',
+      dependent: :destroy,
+      inverse_of: :variant,
+      autosave: true
 
     before_validation :set_cost_currency
+    before_validation :set_price
+    before_validation :build_vat_prices, if: -> { rebuild_vat_prices? || new_record? }
 
     validate :check_price
 
@@ -90,10 +102,10 @@ module Spree
 
     # Returns variants that have a price for the given pricing options
     #
-    # @param pricing_options A Pricing Options object as defined on the pricer class
+    # @param pricing_options A Pricing Options object as defined on the price selector class
     # @return [ActiveRecord::Relation]
     def self.with_prices(pricing_options = Spree::Config.default_pricing_options)
-      joins(:prices).merge(Spree::Price.currently_valid.where(pricing_options.desired_attributes))
+      joins(:prices).merge(Spree::Price.currently_valid.where(pricing_options.search_arguments))
     end
 
     # @return [Spree::TaxCategory] the variant's tax category
@@ -222,20 +234,20 @@ module Spree
       option_values.detect { |o| o.option_type.name == opt_name }.try(:presentation)
     end
 
-    # Returns an instance of the globally configured variant pricer class for this variant.
+    # Returns an instance of the globally configured variant price selector class for this variant.
     # It's cached so we don't create too many objects.
     #
-    # @return [Spree::Variant::Pricer] The default pricer class
-    def pricer
-      @pricer ||= Spree::Config.variant_pricer_class.new(self)
+    # @return [Spree::Variant::PriceSelector] The default price selector class
+    def price_selector
+      @price_selector ||= Spree::Config.variant_price_selector_class.new(self)
     end
 
     # Chooses an appropriate price for the given pricing options
     #
-    # @see Spree::Variant::Pricer#price_for
+    # @see Spree::Variant::PriceSelector#price_for
     # @param [Spree::Config.pricing_options_class] An instance of pricing options
     # @return [Spree::Money] The chosen price as a Money object
-    delegate :price_for, to: :pricer
+    delegate :price_for, to: :price_selector
 
     # Returns the difference in price from the master variant
     def price_difference_from_master(pricing_options = Spree::Config.default_pricing_options)
@@ -333,6 +345,10 @@ module Spree
 
     private
 
+    def rebuild_vat_prices?
+      @rebuild_vat_prices != "0" && @rebuild_vat_prices
+    end
+
     def set_master_out_of_stock
       if product.master && product.master.in_stock?
         product.master.stock_items.update_all(backorderable: false)
@@ -341,14 +357,16 @@ module Spree
     end
 
     # Ensures a new variant takes the product master price when price is not supplied
+    def set_price
+      if price.nil? && Spree::Config[:require_master_price] && !is_master?
+        raise 'No master variant found to infer price' unless product && product.master
+        self.price = product.master.price
+      end
+    end
+
     def check_price
-      if price.nil? && Spree::Config[:require_master_price]
-        if is_master?
-          errors.add :price, 'Must supply price for variant or master.price for product.'
-        else
-          raise 'No master variant found to infer price' unless product && product.master
-          self.price = product.master.price
-        end
+      if price.nil? && Spree::Config[:require_master_price] && is_master?
+        errors.add :price, 'Must supply price for variant or master.price for product.'
       end
     end
 
@@ -362,6 +380,10 @@ module Spree
       end
     end
 
+    def build_vat_prices
+      VatPriceGenerator.new(self).run
+    end
+
     def set_position
       update_column(:position, product.variants.maximum(:position).to_i + 1)
     end

data/config/locales/en.yml

@@ -134,6 +134,10 @@ en:
         name: Name
         preference_source: Preference Source
         type: Provider
+      spree/price:
+        currency: Currency
+        amount: Price
+        is_default: Currently Valid
       spree/product:
         available_on: Available On
         cost_currency: Cost Currency
@@ -189,7 +193,7 @@ en:
         number: Number
         reimbursement_status: Status
         total: Total
-      spree/reimbursement_credit:
+      spree/reimbursement/credit:
         amount: Amount
       spree/reimbursement_type:
         name: Name
@@ -395,6 +399,9 @@ en:
       spree/payment_method:
         one: Payment Method
         other: Payment Methods
+      spree/price:
+        one: Price
+        other: Prices
       spree/product:
         one: Product
         other: Products
@@ -523,6 +530,10 @@ en:
           attributes:
             currency:
               must_match_order_currency: "Must match order currency"
+        spree/price:
+          attributes:
+            currency:
+              invalid_code: "is not a valid currency code"
         spree/promotion:
           attributes:
             apply_automatically:
@@ -763,6 +774,16 @@ en:
           use_product_tax_category: Use Product Tax Category
           pricing: Pricing
           pricing_hint: These values are populated from the product details page and can be overridden below
+      prices:
+        any_country: "Any Country"
+        index:
+          amount_greater_than: Amount greater than
+          amount_less_than: Amount less than
+          new_price: New Price
+        edit:
+          edit_price: Edit Price
+        new:
+          new_price: New Price
     administration: Administration
     agree_to_privacy_policy: Agree to Privacy Policy
     agree_to_terms_of_service: Agree to Terms of Service

data/db/migrate/20140410141842_add_many_missing_indexes.rb

@@ -1,17 +1,19 @@
 class AddManyMissingIndexes < ActiveRecord::Migration
+  include Spree::MigrationHelpers
+
   def change
-    add_index :spree_adjustments, [:adjustable_id, :adjustable_type]
-    add_index :spree_adjustments, :eligible
-    add_index :spree_adjustments, :order_id
-    add_index :spree_promotions, :code
-    add_index :spree_promotions, :expires_at
-    add_index :spree_states, :country_id
-    add_index :spree_stock_items, :deleted_at
-    add_index :spree_option_types, :position
-    add_index :spree_option_values, :position
-    add_index :spree_product_option_types, :option_type_id
-    add_index :spree_product_option_types, :product_id
-    add_index :spree_products_taxons, :position
-    add_index :spree_promotions, :starts_at
+    safe_add_index :spree_adjustments, [:adjustable_id, :adjustable_type]
+    safe_add_index :spree_adjustments, :eligible
+    safe_add_index :spree_adjustments, :order_id
+    safe_add_index :spree_promotions, :code
+    safe_add_index :spree_promotions, :expires_at
+    safe_add_index :spree_states, :country_id
+    safe_add_index :spree_stock_items, :deleted_at
+    safe_add_index :spree_option_types, :position
+    safe_add_index :spree_option_values, :position
+    safe_add_index :spree_product_option_types, :option_type_id
+    safe_add_index :spree_product_option_types, :product_id
+    safe_add_index :spree_products_taxons, :position
+    safe_add_index :spree_promotions, :starts_at
   end
 end