Class: Spree::Product

Inherits:
Object
  • Object
show all
Includes:
MemoizedData, Metadata, Metafields, Channels, LegacyMultiStoreSupport, Slugs, Webhooks, ProductScopes, SearchIndexable, TranslatableResource, VendorConcern
Defined in:
app/models/spree/product.rb,
app/models/spree/product/slugs.rb,
app/models/spree/product/channels.rb,
app/models/spree/product/webhooks.rb,
app/models/spree/product/legacy_multi_store_support.rb

Defined Under Namespace

Modules: Channels, LegacyMultiStoreSupport, Slugs, Webhooks

Constant Summary collapse

MEMOIZED_METHODS = 
%w[total_on_hand taxonomy_ids taxon_and_ancestors
default_variant_id tax_category default_variant variant_for_images
brand_taxon main_taxon
purchasable? in_stock? backorderable? digital?]
STATUSES = 
%w[draft active archived].freeze
STATUS_TO_WEBHOOK_EVENT = 
{
  'active' => 'activated',
  'draft' => 'drafted',
  'archived' => 'archived'
}.freeze
TRANSLATABLE_FIELDS = 
%i[name description slug meta_description meta_title].freeze

Constants included from Channels

Channels::DEPRECATED_DATE_TO_PUBLICATION_FIELD

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from SearchIndexable

#add_to_search_index, #enqueue_search_index, #enqueue_search_removal, #remove_from_search_index, #search_indexing_enabled?, #search_presentation, #store_ids_for_indexing

Methods included from Channels

#product_publications=, #publication_for

Methods included from Slugs

#ensure_slug_is_unique

Methods included from Webhooks

#send_product_activated_webhook, #send_product_archived_webhook, #send_product_drafted_webhook

Methods included from Metadata

#metadata, #metadata=, #public_metadata=

Instance Attribute Details

#option_values_hash ⇒ Object

Returns the value of attribute option_values_hash.



183
184
185
 
# File 'app/models/spree/product.rb', line 183

def option_values_hash
  @option_values_hash
end

#prototype_id ⇒ Object

Adding properties and option types on creation based on a chosen prototype



463
464
465
 
# File 'app/models/spree/product.rb', line 463

def prototype_id
  @prototype_id
end

Class Method Details

.bulk_auto_match_taxons(store, product_ids) ⇒ Object 



311
312
313
314
315
316
317
318
319
320
321
 
# File 'app/models/spree/product.rb', line 311

def self.bulk_auto_match_taxons(store, product_ids)
  return if store.taxons.automatic.none?

  products_to_auto_match_ids = store.products.not_deleted.not_archived.where(id: product_ids).ids

  auto_match_taxons_jobs = products_to_auto_match_ids.map do |product_id|
    Spree::Products::AutoMatchTaxonsJob.new(product_id).tap { |job| job.scheduled_at = 30.seconds.from_now }
  end

  ActiveJob.perform_all_later(auto_match_taxons_jobs)
end

.like_any(fields, values) ⇒ Object 



542
543
544
545
546
547
 
# File 'app/models/spree/product.rb', line 542

def self.like_any(fields, values)
  conditions = fields.product(values).map do |(field, value)|
    arel_table[field].matches("%#{value}%")
  end
  where conditions.inject(:or)
end

Instance Method Details

#any_variant_available?(currency) ⇒ Boolean

Returns:



483
484
485
486
487
488
489
 
# File 'app/models/spree/product.rb', line 483

def any_variant_available?(currency)
  if has_variants?
    first_available_variant(currency).present?
  else
    master.purchasable? && master.price_in(currency).amount.present?
  end
end

#any_variant_in_stock_or_backorderable? ⇒ Boolean

Returns:



611
612
613
614
615
616
617
 
# File 'app/models/spree/product.rb', line 611

def any_variant_in_stock_or_backorderable?
  if has_variants?
    variants_including_master.in_stock_or_backorderable.exists?
  else
    master.in_stock_or_backorderable?
  end
end

#auto_match_taxons ⇒ Object 



628
629
630
631
632
633
634
 
# File 'app/models/spree/product.rb', line 628

def auto_match_taxons
  return if deleted?
  return if archived?
  return if store.nil? || store.taxons.automatic.none?

  Spree::Products::AutoMatchTaxonsJob.set(wait: 30.seconds).perform_later(id)
end

#available? ⇒ Boolean

determine if product is available. deleted products and products with status different than active are not available

