solidus_core 2.11.10 → 3.3.1

data/lib/spree/core/engine.rb

@@ -15,6 +15,12 @@ module Spree
         generator.test_framework :rspec
       end
 
+      if ActiveRecord.respond_to?(:yaml_column_permitted_classes) || ActiveRecord::Base.respond_to?(:yaml_column_permitted_classes)
+        config.active_record.yaml_column_permitted_classes ||= []
+        config.active_record.yaml_column_permitted_classes |=
+          [Symbol, BigDecimal, ActiveSupport::HashWithIndifferentAccess]
+      end
+
       initializer "spree.environment", before: :load_config_initializers do |app|
         app.config.spree = Spree::Config.environment
       end
@@ -40,67 +46,65 @@ module Spree
         ]
       end
 
-      initializer "spree.core.checking_migrations", before: :load_config_initializers do |_app|
+      initializer "spree.core.checking_migrations", after: :load_config_initializers do |_app|
         Migrations.new(config, engine_name).check
       end
 
-      # Setup Event Subscribers
-      initializer 'spree.core.initialize_subscribers' do |app|
-        app.reloader.to_prepare do
-          Spree::Event.activate_autoloadable_subscribers
-        end
+      # Setup pub/sub
+      initializer 'spree.core.pub_sub' do |app|
+        if Spree::Config.use_legacy_events
+          app.reloader.to_prepare do
+            Spree::Event.activate_autoloadable_subscribers
+          end
+
+          app.reloader.before_class_unload do
+            Spree::Event.deactivate_all_subscribers
+          end
+        else
+          app.reloader.to_prepare do
+            Spree::Bus.clear
+
+            %i[
+              order_finalized
+              order_recalculated
+              reimbursement_reimbursed
+              reimbursement_errored
+            ].each { |event_name| Spree::Bus.register(event_name) }
 
-        app.reloader.before_class_unload do
-          Spree::Event.deactivate_all_subscribers
+            Spree::OrderMailerSubscriber.new.subscribe_to(Spree::Bus)
+          end
         end
       end
 
+      # Load in mailer previews for apps to use in development.
+      initializer "spree.core.action_mailer.set_preview_path", after: "action_mailer.set_configs" do |app|
+        original_preview_path = app.config.action_mailer.preview_path
+        solidus_preview_path = Spree::Core::Engine.root.join 'lib/spree/mailer_previews'
+
+        app.config.action_mailer.preview_path = "{#{original_preview_path},#{solidus_preview_path}}"
+        ActionMailer::Base.preview_path = app.config.action_mailer.preview_path
+      end
+
       config.after_initialize do
-        if Spree::Config.raise_with_invalid_currency == true
-          Spree::Deprecation.warn(
-            'Spree::Config.raise_with_invalid_currency set to true is ' \
-            'deprecated. Please note that by switching this value, ' \
-            'Spree::LineItem::CurrencyMismatch will not be raised anymore.',
-            caller
-          )
-        end
-        if Spree::Config.consider_actionless_promotion_active == true
-          Spree::Deprecation.warn(
-            'Spree::Config.consider_actionless_promotion_active set to true is ' \
-            'deprecated. Please note that by switching this value, ' \
-            'promotions with no actions will be considered active.',
-            caller
-          )
-        end
-        if Spree::Config.run_order_validations_on_order_updater != true
-          Spree::Deprecation.warn(
-            'Spree::Config.run_order_validations_on_order_updater set to false is ' \
-            'deprecated and will not be possibile in Solidus 3.0. Please switch this ' \
-            'value to true and check that everything works as expected.',
-            caller
-          )
-        end
+        Spree::Config.check_load_defaults_called('Spree::Config')
+        Spree::Config.static_model_preferences.validate!
+      end
 
