goca-spree-core 3.1.14.rails.5.0

data/app/models/spree/tax_rate.rb

@@ -0,0 +1,110 @@
+module Spree
+  class TaxRate < Spree::Base
+    acts_as_paranoid
+
+    include Spree::CalculatedAdjustments
+    include Spree::AdjustmentSource
+
+    with_options inverse_of: :tax_rates do
+      belongs_to :zone, class_name: "Spree::Zone"
+      belongs_to :tax_category,
+                 class_name: "Spree::TaxCategory"
+    end
+
+    with_options presence: true do
+      validates :amount, numericality: { allow_nil: true }
+      validates :tax_category
+    end
+
+    scope :by_zone, -> (zone) { where(zone_id: zone.id) }
+    scope :potential_rates_for_zone,
+          -> (zone) do
+            where(zone_id: Spree::Zone.potential_matching_zones(zone).pluck(:id))
+          end
+    scope :for_default_zone,
+          -> { potential_rates_for_zone(Spree::Zone.default_tax) }
+    scope :for_tax_category,
+          -> (category) { where(tax_category_id: category.try(:id)) }
+    scope :included_in_price, -> { where(included_in_price: true) }
+
+    # Gets the array of TaxRates appropriate for the specified tax zone
+    def self.match(order_tax_zone)
+      return [] unless order_tax_zone
+      potential_rates_for_zone(order_tax_zone)
+    end
+
+    # Pre-tax amounts must be stored so that we can calculate
+    # correct rate amounts in the future. For example:
+    # https://github.com/spree/spree/issues/4318#issuecomment-34723428
+    def self.store_pre_tax_amount(item, rates)
+      pre_tax_amount = case item
+                       when Spree::LineItem then item.discounted_amount
+                       when Spree::Shipment then item.discounted_cost
+                       end
+
+      included_rates = rates.select(&:included_in_price)
+      if included_rates.any?
+        pre_tax_amount /= (1 + included_rates.map(&:amount).sum)
+      end
+
+      item.update_column(:pre_tax_amount, pre_tax_amount)
+    end
+
+    # Deletes all tax adjustments, then applies all applicable rates
+    # to relevant items.
+    def self.adjust(order, items)
+      rates = match(order.tax_zone)
+      tax_categories = rates.map(&:tax_category)
+
+      # using destroy_all to ensure adjustment destroy callback fires.
+      Spree::Adjustment.where(adjustable: items).tax.destroy_all
+
+      relevant_items = items.select do |item|
+        tax_categories.include?(item.tax_category)
+      end
+
+      relevant_items.each do |item|
+        relevant_rates = rates.select do |rate|
+          rate.tax_category == item.tax_category
+        end
+        store_pre_tax_amount(item, relevant_rates)
+        relevant_rates.each do |rate|
+          rate.adjust(order, item)
+        end
+      end
+    end
+
+    def self.included_tax_amount_for(options)
+      return 0 unless options[:tax_zone] && options[:tax_category]
+      potential_rates_for_zone(options[:tax_zone]).
+        included_in_price.
+        for_tax_category(options[:tax_category]).
+        pluck(:amount).sum
+    end
+
+    def adjust(order, item)
+      create_adjustment(order, item, included_in_price)
+    end
+
+    def compute_amount(item)
+      compute(item)
+    end
+
+    private
+
+    def label
+      Spree.t included_in_price? ? :including_tax : :excluding_tax,
+              scope: "adjustment_labels.tax_rates",
+              name: name.presence || tax_category.name,
+              amount: amount_for_label
+    end
+
+    def amount_for_label
+      return "" unless show_rate_in_label?
+      " " + ActiveSupport::NumberHelper::NumberToPercentageConverter.convert(
+        amount * 100,
+        locale: I18n.locale
+      )
+    end
+  end
+end

data/app/models/spree/taxon.rb

