spree_frontend 4.2.3.1 → 4.3.0.rc2

data/app/helpers/spree/frontend_helper.rb

@@ -1,5 +1,6 @@
 module Spree
   module FrontendHelper
+    include BaseHelper
     include InlineSvg::ActionView::Helpers
 
     def body_class
@@ -7,6 +8,22 @@ module Spree
       @body_class
     end
 
+    def logo(image_path = nil, options = {})
+      image_path ||= if current_store.logo.attached? && current_store.logo.variable?
+                       main_app.url_for(current_store.logo.variant(resize: '244x104>'))
+                     elsif current_store.logo.attached? && current_store.logo.image?
+                       main_app.url_for(current_store.logo)
+                     else
+                       Spree::Config[:logo]
+                     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_breadcrumbs(taxon, _separator = '', product = nil)
       return '' if current_page?('/') || taxon.nil?
 
@@ -137,10 +154,10 @@ module Spree
     end
 
     def asset_exists?(path)
-      if Rails.env.production?
-        Rails.application.assets_manifest.find_sources(path).present?
+      if Rails.configuration.assets.compile
+        Rails.application.precompiled_assets.include? path
       else
-        Rails.application.assets.find_asset(path).present?
+        Rails.application.assets_manifest.assets[path].present?
       end
     end
 
@@ -150,7 +167,7 @@ module Spree
       image_url = if image.present?
                     main_app.url_for(image.url('plp'))
                   else
-                    asset_path('noimage/plp.png')
+                    asset_path('noimage/plp.svg')
                   end
 
       image_style = image&.style(:plp)
@@ -228,6 +245,11 @@ module Spree
     end
 
     def price_filter_values
