spree_storefront 5.0.4 → 5.1.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2558511bde3c23461f7d59985b314ea15d992912d29ba2566ce9d057b6a8cff2
-  data.tar.gz: 99bff2e39e457da5b2bec3fab6ab64b5953128bae0b2a42945c19e16d2b682f3
+  metadata.gz: c8bc38aa5cb40c780c3a1fa2f20d1672b4f95986c66261a1833f725a417fb15b
+  data.tar.gz: 4a04f0367d6c4fd8b53a56a1eb3e7f635c4af6c116751367952e4a6153544c4a
 SHA512:
-  metadata.gz: 709743a94e95bed8ef6a542231843103f60bf7699c610da106d96cd73178fe8a354eeeed5960d71349319ab77ee2915e11e97ec6efd12642f0af3d5af96175a5
-  data.tar.gz: bf929b7256f749ce99590d6f293326f157e2489700411d25e513a9ec0c4359d1352519fb1e1dea0cedfb6881771085e634af4b25b8f012ee4dbee474bd2e81f5
+  metadata.gz: befdf20cbbb63756d6f026ffe47502daa56ffbd3db39048a98c3b9a2d1303e2f08475036004e3bd61f123fce1f05ce53d3d710d520a1a569b2daeb263d573ecd
+  data.tar.gz: c78e23552f955bbe171d2db49d883027002a2f7eb0b5532689819ae64b6595f05dcc4df76e0a95e3e88cf1f93e6497cc26666ac8c5a9b3c333cb414fe8983a8f

data/app/controllers/concerns/spree/locale_urls.rb

@@ -21,7 +21,19 @@ module Spree
     def redirect_to_default_locale
       return if params[:locale].blank? || supported_locale?(params[:locale])
 
-      redirect_to url_for(request.parameters.merge(locale: nil))
+      # Only include safe parameters in the redirect
+      safe_params = {
+        controller: params[:controller],
+        action: params[:action],
+        locale: nil
+      }
+
+      # Add any additional safe parameters that should be preserved
+      %i[id format currency category_id tag].each do |param|
+        safe_params[param] = params[param] if params[param].present?
+      end
+
+      redirect_to url_for(safe_params)
     end
   end
 end

data/app/controllers/concerns/spree/storefront/devise_concern.rb

@@ -0,0 +1,42 @@
+# This concern is used to include the necessary methods and helpers for the Devise controllers
+# It is used to avoid repeating the same code in each controller
+module Spree
+  module Storefront
+    module DeviseConcern
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :title
+        helper_method :stored_location
+        layout 'spree/storefront'
+
+        include Spree::Core::ControllerHelpers::Order
+        include Spree::LocaleUrls
+        include Spree::ThemeConcern
+        include Spree::IntegrationsHelper if defined?(Spree::IntegrationsHelper)
+
+        helper 'spree/wishlist'
+        helper 'spree/currency'
+        helper 'spree/locale'
+        helper 'spree/storefront_locale'
+        helper 'spree/integrations' if defined?(Spree::IntegrationsHelper)
+      end
+
+      def stored_location
+        return unless defined?(after_sign_in_path_for)
+        return unless defined?(store_location_for)
+        return unless defined?(Devise)
+
+        path = after_sign_in_path_for(Devise.mappings.keys.first)
+
+        store_location_for(Devise.mappings.keys.first, path)
+
+        path
+      end
+
+      def password_path(_resource_or_scope = nil)
+        send("#{Spree.user_class.model_name.singular_route_key}_password_path")
+      end
+    end
+  end
+end

data/app/controllers/spree/addresses_controller.rb

@@ -26,6 +26,8 @@ module Spree
         else
           redirect_to spree.account_addresses_path, notice: Spree.t('address_book.successfully_created')
         end
+      elsif params[:from_modal].present?
+        render turbo_stream: turbo_stream.update(:new_address_modal, partial: 'spree/account/addresses/new_address_modal', locals: { address: @address }), status: :unprocessable_entity
       else
         render action: 'new', status: :unprocessable_entity
       end
