spree_core 3.0.9 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae2055c830500d2910112cb1253de8bad23e1e3b
-  data.tar.gz: e908d06731a130ab3dbe0eacacbe202a9c06fe43
+  metadata.gz: 571ff10487097fed3c09a22957ee5a9512282d2e
+  data.tar.gz: 3a67ad1d01235db25c6c9b9a1068e5ad43ad317c
 SHA512:
-  metadata.gz: 48cb4aea0e8d0f67cfe13a35c297abaa749cb33f9f123190250912b0b7f51f8a3879844651941f64383413a68a4c16d362d2b3ad24a4b4ec5285e85669584435
-  data.tar.gz: 62aa5663b14d850707be9d42da3337f24b6aab037478d3046fca828d317d2d44f0e504352e8de676d9447cf740bee00a0441641f6c28fd29c0b922d8f857744b
+  metadata.gz: 28afa52abe76e6bd6fbfc317c015d0cf78d3226edc80d47e820a35a093cfa70fe2e04c260acb4ce0494dd92a2a6fde68e58c788bbc9ed8f463a88fdc10ce135b
+  data.tar.gz: 7d5ede6f4304e3e2ff1647b881689088e0f76f2d74ec1354481ba346614353b9e78190831ac46f2fed0f0790802d6af90d02975bdde8705a73b83423e12af081

data/app/assets/javascripts/{spree.js.coffee.erb → spree.js.coffee}

@@ -8,11 +8,17 @@ class window.Spree
       callback(jQuery)
 
   @mountedAt: ->
-    "<%= Rails.application.routes.url_helpers.spree_path(trailing_slash: true) %>"
+    window.SpreePaths.mounted_at
+
+  @adminPath: ->
+    window.SpreePaths.admin
 
   @pathFor: (path) ->
     locationOrigin = "#{window.location.protocol}//#{window.location.hostname}" + (if window.location.port then ":#{window.location.port}" else "")
-    "#{locationOrigin}#{@mountedAt()}#{path}"
+    @url("#{locationOrigin}#{@mountedAt()}#{path}", @url_params).toString()
+
+  @adminPathFor: (path) ->
+    @pathFor("#{@adminPath()}#{path}")
 
   # Helper function to take a URL and add query parameters to it
   # Uses the JSUri library from here: https://github.com/derek-watson/jsUri
@@ -45,6 +51,9 @@ class window.Spree
       $.ajax(Spree.url(url).toString(), url_or_settings)
 
   @routes:
-    states_search: @pathFor('api/states')
+    states_search: @pathFor('api/v1/states')
     apply_coupon_code: (order_id) ->
-      Spree.pathFor("api/orders/#{order_id}/apply_coupon_code")
+      Spree.pathFor("api/v1/orders/#{order_id}/apply_coupon_code")
+
+  @url_params:
+    {}

data/app/helpers/spree/base_helper.rb

@@ -17,7 +17,10 @@ module Spree
     end
 
     def display_price(product_or_variant)
-      product_or_variant.price_in(current_currency).display_price.to_html
+      product_or_variant.
+        price_in(current_currency).
+        display_price_including_vat_for(current_price_options).
+        to_html
     end
 
     def link_to_tracking(shipment, options = {})
@@ -38,7 +41,7 @@ module Spree
       object = instance_variable_get('@'+controller_name.singularize)
       meta = {}
 
-      if object.kind_of? ActiveRecord::Base
+      if object.kind_of? ApplicationRecord
         meta[:keywords] = object.meta_keywords if object[:meta_keywords].present?
         meta[:description] = object.meta_description if object[:meta_description].present?
       end

data/app/helpers/spree/products_helper.rb

@@ -30,17 +30,12 @@ module Spree
 
     # converts line breaks in product description into <p> tags (for html display purposes)
     def product_description(product)
-      if Spree::Config[:show_raw_product_description]
-        raw(product.description)
-      else
-        raw(product.description.gsub(/(.*?)\r?\n\r?\n/m, '<p>\1</p>'))
-      end
-    end
-
-    def line_item_description(variant)
-      ActiveSupport::Deprecation.warn "line_item_description(variant) is deprecated and may be removed from future releases, use line_item_description_text(line_item.description) instead.", caller
-
-      line_item_description_text(variant.product.description)
+      description = if Spree::Config[:show_raw_product_description]
+                      product.description
+                    else
+                      product.description.to_s.gsub(/(.*?)\r?\n\r?\n/m, '<p>\1</p>')
+                    end
+      description.blank? ? Spree.t(:product_has_no_description) : raw(description)
     end
 
     def line_item_description_text description_text
