spree_frontend 4.1.0 → 4.7.0

data/app/controllers/spree/store_controller.rb

@@ -1,25 +1,38 @@
 module Spree
-  class StoreController < Spree::BaseController
+  class StoreController < ApplicationController
+    include Spree::Core::ControllerHelpers::Auth
+    include Spree::Core::ControllerHelpers::Search
+    include Spree::Core::ControllerHelpers::Store
+    include Spree::Core::ControllerHelpers::StrongParameters
+    include Spree::Core::ControllerHelpers::Locale
+    include Spree::Core::ControllerHelpers::Currency
     include Spree::Core::ControllerHelpers::Order
+    include Spree::LocaleUrls
 
-    skip_before_action :verify_authenticity_token, only: :ensure_cart, raise: false
+    respond_to :html
 
-    def forbidden
-      render 'spree/shared/forbidden', layout: Spree::Config[:layout], status: 403
-    end
+    layout :get_layout
 
-    def unauthorized
-      render 'spree/shared/unauthorized', layout: Spree::Config[:layout], status: 401
-    end
+    helper 'spree/base'
+    helper 'spree/locale'
+    helper 'spree/currency'
+
+    helper_method :title
+    helper_method :title=
+    helper_method :accurate_title
+
+    skip_before_action :verify_authenticity_token, only: :ensure_cart, raise: false
+
+    before_action :redirect_to_default_locale
 
     def account_link
       render partial: 'spree/shared/link_to_account'
-      fresh_when(try_spree_current_user)
+      fresh_when(etag: [try_spree_current_user, I18n.locale])
     end
 
     def cart_link
       render partial: 'spree/shared/link_to_cart'
-      fresh_when(simple_current_order)
+      fresh_when(etag: [simple_current_order, I18n.locale])
     end
 
     def api_tokens
@@ -35,20 +48,72 @@ module Spree
 
     protected
 
+    # can be used in views as well as controllers.
+    # e.g. <% self.title = 'This is a custom title for this view' %>
+    attr_writer :title
+
+    def title
+      title_string = @title.present? ? @title : accurate_title
+      if title_string.present?
+        if Spree::Frontend::Config[:always_put_site_name_in_title] && !title_string.include?(default_title)
+          [title_string, default_title].join(" #{Spree::Frontend::Config[:title_site_name_separator]} ")
+        else
+          title_string
+        end
+      else
+        default_title
+      end
+    end
+
+    def default_title
+      current_store.name
+    end
+
+    # this is a hook for subclasses to provide title
+    def accurate_title
+      current_store.seo_title
+    end
+
     def config_locale
       Spree::Frontend::Config[:locale]
     end
 
+    # Returns which layout to render.
+    #
+    # You can set the layout you want to render inside your Spree configuration with the +:layout+ option.
+    #
+    # Default layout is: +app/views/spree/layouts/spree_application+
+    #
+    def get_layout
+      layout ||= Spree::Frontend::Config[:layout]
+    end
+
     def store_etag
       [
         current_store,
         current_currency,
-        config_locale
-      ]
+        I18n.locale,
+        try_spree_current_user.present?,
+        try_spree_current_user.try(:has_spree_role?, 'admin')
+      ].compact
     end
 
     def store_last_modified
       (current_store.updated_at || Time.current).utc
     end
+
+    def redirect_unauthorized_access
+      if try_spree_current_user
+        flash[:error] = Spree.t(:authorization_failure)
+        redirect_to spree.forbidden_path
+      else
+        store_location
+        if respond_to?(:spree_login_path)
+          redirect_to spree_login_path
+        else
+          redirect_to spree.root_path
+        end
+      end
+    end
   end
 end

data/app/controllers/spree/taxons_controller.rb

@@ -1,22 +1,21 @@
 module Spree
   class TaxonsController < Spree::StoreController
     include Spree::FrontendHelper
+    include Spree::CacheHelper
     helper 'spree/products'
 
     before_action :load_taxon
 
-    respond_to :html
-
     def show
-      if stale?(etag: etag, last_modified: last_modified, public: true)
+      if !http_cache_enabled? || stale?(etag: etag, last_modified: last_modified, public: true)
         load_products
       end
     end
 
     def product_carousel
-      if stale?(etag: carousel_etag, last_modified: last_modified, public: true)
+      if !http_cache_enabled? || stale?(etag: carousel_etag, last_modified: last_modified, public: true)
         load_products
-        if @products.any?
+        if @products.reload.any?
           render template: 'spree/taxons/product_carousel', layout: false
         else
           head :no_content
@@ -31,11 +30,17 @@ module Spree
     end
 
     def load_taxon
-      @taxon = Spree::Taxon.friendly.find(params[:id])
+      @taxon = find_with_fallback_default_locale { current_store.taxons.friendly.find(params[:id]) }
     end
 
     def load_products