@@ -67,8 +69,10 @@ module Spree
             format.html { redirect_to spree.checkout_state_path(@order.token, 'address') }
           end
         else
-          redirect_back_or_default(spree.account_addresses_path)
+          redirect_back(fallback_location: spree.account_addresses_path)
         end
+      elsif params[:from_modal].present?
+        render turbo_stream: turbo_stream.update("edit_address_modal_#{@address.id}", partial: 'spree/account/addresses/edit_address_modal', locals: { address: @address }), status: :unprocessable_entity
       else
         render :edit, status: :unprocessable_entity
       end

data/app/controllers/spree/checkout_controller.rb

@@ -14,6 +14,7 @@ module Spree
 
     before_action :ensure_order_not_completed, only: [:edit, :update]
     before_action :ensure_checkout_allowed
+    before_action :check_if_checkout_started, only: :edit
     before_action :ensure_valid_state, only: [:edit, :update]
 
     before_action :restart_checkout, only: :edit, if: :should_restart_checkout?
@@ -33,13 +34,6 @@ module Spree
 
     # GET /checkout/<token>
     def edit
-      if checkout_started?
-        track_checkout_started
-
-        @order.accept_marketing = true # TODO: move this to store preferences
-        @order.signup_for_an_account = true # TODO: move this to store preferences
-      end
-
       track_checkout_step_viewed
     end
 
@@ -179,8 +173,23 @@ module Spree
           flash[:error] = 'You cannot access this checkout'
           redirect_to_cart
         elsif try_spree_current_user.nil? && !@order.completed?
-          store_location
-          redirect_to spree_login_path
+          if params[:guest] && current_store.prefers_guest_checkout?
+            @order = current_store.
+                       orders.
+                       create!(current_order_params.except(:token, :user_id)).
+                       tap do |order|
+              order.merge!(@order, discard_merged: false)
+              order.disassociate_user!
+            end
+
+            reset_session
+            cookies.permanent.signed[:token] = @order.token
+
+            redirect_to spree.checkout_path(@order.token)
+          else
+            store_location
+            redirect_to spree_login_path
+          end
         end
       end
 
@@ -227,6 +236,15 @@ module Spree
       end
     end
 
+    def check_if_checkout_started
+      if checkout_started?
+        track_checkout_started
+
+        @order.accept_marketing = true # TODO: move this to store preferences
+        @order.signup_for_an_account = true # TODO: move this to store preferences
+      end
+    end
+
     def ensure_valid_state
       redirect_to_state(correct_state) if @order.state != correct_state && !skip_state_validation?
     end

data/app/controllers/spree/contacts_controller.rb

@@ -40,7 +40,7 @@ module Spree
       return if current_store.customer_support_email.present?
 
       flash[:error] = Spree.t('storefront.contacts.customer_support_email_not_configured')
-      redirect_back_or_default root_path
+      redirect_back(fallback_location: root_path)
     end
   end
 end

data/app/controllers/spree/products_controller.rb

@@ -77,9 +77,7 @@ module Spree
       # If an old id or a numeric id was used to find the record,
       # we should do a 301 redirect that uses the current friendly id.
       if params[:id] != @product.friendly_id
-        params[:id] = @product.friendly_id
-        params.permit!
-        redirect_to url_for(params), status: :moved_permanently
+        redirect_to spree.product_path(@product), status: :moved_permanently
       end
     end
 

data/app/controllers/spree/store_controller.rb

@@ -8,6 +8,7 @@ module Spree
     include Spree::PasswordProtected
     include Spree::WishlistHelper
     include Spree::AnalyticsHelper
+    include Spree::IntegrationsHelper
 
     layout :choose_layout
 
@@ -17,6 +18,7 @@ module Spree
     helper 'spree/currency'
     helper 'spree/addresses'
     helper 'spree/wishlist'
+    helper 'spree/integrations'
 
     helper_method :title
     helper_method :title=