@@ -0,0 +1,102 @@
+# TODO let friendly id take care of sanitizing the url
+require 'stringex'
+
+module Spree
+  class Taxon < Spree::Base
+    extend FriendlyId
+    friendly_id :permalink, slug_column: :permalink, use: :slugged
+    before_create :set_permalink
+
+    acts_as_nested_set dependent: :destroy
+
+    belongs_to :taxonomy, class_name: 'Spree::Taxonomy', inverse_of: :taxons
+    has_many :classifications, -> { order(:position) }, dependent: :delete_all, inverse_of: :taxon
+    has_many :products, through: :classifications
+
+    has_many :prototype_taxons, class_name: 'Spree::PrototypeTaxon'
+    has_many :prototypes, through: :prototype_taxons, class_name: 'Spree::Prototype'
+
+    has_many :promotion_rule_taxons, class_name: 'Spree::PromotionRuleTaxon'
+    has_many :promotion_rules, through: :promotion_rule_taxons, class_name: 'Spree::PromotionRule'
+
+    validates :name, presence: true
+    with_options length: { maximum: 255 }, allow_blank: true do
+      validates :meta_keywords
+      validates :meta_description
+      validates :meta_title
+    end
+
+    after_save :touch_ancestors_and_taxonomy
+    after_touch :touch_ancestors_and_taxonomy
+
+    has_attached_file :icon,
+      styles: { mini: '32x32>', normal: '128x128>' },
+      default_style: :mini,
+      url: '/spree/taxons/:id/:style/:basename.:extension',
+      path: ':rails_root/public/spree/taxons/:id/:style/:basename.:extension',
+      default_url: '/assets/default_taxon.png'
+
+    validates_attachment :icon,
+      content_type: { content_type: ["image/jpg", "image/jpeg", "image/png", "image/gif"] }
+
+    # indicate which filters should be used for a taxon
+    # this method should be customized to your own site
+    def applicable_filters
+      fs = []
+      # fs << ProductFilters.taxons_below(self)
+      ## unless it's a root taxon? left open for demo purposes
+
+      fs << Spree::Core::ProductFilters.price_filter if Spree::Core::ProductFilters.respond_to?(:price_filter)
+      fs << Spree::Core::ProductFilters.brand_filter if Spree::Core::ProductFilters.respond_to?(:brand_filter)
+      fs
+    end
+
+    # Return meta_title if set otherwise generates from root name and/or taxon name
+    def seo_title
+      unless meta_title.blank?
+        meta_title
+      else
+        root? ? name : "#{root.name} - #{name}"
+      end
+    end
+
+    # Creates permalink base for friendly_id
+    def set_permalink
+      if parent.present?
+        self.permalink = [parent.permalink, (permalink.blank? ? name.to_url : permalink.split('/').last)].join('/')
+      else
+        self.permalink = name.to_url if permalink.blank?
+      end
+    end
+
+    def active_products
+      products.active
+    end
+
+    def pretty_name
+      ancestor_chain = self.ancestors.inject("") do |name, ancestor|
+        name += "#{ancestor.name} -> "
+      end
+      ancestor_chain + "#{name}"
+    end
+
+    # awesome_nested_set sorts by :lft and :rgt. This call re-inserts the child
+    # node so that its resulting position matches the observable 0-indexed position.
+    # ** Note ** no :position column needed - a_n_s doesn't handle the reordering if
+    #  you bring your own :order_column.
+    #
+    #  See #3390 for background.
+    def child_index=(idx)
+      move_to_child_with_index(parent, idx.to_i) unless self.new_record?
+    end
+
+    private
+
+    def touch_ancestors_and_taxonomy
+      # Touches all ancestors at once to avoid recursive taxonomy touch, and reduce queries.
+      ancestors.update_all(updated_at: Time.current)
+      # Have taxonomy touch happen in #touch_ancestors_and_taxonomy rather than association option in order for imports to override.
+      taxonomy.try!(:touch)
+    end
+  end
+end

