solidus_core 4.4.2 → 4.5.0

data/lib/generators/solidus/install/app_templates/frontend/starter.rb

@@ -1 +1 @@
-apply 'https://github.com/solidusio/solidus_starter_frontend/raw/v4.4/template.rb'
+apply 'https://github.com/solidusio/solidus_starter_frontend/raw/v4.5/template.rb'

data/lib/generators/spree/dummy/dummy_generator.rb

@@ -61,7 +61,7 @@ module Spree
       template "rails/application.rb.tt", "#{dummy_path}/config/application.rb", force: true
       template "rails/routes.rb", "#{dummy_path}/config/routes.rb", force: true
       template "rails/test.rb", "#{dummy_path}/config/environments/test.rb", force: true
-      template "rails/script/rails", "#{dummy_path}/spec/dummy/script/rails", force: true
+      template "rails/manifest.js", "#{dummy_path}/app/assets/config/manifest.js", force: true
     end
 
     def test_dummy_inject_extension_requirements

data/lib/generators/spree/dummy/templates/rails/application.rb.tt

@@ -2,7 +2,7 @@ require File.expand_path('../boot', __FILE__)
 
 require 'rails/all'
 
-Bundler.require(*Rails.groups(assets: %w(development test)))
+Bundler.require(*Rails.groups)
 
 require '<%= lib_name %>'
 

data/lib/generators/spree/dummy/templates/rails/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/lib/spree/app_configuration.rb

@@ -168,6 +168,13 @@ module Spree
     #   @return [String] template to use for layout on the frontend (default: +"spree/layouts/spree_application"+)
     preference :layout, :string, default: 'spree/layouts/spree_application'
 
+    # !@attribute [rw] line_item_comparison_hooks
+    #   @return [Array<Symbol>] An array of methods to call on {Spree::Order} to determine if a line item is equal to another
+    #   (default: +[]+)
+    #   @example
+    #   config.line_item_comparison_hooks << :my_custom_method
+    preference :line_item_comparison_hooks, :array, default: []
+
     # @!attribute [rw] logo
     #   @return [String] URL of logo used on frontend (default: +'logo/solidus.svg'+)
     preference :logo, :string, default: 'logo/solidus.svg'
@@ -209,6 +216,27 @@ module Spree
     #   @return [Integer] Orders to show per-page in the admin (default: +15+)
     preference :orders_per_page, :integer, default: 15
 
+    # @!attribute [rw] meta_data_validation_enabled
+    #   @return [Boolean] Indicates whether validation for customer and admin metadata columns is enabled.
+    #   When this is set to true, the following preferences will be used to validate the metadata:
+    #   - The maximum number of keys that can be added to the metadata columns (meta_data_max_keys).
+    #   - The maximum length of each key in the metadata columns (meta_data_max_key_length).
+    #   - The maximum length of each value in the metadata columns (meta_data_max_value_length).
+    #   (default: +true+)
+    preference :meta_data_validation_enabled, :boolean, default: false
+
+    # @!attribute [rw] meta_data_max_keys
+    #   @return [Integer] Maximum keys that can be allocated in customer and admin metadata column (default: +6+)
+    preference :meta_data_max_keys, :integer, default: 6
+
+    # @!attribute [rw] meta_data_max_key_length
+    #   @return [Integer] Maximum length that key can have in customer and admin metadata column (default: +16+)
+    preference :meta_data_max_key_length, :integer, default: 16
+
+    # @!attribute [rw] meta_data_max_value_length
+    #   @return [Integer] Maximum length that value can have in customer and admin metadata column (default: +256+)
+    preference :meta_data_max_value_length, :integer, default: 256
+
     # @!attribute [rw] properties_per_page
     #   @return [Integer] Properties to show per-page in the admin (default: +15+)
     preference :properties_per_page, :integer, default: 15
