Class: Spree::Variant

Inherits:
Base
  • Object
show all
Includes:
Discard::Model, DefaultPrice, ParanoiaDeprecations
Defined in:
core/app/models/spree/variant.rb,
core/app/models/spree/variant/scopes.rb,
core/app/models/spree/variant/price_selector.rb,
core/app/models/spree/variant/pricing_options.rb,
core/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

#find_or_build_default_price, #has_default_price?

Methods included from ParanoiaDeprecations

#paranoia_delete, #paranoia_destroy

Methods inherited from Base

display_includes, #initialize_preference_defaults, page, preference

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.



36
37
38
# File 'core/app/models/spree/variant.rb', line 36

def rebuild_vat_prices=(value)
  @rebuild_vat_prices = value
end

Class Method Details

.active(currency = nil) ⇒ ActiveRecord::Relation

Deprecated.

Please use the .with_prices scope instead

Returns variants that are not deleted and have a price in the given currency.

Parameters:

  • currency (String) (defaults to: nil)

    the currency to filter by; defaults to Spree's default

Returns:

  • (ActiveRecord::Relation)


136
137
138
139
# File 'core/app/models/spree/variant.rb', line 136

def self.active(currency = nil)
  Spree::Deprecation.warn("`Variant.active(currency)` is deprecated. Please use `Variant.with_prices(pricing_options)` instead.", caller)
  joins(:prices).where(deleted_at: nil).where('spree_prices.currency' => currency || Spree::Config[:currency]).where('spree_prices.amount IS NOT NULL')
end

.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)


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

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)


117
118
119
120
121
122
123
124
125
# File 'core/app/models/spree/variant.rb', line 117

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)


146
147
148
149
150
151
152
153
154
155
156
157
158
159
# File 'core/app/models/spree/variant.rb', line 146

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

#amount_in(currency) ⇒ Float

Deprecated.

Please use #price_for instead and use a money object rathern than a BigDecimal.

Fetches the price amount in the specified currency.

Returns:

  • (Float)

    the amount in the specified currency.



328
329
330
# File 'core/app/models/spree/variant.rb', line 328

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

#can_supply?(quantity = 1) ⇒ Boolean

Returns true if the desired quantity can be supplied

Parameters:

  • quantity (Fixnum) (defaults to: 1)

    how many are desired

Returns:

  • (Boolean)

    true if the desired quantity can be supplied



356
357
358
# File 'core/app/models/spree/variant.rb', line 356

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

#cost_price=(price) ⇒ Bignum

Sets the cost_price for the variant.

Parameters:

  • price (Any)

    the price to set

Returns:

  • (Bignum)


174
175
176
# File 'core/app/models/spree/variant.rb', line 174

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



232
233
234
# File 'core/app/models/spree/variant.rb', line 232

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



224
225
226
# File 'core/app/models/spree/variant.rb', line 224

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

#display_image(fallback: true) ⇒ Spree::Image

Image that can be used for the variant.

Will first search for images on the variant. If it doesn't find any, it'll fallback to any variant image (unless fallback is false) or to a new Image.

Parameters:

  • fallback (Boolean)

    whether or not we should fallback to an image not from this variant

Returns:



384
385
386
387
# File 'core/app/models/spree/variant.rb', line 384

def display_image(fallback: true)
  Spree::Deprecation.warn('Spree::Variant#display_image is DEPRECATED. Choose an image from Spree::Variant#gallery instead')
  images.first || (fallback && product.variant_images.first) || Spree::Image.new
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.



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

def exchange_name
  is_master? ? name : options_text
end

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

Returns:



403
404
405
# File 'core/app/models/spree/variant.rb', line 403

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.



348
349
350
351
352
# File 'core/app/models/spree/variant.rb', line 348

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



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

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

#name_and_skuString

Generates a friendly name and sku string.

Returns:

  • (String)


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

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

#on_backorderFixnum

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

Returns:

  • (Fixnum)


189
190
191
# File 'core/app/models/spree/variant.rb', line 189

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



283
284
285
# File 'core/app/models/spree/variant.rb', line 283

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.



239
240
241
242
243
# File 'core/app/models/spree/variant.rb', line 239

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.



201
202
203
204
205
206
207
208
209
210
211
# File 'core/app/models/spree/variant.rb', line 201

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



301
302
303
304
305
306
# File 'core/app/models/spree/variant.rb', line 301

def price_difference_from_master(pricing_options = Spree::Config.default_pricing_options)
  master_price = product.master.price_for(pricing_options)
  variant_price = price_for(pricing_options)
  return unless master_price && variant_price
  variant_price - master_price
end

#price_in(currency) ⇒ Spree::Price

Deprecated.

Please use #price_for(pricing_options) instead

Converts the variant's price to the given currency.

Parameters:

  • currency (String)

    the desired currency

Returns:



318
319
320
# File 'core/app/models/spree/variant.rb', line 318

def price_in(currency)
  prices.currently_valid.find_by(currency: currency)
end

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

Returns:

  • (Boolean)


308
309
310
311
# File 'core/app/models/spree/variant.rb', line 308

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:



291
292
293
# File 'core/app/models/spree/variant.rb', line 291

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
# File 'core/app/models/spree/variant.rb', line 249

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



372
373
374
# File 'core/app/models/spree/variant.rb', line 372

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)


343
344
345
# File 'core/app/models/spree/variant.rb', line 343

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:



166
167
168
# File 'core/app/models/spree/variant.rb', line 166

def tax_category
  super || product_tax_category
end

#total_on_handFixnum

Fetches the on-hand quantity of the variant.

Returns:

  • (Fixnum)

    the number currently on-hand



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

def total_on_hand
  Spree::Stock::Quantifier.new(self).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:



393
394
395
396
397
# File 'core/app/models/spree/variant.rb', line 393

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

#weight=(weight) ⇒ Bignum

Sets the weight for the variant.

Parameters:

  • weight (Any)

    the weight to set

Returns:

  • (Bignum)


182
183
184
# File 'core/app/models/spree/variant.rb', line 182

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