Class: Spree::Product

Inherits:
ActiveRecord::Base
  • Object
show all
Defined in:
app/models/spree/product.rb,
app/models/spree/product/scopes.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#option_values_hash ⇒ Object

Returns the value of attribute option_values_hash.



74
75
76
 
# File 'app/models/spree/product.rb', line 74

def option_values_hash
  @option_values_hash
end

#prototype_id ⇒ Object

Adding properties and option types on creation based on a chosen prototype



134
135
136
 
# File 'app/models/spree/product.rb', line 134

def prototype_id
  @prototype_id
end

Class Method Details

.active(currency = nil) ⇒ Object 



206
207
208
 
# File 'app/models/spree/product/scopes.rb', line 206

def self.active(currency = nil)
  not_deleted.available(nil, currency)
end

.add_search_scope(name, &block) ⇒ Object 



7
8
9
10
 
# File 'app/models/spree/product/scopes.rb', line 7

def self.add_search_scope(name, &block)
  self.singleton_class.send(:define_method, name.to_sym, &block)
  search_scopes << name.to_sym
end

.add_simple_scopes(scopes) ⇒ Object 



21
22
23
24
25
26
27
28
29
 
# File 'app/models/spree/product/scopes.rb', line 21

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_(.*)/)
    order_text = "#{Product.quoted_table_name}.#{parts[2]} #{parts[1] == 'ascend' ?  "ASC" : "DESC"}"
    self.scope(name.to_s, order(order_text))
  end
end

.available(available_on = nil, currency = nil) ⇒ Object

Can’t use add_search_scope for this as it needs a default argument



197
198
199
200
201
202
203
 
# File 'app/models/spree/product/scopes.rb', line 197

def self.available(available_on = nil, currency = nil)
  scope = joins(:master => :prices).where("#{Product.quoted_table_name}.available_on <= ?", available_on || Time.now)
  unless Spree::Config.show_products_without_price
    scope = scope.where('spree_prices.currency' => currency || Spree::Config[:currency]).where('spree_prices.amount IS NOT NULL')
  end
  scope
end

.group_by_products_id ⇒ Object

This method needs to be defined *as a method*, otherwise it will cause the problem shown in #1247.



217
218
219
220
221
222
223
224
225
226
 
# File 'app/models/spree/product/scopes.rb', line 217

def self.group_by_products_id
  if (ActiveRecord::Base.connection.adapter_name == 'PostgreSQL')
    # Need to check, otherwise `column_names` will fail
    if table_exists?
      group(column_names.map { |col_name| "#{table_name}.#{col_name}"})
    end
  else
    group("#{self.quoted_table_name}.id")
  end
end

.like_any(fields, values) ⇒ Object 



176
177
178
179
180
181
182
 
# File 'app/models/spree/product.rb', line 176

def self.like_any(fields, values)
  where fields.map { |field|
    values.map { |value|
      arel_table[field].matches("%#{value}%")
    }.inject(:or)
  }.inject(:or)
end

.simple_scopes ⇒ Object 



12
13
14
15
16
17
18
19
 
# File 'app/models/spree/product/scopes.rb', line 12

def self.simple_scopes
  [
    :ascend_by_updated_at,
    :descend_by_updated_at,
    :ascend_by_name,
    :descend_by_name
  ]
end

Instance Method Details

#available? ⇒ Boolean

determine if product is available. deleted products and products with nil or future available_on date are not available

Returns:

  • (Boolean) 


165
166
167
 
# File 'app/models/spree/product.rb', line 165

def available?
  !(available_on.nil? || available_on.future?) && !deleted?
end

#categorise_variants_from_option(opt_type) ⇒ Object

split variants list into hash which shows mapping of opt value onto matching variants eg categorise_variants_from_option(color) => -> […], “blue” -> […]



171
172
173
174
 
# File 'app/models/spree/product.rb', line 171

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

#deleted? ⇒ Boolean

use deleted? rather than checking the attribute directly. this allows extensions to override deleted? if they want to provide their own definition.

Returns:

  • (Boolean) 


158
159
160
 
# File 'app/models/spree/product.rb', line 158

def deleted?
  !!deleted_at
end

#duplicate ⇒ Object

for adding products which are closely related to existing ones define “duplicate_extra” for site-specific actions, eg for additional fields



150
151
152
153
 
# File 'app/models/spree/product.rb', line 150

def duplicate
  duplicator = ProductDuplicator.new(self)
  duplicator.duplicate
end

#empty_option_values? ⇒ Boolean

Returns:

  • (Boolean) 


195
196
197
198
199
 
# File 'app/models/spree/product.rb', line 195

def empty_option_values?
  options.empty? || options.any? do |opt|
    opt.option_type.option_values.empty?
  end
end

#ensure_option_types_exist_for_values_hash ⇒ Object

Ensures option_types and product_option_types exist for keys in option_values_hash



140
141
142
143
144
145
146
 
# File 'app/models/spree/product.rb', line 140

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}, without_protection: true) unless product_option_types.pluck(:option_type_id).include?(id)
  end
end

#has_variants? ⇒ Boolean

the master variant is not a member of the variants array

Returns:

  • (Boolean) 


121
122
123
 
# File 'app/models/spree/product.rb', line 121

def has_variants?
  variants.any?
end

#master ⇒ Object

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.



236
237
238
 
# File 'app/models/spree/product.rb', line 236

def master
  super || variants_including_master.with_deleted.where(:is_master => true).first
end

#possible_promotions ⇒ Object 



220
221
222
223
 
# File 'app/models/spree/product.rb', line 220

def possible_promotions
  promotion_ids = promotion_rules.map(&:activator_id).uniq
  Spree::Promotion.advertised.where(id: promotion_ids).reject(&:expired?)
end

#property(property_name) ⇒ Object 



201
202
203
204
 
# File 'app/models/spree/product.rb', line 201

def property(property_name)
  return nil unless prop = properties.find_by_name(property_name)
  product_properties.find_by_property_id(prop.id).try(:value)
end

#set_property(property_name, property_value) ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'app/models/spree/product.rb', line 206

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_id: self.id, property_id: property.id).first_or_initialize
    product_property.value = property_value
    product_property.save!
  end
end

#tax_category ⇒ Object 



125
126
127
128
129
130
131
 
# File 'app/models/spree/product.rb', line 125

def tax_category
  if self[:tax_category_id].nil?
    TaxCategory.where(is_default: true).first
  else
    TaxCategory.find(self[:tax_category_id])
  end
end

#to_param ⇒ Object 



116
117
118
 
# File 'app/models/spree/product.rb', line 116

def to_param
  permalink.present? ? permalink : (permalink_was || name.to_s.to_url)
end

#total_on_hand ⇒ Object 



225
226
227
228
229
230
231
 
# File 'app/models/spree/product.rb', line 225

def total_on_hand
  if self.variants_including_master.any? { |v| !v.should_track_inventory? }
    Float::INFINITY
  else
    self.stock_items.sum(&:count_on_hand)
  end
end

#variants_and_option_values(current_currency = nil) ⇒ Object

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



189
190
191
192
193
 
# File 'app/models/spree/product.rb', line 189

def variants_and_option_values(current_currency = nil)
  variants.includes(:option_values).active(current_currency).select do |variant|
    variant.option_values.any?
  end
end

#variants_with_only_master ⇒ Object 



111
112
113
114
 
# File 'app/models/spree/product.rb', line 111

def variants_with_only_master
  ActiveSupport::Deprecation.warn("[SPREE] Spree::Product#variants_with_only_master will be deprecated in Spree 1.3. Please use Spree::Product#master instead.")
  master
end