Returns:



518
519
520
 
# File 'app/models/spree/product.rb', line 518

def available?
  active? && !deleted? && (available_on.nil? || available_on <= Time.current)
end

#backorderable? ⇒ Boolean

Can’t use short form block syntax due to github.com/Netflix/fast_jsonapi/issues/259

Returns:



334
335
336
 
# File 'app/models/spree/product.rb', line 334

def backorderable?
  default_variant.backorderable? || variants.any?(&:backorderable?)
end

#backordered? ⇒ Boolean

determine if any variant (including master) is out of stock and backorderable

Returns:



538
539
540
 
# File 'app/models/spree/product.rb', line 538

def backordered?
  variants_including_master.any?(&:backordered?)
end

#brand_name ⇒ String

Returns the brand name for the product

Returns:

  • (String) 


595
596
597
 
# File 'app/models/spree/product.rb', line 595

def brand_name
  brand_taxon&.name
end

#brand_taxon ⇒ Spree::Taxon

Returns the brand taxon for the product

Returns:



579
580
581
582
583
584
585
586
587
588
589
590
591
 
# File 'app/models/spree/product.rb', line 579

def brand_taxon
  @brand_taxon ||= if classification_count.zero?
                     nil
                   elsif Spree.use_translations?
                     taxons.joins(:taxonomy).
                       join_translation_table(Taxonomy).
                       find_by(Taxonomy.translation_table_alias => { name: Spree.t(:taxonomy_brands_name) })
                   elsif taxons.loaded?
                     taxons.find { |taxon| taxon.taxonomy.name == Spree.t(:taxonomy_brands_name) }
                   else
                     taxons.joins(:taxonomy).find_by(Taxonomy.table_name => { name: Spree.t(:taxonomy_brands_name) })
                   end
end

#can_supply? ⇒ Boolean

determine if any variant (including master) can be supplied

Returns:



533
534
535
 
# File 'app/models/spree/product.rb', line 533

def can_supply?
  variants_including_master.any?(&:can_supply?)
end

#category_ids=(ids) ⇒ Object

Maps 6.0 API name (category_ids) to model column (taxon_ids). Accepts both prefixed IDs and raw integer IDs.



215
216
217
218
219
 
# File 'app/models/spree/product.rb', line 215

def category_ids=(ids)
  self.taxon_ids = Array(ids).filter_map do |id|
    id.to_s.include?('_') ? Spree::Taxon.decode_prefixed_id(id) : id
  end
end

#default_image ⇒ Object

Deprecated.

Use #primary_media instead.



406
407
408
409
 
# File 'app/models/spree/product.rb', line 406

def default_image
  Spree::Deprecation.warn('Spree::Product#default_image is deprecated and will be removed in Spree 6.0. Please use Spree::Product#primary_media instead.')
  primary_media
end

#default_variant ⇒ Spree::Variant

Returns default Variant for Product If ‘track_inventory_levels` is enabled it will try to find the first Variant in stock or backorderable, if there’s none it will return first Variant sorted by ‘position` attribute If `track_inventory_levels` is disabled it will return first Variant sorted by `position` attribute

Returns:



363
364
365
366
367
368
369
 
# File 'app/models/spree/product.rb', line 363

def default_variant
  @default_variant ||= if Spree::Config[:track_inventory_levels] && has_variants? && available_variant = variants.detect(&:purchasable?)
                         available_variant
                       else
                         has_variants? ? variants.first : find_or_build_master
                       end
end

#default_variant_id ⇒ Integer

Returns default Variant ID for Product

Returns:

  • (Integer) 


373
374
375
 
# File 'app/models/spree/product.rb', line 373

def default_variant_id
  @default_variant_id ||= default_variant.id
end

#digital? ⇒ Boolean

Check if the product is digital by checking if any of its shipping methods are digital delivery This is used to determine if the product is digital and should have a digital delivery price instead of a physical shipping price

Returns:



624
625
626
 
# File 'app/models/spree/product.rb', line 624

def digital?
  @digital ||= shipping_category&.includes_digital_shipping_method?
end

#discontinue! ⇒ Object 



522
523
524
525
526
 
# File 'app/models/spree/product.rb', line 522

def discontinue!
  self.discontinue_on = Time.current
  self.status = 'archived'
  save(validate: false)
end

#discontinued? ⇒ Boolean

Returns:



528
529
530
 
# File 'app/models/spree/product.rb', line 528

