solidus_core 1.0.0.pre

data/app/models/spree/product.rb

@@ -0,0 +1,347 @@
+module Spree
+  # Products represent an entity for sale in a store. Products can have
+  # variations, called variants. Product properties include description,
+  # permalink, availability, shipping category, etc. that do not change by
+  # variant.
+  #
+  # @note this model uses {https://github.com/radar/paranoia paranoia}.
+  #   +#destroy+ will only soft-destroy records and the default scope hides
+  #   soft-destroyed records using +WHERE deleted_at IS NULL+.
+  class Product < Spree::Base
+    extend FriendlyId
+    friendly_id :slug_candidates, use: :history
+
+    acts_as_paranoid
+
+    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
+    has_and_belongs_to_many :promotion_rules, join_table: :spree_products_promotion_rules
+
+    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("#{::Spree::Variant.quoted_table_name}.position ASC") },
+      inverse_of: :product,
+      class_name: 'Spree::Variant'
+
+    has_many :variants_including_master,
+      -> { order("#{::Spree::Variant.quoted_table_name}.position ASC") },
+      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
+
+    delegate_belongs_to :master, :cost_price
+
+    delegate :images, to: :master, prefix: true
+    alias_method :images, :master_images
+
+    has_many :variant_images, -> { order(:position) }, source: :images, through: :variants_including_master
+
+    after_create :set_master_variant_defaults
+    after_create :add_associations_from_prototype
+    after_create :build_variants_from_option_values_hash, if: :option_values_hash
+
+    after_destroy :punch_slug
+
+    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
+
+    validates :meta_keywords, length: { maximum: 255 }
+    validates :meta_title, length: { maximum: 255 }
+    validates :name, presence: true
+    validates :price, presence: true, if: proc { Spree::Config[:require_master_price] }
+    validates :shipping_category_id, presence: true
+    validates :slug, length: { minimum: 3 }, uniqueness: { allow_blank: true }
+
+    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
+
+    # @return [Boolean] true if there are any variants
+    def has_variants?
+      variants.any?
+    end
+
+    # @return [Spree::TaxCategory] tax category for this product, or the default tax category
+    def tax_category
+      if self[:tax_category_id].nil?
+        TaxCategory.where(is_default: true).first
+      else
+        TaxCategory.find(self[:tax_category_id])
+      end
+    end
+
+    # Overrides the prototype_id setter in order to ensure it is cast to an
+    # integer.
+    #
+    # @param value [#to_i] the intended new value
+    # @!attribute [rw] prototype_id
+    #   @return [Fixnum]
+    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.
+    #
+    # @return [Array] the option_values
+    def ensure_option_types_exist_for_values_hash
+      return if option_values_hash.nil?
+      option_values_hash.keys.map(&:to_i).each do |id|
+        self.option_type_ids << id unless option_type_ids.include?(id)
+        product_option_types.create(option_type_id: id) unless product_option_types.pluck(:option_type_id).include?(id)
+      end
+    end
+
+    # Creates a new product with the same attributes, variants, etc.
+    #
+    # @return [Spree::Product] the duplicate
+    def duplicate
+      duplicator = ProductDuplicator.new(self)
+      duplicator.duplicate
+    end
+
+    # Use for checking whether this product has been deleted. Provided for
+    # overriding the logic for determining if a product is deleted.
+    #
+    # @return [Boolean] true if this product is deleted
+    def deleted?
+      !!deleted_at
+    end
+
+    # Determines if product is available. A product is available if it has not
+    # been deleted and the available_on date is in the past.
+    #
+    # @return [Boolean] true if this product is available
+    def available?
+      !(available_on.nil? || available_on.future?) && !deleted?
+    end
+
+    # Groups variants by the specified option type.
+    #
+    # @param opt_type [String] the name of the option type to group by
+    # @return [Hash] option_type as keys, array of variants as values.
+    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
+
+    # Poor man's full text search.
+    #
+    # Filters products to those which have any of the strings in +values+ in
+    # any of the fields in +fields+.
+    #
+    # @param fields [Array{String,Symbol}] columns of the products table to search for values
+    # @param values [Array{String}] strings to search through fields for
+    # @return [ActiveRecord::Relation] scope with WHERE clause for search applied
+    def self.like_any(fields, values)
+      where fields.map { |field|
+        values.map { |value|
+          arel_table[field].matches("%#{value}%")
+        }.inject(:or)
+      }.inject(:or)
+    end
+
+    # @param current_currency [String] currency to filter variants by; defaults to Spree's default
+    # @return [Array<Spree::Variant>] all variants with at least one option value
+    def variants_and_option_values(current_currency = nil)
+      variants.includes(:option_values).active(current_currency).select do |variant|
+        variant.option_values.any?
+      end
+    end
+
+    # @return [Boolean] true if there are no option values
+    def empty_option_values?
+      options.empty? || options.any? do |opt|
+        opt.option_type.option_values.empty?
+      end
+    end
+
+    # @param property_name [String] the name of the property to find
+    # @return [String] the value of the given property. nil if property is undefined on this product
+    def property(property_name)
+      return nil unless prop = properties.find_by(name: property_name)
+      product_properties.find_by(property: prop).try(:value)
+    end
+
+    # Assigns the given value to the given property.
+    #
+    # @param property_name [String] the name of the property
+    # @param property_value [String] the property value
+    def set_property(property_name, property_value)
+      ActiveRecord::Base.transaction do
+        # Works around spree_i18n #301
+        property = if Property.exists?(name: property_name)
+          Property.where(name: property_name).first
+        else
+          Property.create(name: property_name, presentation: property_name)
+        end
+        product_property = ProductProperty.where(product: self, property: property).first_or_initialize
+        product_property.value = property_value
+        product_property.save!
+      end
+    end
+
+    # @return [Array] all advertised and not-rejected promotions
+    def possible_promotions
+      promotion_ids = promotion_rules.map(&:promotion_id).uniq
+      Spree::Promotion.advertised.where(id: promotion_ids).reject(&:expired?)
+    end
+
+    # The number of on-hand stock items; Infinity if any variant does not track
+    # inventory.
+    #
+    # @return [Fixnum, Infinity]
+    def total_on_hand
+      if any_variants_not_track_inventory?
+        Float::INFINITY
+      else
+        stock_items.sum(:count_on_hand)
+      end
+    end
+
+    # Override so if the master variant is deleted, we can still find it.
+    #
+    # @return [Spree::Variant] the master variant
+    def master
+      super || variants_including_master.with_deleted.where(is_master: true).first
+    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?
+      if variants_including_master.loaded?
+        variants_including_master.any? { |v| !v.should_track_inventory? }
+      else
+        !Spree::Config.track_inventory_levels || variants_including_master.where(track_inventory: false).any?
+      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|
+        variant = 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
+      update_column :slug, "#{Time.now.to_i}_#{slug}" # punch slug with date prefix to allow reuse of original
+    end
+
+    def anything_changed?
+      changed? || @nested_changes
+    end
+
+    def reset_nested_changes
+      @nested_changes = false
+    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 && (master.changed? || master.new_record? || (master.default_price && (master.default_price.changed? || master.default_price.new_record?)))
+        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
+
+    # ensures the master variant is flagged as such
+    def set_master_variant_defaults
+      master.is_master = true
+    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
+
+    # Iterate through this products taxons and taxonomies and touch their timestamps in a batch
+    def touch_taxons
+      taxons_to_touch = taxons.map(&:self_and_ancestors).flatten.uniq
+      Spree::Taxon.where(id: taxons_to_touch.map(&:id)).update_all(updated_at: Time.current)
+
+      taxonomy_ids_to_touch = taxons_to_touch.map(&:taxonomy_id).flatten.uniq
+      Spree::Taxonomy.where(id: taxonomy_ids_to_touch).update_all(updated_at: Time.current)
+    end
+
+  end
+end
+
+require_dependency 'spree/product/scopes'

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

@@ -0,0 +1,262 @@
+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
+
+    # Can't use add_search_scope for this as it needs a default argument
+    def self.available(available_on = nil, currency = nil)
+      joins(:master => :prices).where("#{Product.quoted_table_name}.available_on <= ?", available_on || Time.now)
+    end
+    search_scopes << :available
+
+    def self.active(currency = nil)
+      not_deleted.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