@@ -54,7 +49,37 @@ module Spree
     def cache_key_for_products
       count = @products.count
       max_updated_at = (@products.maximum(:updated_at) || Date.today).to_s(:number)
-      "#{I18n.locale}/#{current_currency}/spree/products/all-#{params[:page]}-#{max_updated_at}-#{count}"
+      products_cache_keys = "spree/products/all-#{params[:page]}-#{max_updated_at}-#{count}"
+      (common_product_cache_keys + [products_cache_keys]).compact.join("/")
+    end
+
+    def cache_key_for_product(product = @product)
+      (common_product_cache_keys + [product.cache_key, product.possible_promotions]).compact.join("/")
+    end
+
+    def available_status(product) # will return a human readable string
+      return Spree.t(:discontinued)  if product.discontinued?
+      return Spree.t(:deleted)  if product.deleted?
+
+      if product.available?
+        Spree.t(:available)
+      elsif product.available_on && product.available_on.future?
+        Spree.t(:pending_sale)
+      else
+        Spree.t(:no_available_date_set)
+      end
+    end
+
+    private
+
+    def common_product_cache_keys
+      [I18n.locale, current_currency] + price_options_cache_key
+    end
+
+    def price_options_cache_key
+      current_price_options.sort.map(&:last).map do |value|
+        value.try(:cache_key) || value
+      end
     end
   end
 end

data/app/mailers/spree/base_mailer.rb

@@ -1,6 +1,5 @@
 module Spree
   class BaseMailer < ActionMailer::Base
-
     def from_address
       Spree::Store.current.mail_from_address
     end
@@ -10,9 +9,19 @@ module Spree
     end
     helper_method :money
 
-    def mail(headers={}, &block)
+    def mail(headers = {}, &block)
+      ensure_default_action_mailer_url_host
       super if Spree::Config[:send_core_emails]
     end
 
+    private
+
+    # this ensures that ActionMailer::Base.default_url_options[:host] is always set
+    # this is only a fail-safe solution if developer didn't set this in environment files
+    # http://guides.rubyonrails.org/action_mailer_basics.html#generating-urls-in-action-mailer-views
+    def ensure_default_action_mailer_url_host
+      ActionMailer::Base.default_url_options ||= {}
+      ActionMailer::Base.default_url_options[:host] ||= Spree::Store.current.url
+    end
   end
 end

data/app/mailers/spree/reimbursement_mailer.rb

@@ -1,10 +1,10 @@
 module Spree
   class ReimbursementMailer < BaseMailer
-      def reimbursement_email(reimbursement, resend = false)
-        @reimbursement = reimbursement.respond_to?(:id) ? reimbursement : Spree::Reimbursement.find(reimbursement)
-        subject = (resend ? "[#{Spree.t(:resend).upcase}] " : '')
-        subject += "#{Spree::Store.current.name} #{Spree.t('reimbursement_mailer.reimbursement_email.subject')} ##{@reimbursement.order.number}"
-        mail(to: @reimbursement.order.email, from: from_address, subject: subject)
-      end
+    def reimbursement_email(reimbursement, resend = false)
+      @reimbursement = reimbursement.respond_to?(:id) ? reimbursement : Spree::Reimbursement.find(reimbursement)
+      subject = (resend ? "[#{Spree.t(:resend).upcase}] " : '')
+      subject += "#{Spree::Store.current.name} #{Spree.t('reimbursement_mailer.reimbursement_email.subject')} ##{@reimbursement.order.number}"
+      mail(to: @reimbursement.order.email, from: from_address, subject: subject)
+    end
   end
 end

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

@@ -0,0 +1,11 @@
+module Spree
+  module ActsAsTaggable
+    extend ActiveSupport::Concern
+
+    included do
+      acts_as_taggable
+      Spree::PermittedAttributes.send("#{model_name.param_key}_attributes") <<
+        [:tag_list]
+    end
+  end
+end

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

@@ -14,7 +14,7 @@ module Spree
       return if amount == 0
       adjustments.new(order: order,
                       adjustable: adjustable,
-                      label: label(amount),
+                      label: label,
                       amount: amount,
                       included: included).save
     end
@@ -41,20 +41,13 @@ module Spree
     end
 
     def deals_with_adjustments_for_deleted_source
-      adjustment_scope = adjustments.includes(:order).references(:spree_orders)
-
       # For incomplete orders, remove the adjustment completely.