def discontinued?
  !!discontinue_on && discontinue_on <= Time.current
end

#duplicate ⇒ Object

for adding products which are closely related to existing ones define “duplicate_extra” for site-specific actions, eg for additional fields



511
512
513
 
# File 'app/models/spree/product.rb', line 511

def duplicate
  Products::Duplicator.call(product: self)
end

#ensure_option_types_exist_for_values_hash ⇒ Object

Ensures option_types and product_option_types exist for keys in option_values_hash



498
499
500
501
502
503
504
505
506
507
 
# File 'app/models/spree/product.rb', line 498

def ensure_option_types_exist_for_values_hash
  return if option_values_hash.nil?

  # we need to convert the keys to string to make it work with UUIDs
  required_option_type_ids = option_values_hash.keys.map(&:to_s)
  missing_option_type_ids = required_option_type_ids - option_type_ids.map(&:to_s)
  missing_option_type_ids.each do |id|
    product_option_types.create(option_type_id: id)
  end
end

#featured_image ⇒ Object

Deprecated.

Use #primary_media instead.



412
413
414
415
 
# File 'app/models/spree/product.rb', line 412

def featured_image
  Spree::Deprecation.warn('Spree::Product#featured_image is deprecated and will be removed in Spree 6.0. Please use Spree::Product#primary_media instead.')
  primary_media
end

#find_or_build_master ⇒ Object 



342
343
344
 
# File 'app/models/spree/product.rb', line 342

def find_or_build_master
  master || build_master
end

#find_variant_with_images ⇒ Spree::Variant?

Finds first variant with media using preloaded data when available.

Returns:



444
445
446
447
448
 
# File 'app/models/spree/product.rb', line 444

def find_variant_with_images
  return variants.find(&:has_media?) if variants.loaded?

  variants.joins(:images).first
end

#first_available_variant(currency) ⇒ Object 



475
476
477
 
# File 'app/models/spree/product.rb', line 475

def first_available_variant(currency)
  variants.find { |v| v.purchasable? && v.price_in(currency).amount.present? }
end

#first_or_default_variant(currency) ⇒ Object 



465
466
467
468
469
470
471
472
473
 
# File 'app/models/spree/product.rb', line 465

def first_or_default_variant(currency)
  if !has_variants?
    default_variant
  elsif first_available_variant(currency).present?
    first_available_variant(currency)
  else
    variants.first
  end
end

#gallery_media ⇒ ActiveRecord::Relation

Returns the product’s media gallery. Uses product-level media if present, otherwise falls back to variant images.

Returns:

  • (ActiveRecord::Relation) 


380
381
382
383
384
 
# File 'app/models/spree/product.rb', line 380

def gallery_media
  return media if association(:media).loaded? ? media.any? : media.exists?

  variant_images
end

#has_media? ⇒ Boolean Also known as: has_images?, has_variant_images?

Returns true if the product has any media (product-level or variant-level). Uses counter cache for performance.

Returns:



389
390
391
392
393
 
# File 'app/models/spree/product.rb', line 389

def has_media?
  return variant_images.any? if association(:variant_images).loaded?

  media_count.positive?
end

#has_variants? ⇒ Boolean

Checks if product has variants (non-master variants) Uses variant_count counter cache for performance

Returns:



349
350
351
352
353
 
# File 'app/models/spree/product.rb', line 349

def has_variants?
  return variants.size.positive? if variants.loaded?

  variant_count.positive?
end

#image_count ⇒ Object

Deprecated.

Use media_count instead



430
431
432
 
# File 'app/models/spree/product.rb', line 430

def image_count
  media_count
end

#in_stock? ⇒ Boolean

Can’t use short form block syntax due to github.com/Netflix/fast_jsonapi/issues/259

Returns:



329
330
331
 
# File 'app/models/spree/product.rb', line 329

def in_stock?
  @in_stock ||= default_variant.in_stock? || variants.any?(&:in_stock?)
end

#lowest_price(currency) ⇒ Object

returns the lowest price for the product in the given currency prices_including_master are usually already loaded, so this should not trigger an extra query



493
494
495
 
# File 'app/models/spree/product.rb', line 493

def lowest_price(currency)
  prices_including_master.find_all { |p| p.currency == currency }.min_by(&:amount)
end

#main_taxon ⇒ Object 



599
600
601
602
603
 
# File 'app/models/spree/product.rb', line 599

