solidus_core 2.11.10 → 3.3.1

data/lib/spree/app_configuration.rb

@@ -21,6 +21,7 @@ require "spree/core/search/base"
 require "spree/core/search/variant"
 require 'spree/preferences/configuration'
 require 'spree/core/environment'
+require 'spree/rails_compatibility'
 
 module Spree
   class AppConfiguration < Preferences::Configuration
@@ -34,10 +35,6 @@ module Spree
     #   @return [Boolean] should state/state_name be required (default: +true+)
     preference :address_requires_state, :boolean, default: true
 
-    # @!attribute [rw] legacy
-    #   @return [Boolean] use the legacy address' state validation logic (default: +true+)
-    preference :use_legacy_address_state_validator, :boolean, default: true
-
     # @!attribute [rw] admin_interface_logo
     #   @return [String] URL of logo used in admin (default: +'logo/solidus.svg'+)
     preference :admin_interface_logo, :string, default: 'logo/solidus.svg'
@@ -64,6 +61,11 @@ module Spree
     #   @return [Boolean] When false, customers must create an account to complete an order (default: +true+)
     preference :allow_guest_checkout, :boolean, default: true
 
+    # @!attribute [rw] allow_promotions_any_match_policy
+    #   @return [Boolean] When false, admins cannot create promotions with an "any" match policy (default: +false+)
+    #                     Create individual, separate promotions for each of your rules instead.
+    preference :allow_promotions_any_match_policy, :boolean, default: false
+
     # @!attribute [rw] guest_token_cookie_options
     #   @return [Hash] Add additional guest_token cookie options here (ie. domain or path)
     preference :guest_token_cookie_options, :hash, default: {}
@@ -111,16 +113,6 @@ module Spree
     #   @return [Boolean]
     preference :billing_address_required, :boolean, default: false
 
-    # @!attribute [rw] binary_inventory_cache
-    #   Only invalidate product caches when they change from in stock to out of
-    #   stock. By default, caches are invalidated on any change of inventory
-    #   quantity. Setting this to true should make operations on inventory
-    #   faster.
-    #   (default: +false+)
-    #   @deprecated - use inventory_cache_threshold instead
-    #   @return [Boolean]
-    preference :binary_inventory_cache, :boolean, default: false
-
     # @!attribute [rw] can_restrict_stock_management
     #   @return [Boolean] Indicates if stock management can be restricted by location
     preference :can_restrict_stock_management, :boolean, default: false
@@ -154,19 +146,14 @@ module Spree
     #   @return [Integer] Customer returns to show per-page in the admin (default: +15+)
     preference :customer_returns_per_page, :integer, default: 15
 
-    # @!attribute [rw] default_country_id
-    #   @deprecated Use the default country ISO preference instead
-    #   @return [Integer,nil] id of {Spree::Country} to be selected by default in dropdowns (default: nil)
-    preference :default_country_id, :integer
-
     # @!attribute [rw] default_country_iso
     #   Default customer country ISO code
     #   @return [String] Two-letter ISO code of a {Spree::Country} to assumed as the country of an unidentified customer (default: "US")
     preference :default_country_iso, :string, default: 'US'
 
-    # @!attribute [rw] use_custom_cancancan_actions
-    #   @return [Boolean] Allow to use legacy Solidus custom CanCanCan action aliases (default: +true+)
-    preference :use_custom_cancancan_actions, :boolean, default: true
+    # @!attribute [rw] default_email_regexp
+    #   @return [Regexp] Regex to be used in email validations, for example in Spree::EmailValidator
+    preference :default_email_regexp, :regexp, default: URI::MailTo::EMAIL_REGEXP
 
     # @!attribute [rw] generate_api_key_for_all_roles
     #   @return [Boolean] Allow generating api key automatically for user
@@ -188,9 +175,35 @@ module Spree
     #   @return [String] URL of logo used on frontend (default: +'logo/solidus.svg'+)
     preference :logo, :string, default: 'logo/solidus.svg'
 
