harpiya_frontend 4.3.0.alpha

data/app/helpers/harpiya/cache_helper.rb

@@ -0,0 +1,7 @@
+module Harpiya
+  module CacheHelper
+    def http_cache_enabled?
+      @http_cache_enabled ||= Harpiya::Frontend::Config[:http_cache_enabled]
+    end
+  end
+end

data/app/helpers/harpiya/cms_pages_helper.rb

@@ -0,0 +1,23 @@
+module Harpiya
+  module CmsPagesHelper
+    def simple_page?(page)
+      page.content.present? && !page.sections?
+    end
+
+    def section_tags(section, &block)
+      inner_content = content_tag(:div, class: section.css_classes , &block)
+
+      if section.fullscreen?
+        inner_content
+      else
+        content_tag(:div, inner_content, class: 'container')
+      end
+    end
+
+    def build_section(section)
+      section_tags(section) do
+        render "harpiya/shared/cms/sections/#{harpiya_resource_path(section)}", section: section
+      end
+    end
+  end
+end

data/app/helpers/harpiya/frontend_helper.rb

@@ -0,0 +1,398 @@
+module Harpiya
+  module FrontendHelper
+    include BaseHelper
+    include InlineSvg::ActionView::Helpers
+
+    def body_class
+      @body_class ||= content_for?(:sidebar) ? 'two-col' : 'one-col'
+      @body_class
+    end
+
+    def harpiya_breadcrumbs(taxon, _separator = '', product = nil)
+      return '' if current_page?('/') || taxon.nil?
+
+      # breadcrumbs for root
+      crumbs = [content_tag(:li, content_tag(
+        :a, content_tag(
+          :span, Harpiya.t(:home), itemprop: 'name'
+        ) << content_tag(:meta, nil, itemprop: 'position', content: '0'), itemprop: 'url', href: harpiya.root_path
+      ) << content_tag(:span, nil, itemprop: 'item', itemscope: 'itemscope', itemtype: 'https://schema.org/Thing', itemid: harpiya.root_path), itemscope: 'itemscope', itemtype: 'https://schema.org/ListItem', itemprop: 'itemListElement', class: 'breadcrumb-item')]
+
+      if taxon
+        ancestors = taxon.ancestors.where.not(parent_id: nil)
+
+        # breadcrumbs for ancestor taxons
+        crumbs << ancestors.each_with_index.map do |ancestor, index|
+          content_tag(:li, content_tag(
+            :a, content_tag(
+              :span, ancestor.name, itemprop: 'name'
+            ) << content_tag(:meta, nil, itemprop: 'position', content: index + 1), itemprop: 'url', href: seo_url(ancestor, params: permitted_product_params)
+          ) << content_tag(:span, nil, itemprop: 'item', itemscope: 'itemscope', itemtype: 'https://schema.org/Thing', itemid: seo_url(ancestor, params: permitted_product_params)), itemscope: 'itemscope', itemtype: 'https://schema.org/ListItem', itemprop: 'itemListElement', class: 'breadcrumb-item')
+        end
+
+        # breadcrumbs for current taxon
+        crumbs << content_tag(:li, content_tag(
+          :a, content_tag(
+            :span, taxon.name, itemprop: 'name'
+          ) << content_tag(:meta, nil, itemprop: 'position', content: ancestors.size + 1), itemprop: 'url', href: seo_url(taxon, params: permitted_product_params)
+        ) << content_tag(:span, nil, itemprop: 'item', itemscope: 'itemscope', itemtype: 'https://schema.org/Thing', itemid: seo_url(taxon, params: permitted_product_params)), itemscope: 'itemscope', itemtype: 'https://schema.org/ListItem', itemprop: 'itemListElement', class: 'breadcrumb-item')
+
+        # breadcrumbs for product
+        if product
+          crumbs << content_tag(:li, content_tag(
+            :span, content_tag(
+              :span, product.name, itemprop: 'name'
+            ) << content_tag(:meta, nil, itemprop: 'position', content: ancestors.size + 2), itemprop: 'url', href: harpiya.product_path(product, taxon_id: taxon&.id)
+          ) << content_tag(:span, nil, itemprop: 'item', itemscope: 'itemscope', itemtype: 'https://schema.org/Thing', itemid: harpiya.product_path(product, taxon_id: taxon&.id)), itemscope: 'itemscope', itemtype: 'https://schema.org/ListItem', itemprop: 'itemListElement', class: 'breadcrumb-item')
+        end
+      else
+        # breadcrumbs for product on PDP
+        crumbs << content_tag(:li, content_tag(
+          :span, Harpiya.t(:products), itemprop: 'item'
+        ) << content_tag(:meta, nil, itemprop: 'position', content: '1'), class: 'active', itemscope: 'itemscope', itemtype: 'https://schema.org/ListItem', itemprop: 'itemListElement')
+      end
+      crumb_list = content_tag(:ol, raw(crumbs.flatten.map(&:mb_chars).join), class: 'breadcrumb', itemscope: 'itemscope', itemtype: 'https://schema.org/BreadcrumbList')
+      content_tag(:nav, crumb_list, id: 'breadcrumbs', class: 'col-12 mt-1 mt-sm-3 mt-lg-4', aria: { label: Harpiya.t(:breadcrumbs) })
+    end
+
+    def class_for(flash_type)
+      {
+        success: 'success',
+        registration_error: 'danger',
+        error: 'danger',
+        alert: 'danger',
+        warning: 'warning',
+        notice: 'success'
+      }[flash_type.to_sym]
+    end
+
+    def checkout_progress(numbers: false)
+      states = @order.checkout_steps - ['complete']
+      items = states.each_with_index.map do |state, i|
+        text = Harpiya.t("order_state.#{state}").titleize
+        text.prepend("#{i.succ}. ") if numbers
+
+        css_classes = ['text-uppercase nav-item']
+        current_index = states.index(@order.state)
+        state_index = states.index(state)
+
+        if state_index < current_index
+          css_classes << 'completed'
+          link_content = content_tag :span, nil, class: 'checkout-progress-steps-image checkout-progress-steps-image--full'
+          link_content << text
+          text = link_to(link_content, harpiya.checkout_state_path(state), class: 'd-flex flex-column align-items-center', method: :get)
+        end
+
+        css_classes << 'next' if state_index == current_index + 1
+        css_classes << 'active' if state == @order.state
+        css_classes << 'first' if state_index == 0
+        css_classes << 'last' if state_index == states.length - 1
+        # No more joined classes. IE6 is not a target browser.
+        # Hack: Stops <a> being wrapped round previous items twice.
+        if state_index < current_index
+          content_tag('li', text, class: css_classes.join(' '))
+        else
+          link_content = if state == @order.state
+                           content_tag :span, nil, class: 'checkout-progress-steps-image checkout-progress-steps-image--full'
+                         else
+                           inline_svg_tag 'circle.svg', class: 'checkout-progress-steps-image'
+                         end
+          link_content << text
+          content_tag('li', content_tag('a', link_content, class: "d-flex flex-column align-items-center #{'active' if state == @order.state}"), class: css_classes.join(' '))
+        end
+      end
+      content = content_tag('ul', raw(items.join("\n")), class: 'nav justify-content-between checkout-progress-steps', id: "checkout-step-#{@order.state}")
+      hrs = '<hr />' * (states.length - 1)
+      content << content_tag('div', raw(hrs), class: "checkout-progress-steps-line state-#{@order.state}")
+    end
+
+    def flash_messages(opts = {})
+      flashes = ''
+      excluded_types = opts[:excluded_types].to_a.map(&:to_s)
+
+      flash.to_h.except('order_completed').each do |msg_type, text|
+        next if msg_type.blank? || excluded_types.include?(msg_type)
+
+        flashes << content_tag(:div, class: "alert alert-#{class_for(msg_type)} mb-0") do
+          content_tag(:button, '&times;'.html_safe, class: 'close', data: { dismiss: 'alert', hidden: true }) +
+            content_tag(:span, text)
+        end
+      end
+      flashes.html_safe
+    end
+
+    def link_to_cart(text = nil)
+      text = text ? h(text) : Harpiya.t('cart')
+      css_class = nil
+
+      if simple_current_order.nil? || simple_current_order.item_count.zero?
+        text = "<span class='glyphicon glyphicon-shopping-cart'></span> #{text}: (#{Harpiya.t('empty')})"
+        css_class = 'empty'
+      else
+        text = "<span class='glyphicon glyphicon-shopping-cart'></span> #{text}: (#{simple_current_order.item_count})
+                <span class='amount'>#{simple_current_order.display_total.to_html}</span>"
+        css_class = 'full'
+      end
+
+      link_to text.html_safe, harpiya.cart_path, class: "cart-info nav-link #{css_class}"
+    end
+
+    def asset_exists?(path)
+      if Rails.configuration.assets.compile
+        Rails.application.precompiled_assets.include? path
+      else
+        Rails.application.assets_manifest.assets[path].present?
+      end
+    end
+
+    def plp_and_carousel_image(product, image_class = '')
+      image = default_image_for_product_or_variant(product)
+
+      image_url = if image.present?
+                    main_app.url_for(image.url('plp'))
+                  else
+                    asset_path('noimage/plp.svg')
+                  end
+
+      image_style = image&.style(:plp)
+
+      lazy_image(
+        src: image_url,
+        srcset: carousel_image_source_set(image),
+        alt: product.name,
+        width: image_style&.dig(:width) || 278,
+        height: image_style&.dig(:height) || 371,
+        class: "product-component-image d-block mw-100 #{image_class}"
+      )
+    end
+
+    def lazy_image(src:, alt:, width:, height:, srcset: '', **options)
+      # We need placeholder image with the correct size to prevent page from jumping
+      placeholder = "data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%20#{width}%20#{height}'%3E%3C/svg%3E"
+
+      image_tag placeholder, data: { src: src, srcset: srcset }, class: "#{options[:class]} lazyload", alt: alt
+    end
+
+    def permitted_product_params
+      product_filters = available_option_types.map(&:name)
+      params.permit(product_filters << :sort_by)
+    end
+
+    def carousel_image_source_set(image)
+      return '' unless image
+
+      widths = { lg: 1200, md: 992, sm: 768, xs: 576 }
+      set = []
+      widths.each do |key, value|
+        file = main_app.url_for(image.url("plp_and_carousel_#{key}"))
+
+        set << "#{file} #{value}w"
+      end
+      set.join(', ')
+    end
+
+    def image_source_set(name)
+      widths = {
+        desktop: '1200',
+        tablet_landscape: '992',
+        tablet_portrait: '768',
+        mobile: '576'
+      }
+      set = []
+      widths.each do |key, value|
+        filename = key == :desktop ? name : "#{name}_#{key}"
+        file = asset_path("#{filename}.jpg")
+
+        set << "#{file} #{value}w"
+      end
+      set.join(', ')
+    end
+
+    def taxons_tree(root_taxon, current_taxon, max_level = 1)
+      return '' if max_level < 1 || root_taxon.leaf?
+
+      content_tag :div, class: 'list-group' do
+        taxons = root_taxon.children.map do |taxon|
+          css_class = current_taxon&.self_and_ancestors&.include?(taxon) ? 'list-group-item list-group-item-action active' : 'list-group-item list-group-item-action'
+          link_to(taxon.name, seo_url(taxon), class: css_class) + taxons_tree(taxon, current_taxon, max_level - 1)
+        end
+        safe_join(taxons, "\n")
+      end
+    end
+
+    def set_image_alt(image)
+      return image.alt if image.alt.present?
+    end
+
+    def icon(name:, classes: '', width:, height:)
+      inline_svg_tag "#{name}.svg", class: "harpiya-icon #{classes}", size: "#{width}px*#{height}px"
+    end
+
+    def price_filter_values
+      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+        `FrontendHelper#price_filter_values` is deprecated and will be removed in Harpiya 5.0.
+        Please use `ProductsFiltersHelper#price_filters` method
+      DEPRECATION
+
+      @price_filter_values ||= [
+        "#{I18n.t('activerecord.attributes.harpiya/product.less_than')} #{formatted_price(50)}",
+        "#{formatted_price(50)} - #{formatted_price(100)}",
+        "#{formatted_price(101)} - #{formatted_price(150)}",
+        "#{formatted_price(151)} - #{formatted_price(200)}",
+        "#{formatted_price(201)} - #{formatted_price(300)}"
+      ]
+    end
+
+    def static_filters
+      @static_filters ||= Harpiya::Frontend::Config[:products_filters]
+    end
+
+    def additional_filters_partials
+      @additional_filters_partials ||= Harpiya::Frontend::Config[:additional_filters_partials]
+    end
+
+    def filtering_params
+      @filtering_params ||= available_option_types.map(&:filter_param).concat(static_filters)
+    end
+
+    def filtering_params_cache_key
+      @filtering_params_cache_key ||= begin
+        cache_key_parts = []
+
+        permitted_products_params.each do |key, value|
+          next if value.blank?
+
+          if value.is_a?(String)
+            cache_key_parts << [key, value].join('-')
+          else
+            value.each do |part_key, part_value|
+              next if part_value.blank?
+
+              cache_key_parts << [part_key, part_value].join('-')
+            end
+          end
+        end
+
+        cache_key_parts.join('-').parameterize
+      end
+    end
+
+    def filters_cache_key(kind)
+      base_cache_key + [
+        kind,
+        available_option_types_cache_key,
+        available_properties_cache_key,
+        filtering_params_cache_key,
+        @taxon&.id,
+        params[:menu_open]
+      ].flatten
+    end
+
+    def permitted_products_params
+      @permitted_products_params ||= begin
+        params.permit(*filtering_params, properties: available_properties.map(&:filter_param))
+      end
+    end
+
+    def option_type_cache_key(option_type)
+      filter_param = option_type.filter_param
+      filtered_params = params[filter_param]
+
+      [
+        available_option_types_cache_key,
+        filter_param,
+        filtered_params
+      ]
+    end
+
+    def available_option_types_cache_key
+      @available_option_types_cache_key ||= [
+        Harpiya::OptionType.filterable.maximum(:updated_at).to_f,
+        products_for_filters_cache_key
+      ].flatten.join('/')
+    end
+
+    def available_option_types
+      @available_option_types ||= Rails.cache.fetch("available-option-types/#{available_option_types_cache_key}") do
+        option_values = OptionValues::FindAvailable.new(products_scope: products_for_filters).execute
+        Filters::OptionsPresenter.new(option_values_scope: option_values).to_a
+      end
+    end
+
+    def available_properties_cache_key
+      @available_properties_cache_key ||= [
+        Harpiya::Property.filterable.maximum(:updated_at).to_f,
+        products_for_filters_cache_key
+      ].flatten.join('/')
+    end
+
+    def available_properties
+      @available_properties ||= Rails.cache.fetch("available-properties/#{available_properties_cache_key}") do
+        product_properties = ProductProperties::FindAvailable.new(products_scope: products_for_filters).execute
+        Filters::PropertiesPresenter.new(product_properties_scope: product_properties).to_a
+      end
+    end
+
+    def harpiya_social_link(service)
+      return '' if current_store.send(service).blank?
+
+      link_to "https://#{service}.com/#{current_store.send(service)}", target: :blank, rel: 'nofollow noopener', 'aria-label': service do
+        content_tag :figure, id: service, class: 'px-2' do
+          icon(name: service, width: 22, height: 22)
+        end
+      end
+    end
+
+    def checkout_available_payment_methods
+      @checkout_available_payment_methods ||= @order.available_payment_methods(current_store)
+    end
+
+    def color_option_type_name
+      @color_option_type_name ||= Harpiya::OptionType.color&.name
+    end
+
+    def country_flag_icon(country_iso_code = nil)
+      return if country_iso_code.blank?
+
+      content_tag :span, nil, class: "flag-icon flag-icon-#{country_iso_code.downcase}"
+    end
+
+    private
+
+    def formatted_price(value)
+      Harpiya::Money.new(value, currency: current_currency, no_cents_if_whole: true).to_s
+    end
+
+    def credit_card_icon(type)
+      available_icons = %w[visa american_express diners_club discover jcb maestro master]
+
+      if available_icons.include?(type)
+        image_tag "credit_cards/icons/#{type}.svg", class: 'payment-sources-list-item-image'
+      else
+        image_tag 'credit_cards/icons/generic.svg', class: 'payment-sources-list-item-image'
+      end
+    end
+
+    def checkout_edit_link(step = 'address', order = @order)
+      return if order.uneditable?
+
+      classes = 'align-text-bottom checkout-confirm-delivery-informations-link'
+
+      link_to harpiya.checkout_state_path(step), class: classes, method: :get do
+        inline_svg_tag 'edit.svg'
+      end
+    end
+
+    def products_for_filters
+      Product.for_filters(current_currency, taxon: @taxon, store: current_store)
+    end
+
+    def products_for_filters_cache_key
+      [
+        products_for_filters.maximum(:updated_at).to_f,
+        base_cache_key,
+        @taxon&.permalink
+      ].flatten.compact
+    end
+  end
+end

