Class: Spree::Variant

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

Overview

Master Variant

Every product has one master variant, which stores master price and SKU, size and weight, etc. The master variant does not have option values associated with it. Contains on_hand inventory levels only when there are no variants for the product.

Variants

All variants can access the product properties directly (via reverse delegation). Inventory units are tied to Variant. The master variant can have inventory units, but not option values. All other variants have option values and may have inventory units. Sum of on_hand each variant's inventory level determine “on_hand” level for the product.

Defined Under Namespace

Modules: Scopes Classes: PriceSelector, PricingOptions, VatPriceGenerator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DefaultPrice

#currently_valid_prices, #default_price, #default_price_or_build, #has_default_price?

Methods inherited from Base

display_includes

Methods included from Core::Permalinks

#generate_permalink, #save_permalink

Instance Attribute Details

#rebuild_vat_prices=(value) ⇒ Object (writeonly)

Sets the attribute rebuild_vat_prices

Parameters:

  • value

    the value to set the attribute rebuild_vat_prices to.


28
29
30
# File 'app/models/spree/variant.rb', line 28

def rebuild_vat_prices=(value)
  @rebuild_vat_prices = value
end

Class Method Details

.in_stock(stock_locations = nil) ⇒ ActiveRecord::Relation

Returns variants that are in stock. When stock locations are provided as a parameter, the scope is limited to variants that are in stock in the provided stock locations.

If you want to also include backorderable variants see suppliable

Parameters:

Returns:

  • (ActiveRecord::Relation)

88
89
90
91
92
93
94
95
# File 'app/models/spree/variant.rb', line 88

def self.in_stock(stock_locations = nil)
  return all unless Spree::Config.track_inventory_levels
  in_stock_variants = joins(:stock_items).where(Spree::StockItem.arel_table[:count_on_hand].gt(0).or(arel_table[:track_inventory].eq(false)))
  if stock_locations.present?
    in_stock_variants = in_stock_variants.where(spree_stock_items: { stock_location_id: stock_locations.map(&:id) })
  end
  in_stock_variants
end

.suppliableActiveRecord::Relation

Returns a scope of Variants which are suppliable. This includes:

  • in_stock variants

  • backorderable variants

  • variants which do not track stock

Returns:

  • (ActiveRecord::Relation)

103
104
105
106
107
108
109
110
111
# File 'app/models/spree/variant.rb', line 103

def self.suppliable
  return all unless Spree::Config.track_inventory_levels
  arel_conditions = [
    arel_table[:track_inventory].eq(false),
    Spree::StockItem.arel_table[:count_on_hand].gt(0),
    Spree::StockItem.arel_table[:backorderable].eq(true)
  ]
  joins(:stock_items).where(arel_conditions.inject(:or)).distinct
end

.with_prices(pricing_options = Spree::Config.default_pricing_options) ⇒ ActiveRecord::Relation

Returns variants that have a price for the given pricing options If you have modified the pricing options class, you might want to modify this scope too.

Parameters:

  • pricing_options (defaults to: Spree::Config.default_pricing_options)

    A Pricing Options object as defined on the price selector class

Returns:

  • (ActiveRecord::Relation)

121
122
123
124
125
126
127
128
129
130
131
132
133
134
# File 'app/models/spree/variant.rb', line 121

def self.with_prices(pricing_options = Spree::Config.default_pricing_options)
  where(
    Spree::Price.
      where(Spree::Variant.arel_table[:id].eq(Spree::Price.arel_table[:variant_id])).
      # This next clause should just be `where(pricing_options.search_arguments)`, but ActiveRecord
      # generates invalid SQL, so the SQL here is written manually.
      where(
        "spree_prices.currency = ? AND (spree_prices.country_iso IS NULL OR spree_prices.country_iso = ?)",
        pricing_options.search_arguments[:currency],
        pricing_options.search_arguments[:country_iso].compact
      ).
      arel.exists
  )
end

Instance Method Details

#can_supply?(quantity = 1, stock_location = nil) ⇒ Boolean

Returns true if the desired quantity can be supplied.

Parameters:

  • quantity (Fixnum) (defaults to: 1)

    how many are desired

  • stock_location (Spree::StockLocation) (defaults to: nil)

    Optionally restrict stock quantity check to a specific stock location. If unspecified it will check inventory in all available StockLocations.

Returns:

  • (Boolean)

    true if the desired quantity can be supplied


326
327
328
# File 'app/models/spree/variant.rb', line 326

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

#cost_price=(price) ⇒ Bignum

Sets the cost_price for the variant.

Parameters:

  • price (Any)

    the price to set

Returns:

  • (Bignum)

149
150
151
# File 'app/models/spree/variant.rb', line 149

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

#deleted?Boolean

Returns whether this variant has been deleted. Provided as a method of overriding the logic for determining if a variant is deleted.

Returns:

  • (Boolean)

    true if this variant has been deleted


207
208
209
# File 'app/models/spree/variant.rb', line 207

def deleted?
  !!deleted_at
end

#descriptive_nameString

Generates a verbose name for the variant, appending 'Master' if it is a master variant, otherwise a list of its option values.

Returns:

  • (String)

    the generated name


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

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

#exchange_nameString

Determines the name of an Exchange variant.

Returns:

  • (String)

    the master variant name, if it is a master; or a comma-separated list of all option values.


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

def exchange_name
  is_master? ? name : options_text
end

The gallery for the variant, which represents all the images associated with it

Returns:


363
364
365
# File 'app/models/spree/variant.rb', line 363

def gallery
  @gallery ||= Spree::Config.variant_gallery_class.new(self)
end