-      adjustment_scope.where("spree_orders.completed_at IS NULL").destroy_all
+      adjustments.for_incomplete_order.destroy_all
 
       # For complete orders, the source will be invalid.
       # Therefore we nullify the source_id, leaving the adjustment in place.
       # This would mean that the order's total is not altered at all.
-      adjustment_scope.where("spree_orders.completed_at IS NOT NULL").each do |adjustment|
-        adjustment.update_columns(
-          source_id: nil,
-          updated_at: Time.now,
-        )
-      end
+      adjustments.for_complete_order.update_all(source_id: nil, updated_at: Time.current)
     end
   end
 end

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

@@ -8,7 +8,13 @@ module Spree
         class_name: 'Spree::Price',
         dependent: :destroy
 
-      delegate_belongs_to :default_price, :display_price, :display_amount, :price, :price=, :currency
+      delegate_belongs_to :default_price,
+                          :display_price,
+                          :display_amount,
+                          :price,
+                          :price=,
+                          :price_including_vat_for,
+                          :currency
 
       after_save :save_default_price
 

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

@@ -6,7 +6,7 @@ module Spree
       scope :active, -> { where(active: true) }
       default_scope { order("LOWER(#{self.table_name}.name)") }
 
-      validates :name, presence: true, uniqueness: { case_sensitive: false }
+      validates :name, presence: true, uniqueness: { case_sensitive: false, allow_blank: true }
     end
   end
 end

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

@@ -3,9 +3,10 @@ module Spree::RansackableAttributes
   included do
     class_attribute :whitelisted_ransackable_associations
     class_attribute :whitelisted_ransackable_attributes
+    class_attribute :whitelisted_ransackable_scopes
 
     class_attribute :default_ransackable_attributes
-    self.default_ransackable_attributes = %w[id name]
+    self.default_ransackable_attributes = %w[id name updated_at created_at]
 
     def self.ransackable_associations(*args)
       self.whitelisted_ransackable_associations || []
@@ -14,6 +15,10 @@ module Spree::RansackableAttributes
     def self.ransackable_attributes(*args)
       self.default_ransackable_attributes | (self.whitelisted_ransackable_attributes || [])
     end
+
+    def self.ransackable_scopes(*args)
+      whitelisted_ransackable_scopes || []
+    end
   end
 
 end

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

@@ -1,7 +1,7 @@
 module Spree
   module UserApiAuthentication
     def generate_spree_api_key!
-      self.spree_api_key = SecureRandom.hex(24)
+      self.spree_api_key = generate_spree_api_key
       save!
     end
 
@@ -9,5 +9,11 @@ module Spree
       self.spree_api_key = nil
       save!
     end
+
+    private
+
+    def generate_spree_api_key
+      SecureRandom.hex(24)
+    end
   end
 end

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

@@ -0,0 +1,57 @@
+module Spree
+  module UserMethods
+    extend ActiveSupport::Concern
+
+    include Spree::UserApiAuthentication
+    include Spree::UserPaymentSource
+    include Spree::UserReporting
+    include Spree::RansackableAttributes
+
+    included do
+      # we need to have this callback before any dependent: :destroy associations
+      # https://github.com/rails/rails/issues/3458
+      before_destroy :check_completed_orders
+
+      has_many :role_users, class_name: 'Spree::RoleUser', foreign_key: :user_id, dependent: :destroy
+      has_many :spree_roles, through: :role_users, class_name: 'Spree::Role', source: :role
+
+      has_many :promotion_rule_users, class_name: 'Spree::PromotionRuleUser', foreign_key: :user_id, dependent: :destroy
+      has_many :promotion_rules, through: :promotion_rule_users, class_name: 'Spree::PromotionRule'
+
+      has_many :orders, foreign_key: :user_id, class_name: "Spree::Order"
+      has_many :store_credits, foreign_key: :user_id, class_name: 'Spree::StoreCredit'
+
+      belongs_to :ship_address, class_name: 'Spree::Address'
+      belongs_to :bill_address, class_name: 'Spree::Address'
+
+      self.whitelisted_ransackable_associations = %w[bill_address ship_address]
+      self.whitelisted_ransackable_attributes = %w[id email]
+    end
+
+    # has_spree_role? simply needs to return true or false whether a user has a role or not.
+    def has_spree_role?(role_in_question)
+      spree_roles.any? { |role| role.name == role_in_question.to_s }
+    end
+
+    def last_incomplete_spree_order
+      orders.incomplete.
+        includes(line_items: [variant: [:images, :option_values, :product]]).
+        order('created_at DESC').
+        first
+    end
+
+    def analytics_id
+      id
+    end
+
+    def total_available_store_credit
+      store_credits.reload.to_a.sum(&:amount_remaining)
+    end
+
+    private
+
+    def check_completed_orders
+      raise Spree::Core::DestroyWithOrdersError if orders.complete.present?
+    end
+  end
+end

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