data/app/models/spree/taxonomy.rb

@@ -0,0 +1,24 @@
+module Spree
+  class Taxonomy < Spree::Base
+    acts_as_list
+
+    validates :name, presence: true
+
+    has_many :taxons, inverse_of: :taxonomy
+    has_one :root, -> { where parent_id: nil }, class_name: "Spree::Taxon", dependent: :destroy
+
+    after_create :set_root
+    after_save :set_root_taxon_name
+
+    default_scope { order("#{self.table_name}.position, #{self.table_name}.created_at") }
+
+    private
+      def set_root
+        self.root ||= Taxon.create!(taxonomy_id: id, name: name)
+      end
+
+      def set_root_taxon_name
+        root.update_attributes(name: name)
+      end
+  end
+end

data/app/models/spree/tracker.rb

@@ -0,0 +1,19 @@
+module Spree
+  class Tracker < Spree::Base
+    after_commit :clear_cache
+
+    validates :analytics_id, presence: true, uniqueness: { allow_blank: true }
+
+    def self.current
+      tracker = Rails.cache.fetch("current_tracker") do
+        where(active: true).first
+      end
+      tracker.analytics_id.present? ? tracker : nil if tracker
+    end
+
+
+    def clear_cache
+      Rails.cache.delete("current_tracker")
+    end
+  end
+end

data/app/models/spree/validations/db_maximum_length_validator.rb

@@ -0,0 +1,23 @@
+module Spree
+  module Validations
+    ##
+    # Validates a field based on the maximum length of the underlying DB field, if there is one.
+    class DbMaximumLengthValidator < ActiveModel::Validator
+
+      def initialize(options)
+        super
+        @field = options[:field].to_s
+        raise ArgumentError.new("a field must be specified to the validator") if @field.blank?
+      end
+
+      def validate(record)
+        warn "`Spree::Validations::DbMaximumLengthValidator` is deprecated. Use `DbMaximumLengthValidator` instead."
+        limit = record.class.columns_hash[@field].limit
+        value = record[@field.to_sym]
+        if value && limit && value.to_s.length > limit
+          record.errors.add(@field.to_sym, :too_long, count: limit)
+        end
+      end
+    end
+  end
+end

data/app/models/spree/variant.rb

