goca-spree-core 3.1.14.rails.5.0

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

@@ -0,0 +1,271 @@
+module Spree
+  class Product < Spree::Base
+    cattr_accessor :search_scopes do
+      []
+    end
+
+    def self.add_search_scope(name, &block)
+      self.singleton_class.send(:define_method, name.to_sym, &block)
+      search_scopes << name.to_sym
+    end
+
+    def self.simple_scopes
+      [
+        :ascend_by_updated_at,
+        :descend_by_updated_at,
+        :ascend_by_name,
+        :descend_by_name
+      ]
+    end
+
+    def self.add_simple_scopes(scopes)
+      scopes.each do |name|
+        # We should not define price scopes here, as they require something slightly different
+        next if name.to_s.include?("master_price")
+        parts = name.to_s.match(/(.*)_by_(.*)/)
+        self.scope(name.to_s, -> { order("#{Product.quoted_table_name}.#{parts[2]} #{parts[1] == 'ascend' ?  "ASC" : "DESC"}") })
+      end
+    end
+
+    def self.property_conditions(property)
+      properties = Property.table_name
+      conditions = case property
+      when String   then { "#{properties}.name" => property }
+      when Property then { "#{properties}.id" => property.id }
+      else               { "#{properties}.id" => property.to_i }
+      end
+    end
+
+    add_simple_scopes simple_scopes
+
+    add_search_scope :ascend_by_master_price do
+      joins(:master => :default_price).order("#{price_table_name}.amount ASC")
+    end
+
+    add_search_scope :descend_by_master_price do
+      joins(:master => :default_price).order("#{price_table_name}.amount DESC")
+    end
+
+    add_search_scope :price_between do |low, high|
+      joins(:master => :default_price).where(Price.table_name => { :amount => low..high })
+    end
+
+    add_search_scope :master_price_lte do |price|
+      joins(:master => :default_price).where("#{price_table_name}.amount <= ?", price)
+    end
+
+    add_search_scope :master_price_gte do |price|
+      joins(:master => :default_price).where("#{price_table_name}.amount >= ?", price)
+    end
+
+    # This scope selects products in taxon AND all its descendants
+    # If you need products only within one taxon use
+    #
+    #   Spree::Product.joins(:taxons).where(Taxon.table_name => { :id => taxon.id })
+    #
+    # If you're using count on the result of this scope, you must use the
+    # `:distinct` option as well:
+    #
+    #   Spree::Product.in_taxon(taxon).count(:distinct => true)
+    #
+    # This is so that the count query is distinct'd:
+    #
+    #   SELECT COUNT(DISTINCT "spree_products"."id") ...
+    #
+    #   vs.
+    #
+    #   SELECT COUNT(*) ...
+    add_search_scope :in_taxon do |taxon|
+      includes(:classifications).
+      where("spree_products_taxons.taxon_id" => taxon.self_and_descendants.pluck(:id)).
+      order("spree_products_taxons.position ASC")
+    end
+
+    # This scope selects products in all taxons AND all its descendants
+    # If you need products only within one taxon use
+    #
+    #   Spree::Product.taxons_id_eq([x,y])
+    add_search_scope :in_taxons do |*taxons|
+      taxons = get_taxons(taxons)
+      taxons.first ? prepare_taxon_conditions(taxons) : where(nil)
+    end
+
+    # a scope that finds all products having property specified by name, object or id
+    add_search_scope :with_property do |property|
+      joins(:properties).where(property_conditions(property))
+    end
+
+    # a simple test for product with a certain property-value pairing
+    # note that it can test for properties with NULL values, but not for absent values
+    add_search_scope :with_property_value do |property, value|
+      joins(:properties)
+        .where("#{ProductProperty.table_name}.value = ?", value)
+        .where(property_conditions(property))
+    end
+
+    add_search_scope :with_option do |option|
+      option_types = OptionType.table_name
+      conditions = case option
+      when String     then { "#{option_types}.name" => option }
+      when OptionType then { "#{option_types}.id" => option.id }
+      else                 { "#{option_types}.id" => option.to_i }
+      end
+
+      joins(:option_types).where(conditions)
+    end
+
+    add_search_scope :with_option_value do |option, value|
+      option_values = OptionValue.table_name
+      option_type_id = case option
+        when String then OptionType.find_by(name: option) || option.to_i
+        when OptionType then option.id
+        else option.to_i
+      end
+
+      conditions = "#{option_values}.name = ? AND #{option_values}.option_type_id = ?", value, option_type_id
+      group('spree_products.id').joins(variants_including_master: :option_values).where(conditions)
+    end
+
+    # Finds all products which have either:
+    # 1) have an option value with the name matching the one given
+    # 2) have a product property with a value matching the one given
+    add_search_scope :with do |value|
+      includes(variants_including_master: :option_values).
+      includes(:product_properties).
+      where("#{OptionValue.table_name}.name = ? OR #{ProductProperty.table_name}.value = ?", value, value)
+    end
+
+    # Finds all products that have a name containing the given words.
+    add_search_scope :in_name do |words|
+      like_any([:name], prepare_words(words))
+    end
+
+    # Finds all products that have a name or meta_keywords containing the given words.
+    add_search_scope :in_name_or_keywords do |words|
+      like_any([:name, :meta_keywords], prepare_words(words))
+    end
+
+    # Finds all products that have a name, description, meta_description or meta_keywords containing the given keywords.
+    add_search_scope :in_name_or_description do |words|
+      like_any([:name, :description, :meta_description, :meta_keywords], prepare_words(words))
+    end
+
+    # Finds all products that have the ids matching the given collection of ids.
+    # Alternatively, you could use find(collection_of_ids), but that would raise an exception if one product couldn't be found
+    add_search_scope :with_ids do |*ids|
+      where(id: ids)
+    end
+
+    # Sorts products from most popular (popularity is extracted from how many
+    # times use has put product in cart, not completed orders)
+    #
+    # there is alternative faster and more elegant solution, it has small drawback though,
+    # it doesn stack with other scopes :/
+    #
+    # :joins => "LEFT OUTER JOIN (SELECT line_items.variant_id as vid, COUNT(*) as cnt FROM line_items GROUP BY line_items.variant_id) AS popularity_count ON variants.id = vid",
+    # :order => 'COALESCE(cnt, 0) DESC'
+    add_search_scope :descend_by_popularity do
+      joins(:master).
+      order(%Q{
+           COALESCE((
+             SELECT
+               COUNT(#{LineItem.quoted_table_name}.id)
+             FROM
+               #{LineItem.quoted_table_name}
+             JOIN
+               #{Variant.quoted_table_name} AS popular_variants
+             ON
+               popular_variants.id = #{LineItem.quoted_table_name}.variant_id
+             WHERE
+               popular_variants.product_id = #{Product.quoted_table_name}.id
+           ), 0) DESC
+        })
+    end
+
+    add_search_scope :not_deleted do
+      where("#{Product.quoted_table_name}.deleted_at IS NULL or #{Product.quoted_table_name}.deleted_at >= ?", Time.zone.now)
+    end
+
+    def self.not_discontinued(only_not_discontinued = true)
+      if only_not_discontinued != '0' && only_not_discontinued
+        where("#{Product.quoted_table_name}.discontinue_on IS NULL or #{Product.quoted_table_name}.discontinue_on >= ?", Time.zone.now)
+      else
+        all
+      end
+    end
+    search_scopes << :not_discontinued
+    # Can't use add_search_scope for this as it needs a default argument
+    def self.available(available_on = nil, currency = nil)
+      available_on ||= Time.current
+      not_discontinued.joins(master: :prices).where("#{Product.quoted_table_name}.available_on <= ?", available_on).uniq
+    end
+    search_scopes << :available
+
+    def self.active(currency = nil)
+      not_discontinued.available(nil, currency)
+    end
+    search_scopes << :active
+
+    add_search_scope :taxons_name_eq do |name|
+      group("spree_products.id").joins(:taxons).where(Taxon.arel_table[:name].eq(name))
+    end
+
+    def self.distinct_by_product_ids(sort_order = nil)
+      sort_column = sort_order.split(" ").first
+
+      # Postgres will complain when using ordering by expressions not present in
+      # SELECT DISTINCT. e.g.
+      #
+      #   PG::InvalidColumnReference: ERROR:  for SELECT DISTINCT, ORDER BY
+      #   expressions must appear in select list. e.g.
+      #
+      #   SELECT  DISTINCT "spree_products".* FROM "spree_products" LEFT OUTER JOIN
+      #   "spree_variants" ON "spree_variants"."product_id" = "spree_products"."id" AND "spree_variants"."is_master" = 't'
+      #   AND "spree_variants"."deleted_at" IS NULL LEFT OUTER JOIN "spree_prices" ON
+      #   "spree_prices"."variant_id" = "spree_variants"."id" AND "spree_prices"."currency" = 'USD'
+      #   AND "spree_prices"."deleted_at" IS NULL WHERE "spree_products"."deleted_at" IS NULL AND ('t'='t')
+      #   ORDER BY "spree_prices"."amount" ASC LIMIT 10 OFFSET 0
+      #
+      # Don't allow sort_column, a variable coming from params,
+      # to be anything but a column in the database
+      if ActiveRecord::Base.connection.adapter_name == 'PostgreSQL' && !column_names.include?(sort_column)
+        all
+      else
+        distinct
+      end
+    end
+
+    private
+
+      def self.price_table_name
+        Price.quoted_table_name
+      end
+
+      # specifically avoid having an order for taxon search (conflicts with main order)
+      def self.prepare_taxon_conditions(taxons)
+        ids = taxons.map { |taxon| taxon.self_and_descendants.pluck(:id) }.flatten.uniq
+        joins(:taxons).where("#{Taxon.table_name}.id" => ids)
+      end
+
+      # Produce an array of keywords for use in scopes.
+      # Always return array with at least an empty string to avoid SQL errors
+      def self.prepare_words(words)
+        return [''] if words.blank?
+        a = words.split(/[,\s]/).map(&:strip)
+        a.any? ? a : ['']
+      end
+
+      def self.get_taxons(*ids_or_records_or_names)
+        taxons = Taxon.table_name
+        ids_or_records_or_names.flatten.map { |t|
+          case t
+          when Integer then Taxon.find_by(id: t)
+          when ActiveRecord::Base then t
+          when String
+            Taxon.find_by(name: t) ||
+            Taxon.where("#{taxons}.permalink LIKE ? OR #{taxons}.permalink = ?", "%/#{t}/", "#{t}/").first
+          end
+        }.compact.flatten.uniq
+      end
+    end
+end

data/app/models/spree/product.rb

@@ -0,0 +1,384 @@
+# PRODUCTS
+# Products represent an entity for sale in a store.
+# Products can have variations, called variants
+# Products properties include description, permalink, availability,
+#   shipping category, etc. that do not change by variant.
+#
+# MASTER VARIANT
+# Every product has one master variant, which stores master price and sku, size and weight, etc.
+# The master variant does not have option values associated with it.
+# Price, SKU, size, weight, etc. are all delegated to the master variant.
+# Contains on_hand inventory levels only when there are no variants for the product.
+#
+# VARIANTS
+# All variants can access the product properties directly (via reverse delegation).
+# Inventory units are tied to Variant.
+# The master variant can have inventory units, but not option values.
+# All other variants have option values and may have inventory units.
+# Sum of on_hand each variant's inventory level determine "on_hand" level for the product.
+#
+
+module Spree
+  class Product < Spree::Base
+    extend FriendlyId
+    friendly_id :slug_candidates, use: :history
+
+    acts_as_paranoid
+
+    # we need to have this callback before any dependent: :destroy associations
+    # https://github.com/rails/rails/issues/3458
+    before_destroy :ensure_no_line_items
+
+    has_many :product_option_types, dependent: :destroy, inverse_of: :product
+    has_many :option_types, through: :product_option_types
+    has_many :product_properties, dependent: :destroy, inverse_of: :product
+    has_many :properties, through: :product_properties
+
+    has_many :classifications, dependent: :delete_all, inverse_of: :product
+    has_many :taxons, through: :classifications, before_remove: :remove_taxon
+
+    has_many :product_promotion_rules, class_name: 'Spree::ProductPromotionRule'
+    has_many :promotion_rules, through: :product_promotion_rules, class_name: 'Spree::PromotionRule'
+
+    has_many :promotions, through: :promotion_rules, class_name: 'Spree::Promotion'
+
+    has_many :possible_promotions, -> { advertised.active }, through: :promotion_rules,
+                                                             class_name: 'Spree::Promotion',
+                                                             source: :promotion
+
+    belongs_to :tax_category, class_name: 'Spree::TaxCategory'
+    belongs_to :shipping_category, class_name: 'Spree::ShippingCategory', inverse_of: :products
+
+    has_one :master,
+      -> { where is_master: true },
+      inverse_of: :product,
+      class_name: 'Spree::Variant'
+
+    has_many :variants,
+      -> { where(is_master: false).order(:position) },
+      inverse_of: :product,
+      class_name: 'Spree::Variant'
+
+    has_many :variants_including_master,
+      -> { order(:position) },
+      inverse_of: :product,
+      class_name: 'Spree::Variant',
+      dependent: :destroy
+
+    has_many :prices, -> { order('spree_variants.position, spree_variants.id, currency') }, through: :variants
+
+    has_many :stock_items, through: :variants_including_master
+
+    has_many :line_items, through: :variants_including_master
+    has_many :orders, through: :line_items
+
+    delegate_belongs_to :master, :sku, :price, :currency, :display_amount, :display_price, :weight, :height, :width, :depth,
+                        :is_master, :has_default_price?, :cost_currency, :price_in, :amount_in, :cost_price, :images
+
+    alias_method :master_images, :images
+
+    has_many :variant_images, -> { order(:position) }, source: :images, through: :variants_including_master
+
+    after_create :add_associations_from_prototype
+    after_create :build_variants_from_option_values_hash, if: :option_values_hash
+
+    after_destroy :punch_slug
+    after_restore :update_slug_history
+
+    after_initialize :ensure_master
+
+    after_save :save_master
+    after_save :run_touch_callbacks, if: :anything_changed?
+    after_save :reset_nested_changes
+    after_touch :touch_taxons
+
+    before_validation :normalize_slug, on: :update
+    before_validation :validate_master
+
+    with_options length: { maximum: 255 }, allow_blank: true do
+      validates :meta_keywords
+      validates :meta_title
+    end
+    with_options presence: true do
+      validates :name, :shipping_category
+      validates :price, if: proc { Spree::Config[:require_master_price] }
+    end
+
+    validates :slug, length: { minimum: 3 }, allow_blank: true, uniqueness: true
+    validate :discontinue_on_must_be_later_than_available_on, if: -> { available_on && discontinue_on }
+
+    attr_accessor :option_values_hash
+
+    accepts_nested_attributes_for :product_properties, allow_destroy: true, reject_if: lambda { |pp| pp[:property_name].blank? }
+
+    alias :options :product_option_types
+
+    self.whitelisted_ransackable_associations = %w[stores variants_including_master master variants]
+    self.whitelisted_ransackable_attributes = %w[description name slug discontinue_on]
+    self.whitelisted_ransackable_scopes = %w[not_discontinued]
+
+    # the master variant is not a member of the variants array
+    def has_variants?
+      variants.any?
+    end
+
+    def tax_category
+      super || TaxCategory.find_by(is_default: true)
+    end
+
+    # Adding properties and option types on creation based on a chosen prototype
+    attr_reader :prototype_id
+    def prototype_id=(value)
+      @prototype_id = value.to_i
+    end
+
+    # Ensures option_types and product_option_types exist for keys in option_values_hash
+    def ensure_option_types_exist_for_values_hash
+      return if option_values_hash.nil?
+      required_option_type_ids = option_values_hash.keys.map(&:to_i)
+      missing_option_type_ids = required_option_type_ids - option_type_ids
+      missing_option_type_ids.each do |id|
+        product_option_types.create(option_type_id: id)
+      end
+    end
+
+    # for adding products which are closely related to existing ones
+    # define "duplicate_extra" for site-specific actions, eg for additional fields
+    def duplicate
+      duplicator = ProductDuplicator.new(self)
+      duplicator.duplicate
+    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
+
+    # determine if product is available.
+    # deleted products and products with nil or future available_on date
+    # are not available
+    def available?
+      !(available_on.nil? || available_on.future?) && !deleted? && !discontinued?
+    end
+
+    def discontinue!
+      update_attribute(:discontinue_on, Time.current)
+    end
+
+    def discontinued?
+      !!discontinue_on && discontinue_on <= Time.current
+    end
+
+    # determine if any variant (including master) can be supplied
+    def can_supply?
+      variants_including_master.any?(&:can_supply?)
+    end
+
+    # split variants list into hash which shows mapping of opt value onto matching variants
+    # eg categorise_variants_from_option(color) => {"red" -> [...], "blue" -> [...]}
+    def categorise_variants_from_option(opt_type)
+      return {} unless option_types.include?(opt_type)
+      variants.active.group_by { |v| v.option_values.detect { |o| o.option_type == opt_type} }
+    end
+
+    def self.like_any(fields, values)
+      conditions = fields.product(values).map do |(field, value)|
+        arel_table[field].matches("%#{value}%")
+      end
+      where conditions.inject(:or)
+    end
+
+    # Suitable for displaying only variants that has at least one option value.
+    # There may be scenarios where an option type is removed and along with it
+    # all option values. At that point all variants associated with only those
+    # values should not be displayed to frontend users. Otherwise it breaks the
+    # idea of having variants
+    def variants_and_option_values(current_currency = nil)
+      variants.includes(:option_values).active(current_currency).select do |variant|
+        variant.option_values.any?
+      end
+    end
+
+    def empty_option_values?
+      options.empty? || options.any? do |opt|
+        opt.option_type.option_values.empty?
+      end
+    end
+
+    def property(property_name)
+      product_properties.joins(:property).find_by(spree_properties: { name: property_name }).try(:value)
+    end
+
+    def set_property(property_name, property_value, property_presentation = property_name)
+      ActiveRecord::Base.transaction do
+        # Works around spree_i18n #301
+        property = Property.create_with(presentation: property_presentation).find_or_create_by(name: property_name)
+        product_property = ProductProperty.where(product: self, property: property).first_or_initialize
+        product_property.value = property_value
+        product_property.save!
+      end
+    end
+
+    def total_on_hand
+      if any_variants_not_track_inventory?
+        Float::INFINITY
+      else
+        stock_items.sum(:count_on_hand)
+      end
+    end
+
+    # Master variant may be deleted (i.e. when the product is deleted)
+    # which would make AR's default finder return nil.
+    # This is a stopgap for that little problem.
+    def master
+      super || variants_including_master.with_deleted.find_by(is_master: true)
+    end
+
+    private
+
+    def add_associations_from_prototype
+      if prototype_id && prototype = Spree::Prototype.find_by(id: prototype_id)
+        prototype.properties.each do |property|
+          product_properties.create(property: property)
+        end
+        self.option_types = prototype.option_types
+        self.taxons = prototype.taxons
+      end
+    end
+
+    def any_variants_not_track_inventory?
+      return true unless Spree::Config.track_inventory_levels
+      if variants_including_master.loaded?
+        variants_including_master.any? { |v| !v.track_inventory? }
+      else
+        variants_including_master.where(track_inventory: false).exists?
+      end
+    end
+
+    # Builds variants from a hash of option types & values
+    def build_variants_from_option_values_hash
+      ensure_option_types_exist_for_values_hash
+      values = option_values_hash.values
+      values = values.inject(values.shift) { |memo, value| memo.product(value).map(&:flatten) }
+
+      values.each do |ids|
+        variants.create(
+          option_value_ids: ids,
+          price: master.price
+        )
+      end
+      save
+    end
+
+    def ensure_master
+      return unless new_record?
+      self.master ||= build_master
+    end
+
+    def normalize_slug
+      self.slug = normalize_friendly_id(slug)
+    end
+
+    def punch_slug
+      # punch slug with date prefix to allow reuse of original
+      update_column :slug, "#{Time.current.to_i}_#{slug}"[0..254] unless frozen?
+    end
+
+    def update_slug_history
+      self.save!
+    end
+
+    def anything_changed?
+      changed? || @nested_changes
+    end
+
+    def reset_nested_changes
+      @nested_changes = false
+    end
+
+    def master_updated?
+      master && (
+        master.new_record? ||
+        master.changed? ||
+        (
+          master.default_price &&
+          (
+            master.default_price.new_record? ||
+            master.default_price.changed?
+          )
+        )
+      )
+    end
+
+    # there's a weird quirk with the delegate stuff that does not automatically save the delegate object
+    # when saving so we force a save using a hook
+    # Fix for issue #5306
+    def save_master
+      if master_updated?
+        master.save!
+        @nested_changes = true
+      end
+    end
+
+    # If the master cannot be saved, the Product object will get its errors
+    # and will be destroyed
+    def validate_master
+      # We call master.default_price here to ensure price is initialized.
+      # Required to avoid Variant#check_price validation failing on create.
+      unless master.default_price && master.valid?
+        master.errors.each do |att, error|
+          self.errors.add(att, error)
+        end
+      end
+    end
+
+    # Try building a slug based on the following fields in increasing order of specificity.
+    def slug_candidates
+      [
+        :name,
+        [:name, :sku]
+      ]
+    end
+
+    def run_touch_callbacks
+      run_callbacks(:touch)
+    end
+
+    def taxon_and_ancestors
+      taxons.map(&:self_and_ancestors).flatten.uniq
+    end
+
+    # Get the taxonomy ids of all taxons assigned to this product and their ancestors.
+    def taxonomy_ids
+      taxon_and_ancestors.map(&:taxonomy_id).flatten.uniq
+    end
+
+    # Iterate through this products taxons and taxonomies and touch their timestamps in a batch
+    def touch_taxons
+      Spree::Taxon.where(id: taxon_and_ancestors.map(&:id)).update_all(updated_at: Time.current)
+      Spree::Taxonomy.where(id: taxonomy_ids).update_all(updated_at: Time.current)
+    end
+
+    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 remove_taxon(taxon)
+      removed_classifications = classifications.where(taxon: taxon)
+      removed_classifications.each &:remove_from_list
+    end
+
+    def discontinue_on_must_be_later_than_available_on
+      if discontinue_on < available_on
+        errors.add(:discontinue_on, :invalid_date_range)
+      end
+    end
+  end
+end
+
+require_dependency 'spree/product/scopes'

data/app/models/spree/product_option_type.rb

@@ -0,0 +1,12 @@
+module Spree
+  class ProductOptionType < Spree::Base
+    with_options inverse_of: :product_option_types do
+      belongs_to :product, class_name: 'Spree::Product'
+      belongs_to :option_type, class_name: 'Spree::OptionType'
+    end
+    acts_as_list scope: :product
+
+    validates :product, :option_type, presence: true
+    validates :product_id, uniqueness: { scope: :option_type_id }, allow_nil: true
+  end
+end

data/app/models/spree/product_promotion_rule.rb

@@ -0,0 +1,9 @@
+module Spree
+  class ProductPromotionRule < Spree::Base
+    belongs_to :product, class_name: 'Spree::Product'
+    belongs_to :promotion_rule, class_name: 'Spree::PromotionRule'
+
+    validates :product, :promotion_rule, presence: true
+    validates :product_id, uniqueness: { scope: :promotion_rule_id }, allow_nil: true
+  end
+end