@@ -28,6 +30,8 @@ module Spree
                   :storefront_products_scope, :storefront_products,
                   :default_products_sort, :default_products_finder_params
 
+    helper_method :stored_location
+
     before_action :redirect_to_default_locale
     before_action :render_404_if_store_not_exists
     rescue_from ActionController::InvalidAuthenticityToken, with: :invalid_authenticity_token
@@ -69,7 +73,10 @@ module Spree
           :out_of_stock,
           {
             options: [store_filter_names_hash],
-            taxon_ids: []
+            taxon_ids: [],
+            taxonomy_ids: [
+              taxon_ids: []
+            ]
           }
         ]
       )
@@ -191,7 +198,8 @@ module Spree
     end
 
     def redirect_back_or_default(default)
-      redirect_to(session[:user_return_to] || default)
+      Spree::Deprecation.warn('redirect_back_or_default is deprecated and will be removed in Spree 5.2. Please use redirect_back(fallback_location: default) instead.')
+      redirect_back(fallback_location: default)
     end
 
     def require_user(return_to = nil)
@@ -205,16 +213,15 @@ module Spree
       end
     end
 
-    # this will work for devise out of the box
-    # for other auth systems you will need to override this method
-    def store_location(location = nil)
-      return if try_spree_current_user
-      return unless defined?(store_location_for)
+    def stored_location
+      return unless defined?(after_sign_in_path_for)
       return unless defined?(Devise)
 
-      location ||= request.fullpath
+      path = after_sign_in_path_for(Devise.mappings.keys.first)
+
+      store_location(path)
 
-      store_location_for(Devise.mappings.keys.first, location)
+      path
     end
 
     def redirect_to_cart

data/app/controllers/spree/taxons_controller.rb

@@ -33,9 +33,7 @@ module Spree
       # If an old id or a numeric id was used to find the record,
       # we should do a 301 redirect that uses the current friendly id.
       if params[:id] != @taxon.friendly_id
-        params[:id] = @taxon.friendly_id
-        params.permit!
-        redirect_to url_for(params), status: :moved_permanently
+        redirect_to spree.nested_taxons_path(@taxon), status: :moved_permanently
       end
     end
 

data/app/helpers/spree/analytics_helper.rb

@@ -2,7 +2,7 @@ module Spree
   module AnalyticsHelper
     def analytics_event_handlers
       @analytics_event_handlers ||= Spree::Analytics.event_handlers.map do |handler|
-        handler.new(user: try_spree_current_user, session: session, request: request)
+        handler.new(user: try_spree_current_user, session: session, request: request, store: Spree::Store.current, visitor_id: visitor_id)
       end
     end
 
@@ -16,11 +16,15 @@ module Spree
     rescue => e
       Rails.error.report(
         e,
-        context: { event_name: event_name, record_id: record&.id, record_type: record&.class&.name },
+        context: { event_name: event_name, record: record },
         source: 'spree.storefront'
       )
     end
 
+    def visitor_id
+      session[:spree_visitor_token] ||= SecureRandom.uuid
+    end
+
     def unsupported_event?(event_name)
       !Spree::Analytics.events.key?(event_name.to_sym)
     end

data/app/helpers/spree/checkout_analytics_helper.rb

@@ -68,7 +68,7 @@ module Spree
 
     def track_checkout_completed
       # server-side tracking
-      track_event('checkout_completed', { order: @order })
+      track_event('order_completed', { order: @order })
 
       # client-side tracking
       session[:checkout_completed] = true

data/app/helpers/spree/checkout_helper.rb

@@ -33,7 +33,7 @@ module Spree
     end
 
     def checkout_started?
-      @order.state == 'address' && @order.state_was == 'cart'
+      (@order.state == 'address' && @order.state_was == 'cart') || (@order.state == 'cart' && correct_state == 'address')
     end
 
     def already_have_an_account?

data/app/helpers/spree/filters_helper.rb

@@ -92,7 +92,7 @@ module Spree
     end
 
     def storefront_products_for_taxon_filters