-        if Spree::Config.use_legacy_address_state_validator != false
-          Spree::Deprecation.warn(<<~DEPRECATION.squish, caller)
-            Spree::Config.use_legacy_address_state_validator set to true has been
-            deprecated and will be removed in Solidus 3.0. The Spree::Address state
-            validation has been extracted into a configurable external class.
-            Switch Spree::Config.use_legacy_address_state_validator to false to start
-            using the external validation class.
-          DEPRECATION
+      config.after_initialize do
+        if defined?(Spree::Auth::Engine) &&
+            Gem::Version.new(Spree::Auth::VERSION) < Gem::Version.new('2.5.4') &&
+            defined?(Spree::UsersController)
+          Spree::UsersController.protect_from_forgery with: :exception
         end
+      end
 
-        # Load in mailer previews for apps to use in development.
-        # We need to make sure we call `Preview.all` before requiring our
-        # previews, otherwise any previews the app attempts to add need to be
-        # manually required.
-        if Rails.env.development? || Rails.env.test?
-          ActionMailer::Preview.all
-
-          Dir[root.join("lib/spree/mailer_previews/**/*_preview.rb")].each do |file|
-            require_dependency file
-          end
+      config.after_initialize do
+        if Spree::Config.use_legacy_events && !ENV['CI']
+          Spree::Deprecation.warn <<~MSG
+            Your Solidus store is using the legacy event system. You're
+            encouraged to switch to the new event bus. After you're done, you
+            can remove the `use_legacy_events` setting from `spree.rb`.
+          MSG
         end
       end
     end

data/lib/spree/core/environment_extension.rb

@@ -22,15 +22,6 @@ module Spree
           end
         end
       end
-
-      def add_class(name)
-        Spree::Deprecation.warn(
-          'This method is deprecated. ' \
-          "Please use `#{self.class}.add_class_set(#{name.inspect})` instead.",
-          caller,
-        )
-        singleton_class.send(:add_class_set, name)
-      end
     end
   end
 end

data/lib/spree/core/product_filters.rb

@@ -61,7 +61,7 @@ module Spree
           scope = scope.or(new_scope)
         end
 
-        Spree::Product.joins(master: :default_price).where(scope)
+        Spree::Product.joins(master: :prices).where(scope)
       end
 
       def self.format_price(amount)
@@ -153,46 +153,6 @@ module Spree
           labels: brands.sort.map { |key| [key, key] }
         }
       end
-
-      # Provide filtering on the immediate children of a taxon
-      #
-      # This doesn't fit the pattern of the examples above, so there's a few changes.
-      # Firstly, it uses an existing scope which was not built for filtering - and so
-      # has no need of a conditions mapping, and secondly, it has a mapping of name
-      # to the argument type expected by the other scope.
-      #
-      # This technique is useful for filtering on objects (by passing ids) or with a
-      # scope that can be used directly (eg. testing only ever on a single property).
-      #
-      # This scope selects products in any of the active taxons or their children.
-      #
-      def self.taxons_below(taxon)
-        Spree::Deprecation.warn "taxons_below is deprecated in solidus_core. Please add it to your own application to continue using it."
-        return Spree::Core::ProductFilters.all_taxons if taxon.nil?
-        {
-          name:   'Taxons under ' + taxon.name,
-          scope:  :taxons_id_in_tree_any,
-          labels: taxon.children.sort_by(&:position).map { |element| [element.name, element.id] },
-          conds:  nil
-        }
-      end
-
-      # Filtering by the list of all taxons
-      #
-      # Similar idea as above, but we don't want the descendants' products, hence
-      # it uses one of the auto-generated scopes from Ransack.
-      #
-      # idea: expand the format to allow nesting of labels?
-      def self.all_taxons
-        Spree::Deprecation.warn "all_taxons is deprecated in solidus_core. Please add it to your own application to continue using it."
-        taxons = Spree::Taxonomy.all.flat_map { |element| [element.root] + element.root.descendants }
-        {
-          name:   'All taxons',
-          scope:  :taxons_id_equals_any,
-          labels: taxons.sort_by(&:name).map { |element| [element.name, element.id] },
-          conds:  nil # not needed
-        }
-      end
     end
   end
 end

