Class: Spree::Variant

Inherits:
Base
  • Object
show all
Includes:
DefaultPrice
Defined in:
app/models/spree/variant.rb,
app/models/spree/variant/scopes.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

page

Methods included from Preferences::Preferable

#clear_preferences, #default_preferences, #defined_preferences, #get_preference, #has_preference!, #has_preference?, #preference_default, #preference_type, #set_preference

Class Method Details

.active(currency = nil) ⇒ Object 



49
50
51
 
# File 'app/models/spree/variant.rb', line 49

def self.active(currency = nil)
  joins(:prices).where(deleted_at: nil).where('spree_prices.currency' => currency || Spree::Config[:currency]).where('spree_prices.amount IS NOT NULL')
end

.has_option(option_type, *option_values) ⇒ Object Also known as: has_options

Returns variants that match a given option value

Example:

product.variants_including_master.has_option(OptionType.find_by(name: ‘shoe-size’), OptionValue.find_by(name: ‘8’))



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'app/models/spree/variant/scopes.rb', line 15

def has_option(option_type, *option_values)
  ActiveSupport::Deprecation.warn "Variant.descend_by_popularity is deprecated and will be removed from Spree 3.", caller
  option_types = OptionType.table_name

  option_type_conditions = case option_type
  when OptionType then { "#{option_types}.name" => option_type.name }
  when String     then { "#{option_types}.name" => option_type }
  else                 { "#{option_types}.id"   => option_type }
  end

  relation = joins(:option_values => :option_type).where(option_type_conditions)

  option_values_conditions = option_values.each do |option_value|
    option_value_conditions = case option_value
    when OptionValue then { "#{OptionValue.table_name}.name" => option_value.name }
    when String      then { "#{OptionValue.table_name}.name" => option_value }
    else                  { "#{OptionValue.table_name}.id"   => option_value }
    end
    relation = relation.where(option_value_conditions)
  end

  relation
end

.having_orders ⇒ Object 



53
54
55
 
# File 'app/models/spree/variant.rb', line 53

def self.having_orders
  joins(:line_items).distinct
end

Instance Method Details

#amount_in(currency) ⇒ Object 



161
162
163
 
# File 'app/models/spree/variant.rb', line 161

def amount_in(currency)
  price_in(currency).try(:amount)
end

#can_supply?(quantity = 1) ⇒ Boolean

Returns:

  • (Boolean) 


205
206
207
 
# File 'app/models/spree/variant.rb', line 205

def can_supply?(quantity=1)
  Spree::Stock::Quantifier.new(self).can_supply?(quantity)
end

#cost_price=(price) ⇒ Object 



65
66
67
 
# File 'app/models/spree/variant.rb', line 65

def cost_price=(price)
  self[:cost_price] = Spree::LocalizedNumber.parse(price) if price.present?
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) 


106
107
108
 
# File 'app/models/spree/variant.rb', line 106

def deleted?
  !!deleted_at
end

#descriptive_name ⇒ Object 



99
100
101
 
# File 'app/models/spree/variant.rb', line 99

def descriptive_name
  is_master? ? name + ' - Master' : name + ' - ' + options_text
end

#exchange_name ⇒ Object

Default to master name



95
96
97
 
# File 'app/models/spree/variant.rb', line 95

def exchange_name
  is_master? ? name : options_text
end

#in_stock? ⇒ Boolean

Returns:

  • (Boolean) 


199
200
201
202
203
 
# File 'app/models/spree/variant.rb', line 199

def in_stock?
  Rails.cache.fetch(in_stock_cache_key) do
    total_on_hand > 0
  end
end

#is_backorderable? ⇒ Boolean

Returns:

  • (Boolean) 


78
79
80
 
# File 'app/models/spree/variant.rb', line 78

def is_backorderable?
  Spree::Stock::Quantifier.new(self).backorderable?
end

#name_and_sku ⇒ Object 



191
192
193
 
# File 'app/models/spree/variant.rb', line 191

def name_and_sku
  "#{name} - #{sku}"
end

#on_backorder ⇒ Object

returns number of units currently on backorder for this variant.



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

def on_backorder
  inventory_units.with_state('backordered').size
end

#option_value(opt_name) ⇒ Object 



153
154
155
 
# File 'app/models/spree/variant.rb', line 153

def option_value(opt_name)
  self.option_values.detect { |o| o.option_type.name == opt_name }.try(:presentation)
end

#options=(options = {}) ⇒ Object 



117
118
119
120
121
 
# File 'app/models/spree/variant.rb', line 117

def options=(options = {})
  options.each do |option|
    set_option_value(option[:name], option[:value])
  end
end

#options_text ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
 
# File 'app/models/spree/variant.rb', line 82

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

#price_in(currency) ⇒ Object 



157
158
159
 
# File 'app/models/spree/variant.rb', line 157

def price_in(currency)
  prices.select{ |price| price.currency == currency }.first || Spree::Price.new(variant_id: self.id, currency: currency)
end

#price_modifier_amount(options = {}) ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'app/models/spree/variant.rb', line 178

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

#price_modifier_amount_in(currency, options = {}) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'app/models/spree/variant.rb', line 165

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

#product ⇒ Object

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.



113
114
115
 
# File 'app/models/spree/variant.rb', line 113

def product
  Spree::Product.unscoped { super }
end

#set_option_value(opt_name, opt_value) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'app/models/spree/variant.rb', line 123

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

#should_track_inventory? ⇒ Boolean

Shortcut method to determine if inventory tracking is enabled for this variant This considers both variant tracking flag and site-wide inventory tracking settings

Returns:

  • (Boolean) 


215
216
217
 
# File 'app/models/spree/variant.rb', line 215

def should_track_inventory?
  self.track_inventory? && Spree::Config.track_inventory_levels
end

#sku_and_options_text ⇒ Object 



195
196
197
 
# File 'app/models/spree/variant.rb', line 195

def sku_and_options_text
  "#{sku} #{options_text}".strip
end

#tax_category ⇒ Object 



57
58
59
60
61
62
63
 
# File 'app/models/spree/variant.rb', line 57

def tax_category
  if self[:tax_category_id].nil?
    product.tax_category
  else
    TaxCategory.find(self[:tax_category_id])
  end
end

#total_on_hand ⇒ Object 



209
210
211
 
# File 'app/models/spree/variant.rb', line 209

def total_on_hand
  Spree::Stock::Quantifier.new(self).total_on_hand
end

#weight=(weight) ⇒ Object 



69
70
71
 
# File 'app/models/spree/variant.rb', line 69

def weight=(weight)
  self[:weight] = Spree::LocalizedNumber.parse(weight) if weight.present?
end