-      @storefront_products_for_taxon_filters ||= products_for_filters_scope(except_filters: [:taxons])
+      @storefront_products_for_taxon_filters ||= products_for_filters_scope(except_filters: [:taxons, :taxonomy_ids])
     end
 
     def filter_taxon_ids

data/app/helpers/spree/page_helper.rb

@@ -1,5 +1,13 @@
 module Spree
   module PageHelper
+    # Renders the page with the current theme (or theme preview) and page preview if it exists.
+    # It fetches all page sections and renders them one by one in the order they are set in the page builder by store staff.
+    # It also handles lazy loading of sections.
+    #
+    # @param page [Spree::Page] the page to render
+    # @param variables [Hash] variables to pass to the page sections
+    # @option variables [Array] :pickup_locations ([]) the pickup locations to pass to the page sections
+    # @return [String] the rendered page
     def render_page(page = nil, variables = {})
       page ||= current_page
 
@@ -11,6 +19,12 @@ module Spree
       "<main class='page-contents'>#{sections_html}</main>".html_safe
     end
 
+    # Renders a single section of the page.
+    #
+    # @param section [Spree::PageSection] the section to render
+    # @param variables [Hash] variables to pass to the section
+    # @option variables [Boolean] :lazy_allowed (true) whether lazy loading is allowed for the section (if it supports it)
+    # @return [String] the rendered section
     def render_section(section, variables = {}, lazy_allowed: true)
       return '' if section.blank?
 
@@ -54,6 +68,7 @@ module Spree
       ''
     end
 
+    # Renders a link to the page builder for the given link.
     def page_builder_link_to(link, options = {}, &block)
       if link.present?
         link_to(spree_storefront_resource_url(link.linkable || link), options.except(:label)) do

data/app/helpers/spree/products_helper.rb

@@ -21,11 +21,15 @@ module Spree
     end
 
     def weeks_online(product)
+      Spree::Deprecation.warn('weeks_online is deprecated and will be removed in Spree 5.2')
+
       (Time.current - product.activated_at.in_time_zone(current_store.preferred_timezone)).seconds.in_weeks.to_i.abs
     end
 
     def brand_name(product)
-      product.brand&.name || product.vendor&.display_name
+      Spree::Deprecation.warn('brand_name is deprecated and will be removed in Spree 5.2. Please use `product.brand_name` instead.')
+
+      product.brand&.name || product.try(:vendor)&.display_name
     end
 
     def product_not_selected_options(product, selected_variant, options_param_name: :options)
@@ -152,6 +156,10 @@ module Spree
       product.main_taxon.self_and_ancestors.find_all { |taxon| taxon.depth != 0 }
     end
 