@@ -4,11 +4,11 @@ module Spree
     money_methods :lifetime_value, :average_order_value
 
     def lifetime_value
-      orders.complete.pluck(:total).sum
+      orders.complete.sum(:total)
     end
 
     def order_count
-      BigDecimal(orders.complete.count)
+      BigDecimal(orders.complete.size)
     end
 
     def average_order_value

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

@@ -0,0 +1,47 @@
+module Spree
+  module VatPriceCalculation
+    def gross_amount(amount, price_options)
+      return amount unless outside_default_vat_zone?(price_options)
+      round_to_two_places(add_foreign_vat_for(amount, price_options))
+    end
+
+    private
+
+    def add_foreign_vat_for(amount, price_options)
+      amount = net_amount(amount, price_options[:tax_category])
+      amount_with_foreign_vat(amount, price_options)
+    end
+
+    def net_amount(amount, tax_category)
+      amount / (1 + default_vat(tax_category))
+    end
+
+    def default_vat(tax_category)
+      included_tax_amount(tax_zone: default_zone, tax_category: tax_category)
+    end
+
+    def foreign_vat(price_options)
+      included_tax_amount(price_options)
+    end
+
+    def amount_with_foreign_vat(amount, price_options)
+      amount * (1 + foreign_vat(price_options))
+    end
+
+    def outside_default_vat_zone?(price_options)
+      price_options[:tax_zone] && default_zone && price_options[:tax_zone] != default_zone
+    end
+
+    def included_tax_amount(price_options)
+      Spree::TaxRate.included_tax_amount_for(price_options).to_f
+    end
+
+    def default_zone
+      @_default_zone ||= Spree::Zone.default_tax
+    end
+
+    def round_to_two_places(amount)
+      BigDecimal.new(amount.to_s).round(2, BigDecimal::ROUND_HALF_UP)
+    end
+  end
+end

data/app/models/spree/ability.rb

@@ -60,7 +60,7 @@ module Spree
       end
 
       # Include any abilities registered by extensions, etc.
-      Ability.abilities.each do |clazz|
+      Ability.abilities.merge(abilities_to_register).each do |clazz|
         ability = clazz.send(:new, user)
         @rules = rules + ability.send(:rules)
       end
@@ -68,5 +68,13 @@ module Spree
       # Protect admin role
       cannot [:update, :destroy], Role, name: ['admin']
     end
+
+    private
+
+    # you can override this method to register your abilities
+    # this method has to return array of classes
+    def abilities_to_register
+      []
+    end
   end
 end

data/app/models/spree/address.rb

@@ -2,21 +2,32 @@ module Spree
   class Address < Spree::Base
     require 'twitter_cldr'
 
+    NO_ZIPCODE_ISO_CODES ||= [
+      'AO', 'AG', 'AW', 'BS', 'BZ', 'BJ', 'BM', 'BO', 'BW', 'BF', 'BI', 'CM', 'CF', 'KM', 'CG',
+      'CD', 'CK', 'CUW', 'CI', 'DJ', 'DM', 'GQ', 'ER', 'FJ', 'TF', 'GAB', 'GM', 'GH', 'GD', 'GN',
+      'GY', 'HK', 'IE', 'KI', 'KP', 'LY', 'MO', 'MW', 'ML', 'MR', 'NR', 'AN', 'NU', 'KP', 'PA',
+      'QA', 'RW', 'KN', 'LC', 'ST', 'SC', 'SL', 'SB', 'SO', 'SR', 'SY', 'TZ', 'TL', 'TK', 'TG',
+      'TO', 'TV', 'UG', 'AE', 'VU', 'YE', 'ZW'
+    ].freeze
+
     belongs_to :country, class_name: "Spree::Country"
     belongs_to :state, class_name: "Spree::State"
 
     has_many :shipments, inverse_of: :address
 
-    validates :firstname, :lastname, :address1, :city, :country, presence: true
-    validates :zipcode, presence: true, if: :require_zipcode?
-    validates :phone, presence: true, if: :require_phone?
+    before_validation :clear_invalid_state_entities, if: -> { country.present? }, on: :update
+
+    with_options presence: true do
+      validates :firstname, :lastname, :address1, :city, :country
+      validates :zipcode, if: :require_zipcode?
+      validates :phone, if: :require_phone?
+    end
 
     validate :state_validate, :postal_code_validate
 
     alias_attribute :first_name, :firstname
     alias_attribute :last_name, :lastname
 