-      @searcher = build_searcher(params.merge(taxon: @taxon.id, include_images: true))
+      search_params = params.merge(
+        current_store: current_store,
+        taxon: @taxon,
+        include_images: true
+      )
+
+      @searcher = build_searcher(search_params)
       @products = @searcher.retrieve_products
     end
 
@@ -56,7 +61,10 @@ module Spree
     end
 
     def last_modified
-      @taxon.updated_at&.utc
+      taxon_last_modified = @taxon&.updated_at&.utc
+      current_store_last_modified = current_store.updated_at.utc
+
+      [taxon_last_modified, current_store_last_modified].compact.max
     end
   end
 end

data/app/helpers/spree/addresses_helper.rb

@@ -2,7 +2,7 @@
 module Spree
   module AddressesHelper
     def address_field(form, method, address_id = 'b', &handler)
-      content_tag :p, id: [address_id, method].join, class: 'form-group checkout-content-inner-field' do
+      content_tag :div, id: [address_id, method].join, class: 'form-group checkout-content-inner-field has-float-label' do
         if handler
           yield
         else
@@ -10,28 +10,80 @@ module Spree
           method_name = I18n.t("activerecord.attributes.spree/address.#{method}")
           required = Spree.t(:required)
           form.text_field(method,
-                          class: [is_required ? 'required' : nil, 'spree-flat-input'].compact,
+                          class: ['spree-flat-input'].compact,
                           required: is_required,
-                          placeholder: is_required ? "#{method_name} #{required}" : method_name)
+                          placeholder: is_required ? "#{method_name} #{required}" : method_name,
+                          aria: { label: method_name }) +
+            form.label(method_name,
+                       is_required ? "#{method_name} #{required}" : method_name,
+                       class: 'text-uppercase')
         end
       end
     end
 
-    def address_state(form, country, _address_id = 'b')
-      country ||= Spree::Country.find(Spree::Config[:default_country_id])
+    def address_zipcode(form, country, address_id = 'b')
+      country ||= address_default_country
+      is_required = country.zipcode_required?
+      method_name = Spree.t(:zipcode)
+      required = Spree.t(:required)
+      form.text_field(:zipcode,
+                      class: ['spree-flat-input'].compact,
+                      required: is_required,
+                      placeholder: is_required ? "#{method_name} #{required}" : method_name,
+                      aria: { label: Spree.t(:zipcode) }) +
+        form.label(:zipcode,
+                   is_required ? "#{method_name} #{required}" : method_name,
+                   class: 'text-uppercase',
+                   id: address_id + '_zipcode_label')
+    end
+
+    def address_state(form, country, address_id = 'b')
+      country ||= address_default_country
       have_states = country.states.any?
       state_elements = [
-        form.collection_select(:state_id, country.states.order(:name),
+        form.collection_select(:state_id, checkout_zone_applicable_states_for(country).sort_by(&:name),
                               :id, :name,
-                               { prompt: Spree.t(:state).upcase },
-                               class: have_states ? 'required form-control spree-flat-select' : 'hidden',
+                               { prompt: Spree.t(:state) },
+                               class: ['spree-flat-select'].compact,
+                               aria: { label: Spree.t(:state) },
                                disabled: !have_states) +
-          form.text_field(:state_name, class: !have_states ? 'required' : 'hidden', disabled: have_states) +
-          image_tag('arrow.svg', class: 'position-absolute spree-flat-select-arrow')
+          form.text_field(:state_name,
+                          class: ['spree-flat-input'].compact,
+                          aria: { label: Spree.t(:state) },
+                          disabled: have_states,
+                          placeholder: Spree.t(:state) + " #{Spree.t(:required)}") +
+          form.label(Spree.t(:state).downcase,
+                     raw(Spree.t(:state) + content_tag(:abbr, " #{Spree.t(:required)}")),
+                     class: [have_states ? 'state-select-label' : nil, ' text-uppercase'].compact,
+                     id: address_id + '_state_label') +
+          image_tag('arrow.svg',
+                    class: [!have_states ? 'hidden' : nil, 'position-absolute spree-flat-select-arrow'].compact)
       ].join.tr('"', "'").delete("\n")
 
-      content_tag(:noscript, form.text_field(:state_name, class: 'required')) +
-        javascript_tag("document.write(\"<span class='d-block position-relative'>#{state_elements.html_safe}</span>\");")
+      content_tag :span, class: 'd-block position-relative' do
+        state_elements.html_safe
+      end
+    end
+
+    def user_available_addresses
+      @user_available_addresses ||= begin
+        return [] unless try_spree_current_user
+
+        states = current_store.countries_available_for_checkout.each_with_object([]) do |country, memo|
+          memo << current_store.states_available_for_checkout(country)
+        end.flatten
+
+        try_spree_current_user.addresses.
+          where(country_id: states.pluck(:country_id).uniq)
+      end
+    end
+
+    def checkout_zone_applicable_states_for(country)
+      current_store.states_available_for_checkout(country)
+    end
+
+    def address_default_country
+      @address_default_country ||= current_store.default_country
     end
   end
 end

data/app/helpers/spree/cache_helper.rb

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

data/app/helpers/spree/cms_pages_helper.rb

@@ -0,0 +1,23 @@
+module Spree
+  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 "spree/shared/cms/sections/#{spree_resource_path(section)}", section: section
+      end
+    end
+  end
+end

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,28 @@ module Spree
       @body_class
     end
 
+    def logo(image_path = nil, options = {})
+      logo_attachment = if defined?(Spree::StoreLogo) && current_store.logo.is_a?(Spree::StoreLogo)
+                          current_store.logo.attachment # Spree v5
+                        else
+                          current_store.logo # Spree 4.x
+                        end
+
+      image_path ||= if logo_attachment&.attached? && logo_attachment&.variable?
+                       main_app.cdn_image_url(logo_attachment.variant(resize: '244x104>'))
+                     elsif logo_attachment&.attached? && logo_attachment&.image?
+                       main_app.cdn_image_url(logo_attachment)
+                     else
+                       asset_path('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_breadcrumbs(taxon, _separator = '', product = nil)
       return '' if current_page?('/') || taxon.nil?
 
@@ -51,7 +74,7 @@ module Spree
         ) << 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: 'breadcrumb' })