+    # @!attribute [rw] log_entry_permitted_classes
+    #   @return [Array<String>] An array of extra classes that are allowed to be
+    #     loaded from a serialized YAML as details in {Spree::LogEntry}
+    #     (defaults to a non-frozen empty array, so that extensions can add
+    #     their own classes).
+    #   @example
+    #     config.log_entry_permitted_classes = ['Date']
+    preference :log_entry_permitted_classes, :array, default: []
+
+    # @!attribute [rw] log_entry_allow_aliases
+    #   @return [Boolean] Whether YAML aliases are allowed when loading
+    #     serialized data in {Spree::LogEntry}. It defaults to true. Depending
+    #     on the source of your data, you may consider disabling it to prevent
+    #     entity expansion attacks.
+    preference :log_entry_allow_aliases, :boolean, default: true
+
     # @!attribute [rw] mails_from
     #   @return [String] Email address used as +From:+ field in transactional emails.
+    #   @deprecated Spree::Store#mail_from_address is used instead
     preference :mails_from, :string, default: 'solidus@example.com'
+    def mails_from=(value)
+      Spree::Deprecation.warn(<<~MSG) && preferences[:mail_from] = value
+        Solidus doesn't use `Spree::Config.mails_from` preference and it'll
+        removed on the next major release. Please, remove its definition in
+        `config/initializers/spree.rb`. Use the `Spree::Store#mail_from_address`
+        attribute for the default email address used as the 'From:' field in
+        transactional emails.
+      MSG
+    end
 
     # @!attribute [rw] max_level_in_taxons_menu
     #   @return [Integer] maximum nesting level in taxons menu (default: +1+)
@@ -225,23 +238,6 @@ module Spree
     #   @return [Integer] Promotions to show per-page in the admin (default: +15+)
     preference :promotions_per_page, :integer, default: 15
 
-    # @!attribute [rw] disable_actionless_promotion_validation
-    #   @return [Boolean] Promotions should have actions associated before being considered active (default: +true+)
-    preference :consider_actionless_promotion_active, :boolean, default: true
-
-    # @!attribute [rw] raise_with_invalid_currency
-    #   Whether to raise an exception if trying to set a line item currency
-    #   different from the order currency. When false a validation error
-    #   is added to the instance instead.
-    #   @return [Boolean] (default: +true+)
-    preference :raise_with_invalid_currency, :boolean, default: true
-
-    # @!attribute [rw] redirect_back_on_unauthorized
-    #   Whether to try to redirect users back when they try to access
-    #   unauthorized routes, before redirect them to /unauthorized.
-    #   @return [Boolean] (default: +false+)
-    preference :redirect_back_on_unauthorized, :boolean, default: false
-
     # @!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
@@ -268,10 +264,6 @@ module Spree
     #   (default: +['IT']+)
     preference :countries_that_use_nested_subregions, :array, default: ['IT']
 
-    # @!attribute [rw] run_order_validations_on_order_updater
-    #   @return [Boolean] Whether to run validation when updating an order with the OrderUpdater
-    preference :run_order_validations_on_order_updater, :boolean, default: false
-
     # @!attribute [rw] send_core_emails
     #   @return [Boolean] Whether to send transactional emails (default: true)
     preference :send_core_emails, :boolean, default: true
@@ -307,21 +299,13 @@ module Spree
     #   @return [] Track on_hand values for variants / products. (default: true)
     preference :track_inventory_levels, :boolean, default: true
 
-    # @!attribute [rw] use_combined_first_and_last_name_in_address
-    #   @return [Boolean] Use Spree::Address combined first and last name in HTML views and
-    #   API responses. (default: +false+)
-    preference :use_combined_first_and_last_name_in_address, :boolean, default: false
-
-    # @!attribute [rw] use_legacy_order_state_machine
-    #   @return [Boolean] Uses the legacy order state machine from Spree::Order::Checkout
-    #   (default: +false+)
-    preference :use_legacy_order_state_machine, :boolean, default: true
-
-    # The legacy_store_credit_category_name allows to control whether the legacy
-    # way of fetching the category should be used.
-    #
-    # @param [Boolean] enable/disable the legacy way of fetching the store category name
-    preference :use_legacy_store_credit_reimbursement_category_name, :boolean, default: true
+    # @!attribute [rw] use_legacy_events
+    #   Before v3.2, Solidus used a custom pub/sub implementation based on
+    #   ActiveSupport::Notifications. Now, we internally use and recommend
+    #   [Omnes](https://github.com/nebulab/omnes). This preference allows falling
+    #   back to the old system.
+    #   @return [Boolean]
+    versioned_preference :use_legacy_events, :boolean, initial_value: true, boundaries: { "3.2.0.alpha" => false }
 
     # Other configurations
 
@@ -369,6 +353,9 @@ module Spree
     # 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'
