solidus_core 3.1.6 → 3.2.0

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,18 +46,33 @@ 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
 
@@ -75,6 +96,16 @@ module Spree
           Spree::UsersController.protect_from_forgery with: :exception
         end
       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
   end
 end

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

@@ -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/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

@@ -13,9 +13,11 @@ module Spree
   #
   class EmailValidator < ActiveModel::EachValidator
     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
+      unless Spree::Config.default_email_regexp.match? value
         record.errors.add(attribute, :invalid, **{ value: value }.merge!(options))
       end
     end

data/lib/spree/core/version.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module Spree
-  VERSION = "3.1.6"
+  VERSION = "3.2.0"
 
   def self.solidus_version
     VERSION
   end
 
   def self.previous_solidus_minor_version
-    '3.0'
+    '3.1'
   end
 
   def self.solidus_gem_version

data/lib/spree/core.rb

@@ -21,6 +21,7 @@ require 'ransack'
 require 'state_machines-activerecord'
 
 require 'spree/deprecation'
+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.
@@ -84,6 +85,24 @@ module Spree
   end
 end
 
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.7")
+  Spree::Deprecation.warn <<~HEREDOC
+    Ruby 2.5 & Ruby 2.6 (both EOL) are deprecated and will not be supported anymore from the next Solidus version.
+    Please, upgrade to a more recent Ruby version.
+    Read more on the release notes for different Ruby versions here:
+    https://www.ruby-lang.org/en/downloads/releases/
+  HEREDOC
+end
+
+if Gem::Version.new(Rails.version) < Gem::Version.new('6.0')
+  Spree::Deprecation.warn <<~HEREDOC
+    Rails 5.2 (EOL) is deprecated and will not be supported anymore from the next Solidus version.
+    Please, upgrade to a more recent Rails version.
+    Read more on upgrading from Rails 5.2 to Rails 6.0 here:
+    https://guides.rubyonrails.org/upgrading_ruby_on_rails.html#upgrading-from-rails-5-2-to-rails-6-0
+  HEREDOC
+end
+
 require 'spree/core/version'
 
 require 'spree/core/active_merchant_dependencies'
@@ -95,6 +114,7 @@ require 'spree/core/environment'
 require 'spree/migrations'
 require 'spree/migration_helpers'
 require 'spree/event'
+require 'spree/bus'
 require 'spree/core/engine'
 
 require 'spree/i18n'

data/lib/spree/event/subscriber_registry.rb

@@ -64,13 +64,11 @@ module Spree
       # Loading the files has the side effect of adding their module to the
       # list in Spree::Event.subscribers.
       def require_subscriber_files
-        pattern = "app/subscribers/**/*_subscriber.rb"
+        require_dependency(
+          Spree::Core::Engine.root.join('app', 'subscribers', 'spree', 'mailer_subscriber.rb')
+        )
 
-        # Load Solidus subscribers
-        # rubocop:disable Rails/DynamicFindBy
-        solidus_core_dir = Gem::Specification.find_by_name('solidus_core').gem_dir
-        # rubocop:enable Rails/DynamicFindBy
-        Dir.glob(File.join(solidus_core_dir, pattern)) { |c| require_dependency(c.to_s) }
+        pattern = "app/subscribers/**/*_subscriber.rb"
 
         # Load application subscribers, only when the flag is set to true:
         if Spree::Config.events.autoload_subscribers

data/lib/spree/event.rb

@@ -21,7 +21,7 @@ module Spree
     #
     # @example Trigger an event named 'order_finalized'
     #   Spree::Event.fire 'order_finalized', order: @order do
-    #     @order.finalize!
+    #     @order.complete!
     #   end
     def fire(event_name, opts = {})
       adapter.fire normalize_name(event_name), opts do

data/lib/spree/migrations.rb

@@ -66,7 +66,7 @@ module Spree
     end
 
     def app_dir
-      "#{Rails.root}/db/migrate"
+      Spree::Config.migration_path
     end
 
     def engine_dir