data/lib/spree/core/role_configuration.rb

@@ -31,20 +31,6 @@ module Spree
 
     attr_accessor :roles
 
-    class << self
-      def instance
-        Spree::Deprecation.warn "Spree::RoleConfiguration.instance is DEPRECATED use Spree::Config.roles instead"
-        Spree::Config.roles
-      end
-
-      # Yields the instance of the singleton, used for configuration
-      # @yieldparam instance [Spree::RoleConfiguration]
-      def configure
-        Spree::Deprecation.warn "Spree::RoleConfiguration.configure is deprecated. Call Spree::Config.roles.assign_permissions instead"
-        yield(Spree::Config.roles)
-      end
-    end
-
     # Given a CanCan::Ability, and a user, determine what permissions sets can
     # be activated on the ability, then activate them.
     #

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

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
-require 'spree/deprecation'
-
 module Spree
   module Core
     module Search
       class Base
+        class InvalidOptions < ArgumentError
+          def initialize(option)
+            super("Invalid option passed to the searcher: '#{option}'")
+          end
+        end
+
         attr_accessor :properties
         attr_accessor :current_user
         attr_accessor :pricing_options
@@ -16,17 +20,6 @@ module Spree
           prepare(params)
         end
 
-        def current_currency=(currency)
-          self.pricing_options = Spree::Config.pricing_options_class.new(
-            pricing_options.desired_attributes.merge(currency: currency)
-          )
-        end
-
-        def current_currency
-          pricing_options.currency
-        end
-        deprecate :current_currency, :current_currency=, deprecator: Spree::Deprecation
-
         def retrieve_products
           @products = get_base_scope
           curr_page = @properties[:page] || 1
@@ -37,19 +30,6 @@ module Spree
           @products = @products.page(curr_page).per(@properties[:per_page])
         end
 
-        def method_missing(name)
-          if @properties.key?(name)
-            Spree::Deprecation.warn "Accessing Searcher's #{name} property using #{self.class.name}##{name} is deprecated without replacement"
-            @properties[name]
-          else
-            super
-          end
-        end
-
-        def respond_to_missing?(name)
-          @properties.key?(name) || super(name)
-        end
-
         protected
 
         def get_base_scope
@@ -77,22 +57,25 @@ module Spree
           # separate queries most of the time but opt for a join as soon as any
           # `where` constraints affecting joined tables are added to the search;
           # which is the case as soon as a taxon is added to the base scope.
-          scope = scope.preload(master: :currently_valid_prices)
+          scope = scope.preload(master: :prices)
           scope = scope.preload(master: :images) if @properties[:include_images]
           scope
         end
 
         def add_search_scopes(base_scope)
-          if @properties[:search]
-            @properties[:search].each do |name, scope_attribute|
-              scope_name = name.to_sym
-              if base_scope.respond_to?(:search_scopes) && base_scope.search_scopes.include?(scope_name.to_sym)
-                base_scope = base_scope.send(scope_name, *scope_attribute)
-              else
-                base_scope = base_scope.merge(Spree::Product.ransack({ scope_name => scope_attribute }).result)
-              end
+          return base_scope unless @properties[:search].present?
+          raise InvalidOptions.new(:search) unless @properties[:search].respond_to?(:each_pair)
+
+          @properties[:search].each_pair do |name, scope_attribute|
+            scope_name = name.to_sym
+
+            if base_scope.respond_to?(:search_scopes) && base_scope.search_scopes.include?(scope_name.to_sym)
+              base_scope = base_scope.send(scope_name, *scope_attribute)
+            else
+              base_scope = base_scope.merge(Spree::Product.ransack({ scope_name => scope_attribute }).result)
             end
           end
+
           base_scope
         end
 

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

@@ -73,7 +73,7 @@ module Spree
               end
 
               event :complete do
-                transition to: :complete, from: :confirm
+                transition to: :complete, from: klass.checkout_steps.keys.last
               end
 
               if states[:payment]