@@ -431,6 +418,28 @@ module Spree
     #   Spree::Wallet::DefaultPaymentBuilder.
     class_name_attribute :default_payment_builder_class, default: 'Spree::Wallet::DefaultPaymentBuilder'
 
+    # Allows providing your own class for managing the contents of an order.
+    #
+    # @!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'
+
+    # Allows providing your own class for shipping an order.
+    #
+    # @!attribute [rw] order_shipping_class
+    # @return [Class] a class with the same public interfaces as
+    #   Spree::OrderShipping.
+    class_name_attribute :order_shipping_class, default: 'Spree::OrderShipping'
+
+    # Allows providing your own class for managing the inventory units of a
+    # completed order.
+    #
+    # @!attribute [rw] order_cancellations_class
+    # @return [Class] a class with the same public interfaces as
+    #   Spree::OrderCancellations.
+    class_name_attribute :order_cancellations_class, default: 'Spree::OrderCancellations'
+
     # Allows providing your own class for canceling payments.
     #
     # @!attribute [rw] payment_canceller
@@ -496,13 +505,13 @@ module Spree
 
     # Allows switching attachment library for Image
     #
-    # `Spree::Image::PaperclipAttachment`
-    # is the default and provides the classic Paperclip implementation.
+    # `Spree::Image::ActiveStorageAttachment`
+    # is the default and provides the Active Storage implementation.
     #
     # @!attribute [rw] image_attachment_module
     # @return [Module] a module that can be included into Spree::Image to allow attachments
     # Enumerable of images adhering to the present_image_class interface
-    class_name_attribute :image_attachment_module, default: 'Spree::Image::PaperclipAttachment'
+    class_name_attribute :image_attachment_module, default: Spree::RailsCompatibility.default_image_attachment_module
 
     # @!attribute [rw] allowed_image_mime_types
     #
@@ -512,15 +521,75 @@ module Spree
     # @return [Array]
     class_name_attribute :allowed_image_mime_types, default: %w(image/jpeg image/jpg image/png image/gif).freeze
 
+    # @!attribute [rw] product_image_style_default
+    #
+    # Defines which style to default to when style is not provided
+    # :product is the default.
+    #
+    # @return [Symbol]
+    class_name_attribute :product_image_style_default, default: :product
+
+    # @!attribute [rw] product_image_styles
+    #
+    # Defines image styles/sizes hash for styles
+    # `{ mini: '48x48>',
+    #    small: '400x400>',
+    #    product: '680x680>',
+    #    large: '1200x1200>' } is the default.
+    #
+    # @return [Hash]
+    class_name_attribute :product_image_styles, default: { mini: '48x48>',
+                                                          small: '400x400>',
+                                                          product: '680x680>',
+                                                          large: '1200x1200>' }
+
+    # Allows providing your own class for prioritizing store credit application
+    # to an order.
+    #
+    # @!attribute [rw] store_credit_prioritizer_class
+    # @return [Class] a class with the same public interfaces as
+    #   Spree::StoreCreditPrioritizer.
+    class_name_attribute :store_credit_prioritizer_class, default: 'Spree::StoreCreditPrioritizer'
+
+    # @!attribute [rw] taxon_image_style_default
+    #
+    # Defines which style to default to when style is not provided
+    # :mini is the default.
+    #
+    # @return [Symbol]
+    class_name_attribute :taxon_image_style_default, default: :mini
+
+    # @!attribute [rw] taxon_styles
+    #
+    # Defines taxon styles/sizes hash for styles
+    # `{ mini: '48x48>',
+    #    small: '400x400>',
+    #    product: '680x680>',
+    #    large: '1200x1200>' } is the default.
+    #
+    # @return [Hash]
+    class_name_attribute :taxon_image_styles, default: { mini: '32x32>', normal: '128x128>' }
+
     # Allows switching attachment library for Taxon
     #
-    # `Spree::Taxon::PaperclipAttachment`
-    # is the default and provides the classic Paperclip implementation.
+    # `Spree::Taxon::ActiveStorageAttachment`
+    # is the default and provides the Active Storage implementation.
     #
     # @!attribute [rw] taxon_attachment_module
     # @return [Module] a module that can be included into Spree::Taxon to allow attachments
     # Enumerable of taxons adhering to the present_taxon_class interface