@@ -430,6 +458,13 @@ module Spree
     #   as Spree::Wallet::AddPaymentSourcesToWallet.
     class_name_attribute :add_payment_sources_to_wallet_class, default: 'Spree::Wallet::AddPaymentSourcesToWallet'
 
+    # Allows providing your own class for recalculating totals on an item.
+    #
+    # @!attribute [rw] item_total_class
+    # @return [Class] a class with the same public interfaces as
+    #   Spree::ItemTotal
+    class_name_attribute :item_total_class, default: 'Spree::ItemTotal'
+
     # Allows providing your own class for calculating taxes on an order.
     #
     # This extension point is under development and may change in a future minor release.
@@ -522,6 +557,13 @@ module Spree
     #   Spree::StoreCreditPrioritizer.
     class_name_attribute :store_credit_prioritizer_class, default: 'Spree::StoreCreditPrioritizer'
 
+    # Allows finding brand for product.
+    #
+    # @!attribute [rw] brand_selector_class
+    # @return [Class] a class with the same public interfaces as
+    #   Spree::TaxonBrandSelector.
+    class_name_attribute :brand_selector_class, default: 'Spree::TaxonBrandSelector'
+
     # @!attribute [rw] taxon_image_style_default
     #
     # Defines which style to default to when style is not provided
@@ -551,6 +593,13 @@ module Spree
     # Enumerable of taxons adhering to the present_taxon_class interface
     class_name_attribute :taxon_attachment_module, default: "Spree::Taxon::ActiveStorageAttachment"
 
+    # Allows changing the default behavior for redirects when a user is not authorized
+    #
+    # @!attribute [rw] unauthorized_redirect_handler_class
+    # @return [Class] a class with the same public interfaces as
+    #  Spree::UnauthorizedRedirectHandler.
+    class_name_attribute :unauthorized_redirect_handler_class, default: "Spree::UnauthorizedRedirectHandler"
+
     # Set of classes that can be promotion adjustment sources
     add_class_set :adjustment_promotion_source_types, default: []
 

data/lib/spree/core/controller_helpers/auth.rb

@@ -1,63 +1,7 @@
 # frozen_string_literal: true
 
-require 'cancan'
-
-module Spree
-  module Core
-    module ControllerHelpers
-      module Auth
-        extend ActiveSupport::Concern
-
-        # @!attribute [rw] unauthorized_redirect
-        #   @!scope class
-        #   Extension point for overriding behaviour of access denied errors.
-        #   Default behaviour is to redirect back or to "/unauthorized" with a flash
-        #   message.
-        #   @return [Proc] action to take when access denied error is raised.
-
-        included do
-          before_action :set_guest_token
-          helper_method :spree_current_user
-
-          class_attribute :unauthorized_redirect
-          self.unauthorized_redirect = -> do
-            flash[:error] = I18n.t('spree.authorization_failure')
-            redirect_back(fallback_location: "/unauthorized")
-          end
-
-          rescue_from CanCan::AccessDenied do
-            instance_exec(&unauthorized_redirect)
-          end
-        end
-
-        # Needs to be overriden so that we use Spree's Ability rather than anyone else's.
-        def current_ability
-          @current_ability ||= Spree::Ability.new(spree_current_user)
-        end
-
-        def redirect_back_or_default(default)
-          redirect_to(session["spree_user_return_to"] || default)
-          session["spree_user_return_to"] = nil
-        end
-
-        def set_guest_token
-          unless cookies.signed[:guest_token].present?
-            cookies.permanent.signed[:guest_token] = Spree::Config[:guest_token_cookie_options].merge(
-              value: SecureRandom.urlsafe_base64(nil, false),
-              httponly: true
-            )
-          end
-        end
-
-        def store_location
-          Spree::UserLastUrlStorer.new(self).store_location
-        end
-
-        # Auth extensions are expected to define it, otherwise it's a no-op
-        def spree_current_user
-          defined?(super) ? super : nil
-        end
-      end
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