data/lib/spree/permission_sets/default_customer.rb

@@ -7,7 +7,14 @@ module Spree
         can :read, Country
         can :read, OptionType
         can :read, OptionValue
-        can :create, Order
+        can :create, Order do |order, token|
+          # same user, or both nil
+          order.user == user ||
+          # guest checkout order
+          order.email.present? ||
+          # via API, just like with show and update
+          (order.guest_token.present? && token == order.guest_token)
+        end
         can [:show, :update], Order, Order.where(user: user) do |order, token|
           order.user == user || (order.guest_token.present? && token == order.guest_token)
         end

data/lib/spree/permitted_attributes.rb

@@ -65,10 +65,10 @@ module Spree
 
     @@line_item_attributes = [:id, :variant_id, :quantity]
 
-    @@option_type_attributes = [:name, :presentation, :option_values_attributes]
-
     @@option_value_attributes = [:name, :presentation]
 
+    @@option_type_attributes = [:name, :presentation, option_values_attributes: option_value_attributes]
+
     @@payment_attributes = [:amount, :payment_method_id, :payment_method]
 
     @@product_properties_attributes = [:property_name, :value, :position]
@@ -131,8 +131,8 @@ module Spree
     @@variant_attributes = [
       :name, :presentation, :cost_price, :lock_version,
       :position, :track_inventory,
-      :product_id, :product, :option_values_attributes, :price,
-      :weight, :height, :width, :depth, :sku, :cost_currency, option_value_ids: [], options: [:name, :value]
+      :product_id, :product, :price,
+      :weight, :height, :width, :depth, :sku, :cost_currency, :tax_category_id, option_value_ids: [], options: [:name, :value]
     ]
 
     @@checkout_address_attributes = [

data/lib/spree/preferences/configuration.rb

@@ -38,6 +38,7 @@ module Spree::Preferences
     #     defaults. Set via {#load_defaults}
     attr_reader :loaded_defaults
 
+    # @api private
     attr_reader :load_defaults_called
 
     def initialize
@@ -45,9 +46,9 @@ module Spree::Preferences
       @load_defaults_called = false
     end
 
-    # @param [String] Solidus version from which take defaults when not
-    # overriden.
-    # @see #load_defaults
+    # @param [String] Solidus version from which take defaults when preferences
+    # are not overriden by the user.
+    # @see #loaded_defaults
     def load_defaults(version)
       @loaded_defaults = version
       @load_defaults_called = true
@@ -118,21 +119,35 @@ module Spree::Preferences
       end
     end
 
-    # Generates a different preference default depending on {#version_defaults}
+    def self.inherited(klass)
+      klass.instance_variable_set(:@versioned_preferences, [])
+      class << klass
+        attr_reader :versioned_preferences
+      end
+    end
+
+    # Adds a preference with different default depending on {#loaded_defaults}
     #
-    # This method is meant to be used in the `default:` keyword argument for
-    # {.preference}. For instance, in the example, `foo`'s default was `true`
-    # until version 3.0.0.alpha, when it became `false`:
+    # This method is a specialized version of {.preference} that generates a
+    # different default value for different Solidus versions. For instance, in
+    # the example, `foo`'s default was `true` until version 3.0.0.alpha, when it
+    # became `false`:
     #
     # @example
-    #   preference :foo, :boolean, default: by_version(true, "3.0.0.alpha" => false)
+    #   versioned_preference :foo, :boolean, initial_value: true, boundaries: { "3.0.0.alpha" => false }
     #
+    # @see .preference
     # @see #loaded_defaults
     # @see Spree::Core::VersionedValue
-    def self.by_version(*args)
-      proc do |loaded_defaults|
-        Spree::Core::VersionedValue.new(*args).call(loaded_defaults)
-      end
+    def self.versioned_preference(name, type, initial_value:, boundaries:, **options)
+      @versioned_preferences << name
+      preference(
+        name,
+        type,
+        options.merge(
+          default: by_version(initial_value, boundaries)
+        )
+      )
     end
 
     def self.preference(name, type, options = {})
@@ -160,6 +175,13 @@ module Spree::Preferences
       end
     end
 
+    def self.by_version(*args)
+      proc do |loaded_defaults|
+        Spree::Core::VersionedValue.new(*args).call(loaded_defaults)
+      end
+    end
+    private_class_method :by_version
+
     private
 
     def context_for_default

data/lib/spree/preferences/preferable_class_methods.rb

@@ -49,7 +49,7 @@ module Spree::Preferences
 
                       If you want to branch on the provided Solidus version, you can do like the following:
 
-                      preference :foo, :string, default: by_version(true, "3.2.0" => false)
+                      versioned_preference :foo, :string, initial_value: true, boundaries: { "3.2.0" => false }
 
                     MSG
                     ->(_default_context) { given.call }

data/lib/spree/preferences/preference_differentiator.rb

@@ -12,7 +12,8 @@ module Spree
       def call(from:, to:)
         preferences_from = config_class.new.load_defaults(from)
         preferences_to = config_class.new.load_defaults(to)
-        preferences_from.reduce({}) do |changes, (pref_key, value_from)|
+        config_class.versioned_preferences.reduce({}) do |changes, pref_key|
+          value_from = preferences_from[pref_key]
           value_to = preferences_to[pref_key]
           if value_from == value_to
             changes

data/lib/spree/preferences/static_model_preferences.rb

@@ -36,8 +36,6 @@ module Spree
       end
 
       def add(klass, name, preferences)
-        # We use class name instead of class to allow reloading in dev
-        raise "Static model preference '#{name}' on #{klass} is already defined" if @store[klass.to_s][name]
         @store[klass.to_s][name] = Definition.new(klass, preferences)
       end
 

data/lib/spree/rails_compatibility.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Spree
+  # Supported Rails versions compatibility
+  #
+  # This module is meant to wrap some Rails API changes between supported
+  # versions. It's also meant to contain compatibility for features that we use
+  # internally in the Solidus code base.
+  module RailsCompatibility
+    # Method `#to_fs`
+    #
+    # Available since Rails 7.0, substitutes `#to_s(format)`
+    #
+    # It includes:
+    #
+    # ActiveSupport::NumericWithFormat
+    # ActiveSupport::RangeWithFormat
+    # ActiveSupport::TimeWithZone
+    # Array
+    # Date
+    # DateTime
+    # Time
+    #
+    # See https://github.com/rails/rails/pull/43772 &
+    # https://github.com/rails/rails/pull/44354
+    #
+    # TODO: Remove when deprecating Rails 6.1
+    def self.to_fs(value, *args, **kwargs, &block)
+      if version_gte?('7.0')
+        value.to_fs(*args, **kwargs, &block)
+      else
+        value.to_s(*args, **kwargs, &block)
+      end
+    end
+
+    # `raise_on_missing_translations` config option
+    #
+    # Changed from ActionView to I18n on Rails 6.1
+    #
+    # See https://github.com/rails/rails/pull/31571
+    #
+    # TODO: Remove when deprecating Rails 6.0
+    def self.raise_on_missing_translations(value)
+      if version_gte?('6.1')
+        Rails.application.config.i18n.raise_on_missing_translations = value
+      else
+        Rails.application.config.action_view.raise_on_missing_translations = value
+      end
+    end
+
+    # Set current host for ActiveStorage in a controller
+    #
+    # Changed from `#host` to including a module in Rails 6
+    #
+    # See https://github.com/rails/rails/commit/e33c3cd8ccbecaca6c6af0438956431b02cb3fb2
+    #
+    # TODO: Remove when deprecating Rails 5.2
+    def self.active_storage_set_current(controller)
+      if version_gte?('6')
+        controller.include ActiveStorage::SetCurrent
+      else
+        controller.before_action do
+          ActiveStorage::Current.host = request.base_url
+        end
+      end
+    end
+
+    # Set current host for ActiveStorage
+    #
+    # Changed from `#host` to `#url_options` on Rails 7
+    #
+    # See https://github.com/rails/rails/issues/41388
+    #
+    # TODO: Remove when deprecating Rails 6.1
+    def self.active_storage_url_options_host(value)
+      if version_gte?('7')
+        ActiveStorage::Current.url_options = { host: value }
+      else
+        ActiveStorage::Current.host = value
+      end
+    end
+
+    # Default ActiveStorage variant processor
+    #
+    # Changed from `:mini_magick` to `vips` on Rails 7
+    #
+    # See https://github.com/rails/rails/issues/42744
+    #
+    # TODO: Remove when deprecating Rails 6.1
+    def self.variant_processor
+      version_gte?('7') ? :vips : :mini_magick
+    end
+
+    def self.version_gte?(version)
+      ::Rails.gem_version >= Gem::Version.new(version)
+    end
+    private_class_method :version_gte?
+  end
+end

data/lib/spree/testing_support/bus_helpers.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'spree/bus'
+
+module Spree
+  module TestingSupport
+    # RSpec test helpers for the event bus
+    #
+    # If you want to use the methods defined in this module, include it in your
+    # specs:
+    #
+    # @example
+    #   require 'rails_helper'
+    #   require 'spree/testing_support/bus_helpers'
+    #
+    #   RSpec.describe MyClass do
+    #     include Spree::TestingSupport::BusHelpers
+    #   end
+    #
+    # or, globally, in your `spec_helper.rb`:
+    #
+    # @example
+    #   require 'spree/testing_support/bus_helpers'
+    #
+    #   RSpec.configure do |config|
+    #     config.include Spree::TestingSupport::BusHelpers
+    #   end
+    module BusHelpers
+      extend RSpec::Matchers::DSL
+
+      # Stubs {Spree::Bus}
+      #
+      # After you have called this method in an example, {Spree::Bus} will no
+      # longer publish any event for the duration of that example. All the
+      # method invocations on it will be stubbed.
+      #
+      # Internally, it stubs {Spree::Bus#publish}.
+      #
+      # After you call this method, probably you'll want to call some of the
+      # matchers defined in this module.
+      def stub_spree_bus
+        allow(Spree::Bus).to receive(:publish)
+      end
+
+      # @!method have_been_published(event_name)
+      #   Matcher to test that an event has been published via {Spree::Bus#publish}
+      #
+      #   Before using this matcher, you need to call {#stub_spree_bus}.
+      #
+      #   Remember that the event listeners won't be performed.
+      #
+      #   @example
+      #     it 'publishes foo event' do
+      #       stub_spree_bus
+      #
+      #       Spree::Bus.publish 'foo'
+      #
+      #       expect('foo').to have_been_published
+      #     end
+      #
+      #   It can be chain through `with` to match with the published payload:
+      #
+      #   @example
+      #     it 'publishes foo event with the expected payload' do
+      #       stub_spree_bus
+      #
+      #       Spree::Bus.publish 'foo', bar: :baz, qux: :quux
+      #
+      #       expect('foo').to have_been_published.with(a_hash_including(bar: :baz))
+      #     end
+      #
+      #   @param [Symbol] event_name
+      matcher :have_been_published do
+        chain :with, :payload
+
+        match do |expected_event|
+          expected_event = normalize_name(expected_event)
+          arguments = payload ? [expected_event, payload] : [expected_event, any_args]
+          expect(Spree::Bus).to have_received(:publish).with(*arguments)
+        end
+
+        failure_message do |expected_event|
+          <<~MSG
+            expected #{expected_event.inspect} to have been published.
+            Make sure that provided payload, if any, also matches.
+          MSG
+        end
+
+        def normalize_name(event_name)
+          if event_name.is_a?(Symbol)
+            eq(event_name)
+          else
+            raise ArgumentError, <<~MSG
+              "#{event_name.inspect} is not a valid event name. It must be a Symbol."
+            MSG
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spree/testing_support/common_rake.rb

@@ -6,33 +6,61 @@ end
 
 require 'generators/spree/dummy/dummy_generator'
 
-namespace :common do
-  task :test_app, :user_class do |_t, args|
-    args.with_defaults(user_class: "Spree::LegacyUser")
-    require ENV['LIB_NAME']
+class CommonRakeTasks
+  include Rake::DSL
 
-    ENV["RAILS_ENV"] = 'test'
+  def initialize
+    namespace :common do
+      task :test_app, :user_class do |_t, args|
+        args.with_defaults(user_class: "Spree::LegacyUser")
+        require ENV['LIB_NAME']
+
+        force_rails_environment_to_test
+
+        Spree::DummyGenerator.start ["--lib_name=#{ENV['LIB_NAME']}", "--quiet"]
+        Solidus::InstallGenerator.start ["--lib_name=#{ENV['LIB_NAME']}", "--auto-accept", "--with-authentication=false", "--payment-method=none", "--migrate=false", "--seed=false", "--sample=false", "--quiet", "--user_class=#{args[:user_class]}"]
+
+        puts "Setting up dummy database..."
 
-    Spree::DummyGenerator.start ["--lib_name=#{ENV['LIB_NAME']}", "--quiet"]
-    Solidus::InstallGenerator.start ["--lib_name=#{ENV['LIB_NAME']}", "--auto-accept", "--with-authentication=false", "--payment-method=none", "--migrate=false", "--seed=false", "--sample=false", "--quiet", "--user_class=#{args[:user_class]}"]
+        sh "bin/rails db:environment:set RAILS_ENV=test"
+        sh "bin/rails db:drop db:create db:migrate VERBOSE=false RAILS_ENV=test"
 
-    puts "Setting up dummy database..."
+        if extension_installation_generator_exists?
+          puts 'Running extension installation generator...'
+          sh "bin/rails generate #{rake_generator_namespace}:install --auto-run-migrations"
+        end
+      end
 
-    sh "bin/rails db:environment:set RAILS_ENV=test"
-    sh "bin/rails db:drop db:create db:migrate VERBOSE=false RAILS_ENV=test"
+      task :seed do |_t, _args|
+        puts "Seeding ..."
 
-    begin
-      require "generators/#{ENV['LIB_NAME']}/install/install_generator"
-      puts 'Running extension installation generator...'
-      "#{ENV['LIB_NAMESPACE'] || ENV['LIB_NAME'].camelize}::Generators::InstallGenerator".constantize.start(["--auto-run-migrations"])
-    rescue LoadError
-      # No extension generator to run
+        sh "bundle exec rake db:seed RAILS_ENV=test"
+      end
     end
   end
 
-  task :seed do |_t, _args|
-    puts "Seeding ..."
+  private
 
-    sh "bundle exec rake db:seed RAILS_ENV=test"
+  def force_rails_environment_to_test
+    ENV["RAILS_ENV"] = 'test'
+    Rails.env = 'test'
+  end
+
+  def extension_installation_generator_exists?
+    require "generators/#{generator_namespace}/install/install_generator"
+
+    true
+  rescue LoadError
+    false
+  end
+
+  def generator_namespace
+    "#{ENV['LIB_NAMESPACE']&.underscore || ENV['LIB_NAME']}"
+  end
+
+  def rake_generator_namespace
+    generator_namespace.gsub("/", ":")
   end
 end
+
+CommonRakeTasks.new

data/lib/spree/testing_support/dummy_app/assets/javascripts/spree/backend/all.js

@@ -1,5 +1,5 @@
 // This is a manifest file that'll be compiled into including all the files listed below.
-// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// Add new JavaScript code in separate files in this directory and they'll automatically
 // be included in the compiled file accessible from http://example.com/assets/application.js
 // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
 // the compiled file.