#in_stock?Boolean

Returns true if there is stock on-hand for the variant.

Returns:

  • (Boolean)

    true if there is stock on-hand for the variant.


315
316
317
318
319
# File 'app/models/spree/variant.rb', line 315

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

#is_backorderable?Boolean

Returns true if this variant can be backordered.

Returns:

  • (Boolean)

    true if this variant can be backordered


169
170
171
# File 'app/models/spree/variant.rb', line 169

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

#name_and_skuString

Generates a friendly name and sku string.

Returns:

  • (String)

303
304
305
# File 'app/models/spree/variant.rb', line 303

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

#on_backorderFixnum

Counts the number of units currently on backorder for this variant.

Returns:

  • (Fixnum)

164
165
166
# File 'app/models/spree/variant.rb', line 164

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

#option_value(opt_name) ⇒ String

Fetches the option value for the given option name.

Parameters:

  • opt_name (String)

    the name of the option whose value you want

Returns:

  • (String)

    the option value


258
259
260
# File 'app/models/spree/variant.rb', line 258

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

#options=(options = {}) ⇒ Object

Assign given options hash to option values.

Parameters:

  • options (Array) (defaults to: {})

    array of hashes with a name and value.


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

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

#options_textString

Creates a sentence out of the variant's (sorted) option values.

Returns:

  • (String)

    a sentence-ified string of option values.


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

def options_text
  values = option_values.includes(:option_type).sort_by do |option_value|
    option_value.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_difference_from_master(pricing_options = Spree::Config.default_pricing_options) ⇒ Object

Returns the difference in price from the master variant


277
278
279
280
281
282
# File 'app/models/spree/variant.rb', line 277

def price_difference_from_master(pricing_options = Spree::Config.default_pricing_options)
  master_price = product.master.price_for_options(pricing_options)
  variant_price = price_for_options(pricing_options)
  return unless master_price && variant_price
  Spree::Money.new(variant_price.amount - master_price.amount, currency: pricing_options.currency)
end

#price_for_options(price_options) ⇒ Object


289
290
291
292
293
294
295
296
297
298
# File 'app/models/spree/variant.rb', line 289

def price_for_options(price_options)
  if price_selector.respond_to?(:price_for_options)
    price_selector.price_for_options(price_options)
  else
    money = price_for(price_options)
    return if money.nil?

    Spree::Price.new(amount: money.to_d, variant: self, currency: price_options.currency)
  end
end

#price_same_as_master?(pricing_options = Spree::Config.default_pricing_options) ⇒ Boolean

Returns:

  • (Boolean)

284
285
286
287
# File 'app/models/spree/variant.rb', line 284

def price_same_as_master?(pricing_options = Spree::Config.default_pricing_options)
  diff = price_difference_from_master(pricing_options)
  diff && diff.zero?
end

#price_selectorSpree::Variant::PriceSelector

Returns an instance of the globally configured variant price selector class for this variant. It's cached so we don't create too many objects.

Returns:


266
267
268
# File 'app/models/spree/variant.rb', line 266

def price_selector
  @price_selector ||= Spree::Config.variant_price_selector_class.new(self)
end

#set_option_value(opt_name, opt_value) ⇒ Object

Sets an option type and value for the given name and value.

Parameters:

  • opt_name (String)

    the name of the option

  • opt_value (String)

    the value to set to the option


224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'app/models/spree/variant.rb', line 224

def set_option_value(opt_name, opt_value)
  # no option values on master
  return if is_master

  option_type = Spree::OptionType.where(name: opt_name).first_or_initialize do |option|
    option.presentation = opt_name
    option.save!
  end

  current_value = option_values.detect { |option| option.option_type.name == opt_name }

  if current_value
    return if current_value.name == opt_value
    option_values.delete(current_value)
  else
    # then we have to check to make sure that the product has the option type
    unless product.option_types.include? option_type
      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 |option|
    option.presentation = opt_value
    option.save!
  end

  option_values << option_value
  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)

    true if inventory tracking is enabled


345
346
347
# File 'app/models/spree/variant.rb', line 345

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

#sku_and_options_textString

Generates a string of the SKU and a list of all the option values.

Returns:

  • (String)

310
311
312
# File 'app/models/spree/variant.rb', line 310

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

#tax_categorySpree::TaxCategory

This returns the product's tax category if the tax category ID on the variant is nil. It looks like an association, but really is an override.

Returns:


141
142
143
# File 'app/models/spree/variant.rb', line 141

def tax_category
  super || product_tax_category
end

#total_on_hand(stock_location = nil) ⇒ Fixnum

Fetches the on-hand quantity of the variant.

Parameters:

  • stock_location (Spree::StockLocation) (defaults to: nil)

    Optionally restrict stock quantity check to a specific stock location. If unspecified it will check inventory in all available StockLocations.

Returns:

  • (Fixnum)

    the number currently on-hand


336
337
338
# File 'app/models/spree/variant.rb', line 336

def total_on_hand(stock_location = nil)
  Spree::Stock::Quantifier.new(self, stock_location).total_on_hand
end

#variant_propertiesArray<Spree::VariantPropertyRuleValue>

Determines the variant's property values by verifying which of the product's variant property rules apply to itself.

Returns:


353
354
355
356
357
# File 'app/models/spree/variant.rb', line 353

def variant_properties
  product.variant_property_rules.flat_map do |rule|
    rule.values if rule.applies_to_variant?(self)
  end.compact
end

#weight=(weight) ⇒ Bignum

Sets the weight for the variant.

Parameters:

  • weight (Any)

    the weight to set

Returns:

  • (Bignum)

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

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