solidus_core 3.1.8 → 3.2.0.alpha

data/lib/generators/solidus/install/templates/config/initializers/spree.rb.tt

@@ -31,16 +31,6 @@ Spree.config do |config|
   # to a custom users role:
   # config.roles.assign_permissions :role_name, ['Spree::PermissionSets::CustomPermissionSet']
 
-
-  # Frontend:
-
-  # Custom logo for the frontend
-  # config.logo = "logo/solidus.svg"
-
-  # Template to use when rendering layout
-  # config.layout = "spree/layouts/spree_application"
-
-
   # Admin:
 
   # Custom logo for the admin
@@ -62,12 +52,6 @@ Spree.config do |config|
   # )
 end
 
-<% if defined?(Spree::Frontend::Engine) -%>
-Spree::Frontend::Config.configure do |config|
-  config.locale = 'en'
-end
-<% end -%>
-
 <% if defined?(Spree::Backend::Engine) -%>
 Spree::Backend::Config.configure do |config|
   config.locale = 'en'
@@ -80,6 +64,12 @@ Spree::Backend::Config.configure do |config|
   #   'icon-name',
   #   url: 'https://solidus.io/'
   # )
+
+  # Custom frontend product path
+  #
+  # config.frontend_product_path = ->(template_context, product) {
+  #   template_context.spree.product_path(product)
+  # }
 end
 <% end -%>
 

data/lib/generators/solidus/install/templates/vendor/assets/javascripts/spree/backend/all.js

@@ -1,10 +1,10 @@
 // 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.
 //
-//= require jquery
+//= require jquery3
 //= require rails-ujs
 //= require spree/backend
 //= require_tree .

data/lib/spree/app_configuration.rb

@@ -21,7 +21,6 @@ require "spree/core/search/base"
 require "spree/core/search/variant"
 require 'spree/preferences/configuration'
 require 'spree/core/environment'
-require 'rails/gem_version'
 
 module Spree
   class AppConfiguration < Preferences::Configuration
@@ -61,6 +60,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: {}
@@ -146,6 +150,10 @@ module Spree
     #   @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] 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
     #   at role_user creation for all roles. (default: +false+)
@@ -280,6 +288,13 @@ module Spree
     #   @return [] Track on_hand values for variants / products. (default: true)
     preference :track_inventory_levels, :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
 
@@ -482,7 +497,7 @@ module Spree
     # @!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: Rails.gem_version >= Gem::Version.new("6.1.0") ? "Spree::Image::ActiveStorageAttachment" : "Spree::Image::PaperclipAttachment"
+    class_name_attribute :image_attachment_module, default: 'Spree::Image::ActiveStorageAttachment'
 
     # @!attribute [rw] allowed_image_mime_types
     #
@@ -540,7 +555,18 @@ module Spree
     # @!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: Rails.gem_version >= Gem::Version.new("6.1.0") ? "Spree::Taxon::ActiveStorageAttachment" : "Spree::Taxon::PaperclipAttachment"
+    class_name_attribute :taxon_attachment_module, default: 'Spree::Taxon::ActiveStorageAttachment'
+
+    # 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.
     #

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
+  Bus.define_singleton_method(:publish) do |*args, **kwargs, &block|
+    if Spree::Config.use_legacy_events
+      Spree::Event.fire(*args, **kwargs, &block)
+    else
+      # Override caller_location to point to the actual event publisher
+      super(*args, **kwargs, caller_location: caller_locations(1)[0], &block)
+    end
+  end
+end

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

@@ -18,6 +18,7 @@ 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
@@ -32,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)
@@ -53,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
@@ -65,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,7 @@ module Spree
         extend ActiveSupport::Concern
 
         included do
-          before_action do
-            ActiveStorage::Current.host = request.base_url
-          end
+          Spree::RailsCompatibility.active_storage_set_current(self)
         end
       end
     end

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

@@ -24,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
 
@@ -38,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
@@ -58,11 +58,11 @@ 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
@@ -76,7 +76,7 @@ module Spree
           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/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/engine.rb

@@ -46,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
 
-        app.reloader.before_class_unload do
-          Spree::Event.deactivate_all_subscribers
+            %i[
+              order_finalized
+              order_recalculated
+              reimbursement_reimbursed
+              reimbursement_errored
+            ].each { |event_name| Spree::Bus.register(event_name) }
+
+            Spree::OrderMailerSubscriber.new.subscribe_to(Spree::Bus)
+          end
         end
       end
 
@@ -81,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,7 +1,7 @@
 # frozen_string_literal: true
 
 module Spree
-  VERSION = "3.1.8"
+  VERSION = "3.2.0.alpha"
 
   def self.solidus_version
     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