data/app/helpers/harpiya/navigation_helper.rb

@@ -0,0 +1,112 @@
+require 'digest'
+
+module Harpiya
+  module NavigationHelper
+    def harpiya_navigation_data
+      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+        NavigationHelper#harpiya_navigation_data is deprecated and will be removed in Harpiya 5.0.
+        Please migrate to the new navigation cms system.
+      DEPRECATION
+
+      @harpiya_navigation_data ||= HarpiyaStorefrontConfig.dig(I18n.locale,
+                                                           :navigation) || HarpiyaStorefrontConfig.dig(current_store.code,
+                                                                                                     :navigation) || HarpiyaStorefrontConfig.dig(
+                                                                                                       :default, :navigation
+                                                                                                     ) || []
+    # safeguard for older Harpiya installs that don't have harpiya_navigation initializer
+    # or harpiya.yml file present
+    rescue StandardError
+      []
+    end
+
+    def harpiya_nav_cache_key(section = 'header')
+      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+        NavigationHelper#harpiya_nav_cache_key is deprecated and will be removed in Harpiya 5.0.
+        Please migrate to the new navigation cms system.
+      DEPRECATION
+
+      @harpiya_nav_cache_key = begin
+        keys = base_cache_key + [current_store, harpiya_navigation_data_cache_key, Harpiya::Config[:logo], stores&.cache_key_with_version, section]
+        Digest::MD5.hexdigest(keys.join('-'))
+      end
+    end
+
+    def harpiya_menu_cache_key(section = 'header')
+      keys = base_cache_key + [
+        current_store.cache_key_with_version,
+        harpiya_menu(section)&.cache_key_with_version,
+        Harpiya::Config[:logo],
+        stores&.maximum(:updated_at),
+        section
+      ]
+      Digest::MD5.hexdigest(keys.join('-'))
+    end
+
+    def main_nav_image(image_path, title = '')
+      image_url = asset_path(asset_exists?(image_path) ? image_path : 'noimage/plp.svg')
+
+      lazy_image(
+        src: image_url,
+        alt: title,
+        width: 350,
+        height: 234
+      )
+    end
+
+    def harpiya_menu(location = 'header')
+      method_name = "for_#{location}"
+
+      if available_menus.respond_to?(method_name) && Harpiya::Menu::MENU_LOCATIONS_PARAMETERIZED.include?(location)
+        available_menus.send(method_name, I18n.locale) || current_store.default_menu(location)
+      end
+    end
+
+    def harpiya_localized_link(item)
+      return if item.link.nil?
+
+      output_locale = if locale_param
+                        "/#{I18n.locale}"
+                      end
+
+      if Harpiya::MenuItem::DYNAMIC_RESOURCE_TYPE.include? item.linked_resource_type
+        output_locale.to_s + item.link
+      elsif item.linked_resource_type == 'Home Page'
+        "/#{locale_param}"
+      else
+        item.link
+      end
+    end
+
+    def should_render_internationalization_dropdown?
+      (defined?(should_render_locale_dropdown?) && should_render_locale_dropdown?) ||
+        (defined?(should_render_currency_dropdown?) && should_render_currency_dropdown?)
+    end
+
+    def harpiya_nav_link_tag(item, opts = {}, &block)
+      if item.new_window
+        target = opts[:target] || '_blank'
+        rel = opts[:rel] || 'noopener noreferrer'
+      end
+
+      active_class = if request && current_page?(harpiya_localized_link(item))
+                       "active #{opts[:class]}"
+                     else
+                       opts[:class]
+                     end
+
+      link_opts = { target: target, rel: rel, class: active_class, id: opts[:id], data: opts[:data], aria: opts[:aria] }
+
+      if block_given?
+        link_to harpiya_localized_link(item), link_opts, &block
+      else
+        link_to item.name, harpiya_localized_link(item), link_opts
+      end
+    end
+
+    private
+
+    def harpiya_navigation_data_cache_key
+      @harpiya_navigation_data_cache_key ||= Digest::MD5.hexdigest(harpiya_navigation_data.to_s)
+    end
+  end
+end