solidus_core 4.1.6 → 4.5.1

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/generators/spree/dummy/templates/rails/test.rb

@@ -18,7 +18,12 @@ Dummy::Application.configure do
   config.eager_load = false
 
   # Raise exceptions instead of rendering exception templates
-  config.action_dispatch.show_exceptions = false
+  if Rails.gem_version >= Gem::Version.new('7.1')
+    config.action_controller.raise_on_missing_callback_actions = true
+    config.action_dispatch.show_exceptions = :none
+  else
+    config.action_dispatch.show_exceptions = false
+  end
 
   # Disable request forgery protection in test environment
   config.action_controller.allow_forgery_protection = false

data/lib/spree/app_configuration.rb

@@ -26,6 +26,7 @@ require 'uri'
 
 module Spree
   class AppConfiguration < Preferences::Configuration
+    include Spree::Core::EnvironmentExtension
     # Preferences (alphabetized to more easily lookup particular preferences)
 
     # @!attribute [rw] address_requires_phone
@@ -167,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'
@@ -208,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: +false+)
+    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
@@ -216,10 +245,6 @@ module Spree
     #   @return [Integer] Products to show per-page in the frontend (default: +12+)
     preference :products_per_page, :integer, default: 12
 
-    # @!attribute [rw] promotions_per_page
-    #   @return [Integer] Promotions to show per-page in the admin (default: +15+)
-    preference :promotions_per_page, :integer, default: 15
-
     # @!attribute [rw] require_master_price
     #   @return [Boolean] Require a price on the master variant of a product (default: +true+)
     preference :require_master_price, :boolean, default: true
@@ -324,12 +349,6 @@ module Spree
     #   Spree::Variant::VatPriceGenerator.
     class_name_attribute :variant_vat_prices_generator_class, default: 'Spree::Variant::VatPriceGenerator'
 
-    # promotion_chooser_class allows extensions to provide their own PromotionChooser
-    class_name_attribute :promotion_chooser_class, default: 'Spree::PromotionChooser'
-
-    # promotion_adjuster_class allows extensions to provide their own Promotion Adjuster
-    class_name_attribute :promotion_adjuster_class, default: 'Spree::Promotion::OrderAdjustmentsRecalculator'
-
     class_name_attribute :allocator_class, default: 'Spree::Stock::Allocator::OnHandFirst'
 
     class_name_attribute :shipping_rate_sorter_class, default: 'Spree::Stock::ShippingRateSorter'
@@ -367,15 +386,6 @@ module Spree
     #   Spree::OrderUpdater.
     class_name_attribute :order_recalculator_class, default: 'Spree::OrderUpdater'
 
-    # Allows providing your own Mailer for promotion code batch mailer.
-    #
-    # @!attribute [rw] promotion_code_batch_mailer_class
-    # @return [ActionMailer::Base] an object that responds to "promotion_code_batch_finished",
-    #   and "promotion_code_batch_errored"
-    #   (e.g. an ActionMailer with a "promotion_code_batch_finished" method) with the same
-    #   signature as Spree::PromotionCodeBatchMailer.promotion_code_batch_finished.
-    class_name_attribute :promotion_code_batch_mailer_class, default: 'Spree::PromotionCodeBatchMailer'
-
     # Allows providing your own Mailer for reimbursement mailer.
     #
     # @!attribute [rw] reimbursement_mailer_class
@@ -412,7 +422,7 @@ module Spree
     # @!attribute [rw] order_contents_class
     # @return [Class] a class with the same public interfaces as
     #   Spree::OrderContents.
-    class_name_attribute :order_contents_class, default: 'Spree::OrderContents'
+    class_name_attribute :order_contents_class, default: 'Spree::SimpleOrderContents'
 
     # Allows providing your own class for shipping an order.
     #
@@ -448,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.
@@ -540,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
@@ -569,6 +593,16 @@ 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: []
+
     # Configures the absolute path that contains the Solidus engine
     # migrations. This will be checked at app boot to confirm that all Solidus
     # migrations are installed.
@@ -603,6 +637,54 @@ module Spree
       @stock_configuration ||= Spree::Core::StockConfiguration.new
     end
 