def main_taxon
  return if classification_count.zero?

  @main_taxon ||= taxons.first
end

#master ⇒ Object

Master variant may be deleted (i.e. when the product is deleted) which would make AR’s default finder return nil. This is a stopgap for that little problem.



573
574
575
 
# File 'app/models/spree/product.rb', line 573

def master
  super || variants_including_master.with_deleted.find_by(is_master: true)
end

#media=(media_params) ⇒ void

This method returns an undefined value.

Sync media inline. Entries with ‘id` patch the existing asset (alt/position/variant_ids); entries with `signed_id` create + attach a fresh upload; missing items are left alone (delete still goes through the dedicated DELETE /media endpoint to avoid accidental data loss when a form ships stale state).

Deferred: ActiveStorage attaches require a persisted record, so on new records we stash the params and replay them in ‘after_create`.

Parameters:

  • media_params (Array<Hash>) 


231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'app/models/spree/product.rb', line 231

def media=(media_params)
  # Blank input is a no-op — never call `super` with an empty array,
  # because the ActiveRecord collection setter would replace media with
  # `[]` and trigger `dependent: :destroy` on every persisted asset.
  # Explicit deletes go through the dedicated DELETE /media endpoint.
  return if media_params.blank?
  return super if media_params.first.is_a?(Spree::Asset)

  if new_record?
    @pending_media_params = media_params
    return
  end

  apply_media(media_params)
end

#on_sale?(currency) ⇒ Boolean

Returns:



338
339
340
 
# File 'app/models/spree/product.rb', line 338

def on_sale?(currency)
  prices_including_master.find_all { |p| p.currency == currency }.any?(&:discounted?)
end

#price_varies?(currency) ⇒ Boolean

Returns:



479
480
481
 
# File 'app/models/spree/product.rb', line 479

def price_varies?(currency)
  prices_including_master.find_all { |p| p.currency == currency && p.amount.present? }.map(&:amount).uniq.count > 1
end

#prices=(prices_params) ⇒ Object

Sets prices on the master variant. Accepts array of { currency:, amount:, compare_at_amount: } hashes.



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

def prices=(prices_params)
  find_or_build_master.prices = prices_params
end

#primary_image ⇒ Object

Deprecated.

Use #primary_media instead.



418
419
420
421
 
# File 'app/models/spree/product.rb', line 418

def primary_image
  Spree::Deprecation.warn('Spree::Product#primary_image is deprecated and will be removed in Spree 6.0. Please use Spree::Product#primary_media instead.')
  primary_media
end

#purchasable? ⇒ Boolean

Can’t use short form block syntax due to github.com/Netflix/fast_jsonapi/issues/259

Returns:



324
325
326
 
# File 'app/models/spree/product.rb', line 324

def purchasable?
  @purchasable ||= default_variant.purchasable? || variants.any?(&:purchasable?)
end

#secondary_image ⇒ Spree::Asset?

Returns secondary media for Product (for hover effects).

Returns:



425
426
427
 
# File 'app/models/spree/product.rb', line 425

def secondary_image
  variant_for_images&.secondary_image
end

#storefront_description ⇒ String

Returns the short description for the product

Returns:

  • (String) 


452
453
454
 
# File 'app/models/spree/product.rb', line 452

def storefront_description
  description
end

#tags=(tags) ⇒ Object

Maps tags array to tag_list for API convenience.

Parameters:

  • tags (Array<String>) 


203
204
205
 
# File 'app/models/spree/product.rb', line 203

def tags=(tags)
  self.tag_list = tags
end

#tax_category ⇒ Spree::TaxCategory?

Returns tax category for Product

Returns:



458
459
460
 
# File 'app/models/spree/product.rb', line 458

def tax_category
  @tax_category ||= super || TaxCategory.default
end

#taxons_for_store(store) ⇒ Object 



605
606
607
608
609
 
# File 'app/models/spree/product.rb', line 605

def taxons_for_store(store)
  return if classification_count.zero?

  taxons.loaded? ? taxons.find_all { |taxon| taxon.taxonomy.store_id == store.id } : taxons.for_store(store)
end

#to_csv(store = nil) ⇒ Object 



636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'app/models/spree/product.rb', line 636

