core/app/helpers/spree/base_helper.rb
module Spree
module BaseHelper
def available_countries
countries = current_store.countries_available_for_checkout
countries.collect do |country|
country.name = Spree.t(country.iso, scope: 'country_names', default: country.name)
country
end.sort_by { |c| c.name.parameterize }
end
def all_countries
countries = Spree::Country.all
countries.collect do |country|
country.name = Spree.t(country.iso, scope: 'country_names', default: country.name)
country
end.sort_by { |c| c.name.parameterize }
end
def spree_resource_path(resource)
last_word = resource.class.name.split('::', 10).last
spree_class_name_as_path(last_word)
end
def spree_class_name_as_path(class_name)
class_name.underscore.humanize.parameterize(separator: '_')
end
def display_price(product_or_variant)
product_or_variant.
price_in(current_currency).
display_price_including_vat_for(current_price_options).
to_html
end
def display_compare_at_price(product_or_variant)
product_or_variant.
price_in(current_currency).
display_compare_at_price_including_vat_for(current_price_options).
to_html
end
def link_to_tracking(shipment, options = {})
return unless shipment.tracking && shipment.shipping_method
options[:target] ||= :blank
if shipment.tracking_url
link_to(shipment.tracking, shipment.tracking_url, options)
else
content_tag(:span, shipment.tracking)
end
end
def logo(image_path = nil, options = {})
Spree::Deprecation.warn(<<-DEPRECATION, caller)
`BaseHelper#logo` is deprecated and will be removed in Spree 5.0.
Please use `FrontendHelper#logo` instead
DEPRECATION
image_path ||= if current_store.logo.attached? && current_store.logo.variable?
main_app.cdn_image_url(current_store.logo.variant(resize_to_limit: [244, 104]))
elsif current_store.logo.attached? && current_store.logo.image?
main_app.cdn_image_url(current_store.logo)
else
'logo/spree_50.png'
end
path = spree.respond_to?(:root_path) ? spree.root_path : main_app.root_path
link_to path, 'aria-label': current_store.name, method: options[:method] do
image_tag image_path, alt: current_store.name, title: current_store.name
end
end
def spree_favicon_path
if current_store.favicon.present?
main_app.cdn_image_url(current_store.favicon)
else
url_for('favicon.ico')
end
end
def object
instance_variable_get('@' + controller_name.singularize)
end
def og_meta_data
og_meta = {}
if object.is_a? Spree::Product
image = default_image_for_product_or_variant(object)
og_meta['og:image'] = main_app.cdn_image_url(image.attachment) if image&.attachment
og_meta['og:url'] = spree.url_for(object) if frontend_available? # url_for product needed
og_meta['og:type'] = object.class.name.demodulize.downcase
og_meta['og:title'] = object.name
og_meta['og:description'] = object.description
price = object.price_in(current_currency)
if price
og_meta['product:price:amount'] = price.amount
og_meta['product:price:currency'] = current_currency
end
end
og_meta
end
def meta_data
meta = {}
if object.is_a? ApplicationRecord
meta[:keywords] = object.meta_keywords if object.try(:meta_keywords).present?
meta[:description] = object.meta_description if object.try(:meta_description).present?
end
if meta[:description].blank? && object.is_a?(Spree::Product)
meta[:description] = truncate(strip_tags(object.description), length: 160, separator: ' ')
end
if meta[:keywords].blank? || meta[:description].blank?
if object && object[:name].present?
meta.reverse_merge!(keywords: [object.name, current_store.meta_keywords].reject(&:blank?).join(', '),
description: [object.name, current_store.meta_description].reject(&:blank?).join(', '))
else
meta.reverse_merge!(keywords: (current_store.meta_keywords || current_store.seo_title),
description: (current_store.homepage(I18n.locale)&.seo_meta_description || current_store.seo_meta_description))
end
end
meta
end
def og_meta_data_tags
og_meta_data.map do |property, content|
tag('meta', property: property, content: content) unless property.nil? || content.nil?
end.join("\n")
end
def meta_data_tags
meta_data.map do |name, content|
tag('meta', name: name, content: content) unless name.nil? || content.nil?
end.join("\n")
end
def method_missing(method_name, *args, &block)
if image_style = image_style_from_method_name(method_name)
define_image_method(image_style)
send(method_name, *args)
else
super
end
end
def pretty_time(time)
return '' if time.blank?
[I18n.l(time.to_date, format: :long), time.strftime('%l:%M %p %Z')].join(' ')
end
def pretty_date(date)
return '' if date.blank?
[I18n.l(date.to_date, format: :long)].join(' ')
end
def seo_url(taxon, options = {})
spree.nested_taxons_path(taxon.permalink, options.merge(locale: locale_param))
end
def frontend_available?
Spree::Core::Engine.frontend_available?
end
def spree_storefront_resource_url(resource, options = {})
if defined?(locale_param) && locale_param.present?
options.merge!(locale: locale_param)
end
localize = if options[:locale].present?
"/#{options[:locale]}"
else
''
end
if resource.instance_of?(Spree::Product)
"#{current_store.formatted_url + localize}/#{Spree::Config[:storefront_products_path]}/#{resource.slug}"
elsif resource.instance_of?(Spree::Taxon)
"#{current_store.formatted_url + localize}/#{Spree::Config[:storefront_taxons_path]}/#{resource.permalink}"
elsif resource.instance_of?(Spree::Cms::Pages::FeaturePage) || resource.instance_of?(Spree::Cms::Pages::StandardPage)
"#{current_store.formatted_url + localize}/#{Spree::Config[:storefront_pages_path]}/#{resource.slug}"
elsif localize.blank?
current_store.formatted_url
else
current_store.formatted_url + localize
end
end
# we should always try to render image of the default variant
# same as it's done on PDP
def default_image_for_product(product)
if product.images.any?
product.images.first
elsif product.default_variant.images.any?
product.default_variant.images.first
elsif product.variant_images.any?
product.variant_images.first
end
end
def default_image_for_product_or_variant(product_or_variant)
Rails.cache.fetch("spree/default-image/#{product_or_variant.cache_key_with_version}") do
if product_or_variant.is_a?(Spree::Product)
default_image_for_product(product_or_variant)
elsif product_or_variant.is_a?(Spree::Variant)
if product_or_variant.images.any?
product_or_variant.images.first
else
default_image_for_product(product_or_variant.product)
end
end
end
end
def base_cache_key
[I18n.locale, current_currency, defined?(try_spree_current_user) && try_spree_current_user.present?,
defined?(try_spree_current_user) && try_spree_current_user.try(:has_spree_role?, 'admin')]
end
def maximum_quantity
Spree::DatabaseTypeUtilities.maximum_value_for(:integer)
end
private
def create_product_image_tag(image, product, options, style)
options[:alt] = image.alt.blank? ? product.name : image.alt
image_tag main_app.cdn_image_url(image.url(style)), options
end
def define_image_method(style)
self.class.send :define_method, "#{style}_image" do |product, *options|
options = options.first || {}
options[:alt] ||= product.name
image_path = default_image_for_product_or_variant(product)
img = if image_path.present?
create_product_image_tag image_path, product, options, style
else
inline_svg_tag 'noimage/backend-missing-image.svg', class: 'noimage', size: '60%*60%'
end
content_tag(:div, img, class: "admin-product-image-container #{style}-img")
end
end
# Returns style of image or nil
def image_style_from_method_name(method_name)
if method_name.to_s.match(/_image$/) && style = method_name.to_s.sub(/_image$/, '')
style if style.in? Spree::Image.styles.with_indifferent_access
end
end
def meta_robots
return unless current_store.respond_to?(:seo_robots)
return if current_store.seo_robots.blank?
tag('meta', name: 'robots', content: current_store.seo_robots)
end
end
end