data/lib/spree/core/controller_helpers/common.rb

@@ -1,82 +1,7 @@
 # frozen_string_literal: true
 
-require 'carmen'
-
-module Spree
-  module Core
-    module ControllerHelpers
-      module Common
-        extend ActiveSupport::Concern
-        included do
-          helper_method :title
-          helper_method :title=
-          helper_method :accurate_title
-
-          layout :get_layout
-
-          before_action :set_user_language
-        end
-
-        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::Config[:always_put_site_name_in_title]
-              [title_string, default_title].join(' - ')
-            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
-
-        private
-
-        def set_user_language_locale_key
-          :locale
-        end
-
-        def set_user_language
-          available_locales = Spree.i18n_available_locales
-          locale = [
-            params[:locale],
-            session[set_user_language_locale_key],
-            (config_locale if respond_to?(:config_locale, true)),
-            I18n.default_locale
-          ].detect do |candidate|
-            candidate &&
-              available_locales.include?(candidate.to_sym)
-          end
-          session[set_user_language_locale_key] = locale
-          I18n.locale = locale
-          Carmen.i18n_backend.locale = 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
-          Spree::Config[:layout]
-        end
-      end
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

data/lib/spree/core/controller_helpers/order.rb

@@ -1,88 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/core/controller_helpers/pricing'
-
-module Spree
-  module Core
-    module ControllerHelpers
-      module Order
-        extend ActiveSupport::Concern
-        include ControllerHelpers::Pricing
-
-        included do
-          helper_method :current_order
-        end
-
-        # The current incomplete order from the guest_token for use in cart and during checkout
-        def current_order(options = {})
-          should_create = options[:create_order_if_necessary] || false
-          should_build = options[:build_order_if_necessary] || should_create
-
-          return @current_order if @current_order
-
-          @current_order = find_order_by_token_or_user(lock: options[:lock])
-
-          if should_build && (@current_order.nil? || @current_order.completed?)
-            @current_order = Spree::Order.new(new_order_params)
-            @current_order.user ||= spree_current_user
-            # See issue https://github.com/spree/spree/issues/3346 for reasons why this line is here
-            @current_order.created_by ||= spree_current_user
-            @current_order.save! if should_create
-          end
-
-          if @current_order
-            @current_order.record_ip_address(ip_address)
-            return @current_order
-          end
-        end
-
-        def associate_user
-          @order ||= current_order
-          if spree_current_user && @order
-            @order.associate_user!(spree_current_user) if @order.user.blank? || @order.email.blank?
-          end
-        end
-
-        def set_current_order
-          if spree_current_user && current_order
-            spree_current_user.orders.by_store(current_store).incomplete.where('id != ?', current_order.id).find_each do |order|
-              current_order.merge!(order, spree_current_user)
-            end
-          end
-        end
-
-        def ip_address
-          request.remote_ip
-        end
-
-        private
-
-        def last_incomplete_order
-          @last_incomplete_order ||= spree_current_user.last_incomplete_spree_order(store: current_store)
-        end
-
-        def current_order_params
-          { currency: current_pricing_options.currency, guest_token: cookies.signed[:guest_token], store_id: current_store.id, user_id: spree_current_user.try(:id) }
-        end
-
-        def new_order_params
-          current_order_params.merge(last_ip_address: ip_address)
-        end
-
-        def find_order_by_token_or_user(options = {})
-          should_lock = options[:lock] || false
-
-          # Find any incomplete orders for the guest_token
-          order = Spree::Order.incomplete.lock(should_lock).find_by(current_order_params)
-
-          # Find any incomplete orders for the current user
-          if order.nil? && spree_current_user
-            order = last_incomplete_order
-          end
-
-          order
-        end
-      end
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

data/lib/spree/core/controller_helpers/payment_parameters.rb

@@ -1,165 +1,7 @@
 # frozen_string_literal: true
 