def to_csv(store = nil)
  store ||= self.store
  properties_for_csv = if respond_to?(:product_properties) && Spree::Config.respond_to?(:product_properties_enabled) && Spree::Config[:product_properties_enabled]
                         Spree::Property.order(:position).flat_map do |property|
                           [
                             property.name,
                             product_properties.find { |pp| pp.property_id == property.id }&.value
                           ]
                         end
                       else
                         []
                       end
  metafields_for_csv ||= Spree::MetafieldDefinition.for_resource_type('Spree::Product').order(:namespace, :key).map do |mf_def|
    metafields.find { |mf| mf.metafield_definition_id == mf_def.id }&.csv_value
  end
  taxons_for_csv ||= taxons.manual.reorder(depth: :desc).first(3).pluck(:pretty_name)
  taxons_for_csv.fill(nil, taxons_for_csv.size...3)

  csv_lines = []
  all_variants = has_variants? ? variants_including_master.to_a : [master]
  default_currency = store.default_currency
  additional_currencies = store.supported_currencies_list.map(&:iso_code) - [default_currency]

  # Primary rows in the store's default currency
  all_variants.each_with_index do |variant, index|
    csv_lines << Spree::CSV::ProductVariantPresenter.new(self, variant, index, properties_for_csv, taxons_for_csv, store,
                                                         metafields_for_csv).call
  end

  # Price-only rows for each additional currency
  additional_currencies.each do |currency|
    all_variants.each do |variant|
      next unless variant.amount_in(currency)

      csv_lines << Spree::CSV::ProductVariantPresenter.new(self, variant, 0, [], [], store,
                                                           [], currency).call
    end
  end

  csv_lines
end

#to_translation_csv(store = nil, locales = []) ⇒ Object 



678
679
680
681
682
683
684
685
686
687
 
# File 'app/models/spree/product.rb', line 678

def to_translation_csv(store = nil, locales = [])
  locales.filter_map do |locale|
    # Only export if at least one field has a translation for this locale
    has_translation = Spree::CSV::ProductTranslationPresenter::TRANSLATABLE_FIELDS.any? do |field|
      get_field_with_locale(locale, field).present?
    end

    Spree::CSV::ProductTranslationPresenter.new(self, locale).call if has_translation
  end
end

#total_on_hand ⇒ Object 



558
559
560
561
562
563
564
565
566
567
568
 
# File 'app/models/spree/product.rb', line 558

def total_on_hand
  @total_on_hand ||= if any_variants_not_track_inventory?
                       BigDecimal::INFINITY
                     else
                       if variants_including_master.loaded?
                         variants_including_master.sum(&:total_on_hand)
                       else
                         stock_items.loaded? ? stock_items.sum(&:count_on_hand) : stock_items.sum(:count_on_hand)
                       end
                     end
end

#update_thumbnail! ⇒ Object

Updates primary_media_id to the first media item. Checks product-level media first, then falls back to variant images. Called when media is added, removed, or reordered.



437
438
439
440
 
# File 'app/models/spree/product.rb', line 437

def update_thumbnail!
  first_media = media.order(:position).first || variant_images.order(:position).first
  update_column(:primary_media_id, first_media&.id)
end

#variant_for_images ⇒ Spree::Variant?

Returns the variant that should be used for displaying images. Priority: master > default_variant > first variant with images

Returns:



401
402
403
 
# File 'app/models/spree/product.rb', line 401

def variant_for_images
  @variant_for_images ||= find_variant_for_images
end

#variants=(variants_params) ⇒ void

This method returns an undefined value.

Syncs variants from an array of hashes. Creates new variants, updates existing ones (matched by :id), and removes unlisted ones. Must be called on a persisted product (use after_save or call explicitly after create).

Parameters:

  • variants_params (Array<Hash>) —

    array of variant attribute hashes



252
253
254
255
256
257
258
259
260
261
262
 
# File 'app/models/spree/product.rb', line 252

def variants=(variants_params)
  return super if variants_params.blank? || variants_params.first.is_a?(Spree::Variant)

  # Store for deferred processing if product is not yet persisted
  if new_record?
    @pending_variants_params = variants_params
    return
  end

  apply_variants(variants_params)
end

#variants_and_option_values(current_currency = nil) ⇒ Object

Suitable for displaying only variants that has at least one option value. There may be scenarios where an option type is removed and along with it all option values. At that point all variants associated with only those values should not be displayed to frontend users. Otherwise it breaks the idea of having variants



554
555
556
 
# File 'app/models/spree/product.rb', line 554

def variants_and_option_values(current_currency = nil)
  variants.active(current_currency).joins(:option_value_variants)
end