+    # Generates the JSON-LD elements for a list of products.
+    #
+    # @param product_slugs [Array<String>] The slugs of the products to generate elements for
+    # @return [Array<Hash>] The JSON-LD elements
     def product_list_json_ld_elements(product_slugs)
       product_slugs.each_with_index.map do |product_slug, index|
         {
@@ -162,6 +170,10 @@ module Spree
       end
     end
 
+    # Generates the JSON-LD breadcrumbs for a product.
+    #
+    # @param product [Spree::Product] The product to generate breadcrumbs for
+    # @return [Hash] The JSON-LD breadcrumbs
     def product_json_ld_breadcrumbs(product)
       json_ld = {
         '@context' => 'https://schema.org',

data/app/helpers/spree/storefront_helper.rb

@@ -3,12 +3,20 @@ module Spree
     include BaseHelper
     include Heroicon::Engine.helpers
 
+    # Renders the storefront partials for the given section.
+    #
+    # @param section [String] The section to render
+    # @param options [Hash] The options/variables to pass to the partials
+    # @return [String] The rendered partials
     def render_storefront_partials(section, options = {})
       Rails.application.config.spree_storefront.send(section).map do |partial|
         render partial, options
       end.join.html_safe
     end
 
+    # Returns the page description for the current page.
+    #
+    # @return [String] The page description
     def page_description
       return @page_description if @page_description.present?
 
@@ -23,6 +31,10 @@ module Spree
       @page_description
     end
 
+    # Returns the page image for the current page.
+    # This is used for SEO, social media and Open Graph tags.
+    #
+    # @return [String] The page image
     def page_image
       return @page_image if @page_image.present?
 

data/app/helpers/spree/storefront_locale_helper.rb

@@ -1,5 +1,8 @@
 module Spree
   module StorefrontLocaleHelper
+    # Returns the currently selected locale.
+    #
+    # @return [String] The currently selected locale
     def current_locale
       @current_locale ||= if user_locale?
                             try_spree_current_user.selected_locale

data/app/helpers/spree/theme_helper.rb

@@ -1,9 +1,16 @@
 module Spree
   module ThemeHelper
+    # Returns the current page, if not found it will fallback to the homepage
+    #
+    # @return [Spree::Page] the current page
     def current_page
       @current_page ||= current_theme.pages.find_by(type: 'Spree::Pages::Homepage')
     end
 
+    # Returns the current theme, if not found it will fallback to the default theme
+    # If `theme_id` is provided in the params, it will return the theme with the given id
+    #
+    # @return [Spree::Theme] the current theme
     def current_theme
       @current_theme ||= if params[:theme_id].present?
                            current_store.themes.find_by(id: params[:theme_id])
@@ -14,34 +21,56 @@ module Spree
       @current_theme ||= current_store.themes.first
     end
 
+    # Returns the current theme preview
+    #
+    # @return [Spree::ThemePreview] the current theme preview
     def current_theme_preview
       return if params[:theme_preview_id].blank?
 
       @current_theme_preview ||= current_theme.previews.find_by(id: params[:theme_preview_id])
     end
 
+    # Returns the current page preview
+    #
+    # @return [Spree::PagePreview] the current page preview
     def current_page_preview
       return if params[:page_preview_id].blank?
 
       @current_page_preview ||= current_page.previews.find_by(id: params[:page_preview_id])
     end
 
+    # Returns the current page or page preview, preview takes priority
+    #
+    # @return [Spree::Page] the current page or page preview
     def current_page_or_preview
       @current_page_or_preview ||= current_page_preview || current_page
     end
 
+    # Returns the current theme or theme preview, preview takes priority
+    #
+    # @return [Spree::Theme] the current theme or theme preview
     def current_theme_or_preview
       @current_theme_or_preview ||= current_theme_preview || current_theme
     end
 
+    # Returns the logo set in the `Spree::PageSections::Header` section
+    #
+    # @return [ActiveStorage::Attachment] the logo
     def current_header_logo
       @current_header_logo ||= current_theme_or_preview.sections.find_by(type: 'Spree::PageSections::Header')&.logo
     end
 
+    # Returns whether the page builder is enabled
+    # It checks if there is a theme preview or page preview and if the `page_builder` param is set to `true`
+    #
+    # @return [Boolean] whether the page builder is enabled
     def page_builder_enabled?
       @page_builder_enabled ||= (current_theme_preview.present? || current_page_preview.present?) && params[:page_builder] == 'true'
     end
 
+    # Returns the theme layout sections, eg. header, footer, etc.
+    #
+    # @return [Hash] the theme layout sections
     def theme_layout_sections
       @theme_layout_sections ||= current_theme_or_preview.sections.includes(:links, { asset_attachment: :blob },
                                                                             { blocks: [:rich_text_text, :links] }).all.each_with_object({}) do |section, hash|
@@ -55,6 +84,11 @@ module Spree
       {}
     end
 
+    # Returns the theme setting for the given name
+    # if preview is present, it will return the preview setting, otherwise it will return the theme setting
+    #
+    # @param name [String] the name of the theme setting
+    # @return [String] the theme setting
     def theme_setting(name)
       if current_theme_preview.present?
         current_theme_preview.preferences.with_indifferent_access[name]
@@ -64,6 +98,9 @@ module Spree
     end
 
     # This helper allows us to specify opacity in Tailwind's color palette
+    #
+    # @param name [String] the name of the theme setting
+    # @return [String] the theme setting
     def theme_setting_rgb_components(name)
       hex_color = theme_setting(name)
       return unless hex_color.present?
@@ -73,6 +110,10 @@ module Spree
     end
 
     # https://makandracards.com/makandra/496431-ruby-how-to-convert-hex-color-codes-to-rgb-or-rgba
+    # Converts a hex color to rgb
+    #
+    # @param hex [String] the hex color
+    # @return [String] the rgb color
     def hex_color_to_rgb(hex)
       return unless hex.present?
 
@@ -80,6 +121,10 @@ module Spree
       "rgb(#{rgb.join(', ')})"
     end
 
+    # Converts a hex color to rgba
+    #
+    # @param hex [String] the hex color
+    # @return [String] the rgba color
     def hex_color_to_rgba(hex)
       return unless hex.present?
 
@@ -88,6 +133,10 @@ module Spree
       "rgba(#{rgb.join(', ')}, #{opacity.round(2)})"
     end
 
+    # Returns the section inline CSS styles
+    #
+    # @param section [Spree::PageSection] the section
+    # @return [String] the section inline CSS styles
     def section_styles(section)
       styles = {}
 
@@ -116,6 +165,10 @@ module Spree
       styles.map { |k, v| "#{k}: #{v}" }.join(';')
     end
 
+    # Returns the section heading inline CSS styles
+    #
+    # @param section [Spree::PageSection] the section
+    # @return [String] the section heading inline CSS styles
     def section_heading_styles(section)
       styles = {}
 
@@ -128,6 +181,11 @@ module Spree
       styles.compact_blank.map { |k, v| "#{k}: #{v}" }.join(';')
     end
 
+    # Returns the block HTML attributes
+    # it automatically adds data attributes for page builder
+    #
+    # @param block [Spree::PageBlock] the block
+    # @return [Hash] the block attributes
     def block_attributes(block, allowed_styles: :all)
       has_width_desktop = block.respond_to?(:preferred_width_desktop) && block.preferred_width_desktop.present? ? "width-desktop='true'" : nil
 
@@ -147,6 +205,11 @@ module Spree
       tag.attributes(attributes)
     end
 
+    # Returns the link HTML attributes
+    # it automatically adds data attributes for page builder
+    #
+    # @param link [Spree::PageLink] the link
+    # @return [Hash] the link attributes
     def link_attributes(link, as_html: true)
       parent_type = case link.parent_type
                     when 'Spree::PageSection'
@@ -184,6 +247,11 @@ module Spree
       end
     end
 
+    # Returns the block inline CSS styles
+    #
+    # @param block [Spree::PageBlock] the block
+    # @param allowed_styles [Symbol] the allowed styles, if not provided, all styles will be returned
+    # @return [String] the block inline CSS styles
     def block_styles(block, allowed_styles: :all)
       styles = {}
 
@@ -229,12 +297,20 @@ module Spree
       styles.map { |k, v| "#{k}: #{v}" }.join(';')
     end
 
+    # Returns the block background color style
+    #
+    # @param block [Spree::PageBlock] the block
+    # @return [String] the block background color style
     def block_background_color_style(block)
       return nil unless block.respond_to?(:preferred_background_color) && block.preferred_background_color.present?
 
       "background-color: #{block.preferred_background_color};"
     end
 
+    # Returns the block CSS classes
+    #
+    # @param block [Spree::PageBlock] the block
+    # @return [String] the block CSS classes
     def block_css_classes(block)
       classes = []
       classes << "justify-#{block.preferred_justify}" if block.respond_to?(:preferred_justify) && block.preferred_justify.present?

data/app/helpers/spree/wishlist_helper.rb

@@ -1,5 +1,8 @@
 module Spree
   module WishlistHelper
+    # Returns the current wishlist for the current user.
+    #
+    # @return [Spree::Wishlist] The current wishlist
     def current_wishlist
       @current_wishlist ||= try_spree_current_user&.default_wishlist_for_store(current_store)
     end