-module Spree
-  module Core::ControllerHelpers::PaymentParameters
-    # This method handles the awkwardness of how the html forms are currently
-    # set up for frontend.
-    #
-    # This method expects a params hash in the format of:
-    #
-    #  {
-    #    payment_source: {
-    #      # The keys here are spree_payment_method.id's
-    #      '1' => {...source attributes for payment method 1...},
-    #      '2' => {...source attributes for payment method 2...},
-    #    },
-    #    order: {
-    #      # Note that only a single entry is expected/handled in this array
-    #      payments_attributes: [
-    #        {
-    #          payment_method_id: '1',
-    #        },
-    #      ],
-    #      ...other params...
-    #    },
-    #    ...other params...
-    #  }
-    #
-    # And this method modifies the params into the format of:
-    #
-    #  {
-    #    order: {
-    #      payments_attributes: [
-    #        {
-    #          payment_method_id: '1',
-    #          source_attributes: {...source attributes for payment method 1...}
-    #        },
-    #      ],
-    #      ...other params...
-    #    },
-    #    ...other params...
-    #  }
-    #
-    def move_payment_source_into_payments_attributes(params)
-      # Step 1: Gather all the information and ensure all the pieces are there.
-
-      return params if params[:payment_source].blank?
-
-      payment_params = params[:order] &&
-                       params[:order][:payments_attributes] &&
-                       params[:order][:payments_attributes].first
-      return params if payment_params.blank?
-
-      payment_method_id = payment_params[:payment_method_id]
-      return params if payment_method_id.blank?
-
-      source_params = params[:payment_source][payment_method_id]
-      return params if source_params.blank?
-
-      # Step 2: Perform the modifications.
-
-      payment_params[:source_attributes] = source_params
-      params.delete(:payment_source)
-
-      params
-    end
-
-    # This method handles the awkwardness of how the html forms are currently
-    # set up for frontend.
-    #
-    # This method expects a params hash in the format of:
-    #
-    #  {
-    #    order: {
-    #      wallet_payment_source_id: '123',
-    #      ...other params...
-    #    },
-    #    cvc_confirm: '456', # optional
-    #    ...other params...
-    #  }
-    #
-    # And this method modifies the params into the format of:
-    #
-    #  {
-    #    order: {
-    #      payments_attributes: [
-    #        {
-    #          source_attributes: {
-    #            wallet_payment_source_id: '123',
-    #            verification_value: '456',
-    #          },
-    #        },
-    #      ]
-    #      ...other params...
-    #    },
-    #    ...other params...
-    #  }
-    #
-    def move_wallet_payment_source_id_into_payments_attributes(params)
-      return params if params[:order].blank?
-
-      wallet_payment_source_id = params[:order][:wallet_payment_source_id].presence
-      cvc_confirm = params[:cvc_confirm].presence
-
-      return params if wallet_payment_source_id.nil?
-
-      params[:order][:payments_attributes] = [
-        {
-          source_attributes: {
-            wallet_payment_source_id:,
-            verification_value: cvc_confirm
-          }
-        }
-      ]
-
-      params[:order].delete(:wallet_payment_source_id)
-      params.delete(:cvc_confirm)
-
-      params
-    end
-
-    # This is a strange thing to do since an order can have multiple payments
-    # but we always assume that it only has a single payment and that its
-    # amount should be the current order total after store credit is applied.
-    # We should reconsider this method and its usage at some point.
-    #
-    # This method expects a params hash in the format of:
-    #
-    #  {
-    #    order: {
-    #      # Note that only a single entry is expected/handled in this array
-    #      payments_attributes: [
-    #        {
-    #          ...params...
-    #        },
-    #      ],
-    #      ...other params...
-    #    },
-    #    ...other params...
-    #  }
-    #
-    # And this method modifies the params into the format of:
-    #
-    #  {
-    #    order: {
-    #      payments_attributes: [
-    #        {
-    #          ...params...
-    #          amount: <the order total after store credit>,
-    #        },
-    #      ],
-    #      ...other params...
-    #    },
-    #    ...other params...
-    #  }
-    #
-    def set_payment_parameters_amount(params, order)
-      return params if params[:order].blank?
-      return params if params[:order][:payments_attributes].blank?
-
-      params[:order][:payments_attributes].first[:amount] = order.order_total_after_store_credit
-
-      params
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