+    # Allows providing your own promotion configuration instance
+    # @!attribute [rw] promotions
+    # @return [Spree::Core::NullPromotionConfiguration] an object that conforms to the API of
+    #   the example promotion configuration class Spree::Core::NullPromotionConfiguration.
+    attr_writer :promotions
+    def promotions
+      @promotions ||= Spree::Core::NullPromotionConfiguration.new
+    end
+
+    class << self
+      private
+
+      def promotions_deprecation_message(method, new_method_name = nil)
+        "The `Spree::Config.#{method}` preference is deprecated and will be removed in Solidus 5.0. " \
+        "Use `Spree::Config.promotions.#{new_method_name || method}` instead"
+      end
+    end
+
+    def promotion_adjuster_class
+      promotions.order_adjuster_class
+    end
+
+    def promotion_adjuster_class=(klass)
+      promotions.order_adjuster_class = klass
+    end
+    deprecate promotion_adjuster_class: promotions_deprecation_message("promotion_adjuster_class", "order_adjuster_class"), deprecator: Spree.deprecator
+    deprecate "promotion_adjuster_class=": promotions_deprecation_message("promotion_adjuster_class=", "order_adjuster_class="), deprecator: Spree.deprecator
+
+    delegate :promotion_chooser_class, :promotion_chooser_class=, to: :promotions
+    deprecate promotion_chooser_class: promotions_deprecation_message("promotion_chooser_class"), deprecator: Spree.deprecator
+    deprecate "promotion_chooser_class=": promotions_deprecation_message("promotion_chooser_class="), deprecator: Spree.deprecator
+
+    delegate :shipping_promotion_handler_class, :shipping_promotion_handler_class=, to: :promotions
+    deprecate shipping_promotion_handler_class: promotions_deprecation_message("shipping_promotion_handler_class"), deprecator: Spree.deprecator
+    deprecate "shipping_promotion_handler_class=": promotions_deprecation_message("shipping_promotion_handler_class="), deprecator: Spree.deprecator
+
+    delegate :coupon_code_handler_class, :coupon_code_handler_class=, to: :promotions
+    deprecate coupon_code_handler_class: promotions_deprecation_message("coupon_code_handler_class"), deprecator: Spree.deprecator
+    deprecate "coupon_code_handler_class=": promotions_deprecation_message("coupon_code_handler_class"), deprecator: Spree.deprecator
+
+    delegate :promotion_code_batch_mailer_class, :promotion_code_batch_mailer_class=, to: :promotions
+    deprecate promotion_code_batch_mailer_class: promotions_deprecation_message("promotion_code_batch_mailer_class"), deprecator: Spree.deprecator
+    deprecate "promotion_code_batch_mailer_class=": promotions_deprecation_message("promotion_code_batch_mailer_class="), deprecator: Spree.deprecator
+
+    delegate :preferred_promotions_per_page, :preferred_promotions_per_page=, to: :promotions
+    deprecate preferred_promotions_per_page: promotions_deprecation_message("preferred_promotions_per_page"), deprecator: Spree.deprecator
+    deprecate "preferred_promotions_per_page=": promotions_deprecation_message("preferred_promotions_per_page="), deprecator: Spree.deprecator
+
     def roles
       @roles ||= Spree::RoleConfiguration.new.tap do |roles|
         roles.assign_permissions :default, ['Spree::PermissionSets::DefaultCustomer']
@@ -618,27 +700,6 @@ module Spree
 
     def environment
       @environment ||= Spree::Core::Environment.new(self).tap do |env|
-        env.calculators.promotion_actions_create_adjustments = %w[
-          Spree::Calculator::FlatPercentItemTotal
-          Spree::Calculator::FlatRate
-          Spree::Calculator::FlexiRate
-          Spree::Calculator::TieredPercent
-          Spree::Calculator::TieredFlatRate
-        ]
-
-        env.calculators.promotion_actions_create_item_adjustments = %w[
-          Spree::Calculator::DistributedAmount
-          Spree::Calculator::FlatRate
-          Spree::Calculator::FlexiRate
-          Spree::Calculator::PercentOnLineItem
-          Spree::Calculator::TieredPercent
-        ]
-
-        env.calculators.promotion_actions_create_quantity_adjustments = %w[
-          Spree::Calculator::PercentOnLineItem
-          Spree::Calculator::FlatRate
-        ]
-
         env.calculators.shipping_methods = %w[
           Spree::Calculator::Shipping::FlatPercentItemTotal
           Spree::Calculator::Shipping::FlatRate
@@ -659,32 +720,6 @@ module Spree
           Spree::PaymentMethod::Check
         ]
 
-        env.promotions.rules = %w[
-          Spree::Promotion::Rules::ItemTotal
-          Spree::Promotion::Rules::Product
-          Spree::Promotion::Rules::User
-          Spree::Promotion::Rules::FirstOrder
-          Spree::Promotion::Rules::UserLoggedIn
-          Spree::Promotion::Rules::OneUsePerUser
-          Spree::Promotion::Rules::Taxon
-          Spree::Promotion::Rules::NthOrder
-          Spree::Promotion::Rules::OptionValue
-          Spree::Promotion::Rules::FirstRepeatPurchaseSince
-          Spree::Promotion::Rules::UserRole
-          Spree::Promotion::Rules::Store
-        ]
-
-        env.promotions.actions = %w[
-          Spree::Promotion::Actions::CreateAdjustment
-          Spree::Promotion::Actions::CreateItemAdjustments
-          Spree::Promotion::Actions::CreateQuantityAdjustments
-          Spree::Promotion::Actions::FreeShipping
-        ]
-
-        env.promotions.shipping_actions = %w[
-          Spree::Promotion::Actions::FreeShipping
-        ]
-
         env.stock_splitters = %w[
           Spree::Stock::Splitter::ShippingCategory
           Spree::Stock::Splitter::Backordered

data/lib/spree/core/class_constantizer.rb

@@ -8,8 +8,8 @@ module Spree
       class Set
         include Enumerable
 
-        def initialize
-          @collection = ::Set.new
+        def initialize(default: [])
+          @collection = ::Set.new(default)
         end
 
         def <<(klass)

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
+)