Module: Spree::ProductsHelper

Defined in:
app/helpers/spree/products_helper.rb

Instance Method Summary collapse

Instance Method Details

#cache_key_for_products ⇒ String

Returns a cache invalidation key for products.

Returns:

  • (String) —

    a cache invalidation key for products



69
70
71
72
73
 
# File 'app/helpers/spree/products_helper.rb', line 69

def cache_key_for_products
  count = @products.count
  max_updated_at = (@products.maximum(:updated_at) || Date.today).to_fs(:number)
  "#{I18n.locale}/#{current_pricing_options.cache_key}/spree/products/all-#{params[:page]}-#{max_updated_at}-#{count}"
end

#line_item_description_text(description_text) ⇒ String

Filters and truncates the given description.

Parameters:

  • description_text (String) —

    the text to filter

Returns:

  • (String) —

    the filtered text



60
61
62
63
64
65
66
 
# File 'app/helpers/spree/products_helper.rb', line 60

def line_item_description_text(description_text)
  if description_text.present?
    truncate(strip_tags(description_text.gsub(' ', ' ')), length: 100)
  else
    t('spree.product_has_no_description')
  end
end

#product_description(product) ⇒ String

Converts line breaks in product description into <p> tags.

Parameters:

  • product (Spree::Product) —

    the product whose description you want to filter

Returns:

  • (String) —

    the generated HTML



48
49
50
51
52
53
54
 
# File 'app/helpers/spree/products_helper.rb', line 48

def product_description(product)
  if Spree::Config[:show_raw_product_description]
    raw(product.description)
  else
    raw(product.description.gsub(/(.*?)\r?\n\r?\n/m, '<p>\1</p>'))
  end
end

#variant_full_price(variant) ⇒ Spree::Money

Returns the formatted full price for the variant, if at least one variant price differs from product price.

Parameters:

Returns:



36
37
38
39
40
41
42
 
# File 'app/helpers/spree/products_helper.rb', line 36

def variant_full_price(variant)
  return if variant.product.variants
              .with_prices(current_pricing_options)
              .all? { |variant_with_prices| variant_with_prices.price_same_as_master?(current_pricing_options) }

  variant.price_for_options(current_pricing_options)&.money&.to_html
end

#variant_price(variant) ⇒ Spree::Money

Returns the formatted price for the specified variant as a full price or a difference depending on configuration

Parameters:

Returns:



10
11
12
13
14
15
16
 
# File 'app/helpers/spree/products_helper.rb', line 10

def variant_price(variant)
  if Spree::Config[:show_variant_full_price]
    variant_full_price(variant)
  else
    variant_price_diff(variant)
  end
end

#variant_price_diff(variant) ⇒ String

Returns the formatted price for the specified variant as a difference from product price

Parameters:

Returns:

  • (String) —

    formatted string with label and amount



23
24
25
26
27
28
29
 
# File 'app/helpers/spree/products_helper.rb', line 23

def variant_price_diff(variant)
  return if variant.price_same_as_master?(current_pricing_options)
  difference = variant.price_difference_from_master(current_pricing_options)
  absolute_amount = Spree::Money.new(difference.to_d.abs, currency: difference.currency.iso_code)
  i18n_key = difference.to_d > 0 ? :price_diff_add_html : :price_diff_subtract_html
  t(i18n_key, scope: [:spree, :helpers, :products], amount_html: absolute_amount.to_html)
end