-    class_name_attribute :taxon_attachment_module, default: 'Spree::Taxon::PaperclipAttachment'
+    class_name_attribute :taxon_attachment_module, default: Spree::RailsCompatibility.default_taxon_attachment_module
+
+    # 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.
+    #
+    # @!attribute [rw] migration_path
+    # @return [Pathname] the configured path. (default: `Rails.root.join('db', 'migrate')`)
+    attr_writer :migration_path
+    def migration_path
+      @migration_path ||= ::Rails.root.join('db', 'migrate')
+    end
 
     # Allows providing your own class instance for generating order numbers.
     #
@@ -595,6 +664,7 @@ module Spree
 
         env.calculators.tax_rates = %w[
           Spree::Calculator::DefaultTax
+          Spree::Calculator::FlatFee
         ]
 
         env.payment_methods = %w[

data/lib/spree/bus.rb

@@ -0,0 +1,20 @@
+require 'omnes'
+
+module Spree
+  # Global [Omnes](https://github.com/nebulab/omnes) bus.
+  #
+  # This is used for internal events, while host applications are also able to
+  # use it.
+  #
+  # It has some modifications to support internal usage of the legacy event
+  # system {see Spree::AppConfiguration#use_legacy_events}.
+  Bus = Omnes::Bus.new
+  def Bus.publish(event, **kwargs)
+    if Spree::Config.use_legacy_events
+      Spree::Event.fire(event, **kwargs)
+    else
+      # Override caller_location to point to the actual event publisher
+      super(event, **kwargs, caller_location: caller_locations(1)[0])
+    end
+  end
+end

data/lib/spree/core/class_constantizer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/module'
+
 module Spree
   module Core
     module ClassConstantizer

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

@@ -18,24 +18,12 @@ module Spree
         included do
           before_action :set_guest_token
           helper_method :try_spree_current_user
+          helper_method :spree_current_user
 
           class_attribute :unauthorized_redirect
           self.unauthorized_redirect = -> do
             flash[:error] = I18n.t('spree.authorization_failure')
-            if Spree::Config.redirect_back_on_unauthorized
-              redirect_back(fallback_location: "/unauthorized")
-            else
-              Spree::Deprecation.warn <<-WARN.strip_heredoc, caller
-                Having Spree::Config.redirect_back_on_unauthorized set
-                to `false` is deprecated and will not be supported in Solidus 3.0.
-
-                Please change this configuration to `true` and be sure that your
-                application does not break trying to redirect back when there is
-                an unauthorized access.
-              WARN
-
-              redirect_to "/unauthorized"
-            end
+            redirect_back(fallback_location: "/unauthorized")
           end
 
           rescue_from CanCan::AccessDenied do
@@ -45,7 +33,7 @@ module Spree
 
         # Needs to be overriden so that we use Spree's Ability rather than anyone else's.
         def current_ability
-          @current_ability ||= Spree::Ability.new(try_spree_current_user)
+          @current_ability ||= Spree::Ability.new(spree_current_user)
         end
 
         def redirect_back_or_default(default)
@@ -66,6 +54,11 @@ module Spree
           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
+
         # proxy method to *possible* spree_current_user method
         # Authentication extensions (such as spree_auth_devise) are meant to provide spree_current_user
         def try_spree_current_user
@@ -78,6 +71,8 @@ module Spree
             current_spree_user
           end
         end
+
+        deprecate try_spree_current_user: :spree_current_user, deprecator: Spree::Deprecation
       end
     end
   end

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

@@ -7,9 +7,11 @@ module Spree
         extend ActiveSupport::Concern
 
         included do
-          before_action do
-            ActiveStorage::Current.host = request.base_url
-          end
+          Spree::Deprecation.warn <<~MSG
+            'Spree::Core::ControllerHelpers::CurrentHost' is deprecated.
+            Please, include 'ActiveStorage::SetCurrent' instead.
+          MSG
+          include ActiveStorage::SetCurrent
         end
       end
     end

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

@@ -11,23 +11,8 @@ module Spree
 
         included do
           helper_method :current_order
-          helper_method :simple_current_order
         end
 
-        def simple_current_order
-          return @simple_current_order if @simple_current_order
-
-          @simple_current_order = find_order_by_token_or_user
-
-          if @simple_current_order
-            @simple_current_order.last_ip_address = ip_address
-            return @simple_current_order
-          else
-            @simple_current_order = Spree::Order.new(current_order_params)
-          end
-        end
-        deprecate simple_current_order: :current_order, deprecator: Spree::Deprecation
-
         # 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
@@ -39,9 +24,9 @@ module Spree
 
           if should_build && (@current_order.nil? || @current_order.completed?)
             @current_order = Spree::Order.new(new_order_params)
-            @current_order.user ||= try_spree_current_user
+            @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 ||= try_spree_current_user
+            @current_order.created_by ||= spree_current_user
             @current_order.save! if should_create
           end
 
@@ -53,15 +38,15 @@ module Spree
 
         def associate_user
           @order ||= current_order
-          if try_spree_current_user && @order
-            @order.associate_user!(try_spree_current_user) if @order.user.blank? || @order.email.blank?
+          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 try_spree_current_user && current_order
-            try_spree_current_user.orders.by_store(current_store).incomplete.where('id != ?', current_order.id).each do |order|
-              current_order.merge!(order, try_spree_current_user)
+          if spree_current_user && current_order
+            spree_current_user.orders.by_store(current_store).incomplete.where('id != ?', current_order.id).each do |order|
+              current_order.merge!(order, spree_current_user)
             end
           end
         end
@@ -73,30 +58,25 @@ module Spree
         private
 
         def last_incomplete_order
-          @last_incomplete_order ||= try_spree_current_user.last_incomplete_spree_order(store: current_store)
+          @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: try_spree_current_user.try(:id) }
+          { 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 = {}, with_adjustments = false)
+        def find_order_by_token_or_user(options = {})
           should_lock = options[:lock] || false
 
           # Find any incomplete orders for the guest_token