-
     self.whitelisted_ransackable_attributes = %w[firstname lastname company]
 
     def self.build_default
@@ -25,7 +36,7 @@ module Spree
     end
 
     def self.default(user = nil, kind = "bill")
-      if user && user_address = user.send(:"#{kind}_address")
+      if user && user_address = user.public_send(:"#{kind}_address")
         user_address.clone
       else
         build_default
@@ -64,13 +75,13 @@ module Spree
       self_attrs = self.attributes
       other_attrs = other_address.respond_to?(:attributes) ? other_address.attributes : {}
 
-      [self_attrs, other_attrs].each { |attrs| attrs.except!('id', 'created_at', 'updated_at', 'order_id') }
+      [self_attrs, other_attrs].each { |attrs| attrs.except!('id', 'created_at', 'updated_at') }
 
       self_attrs == other_attrs
     end
 
     def empty?
-      attributes.except('id', 'created_at', 'updated_at', 'order_id', 'country_id').all? { |_, v| v.nil? }
+      attributes.except('id', 'created_at', 'updated_at', 'country_id').all? { |_, v| v.nil? }
     end
 
     # Generates an ActiveMerchant compatible address hash
@@ -92,53 +103,72 @@ module Spree
     end
 
     def require_zipcode?
-      true
+      country ? country.zipcode_required? : true
     end
 
     private
-      def state_validate
-        # Skip state validation without country (also required)
-        # or when disabled by preference
-        return if country.blank? || !Spree::Config[:address_requires_state]
-        return unless country.states_required
-
-        # ensure associated state belongs to country
-        if state.present?
-          if state.country == country
-            self.state_name = nil #not required as we have a valid state and country combo
-          else
-            if state_name.present?
-              self.state = nil
-            else
-              errors.add(:state, :invalid)
-            end
-          end
+
+    def clear_state_entities
+      clear_state
+      clear_state_name
+    end
+
+    def clear_state
+      self.state = nil
+    end
+
+    def clear_state_name
+      self.state_name = nil
+    end
+
+    def clear_invalid_state_entities
+      if state.present? && (state.country != country)
+        clear_state
+      elsif state_name.present? && !country.states_required? && country.states.empty?
+        clear_state_name
+      end
+    end
+
+    def state_validate
+      # Skip state validation without country (also required)
+      # or when disabled by preference
+      return if country.blank? || !Spree::Config[:address_requires_state]
+      return unless country.states_required
+      # ensure associated state belongs to country
+      if state.present?
+        if state.country == country
+          clear_state_name # not required as we have a valid state and country combo
+        elsif state_name.present?
+          clear_state
+        else
+          errors.add(:state, :invalid)
         end
+      end
+
+      # ensure state_name belongs to country without states, or that it matches a predefined state name/abbr
+      if state_name.present?
+        if country.states.present?
+          states = country.states.find_all_by_name_or_abbr(state_name)
 
-        # ensure state_name belongs to country without states, or that it matches a predefined state name/abbr
-        if state_name.present?
-          if country.states.present?
-            states = country.states.find_all_by_name_or_abbr(state_name)
-
-            if states.size == 1
-              self.state = states.first
-              self.state_name = nil
-            else
-              errors.add(:state, :invalid)
-            end
+          if states.size == 1
+            self.state = states.first
+            clear_state_name
+          else
+            errors.add(:state, :invalid)
           end
         end
-
-        # 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)
+      # 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.strip)
-      end
+      postal_code = TwitterCldr::Shared::PostalCodes.for_territory(country.iso)
+      errors.add(:zipcode, :invalid) if !postal_code.valid?(zipcode.to_s.strip)
+    end
   end
 end

data/app/models/spree/adjustable/adjuster/base.rb

@@ -0,0 +1,25 @@
+module Spree
+  module Adjustable
+    module Adjuster
+      class Base
+        def self.adjust(adjustable, totals)
+          new(adjustable, totals).update
+        end
+
+        def initialize(adjustable, totals)
+          @adjustable = adjustable
+          @totals = totals
+        end
+
+        def update
+          raise NotImplementedError, "Please implement 'update' in your adjuster: #{self.class.name}"
+        end
+
+        private
+
+        attr_reader :adjustable
+        delegate :adjustments, to: :adjustable
+      end
+    end
+  end
+end