data/lib/spree/core/controller_helpers/pricing.rb

@@ -1,19 +1,7 @@
 # frozen_string_literal: true
 
-module Spree
-  module Core
-    module ControllerHelpers
-      module Pricing
-        extend ActiveSupport::Concern
-
-        included do
-          helper_method :current_pricing_options
-        end
-
-        def current_pricing_options
-          Spree::Config.pricing_options_class.from_context(self)
-        end
-      end
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

data/lib/spree/core/controller_helpers/search.rb

@@ -1,16 +1,7 @@
 # frozen_string_literal: true
 
-module Spree
-  module Core
-    module ControllerHelpers
-      module Search
-        def build_searcher(params)
-          Spree::Config.searcher_class.new(params).tap do |searcher|
-            searcher.current_user = spree_current_user
-            searcher.pricing_options = current_pricing_options
-          end
-        end
-      end
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

data/lib/spree/core/controller_helpers/store.rb

@@ -1,19 +1,7 @@
 # frozen_string_literal: true
 
-module Spree
-  module Core
-    module ControllerHelpers
-      module Store
-        extend ActiveSupport::Concern
-
-        included do
-          helper_method :current_store
-        end
-
-        def current_store
-          @current_store ||= Spree::Config.current_store_selector_class.new(request).store
-        end
-      end
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

data/lib/spree/core/controller_helpers/strong_parameters.rb

@@ -1,73 +1,7 @@
 # frozen_string_literal: true
 
-module Spree
-  module Core
-    module ControllerHelpers
-      module StrongParameters
-        def permitted_attributes
-          Spree::PermittedAttributes
-        end
-
-        delegate(*Spree::PermittedAttributes::ATTRIBUTES,
-                 to: :permitted_attributes,
-                 prefix: :permitted)
-
-        def permitted_credit_card_update_attributes
-          permitted_attributes.credit_card_update_attributes + [
-            address_attributes: permitted_address_attributes
-          ]
-        end
-
-        def permitted_payment_attributes
-          permitted_attributes.payment_attributes + [
-            source_attributes: permitted_source_attributes
-          ]
-        end
-
-        def permitted_source_attributes
-          permitted_attributes.source_attributes + [
-            address_attributes: permitted_address_attributes
-          ]
-        end
-
-        def permitted_checkout_address_attributes
-          permitted_attributes.checkout_address_attributes
-        end
-
-        def permitted_checkout_delivery_attributes
-          permitted_attributes.checkout_delivery_attributes
-        end
-
-        def permitted_checkout_payment_attributes
-          permitted_attributes.checkout_payment_attributes
-        end
-
-        def permitted_checkout_confirm_attributes
-          permitted_attributes.checkout_confirm_attributes
-        end
-
-        def permitted_order_attributes
-          permitted_checkout_address_attributes +
-          permitted_checkout_delivery_attributes +
-          permitted_checkout_payment_attributes +
-          permitted_checkout_confirm_attributes + [
-            line_items_attributes: permitted_line_item_attributes
-          ]
-        end
-
-        def permitted_product_attributes
-          permitted_attributes.product_attributes + [
-            product_properties_attributes: permitted_product_properties_attributes
-          ]
-        end
-
-        def permitted_user_attributes
-          permitted_attributes.user_attributes + [
-            bill_address_attributes: permitted_address_attributes,
-            ship_address_attributes: permitted_address_attributes
-          ]
-        end
-      end
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)