@@ -119,7 +119,7 @@ module Spree
                 before_transition to: :complete, do: :process_payments_before_complete
               end
 
-              after_transition to: :complete, do: :finalize!
+              after_transition to: :complete, do: :finalize
               after_transition to: :resumed,  do: :after_resume
               after_transition to: :canceled, do: :after_cancel
 

data/lib/spree/core/state_machines.rb

@@ -68,17 +68,8 @@ module Spree
 
       def order
         @order ||= begin
-          if Spree::Config.use_legacy_order_state_machine
-            Spree::Deprecation.warn(
-              "Spree::Order state machine defined in Spree::Order::Checkout is deprecated. " \
-              "Future versions of Solidus will use Spree::Core::StateMachines::Order}",
-              caller
-            )
-            'Spree::Order::Checkout'
-          else
-            require 'spree/core/state_machines/order'
-            'Spree::Core::StateMachines::Order'
-          end
+          require 'spree/core/state_machines/order'
+          'Spree::Core::StateMachines::Order'
         end
 
         @order.constantize

data/lib/spree/core/stock_configuration.rb

@@ -8,6 +8,9 @@ module Spree
       attr_writer :location_filter_class
       attr_writer :location_sorter_class
       attr_writer :allocator_class
+      attr_writer :inventory_unit_builder_class
+      attr_writer :availability_validator_class
+      attr_writer :inventory_validator_class
 
       def coordinator_class
         @coordinator_class ||= '::Spree::Stock::SimpleCoordinator'
@@ -33,6 +36,21 @@ module Spree
         @allocator_class ||= '::Spree::Stock::Allocator::OnHandFirst'
         @allocator_class.constantize
       end
+
+      def inventory_unit_builder_class
+        @inventory_unit_builder_class ||= '::Spree::Stock::InventoryUnitBuilder'
+        @inventory_unit_builder_class.constantize
+      end
+
+      def availability_validator_class
+        @availability_validator_class ||= '::Spree::Stock::AvailabilityValidator'
+        @availability_validator_class.constantize
+      end
+ 
+      def inventory_validator_class
+        @inventory_validator_class ||= '::Spree::Stock::InventoryValidator'
+        @inventory_validator_class.constantize
+      end
     end
   end
 end

data/lib/spree/core/validators/email.rb

@@ -12,11 +12,13 @@ module Spree
   #     end
   #
   class EmailValidator < ActiveModel::EachValidator
-    EMAIL_REGEXP = /\A([^@\.]|[^@\.]([^@\s]*)[^@\.])@([^@\s]+\.)+[^@\s]+\z/
+    EMAIL_REGEXP = URI::MailTo::EMAIL_REGEXP
+    # Use Spree::Config.default_email_regexp instead
+    deprecate_constant :EMAIL_REGEXP
 
     def validate_each(record, attribute, value)
-      unless EMAIL_REGEXP.match? value
-        record.errors.add(attribute, :invalid, { value: value }.merge!(options))
+      unless Spree::Config.default_email_regexp.match? value
+        record.errors.add(attribute, :invalid, **{ value: value }.merge!(options))
       end
     end
   end

data/lib/spree/core/version.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
 module Spree
-  VERSION = "2.11.10"
+  VERSION = "3.3.1"
 
   def self.solidus_version
     VERSION
   end
 
+  def self.previous_solidus_minor_version
+    '3.2'
+  end
+
   def self.solidus_gem_version
     Gem::Version.new(solidus_version)
   end

