Class: Spree::Variant
Constant Summary
collapse
- LOCALIZED_NUMBERS =
%w(cost_price weight depth width height)
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
57
58
59
|
# File 'app/models/spree/variant.rb', line 57
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
|
.having_orders ⇒ Object
61
62
63
|
# File 'app/models/spree/variant.rb', line 61
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
#deleted? ⇒ Boolean
use deleted? rather than checking the attribute directly. this allows extensions to override deleted? if they want to provide their own definition.
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
|
#dimension ⇒ Object
227
228
229
|
# File 'app/models/spree/variant.rb', line 227
def dimension
(width || 0) + (height || 0) + (depth || 0)
end
|
#exchange_name ⇒ Object
95
96
97
|
# File 'app/models/spree/variant.rb', line 95
def exchange_name
is_master? ? name : options_text
end
|
#in_stock? ⇒ 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
#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.detect { |price| price.currency == currency } || Spree::Price.new(variant_id: 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)
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
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
65
66
67
68
69
70
71
|
# File 'app/models/spree/variant.rb', line 65
def tax_category
if self[:tax_category_id].nil?
product.tax_category
else
TaxCategory.find(self[:tax_category_id])
end
end
|
#track_inventory ⇒ Object
219
220
221
|
# File 'app/models/spree/variant.rb', line 219
def track_inventory
self.should_track_inventory?
end
|
#volume ⇒ Object
223
224
225
|
# File 'app/models/spree/variant.rb', line 223
def volume
(width || 0) * (height || 0) * (depth || 0)
end
|