@@ -0,0 +1,312 @@
+module Spree
+  class Variant < Spree::Base
+    acts_as_paranoid
+    acts_as_list scope: :product
+
+    include Spree::DefaultPrice
+
+    belongs_to :product, touch: true, class_name: 'Spree::Product', inverse_of: :variants
+    belongs_to :tax_category, class_name: 'Spree::TaxCategory'
+
+    delegate_belongs_to :product, :name, :description, :slug, :available_on,
+                        :shipping_category_id, :meta_description, :meta_keywords,
+                        :shipping_category
+
+    # we need to have this callback before any dependent: :destroy associations
+    # https://github.com/rails/rails/issues/3458
+    before_destroy :ensure_no_line_items
+
+    with_options inverse_of: :variant do
+      has_many :inventory_units
+      has_many :line_items
+      has_many :stock_items, dependent: :destroy
+    end
+
+    has_many :orders, through: :line_items
+    with_options through: :stock_items do
+      has_many :stock_locations
+      has_many :stock_movements
+    end
+
+    has_many :option_value_variants, class_name: 'Spree::OptionValueVariant'
+    has_many :option_values, through: :option_value_variants, class_name: 'Spree::OptionValue'
+
+    has_many :images, -> { order(:position) }, as: :viewable, dependent: :destroy, class_name: "Spree::Image"
+
+    has_many :prices,
+      class_name: 'Spree::Price',
+      dependent: :destroy,
+      inverse_of: :variant
+
+    before_validation :set_cost_currency
+
+    validate :check_price
+
+    validates :option_values, presence: true, unless: :is_master?
+
+    with_options numericality: { greater_than_or_equal_to: 0, allow_nil: true } do
+      validates :cost_price
+      validates :price
+    end
+    validates :sku, uniqueness: { conditions: -> { where(deleted_at: nil) } }, allow_blank: true
+
+    after_create :create_stock_items
+    after_create :set_master_out_of_stock, unless: :is_master?
+
+    after_touch :clear_in_stock_cache
+
+    scope :in_stock, -> { joins(:stock_items).where('count_on_hand > ? OR track_inventory = ?', 0, false) }
+
+    scope :not_discontinued, -> do
+      variant_table_name = Variant.quoted_table_name
+      where("#{variant_table_name}.discontinue_on IS NULL OR #{variant_table_name}.discontinue_on >= ?", Time.current)
+    end
+
+    scope :not_deleted, -> { where("#{Variant.quoted_table_name}.deleted_at IS NULL") }
+
+    scope :for_currency_and_available_price_amount, -> (currency) do
+      currency ||= Spree::Config[:currency]
+      joins(:prices).where("spree_prices.currency = ?", currency).where("spree_prices.amount IS NOT NULL").uniq
+    end
+
+    scope :active, -> (currency = nil) do
+      not_discontinued.not_deleted.
+        for_currency_and_available_price_amount(currency)
+    end
+
+    LOCALIZED_NUMBERS = %w(cost_price weight depth width height)
+
+    LOCALIZED_NUMBERS.each do |m|
+      define_method("#{m}=") do |argument|
+        self[m] = Spree::LocalizedNumber.parse(argument) if argument.present?
+      end
+    end
+
+    self.whitelisted_ransackable_associations = %w[option_values product prices default_price]
+    self.whitelisted_ransackable_attributes = %w[weight sku]
+
+    def available?
+      !discontinued? && product.available?
+    end
+
+    def self.having_orders
+      joins(:line_items).distinct
+    end
+
+    def tax_category
+      if self[:tax_category_id].nil?
+        product.tax_category
+      else
+        TaxCategory.find(self[:tax_category_id])
+      end
+    end
+
+    # returns number of units currently on backorder for this variant.
+    def on_backorder
+      inventory_units.with_state('backordered').size
+    end
+
+    def options_text
+      values = self.option_values.sort do |a, b|
+        a.option_type.position <=> b.option_type.position
+      end
+
+      values.to_a.map! do |ov|
+        "#{ov.option_type.presentation}: #{ov.presentation}"
+      end
+
+      values.to_sentence({ words_connector: ", ", two_words_connector: ", " })
+    end
+
+    # Default to master name
+    def exchange_name
+      is_master? ? name : options_text
+    end
+
+    def descriptive_name
+      is_master? ? name + ' - Master' : name + ' - ' + options_text
+    end
+
+    # use deleted? rather than checking the attribute directly. this
+    # allows extensions to override deleted? if they want to provide
+    # their own definition.
+    def deleted?
+      !!deleted_at
+    end
+
+    # Product may be created with deleted_at already set,
+    # which would make AR's default finder return nil.
+    # This is a stopgap for that little problem.
+    def product
+      Spree::Product.unscoped { super }
+    end
+
+    def options=(options = {})
+      options.each do |option|
+        set_option_value(option[:name], option[:value])
+      end
+    end
+
+    def set_option_value(opt_name, opt_value)
+      # no option values on master
+      return if self.is_master
+
+      option_type = Spree::OptionType.where(name: opt_name).first_or_initialize do |o|
+        o.presentation = opt_name
+        o.save!
+      end
+
+      current_value = self.option_values.detect { |o| o.option_type.name == opt_name }
+
+      unless current_value.nil?
+        return if current_value.name == opt_value
+        self.option_values.delete(current_value)
+      else
+        # then we have to check to make sure that the product has the option type
+        unless self.product.option_types.include? option_type
+          self.product.option_types << option_type
+        end
+      end
+
+      option_value = Spree::OptionValue.where(option_type_id: option_type.id, name: opt_value).first_or_initialize do |o|
+        o.presentation = opt_value
+        o.save!
+      end
+
+      self.option_values << option_value
+      self.save
+    end
+
+    def option_value(opt_name)
+      self.option_values.detect { |o| o.option_type.name == opt_name }.try(:presentation)
+    end
+
+    def price_in(currency)
+      prices.detect { |price| price.currency == currency } || prices.build(currency: currency)
+    end
+
+    def amount_in(currency)
+      price_in(currency).try(:amount)
+    end
+
+    def price_modifier_amount_in(currency, options = {})
+      return 0 unless options.present?
+
+      options.keys.map { |key|
+        m = "#{key}_price_modifier_amount_in".to_sym
+        if self.respond_to? m
+          self.send(m, currency, options[key])
+        else
+          0
+        end
+      }.sum
+    end
+
+    def price_modifier_amount(options = {})
+      return 0 unless options.present?
+
+      options.keys.map { |key|
+        m = "#{key}_price_modifier_amount".to_sym
+        if self.respond_to? m
+          self.send(m, options[key])
+        else
+          0
+        end
+      }.sum
+    end
+
+    def name_and_sku
+      "#{name} - #{sku}"
+    end
+
+    def sku_and_options_text
+      "#{sku} #{options_text}".strip
+    end
+
+    def in_stock?
+      Rails.cache.fetch(in_stock_cache_key) do
+        total_on_hand > 0
+      end
+    end
+
+    delegate :total_on_hand, :can_supply?, :backorderable?, to: :quantifier
+
+    alias is_backorderable? backorderable?
+
+    # Shortcut method to determine if inventory tracking is enabled for this variant
+    # This considers both variant tracking flag and site-wide inventory tracking settings
+    def should_track_inventory?
+      self.track_inventory? && Spree::Config.track_inventory_levels
+    end
+
+    def track_inventory
+      self.should_track_inventory?
+    end
+
+    def volume
+      (width || 0) * (height || 0) * (depth || 0)
+    end
+
+    def dimension
+      (width || 0) + (height || 0) + (depth || 0)
+    end
+
+    def discontinue!
+      update_attribute(:discontinue_on, Time.current)
+    end
+
+    def discontinued?
+      !!discontinue_on && discontinue_on <= Time.current
+    end
+
+    private
+
+    def ensure_no_line_items
+      if line_items.any?
+        errors.add(:base, Spree.t(:cannot_destroy_if_attached_to_line_items))
+        return false
+      end
+    end
+
+    def quantifier
+      Spree::Stock::Quantifier.new(self)
+    end
+
+    def set_master_out_of_stock
+      if product.master && product.master.in_stock?
+        product.master.stock_items.update_all(backorderable: false)
+        product.master.stock_items.each(&:reduce_count_on_hand_to_zero)
+      end
+    end
+
+    # Ensures a new variant takes the product master price when price is not supplied
+    def check_price
+      if price.nil? && Spree::Config[:require_master_price]
+        raise 'No master variant found to infer price' unless product && product.master
+        raise 'Must supply price for variant or master.price for product.' if self == product.master
+        self.price = product.master.price
+      end
+      if price.present? && currency.nil?
+        self.currency = Spree::Config[:currency]
+      end
+    end
+
+    def set_cost_currency
+      self.cost_currency = Spree::Config[:currency] if cost_currency.blank?
+    end
+
+    def create_stock_items
+      StockLocation.where(propagate_all_variants: true).each do |stock_location|
+        stock_location.propagate_variant(self)
+      end
+    end
+
+    def in_stock_cache_key
+      "variant-#{id}-in_stock"
+    end
+
+    def clear_in_stock_cache
+      Rails.cache.delete(in_stock_cache_key)
+    end
+  end
+end