data/lib/spree/core/versioned_value.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Spree
+  module Core
+    # Wrapper for a value that can be different depending on the Solidus version
+    #
+    # Some configuration defaults can be added or changed when a new Solidus
+    # version is released. This class encapsulates getting the correct value for a
+    # given Solidus version.
+    #
+    # The way it works is you provide an initial value in time, plus the version
+    # boundary where it got changed. Then you can fetch the value providing the
+    # desired Solidus version:
+    #
+    # @example
+    #   value = VersionedValue.new(true, "3.0.0" => false)
+    #   value.call("2.7.0") # => true
+    #   value.call("3.0.0") # => false
+    #   value.call("3.1.0") # => false
+    #
+    # Remember that you must provide the exact boundary when a value got changed,
+    # which could easily be during a pre-release:
+    #
+    # @example
+    #   value = VersionedValue.new(true, "3.0.0" => false)
+    #   value.call("3.0.0.alpha") # => true
+    #
+    #   value = VersionedValue.new(true, "3.0.0.alpha" => false)
+    #   value.call("3.0.0.alpha") # => false
+    #
+    # Multiple boundaries can also be provided:
+    #
+    # @example
+    #   value = VersionedValue.new(0, "2.0.0" => 1, "3.0.0" => 2)
+    #   value.call("1.0.0") # => 0
+    #   value.call("2.1.0") # => 1
+    #   value.call("3.0.0") # => 2
+    class VersionedValue
+      attr_reader :boundaries
+
+      # @param initial_value [Any]
+      # @param boundary [Hash<String, Any>] Map from version number to new value
+      def initialize(initial_value, boundaries = {})
+        @boundaries = Hash[
+                        { '0' => initial_value }
+                        .merge(boundaries)
+                        .transform_keys { |version| to_gem_version(version) }
+                        .sort
+                      ]
+      end
+
+      # @param solidus_version [String]
+      def call(solidus_version = Spree.solidus_version)
+        solidus_version = to_gem_version(solidus_version)
+        boundaries.fetch(
+          boundaries
+            .keys
+            .reduce do |target, following|
+              if target <= solidus_version && solidus_version < following
+                target
+              else
+                following
+              end
+            end
+        )
+      end
+
+      private
+
+      def to_gem_version(string)
+        Gem::Version.new(string)
+      end
+    end
+  end
+end

data/lib/spree/core.rb

@@ -1,27 +1,33 @@
 # frozen_string_literal: true
 
-require 'rails/all'
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "active_job/railtie"
+require "active_model/railtie"
+require "active_record/railtie"
+require "active_storage/engine"
+require "sprockets/railtie"
+
 require 'acts_as_list'
 require 'awesome_nested_set'
 require 'cancan'
 require 'friendly_id'
 require 'kaminari/activerecord'
-require 'mail'
 require 'monetize'
 require 'paperclip'
-require 'paranoia'
 require 'ransack'
 require 'state_machines-activerecord'
 
 require 'spree/deprecation'
-require 'spree/paranoia_deprecations'
+require 'spree/rails_compatibility'
 
 # This is required because ActiveModel::Validations#invalid? conflicts with the
 # invalid state of a Payment. In the future this should be removed.
 StateMachines::Machine.ignore_method_conflicts = true
 
 module Spree
-  mattr_accessor :user_class
+  mattr_accessor :user_class, default: 'Spree::LegacyUser'
 
   def self.user_class
     if @@user_class.is_a?(Class)
@@ -31,6 +37,16 @@ module Spree
     end
   end
 
+  # Load the same version defaults for all available Solidus components
+  #
+  # @see Spree::Preferences::Configuration#load_defaults
+  def self.load_defaults(version)
+    Spree::Config.load_defaults(version)
+    Spree::Frontend::Config.load_defaults(version) if defined?(Spree::Frontend::Config)
+    Spree::Backend::Config.load_defaults(version) if defined?(Spree::Backend::Config)
+    Spree::Api::Config.load_defaults(version) if defined?(Spree::Api::Config)
+  end
+
   # Used to configure Spree.
   #
   # Example:
@@ -46,10 +62,25 @@ module Spree
   end
 
   module Core
-    class GatewayError < RuntimeError; end
+    # @api private
+    def self.has_install_generator_been_run?(rails_paths: Rails.application.paths, initializer_name: 'spree.rb', dummy_app_name: 'DummyApp::Application')
+      does_spree_initializer_exist?(rails_paths, initializer_name) ||
+        running_solidus_test_suite_with_dummy_app?(dummy_app_name)
+    end
 