+      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+        `FrontendHelper#price_filter_values` is deprecated and will be removed in Spree 5.0.
+        Please use `ProductsFiltersHelper#price_filters` method
+      DEPRECATION
+
       @price_filter_values ||= [
         "#{I18n.t('activerecord.attributes.spree/product.less_than')} #{formatted_price(50)}",
         "#{formatted_price(50)} - #{formatted_price(100)}",
@@ -250,18 +272,81 @@ module Spree
     end
 
     def filtering_params_cache_key
-      @filtering_params_cache_key ||= params.permit(*filtering_params)&.reject { |_, v| v.blank? }&.to_param
+      @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 ||= Spree::OptionType.filterable.maximum(:updated_at)&.utc&.to_i
+      @available_option_types_cache_key ||= [
+        Spree::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
-        Spree::OptionType.includes(:option_values).filterable.to_a
+        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 ||= [
+        Spree::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
-      @available_option_types
     end
 
     def spree_social_link(service)
@@ -275,7 +360,7 @@ module Spree
     end
 
     def checkout_available_payment_methods
-      @checkout_available_payment_methods ||= @order.available_payment_methods(current_store)
+      @checkout_available_payment_methods ||= @order.available_payment_methods
     end
 
     def color_option_type_name
@@ -305,7 +390,7 @@ module Spree
     end
 
     def checkout_edit_link(step = 'address', order = @order)
-      return if order.complete?
+      return if order.uneditable?
 
       classes = 'align-text-bottom checkout-confirm-delivery-informations-link'
 
@@ -313,5 +398,19 @@ module Spree
         inline_svg_tag 'edit.svg'
       end
     end
+
+    def products_for_filters
+      @products_for_filters ||= current_store.products.for_filters(current_currency, taxon: @taxon)
+    end
+
+    def products_for_filters_cache_key
+      @products_for_filters_cache_key ||= begin
+        [
+          products_for_filters.maximum(:updated_at).to_f,
+          base_cache_key,
+          @taxon&.permalink
+        ].flatten.compact
+      end
+    end
   end
 end

data/app/helpers/spree/navigation_helper.rb

@@ -3,22 +3,46 @@ require 'digest'
 module Spree
   module NavigationHelper
     def spree_navigation_data
-      @spree_navigation_data ||= SpreeStorefrontConfig.dig(I18n.locale, :navigation) || SpreeStorefrontConfig.dig(current_store.code, :navigation) || SpreeStorefrontConfig.dig(:default, :navigation) || []
+      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+        NavigationHelper#spree_navigation_data is deprecated and will be removed in Spree 5.0.
+        Please migrate to the new navigation cms system.
+      DEPRECATION
+
+      @spree_navigation_data ||= SpreeStorefrontConfig.dig(I18n.locale,
+                                                           :navigation) || SpreeStorefrontConfig.dig(current_store.code,
+                                                                                                     :navigation) || SpreeStorefrontConfig.dig(
+                                                                                                       :default, :navigation
+                                                                                                     ) || []
     # safeguard for older Spree installs that don't have spree_navigation initializer
     # or spree.yml file present
-    rescue
+    rescue StandardError
       []
     end
 
     def spree_nav_cache_key(section = 'header')
+      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+        NavigationHelper#spree_nav_cache_key is deprecated and will be removed in Spree 5.0.
+        Please migrate to the new navigation cms system.
+      DEPRECATION
+
       @spree_nav_cache_key = begin
-        keys = base_cache_key + [current_store, spree_navigation_data_cache_key, Spree::Config[:logo], stores&.cache_key, section]
+        keys = base_cache_key + [current_store, spree_navigation_data_cache_key, Spree::Config[:logo], stores&.cache_key_with_version, section]
         Digest::MD5.hexdigest(keys.join('-'))
       end
     end
 
+    def spree_menu_cache_key(section = 'header')
+      keys = base_cache_key + [
+        current_store.cache_key_with_version,
+        spree_menu(section)&.cache_key_with_version,
+        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.png')
+      image_url = asset_path(asset_exists?(image_path) ? image_path : 'noimage/plp.svg')
 
       lazy_image(
         src: image_url,
@@ -28,11 +52,56 @@ module Spree
       )
     end
 
+    def spree_menu(location = 'header')
+      method_name = "for_#{location}"
+
+      if available_menus.respond_to?(method_name) && Spree::Menu::MENU_LOCATIONS_PARAMETERIZED.include?(location)
+        available_menus.send(method_name, I18n.locale) || current_store.default_menu(location)
+      end
+    end
+
+    def spree_localized_link(item)
+      return if item.link.nil?
+
+      output_locale = if locale_param
+                        "/#{I18n.locale}"
+                      end
+
+      if Spree::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 spree_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?(spree_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 spree_localized_link(item), link_opts, &block
+      else
+        link_to item.name, spree_localized_link(item), link_opts
+      end
+    end
+
     private
 
     def spree_navigation_data_cache_key

data/app/helpers/spree/products_filters_helper.rb

@@ -0,0 +1,168 @@
+module Spree
+  module ProductsFiltersHelper
+    PRICE_FILTER_NAME = 'price'.freeze
+
+    FILTER_LINK_CSS_CLASSES = 'd-inline-block text-uppercase py-1 px-2 m-1 plp-overlay-card-item'.freeze
+    ACTIVE_FILTER_LINK_CSS_CLASSES = 'plp-overlay-card-item--selected'.freeze
+
+    CLEAR_ALL_FILTERS_LINK_CSS_CLASSES = 'btn spree-btn btn-outline-primary w-100 mb-4'.freeze
+
+    def price_filters
+      @price_filters ||= [
+        filters_less_than_price_range(50),
+        filters_price_range(50, 100),
+        filters_price_range(101, 150),
+        filters_price_range(151, 200),
+        filters_price_range(201, 300),
+        filters_more_than_price_range(300)
+      ]
+    end
+
+    def min_price_filter_input(**html_options)
+      price_filter_input(
+        name: :min_price,
+        value: filters_price_range_from_param.min_price.to_i,
+        placeholder: "#{currency_symbol(current_currency)} #{Spree.t(:min)}",
+        **html_options
+      )
+    end
+
+    def max_price_filter_input(**html_options)
+      price_filter_input(
+        name: :max_price,
+        value: filters_price_range_from_param.max_price.to_i,
+        placeholder: "#{currency_symbol(current_currency)} #{Spree.t(:max)}",
+        **html_options
+      )
+    end
+
+    def price_filter_input(name:, value:, placeholder:, **html_options)
+      price_value = value&.zero? ? '' : value
+      style_class = "spree-flat-input #{html_options[:class]}"
+
+      number_field_tag(
+        name, price_value,
+        id: name,
+        class: style_class,
+        min: 0, step: 1, placeholder: placeholder,
+        **html_options.except(:class)
+      )
+    end
+
+    def option_value_filter_link(option_value, permitted_params, opts = {})
+      id = option_value.id
+      ot_downcase_name = option_value.option_type.filter_param
+      selected_option_values = params[ot_downcase_name]&.split(',')&.map(&:to_i) || []
+      is_selected = selected_option_values.include?(id)
+      option_value_param = (is_selected ? selected_option_values - [id] : selected_option_values + [id]).join(',')
+      new_params = permitted_params.merge(ot_downcase_name => option_value_param, menu_open: 1)
+
+      link_to new_params, data: { params: new_params, id: id, filter_name: ot_downcase_name, multiselect: true } do
+        # TODO: refactor this
+        if color_option_type_name.present? && color_option_type_name.downcase == ot_downcase_name
+          content_tag :span, class: 'd-inline-block mb-1' do
+            render partial: 'spree/shared/color_select', locals: {
+              color: option_value.presentation,
+              selected: is_selected
+            }
+          end
+        else
+          filter_content_tag(option_value.name, opts.merge(is_selected: is_selected))
+        end
+      end
+    end
+
+    def property_value_filter_link(property, value, permitted_params, opts = {})
+      id = value.first
+      name = value.last
+
+      selected_properties = params.dig(:properties, property.filter_param)&.split(',') || []
+      is_selected = selected_properties.include?(id)
+      property_values = (is_selected ? selected_properties - [id] : selected_properties + [id])
+      url = permitted_params.merge(properties: { property.filter_param => property_values }, menu_open: 1)
+      filter_name = "properties[#{property.filter_param}]"
+      new_params = permitted_params.merge(filter_name => property_values, menu_open: 1)
+
+      base_filter_link(url, name, opts.merge(params: new_params, is_selected: is_selected, filter_name: filter_name, id: id, multiselect: true))
+    end
+
+    def price_filter_link(price_range, permitted_params, opts = {})
+      is_selected = params[:price] == price_range.to_param
+      price_param = is_selected ? '' : price_range.to_param
+      url = permitted_params.merge(price: price_param, menu_open: 1)
+
+      opts[:is_selected] ||= is_selected
+
+      content_tag :div do
+        base_filter_link(url, price_range, opts.merge(is_selected: is_selected, filter_name: PRICE_FILTER_NAME, id: price_param))
+      end
+    end
+
+    def product_filters_present?(permitted_params)
+      properties = permitted_params.fetch(:properties, {}).to_unsafe_h
+      flatten_params = permitted_params.to_h.merge(properties)
+
+      flatten_params.any? { |name, value| product_filter_present?(name, value) }
+    end
+
+    def clear_all_filters_link(permitted_params, opts = {})
+      opts[:css_class] ||= CLEAR_ALL_FILTERS_LINK_CSS_CLASSES
+      sort_by_param = permitted_params.slice(:sort_by)
+
+      link_to Spree.t('plp.clear_all'), sort_by_param, class: opts[:css_class], data: { params: sort_by_param }
+    end
+
+    private
+
+    def product_filter_present?(filter_param, filter_value)
+      filter_param.in?(product_filters_params) && filter_value.present?
+    end
+
+    def product_filters_params
+      options_filter_params = OptionType.filterable.map(&:filter_param)
+      properties_filter_params = Property.filterable.pluck(:filter_param)
+
+      options_filter_params + properties_filter_params + [PRICE_FILTER_NAME]
+    end
+
+    def base_filter_link(url, label, opts = {})
+      opts[:params] ||= url
+
+      link_to url, data: { filter_name: opts[:filter_name], id: opts[:id], params: opts[:params], multiselect: opts[:multiselect] } do
+        filter_content_tag(label, opts)
+      end
+    end
+
+    def filter_content_tag(label, opts = {})
+      opts[:css_class]        ||= FILTER_LINK_CSS_CLASSES
+      opts[:css_active_class] ||= ACTIVE_FILTER_LINK_CSS_CLASSES
+
+      content_tag :div, class: "#{opts[:css_class]} #{opts[:css_active_class] if opts[:is_selected]}" do
+        label.to_s
+      end
+    end
+
+    def filters_price_range_from_param
+      Filters::PriceRangePresenter.from_param(params[:price].to_s, currency: current_currency)
+    end
+
+    def filters_price_range(min_amount, max_amount)
+      Filters::PriceRangePresenter.new(
+        min_price: filters_price(min_amount),
+        max_price: filters_price(max_amount)
+      )
+    end
+
+    def filters_less_than_price_range(amount)
+      Filters::QuantifiedPriceRangePresenter.new(price: filters_price(amount), quantifier: :less_than)
+    end
+
+    def filters_more_than_price_range(amount)
+      Filters::QuantifiedPriceRangePresenter.new(price: filters_price(amount), quantifier: :more_than)
+    end
+
+    def filters_price(amount)
+      Filters::PricePresenter.new(amount: amount, currency: current_currency)
+    end
+  end
+end