-          if with_adjustments
-            Spree::Deprecation.warn "The second argument to find_order_by_token_or_user is deprecated, and will be removed in a future version."
-            order = Spree::Order.incomplete.includes(:adjustments).lock(should_lock).find_by(current_order_params)
-          else
-            order = Spree::Order.incomplete.lock(should_lock).find_by(current_order_params)
-          end
+          order = Spree::Order.incomplete.lock(should_lock).find_by(current_order_params)
 
           # Find any incomplete orders for the current user
-          if order.nil? && try_spree_current_user
+          if order.nil? && spree_current_user
             order = last_incomplete_order
           end
 

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

@@ -64,60 +64,6 @@ module Spree
       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: {
-    #      existing_card: '123',
-    #      ...other params...
-    #    },
-    #    cvc_confirm: '456', # optional
-    #    ...other params...
-    #  }
-    #
-    # And this method modifies the params into the format of:
-    #
-    #  {
-    #    order: {
-    #      payments_attributes: [
-    #        {
-    #          source_attributes: {
-    #            existing_card_id: '123',
-    #            verification_value: '456',
-    #          },
-    #        },
-    #      ]
-    #      ...other params...
-    #    },
-    #    ...other params...
-    #  }
-    #
-    def move_existing_card_into_payments_attributes(params)
-      return params if params[:order].blank?
-
-      card_id = params[:order][:existing_card].presence
-      cvc_confirm = params[:cvc_confirm].presence
-
-      return params if card_id.nil?
-
-      params[:order][:payments_attributes] = [
-        {
-          source_attributes: {
-            existing_card_id: card_id,
-            verification_value: cvc_confirm
-          }
-        }
-      ]
-
-      params[:order].delete(:existing_card)
-      params.delete(:cvc_confirm)
-
-      params
-    end
-
     # This method handles the awkwardness of how the html forms are currently
     # set up for frontend.
     #

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spree/deprecation'
-
 module Spree
   module Core
     module ControllerHelpers
@@ -9,18 +7,12 @@ module Spree
         extend ActiveSupport::Concern
 
         included do
-          helper_method :current_currency
           helper_method :current_pricing_options
         end
 
         def current_pricing_options
           Spree::Config.pricing_options_class.from_context(self)
         end
-
-        def current_currency
-          current_pricing_options.currency
-        end
-        deprecate current_currency: :current_pricing_options, deprecator: Spree::Deprecation
       end
     end
   end

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

@@ -6,7 +6,7 @@ module Spree
       module Search
         def build_searcher(params)
           Spree::Config.searcher_class.new(params).tap do |searcher|
-            searcher.current_user = try_spree_current_user
+            searcher.current_user = spree_current_user
             searcher.pricing_options = current_pricing_options
           end
         end

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

@@ -30,10 +30,6 @@ module Spree
           ]
         end
 
-        def permitted_checkout_attributes
-          permitted_attributes.checkout_attributes
-        end
-
         def permitted_checkout_address_attributes
           permitted_attributes.checkout_address_attributes
         end