-    include ActiveSupport::Deprecation::DeprecatedConstantAccessor
-    deprecate_constant 'DestroyWithOrdersError', ActiveRecord::DeleteRestrictionError, deprecator: Spree::Deprecation
+    def self.running_solidus_test_suite_with_dummy_app?(dummy_app_name)
+      Rails.env.test? && Rails.application.class.name == dummy_app_name
+    end
+    private_class_method :running_solidus_test_suite_with_dummy_app?
+
+    def self.does_spree_initializer_exist?(rails_paths, initializer_name)
+      rails_paths['config/initializers'].any? do |path|
+        File.exist?(Pathname.new(path).join(initializer_name))
+      end
+    end
+    private_class_method :does_spree_initializer_exist?
+
+    class GatewayError < RuntimeError; end
   end
 end
 
@@ -61,10 +92,10 @@ require 'spree/core/environment_extension'
 require 'spree/core/environment/calculators'
 require 'spree/core/environment/promotions'
 require 'spree/core/environment'
-require 'spree/promo/environment'
 require 'spree/migrations'
 require 'spree/migration_helpers'
 require 'spree/event'
+require 'spree/bus'
 require 'spree/core/engine'
 
 require 'spree/i18n'
@@ -75,10 +106,8 @@ require 'spree/permitted_attributes'
 require 'spree/core/importer'
 require 'spree/core/permalinks'
 require 'spree/core/product_duplicator'
-require 'spree/core/current_store'
 require 'spree/core/controller_helpers/auth'
 require 'spree/core/controller_helpers/common'
-require 'spree/core/controller_helpers/current_host'
 require 'spree/core/controller_helpers/order'
 require 'spree/core/controller_helpers/payment_parameters'
 require 'spree/core/controller_helpers/pricing'

data/lib/spree/deprecation.rb

@@ -3,7 +3,7 @@
 require 'active_support/deprecation'
 
 module Spree
-  Deprecation = ActiveSupport::Deprecation.new('3.0', 'Solidus')
+  Deprecation = ActiveSupport::Deprecation.new('4.0', 'Solidus')
 
   # This DeprecatedInstanceVariableProxy transforms instance variable to
   # deprecated instance variable.

data/lib/spree/event/configuration.rb

@@ -7,11 +7,6 @@ module Spree
         @subscriber_registry ||= Spree::Event::SubscriberRegistry.new
       end
 
-      def subscribers
-        Spree::Deprecation.warn("`Spree::Config.events.subscribers` is deprecated. Please use `Spree::Config.events.subscriber_registry`.", caller)
-        subscriber_registry.send(:registry).keys.map { |module_name| module_name.constantize }
-      end
-
       attr_writer :adapter, :suffix, :autoload_subscribers
 
       def autoload_subscribers

data/lib/spree/event/subscriber.rb

@@ -59,14 +59,6 @@ module Spree
       #     end
       #   end
       def event_action(method_name, event_name: nil)
-        mattr_writer "#{method_name}_handler"
-
-        define_method "#{method_name}_handler" do
-          Spree::Deprecation.warn("#{name}.#{method_name}_handler and #{name}.#{method_name}_handler= from the old events mapping interface are deprecated. Please use the new mapping stored in Spree::Event.subscribers.", caller)
-
-          class_variable_get("@@#{method_name}_handler")
-        end
-
         event_actions[method_name] = (event_name || method_name).to_s
       end
 
@@ -89,16 +81,6 @@ module Spree
       def deactivate(event_action_name = nil)
         Spree::Event.subscriber_registry.deactivate_subscriber(self, event_action_name)
       end
-
-      def subscribe!
-        Spree::Deprecation.warn("#{self}.subscribe! is deprecated. Please use `#{self}.activate`.", caller)
-        activate
-      end
-
-      def unsubscribe!
-        Spree::Deprecation.warn("#{self}.unsubscribe! is deprecated. Please use `#{self}.deactivate`.", caller)
-        deactivate
-      end
     end
   end
 end