Class: Spree::Variant
- Inherits:
-
Base
- Object
- ActiveRecord::Base
- Base
- Spree::Variant
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
#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
46
47
48
|
# File 'app/models/spree/variant.rb', line 46
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
|
Instance Method Details
#amount_in(currency) ⇒ Object
150
151
152
|
# File 'app/models/spree/variant.rb', line 150
def amount_in(currency)
price_in(currency).try(:amount)
end
|
#can_supply?(quantity = 1) ⇒ Boolean
#cost_price=(price) ⇒ Object
58
59
60
|
# File 'app/models/spree/variant.rb', line 58
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.
95
96
97
|
# File 'app/models/spree/variant.rb', line 95
def deleted?
!!deleted_at
end
|
#exchange_name ⇒ Object
88
89
90
|
# File 'app/models/spree/variant.rb', line 88
def exchange_name
is_master? ? name : options_text
end
|
#in_stock? ⇒ Boolean
188
189
190
191
192
|
# File 'app/models/spree/variant.rb', line 188
def in_stock?
Rails.cache.fetch(in_stock_cache_key) do
total_on_hand > 0
end
end
|
#is_backorderable? ⇒ Boolean
#name_and_sku ⇒ Object
180
181
182
|
# File 'app/models/spree/variant.rb', line 180
def name_and_sku
"#{name} - #{sku}"
end
|
#on_backorder ⇒ Object
returns number of units currently on backorder for this variant.
67
68
69
|
# File 'app/models/spree/variant.rb', line 67
def on_backorder
inventory_units.with_state('backordered').size
end
|
#option_value(opt_name) ⇒ Object
142
143
144
|
# File 'app/models/spree/variant.rb', line 142
def option_value(opt_name)
self.option_values.detect { |o| o.option_type.name == opt_name }.try(:presentation)
end
|
#options=(options = {}) ⇒ Object
106
107
108
109
110
|
# File 'app/models/spree/variant.rb', line 106
def options=(options = {})
options.each do |option|
set_option_value(option[:name], option[:value])
end
end
|
#options_text ⇒ Object
75
76
77
78
79
80
81
82
83
84
85
|
# File 'app/models/spree/variant.rb', line 75
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
146
147
148
|
# File 'app/models/spree/variant.rb', line 146
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
167
168
169
170
171
172
173
174
175
176
177
178
|
# File 'app/models/spree/variant.rb', line 167
def price_modifier_amount(options = {})
return 0 unless options.present?
options.keys.map { |key|
m = "#{options[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
154
155
156
157
158
159
160
161
162
163
164
165
|
# File 'app/models/spree/variant.rb', line 154
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.
102
103
104
|
# File 'app/models/spree/variant.rb', line 102
def product
Spree::Product.unscoped { super }
end
|
#set_option_value(opt_name, opt_value) ⇒ Object
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
# File 'app/models/spree/variant.rb', line 112
def set_option_value(opt_name, opt_value)
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
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
204
205
206
|
# File 'app/models/spree/variant.rb', line 204
def should_track_inventory?
self.track_inventory? && Spree::Config.track_inventory_levels
end
|
#sku_and_options_text ⇒ Object
184
185
186
|
# File 'app/models/spree/variant.rb', line 184
def sku_and_options_text
"#{sku} #{options_text}".strip
end
|
#tax_category ⇒ Object
50
51
52
53
54
55
56
|
# File 'app/models/spree/variant.rb', line 50
def tax_category
if self[:tax_category_id].nil?
product.tax_category
else
TaxCategory.find(self[:tax_category_id])
end
end
|
#weight=(weight) ⇒ Object
62
63
64
|
# File 'app/models/spree/variant.rb', line 62
def weight=(weight)
self[:weight] = Spree::LocalizedNumber.parse(weight) if weight.present?
end
|