+      content_tag(:nav, crumb_list, id: 'breadcrumbs', class: 'col-12 mt-1 mt-sm-3 mt-lg-4', aria: { label: Spree.t(:breadcrumbs) })
     end
 
     def class_for(flash_type)
@@ -101,7 +124,8 @@ module Spree
         end
       end
       content = content_tag('ul', raw(items.join("\n")), class: 'nav justify-content-between checkout-progress-steps', id: "checkout-step-#{@order.state}")
-      content << content_tag('div', raw('<hr /><hr /><hr />'), class: "checkout-progress-steps-line state-#{@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 = {})
@@ -136,16 +160,22 @@ 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
 
     def plp_and_carousel_image(product, image_class = '')
       image = default_image_for_product_or_variant(product)
-      image_url = image&.plp_url || asset_path('noimage/plp.png')
+
+      image_url = if image.present?
+                    main_app.cdn_image_url(image.url('plp'))
+                  else
+                    asset_path('noimage/plp.svg')
+                  end
+
       image_style = image&.style(:plp)
 
       lazy_image(
@@ -176,7 +206,7 @@ module Spree
       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}"))
+        file = main_app.cdn_image_url(image.url("plp_and_carousel_#{key}"))
 
         set << "#{file} #{value}w"
       end
@@ -221,7 +251,12 @@ module Spree
     end
 
     def price_filter_values
-      [
+      Spree::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)}",
         "#{formatted_price(101)} - #{formatted_price(150)}",
@@ -230,37 +265,138 @@ module Spree
       ]
     end
 
-    def filtering_params
-      static_filters = %w(keywords price sort_by)
+    def static_filters
+      @static_filters ||= Spree::Frontend::Config[:products_filters]
+    end
+
+    def additional_filters_partials
+      @additional_filters_partials ||= Spree::Frontend::Config[:additional_filters_partials]
+    end
 
-      available_option_types.map(&:filter_param).concat(static_filters)
+    def filtering_params
+      @filtering_params ||= available_option_types.map(&:filter_param).concat(static_filters)
     end
 
     def filtering_params_cache_key
-      params.permit(*filtering_params)&.reject { |_, v| v.blank? }&.to_s
+      @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.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).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)
       return '' if current_store.send(service).blank?
 
-      link_to "https://#{service}.com/#{current_store.send(service)}", target: :blank, rel: 'nofollow noopener' do
-        content_tag :gigure, id: service, class: 'px-2' do
+      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
+    end
+
+    def color_option_type_name
+      @color_option_type_name ||= Spree::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
+
+    def product_wysiwyg_editor_enabled?
+      defined?(Spree::Backend) && Spree::Backend::Config[:product_wysiwyg_editor_enabled]
+    end
+
+    def taxon_wysiwyg_editor_enabled?
+      defined?(Spree::Backend) && Spree::Backend::Config[:taxon_wysiwyg_editor_enabled]
+    end
+
+    # converts line breaks in product description into <p> tags (for html display purposes)
+    def product_description(product)
+      description = if Spree::Frontend::Config[:show_raw_product_description] || product_wysiwyg_editor_enabled?
+                      product.description
+                    else
+                      product.description.to_s.gsub(/(.*?)\r?\n\r?\n/m, '<p>\1</p>')
+                    end
+      description.blank? ? Spree.t(:product_has_no_description) : description
+    end
+
     private
 
     def formatted_price(value)
@@ -277,12 +413,28 @@ module Spree
       end
     end
 
-    def checkout_edit_link(step = 'address')
+    def checkout_edit_link(step = 'address', order = @order)
+      return if order.uneditable?
+
       classes = 'align-text-bottom checkout-confirm-delivery-informations-link'
 
       link_to spree.checkout_state_path(step), class: classes, method: :get do
         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