solidus_core 3.2.4 → 3.3.0

data/lib/generators/spree/dummy/templates/rails/database.yml

@@ -1,6 +1,3 @@
-<% if agent_number = ENV['TC_AGENT_NUMBER']
-database_prefix = agent_number + '_'
-end %>
 <% db = case ENV['DB']
         when 'mysql'
           'mysql'
@@ -22,14 +19,11 @@ end %>
 <% db_username = ENV['DB_USERNAME'] %>
 <% db_password = ENV['DB_PASSWORD'] %>
 
-
-
-
 <% case ENV['DB']
   when 'mysql' %>
 development:
   adapter: mysql2
-  database: <%= database_prefix %><%= options[:lib_name] %>_solidus_development
+  database: <%= options[:lib_name] %>_solidus_development
   <% unless db_username.blank? %>
   username: <%= db_username %>
   <% end %>
@@ -42,7 +36,7 @@ development:
   encoding: utf8
 test:
   adapter: mysql2
-  database: <%= database_prefix %><%= options[:lib_name] %>_solidus_test
+  database: <%= options[:lib_name] %>_solidus_test
   <% unless db_username.blank? %>
   username: <%= db_username %>
   <% end %>
@@ -55,7 +49,7 @@ test:
   encoding: utf8
 production:
   adapter: mysql2
-  database: <%= database_prefix %><%= options[:lib_name] %>_solidus_production
+  database: <%= options[:lib_name] %>_solidus_production
   <% unless db_username.blank? %>
   username: <%= db_username %>
   <% end %>
@@ -69,7 +63,7 @@ production:
 <% when 'postgres', 'postgresql' %>
 development:
   adapter: postgresql
-  database: <%= database_prefix %><%= options[:lib_name] %>_solidus_development
+  database: <%= options[:lib_name] %>_solidus_development
   <% unless db_username.blank? %>
   username: <%= db_username %>
   <% end %>
@@ -82,7 +76,7 @@ development:
   min_messages: warning
 test:
   adapter: postgresql
-  database: <%= database_prefix %><%= options[:lib_name] %>_solidus_test
+  database: <%= options[:lib_name] %>_solidus_test
   <% unless db_username.blank? %>
   username: <%= db_username %>
   <% end %>
@@ -95,7 +89,7 @@ test:
   min_messages: warning
 production:
   adapter: postgresql
-  database: <%= database_prefix %><%= options[:lib_name] %>_solidus_production
+  database: <%= options[:lib_name] %>_solidus_production
   <% unless db_username.blank? %>
   username: <%= db_username %>
   <% end %>

data/lib/spree/app_configuration.rb

@@ -193,7 +193,17 @@ module Spree
 
     # @!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+)
@@ -343,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'
@@ -529,6 +542,15 @@ module Spree
                                                           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
@@ -642,6 +664,7 @@ module Spree
 
         env.calculators.tax_rates = %w[
           Spree::Calculator::DefaultTax
+          Spree::Calculator::FlatFee
         ]
 
         env.payment_methods = %w[

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

@@ -7,7 +7,11 @@ module Spree
         extend ActiveSupport::Concern
 
         included do
-          Spree::RailsCompatibility.active_storage_set_current(self)
+          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/engine.rb

@@ -87,6 +87,7 @@ module Spree
 
       config.after_initialize do
         Spree::Config.check_load_defaults_called('Spree::Config')
+        Spree::Config.static_model_preferences.validate!
       end
 
       config.after_initialize do

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

@@ -4,6 +4,12 @@ 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
@@ -57,16 +63,19 @@ module Spree
         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/version.rb

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

data/lib/spree/core.rb

@@ -14,7 +14,6 @@ require 'awesome_nested_set'
 require 'cancan'
 require 'friendly_id'
 require 'kaminari/activerecord'
-require 'mail'
 require 'monetize'
 require 'paperclip'
 require 'ransack'
@@ -28,7 +27,7 @@ require 'spree/rails_compatibility'
 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)
@@ -85,24 +84,6 @@ 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'
@@ -127,7 +108,6 @@ require 'spree/core/permalinks'
 require 'spree/core/product_duplicator'
 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/migrations.rb

@@ -23,16 +23,18 @@ module Spree
     # Shouldn't run on test mode because migrations inside engine don't have
     # engine name on the file name
     def check
-      if File.directory?(app_dir)
-        unless missing_migrations.empty?
-          puts "[#{engine_name.capitalize} WARNING] Missing migrations."
-          missing_migrations.each do |migration|
-            puts "[#{engine_name.capitalize} WARNING] #{migration} from #{engine_name} is missing."
-          end
-          puts "[#{engine_name.capitalize} WARNING] Run `bundle exec rake railties:install:migrations` to get them.\n\n"
-          true
-        end
-      end
+      return unless File.directory?(app_dir)
+      return if missing_migrations.empty?
+      return if ENV['SOLIDUS_SKIP_MIGRATIONS_CHECK']
+
+      prefix = "[WARNING #{engine_name.capitalize}]"
+      warn <<~WARN
+        #{prefix} Missing migrations.
+        #{missing_migrations.map {|m| "#{prefix} - #{m}"}.join("\n")}
+        #{prefix}
+        #{prefix} Run `bin/rails railties:install:migrations` to get them.
+        #{prefix} You can silence this warning by setting the `SOLIDUS_SKIP_MIGRATIONS_CHECK` environment variable.
+      WARN
     end
 
     def missing_migrations

data/lib/spree/permitted_attributes.rb

@@ -132,7 +132,10 @@ module Spree
       :name, :presentation, :cost_price, :lock_version,
       :position, :track_inventory,
       :product_id, :product, :price,
-      :weight, :height, :width, :depth, :sku, :cost_currency, :tax_category_id, option_value_ids: [], options: [:name, :value]
+      :weight, :height, :width, :depth, :sku, :cost_currency,
+      :tax_category_id, :shipping_category_id,
+      option_value_ids: [],
+      options: [:name, :value]
     ]
 
     @@checkout_address_attributes = [

data/lib/spree/preferences/preferable.rb

@@ -10,6 +10,9 @@ module Spree
     #
     # A class including Preferable must implement #preferences which should return
     # an object responding to .fetch(key), []=(key, val), and .delete(key).
+    # If #preferences is initialized with `default_preferences` and one of the
+    # preferences is another preference, it will cause a stack level too deep error.
+    # To avoid it do not memoize #preferences.
     #
     # It may also define a `#context_for_default` method. It should return an
     # array with the arguments to be provided to a proc used as the `default:`
@@ -111,6 +114,8 @@ module Spree
       end
 
       # @return [Hash{Symbol => Object}] Default for all preferences defined on this class
+      # This may raise an infinite loop error if any of the defaults are
+      # dependent on other preferences defaults.
       def default_preferences
         Hash[
           defined_preferences.map do |preference|

data/lib/spree/preferences/preferable_class_methods.rb

@@ -75,7 +75,7 @@ module Spree::Preferences
       # is a pending preference before going to default
       define_method preference_getter_method(name) do
         value = preferences.fetch(name) do
-          default.call(*context_for_default)
+          instance_exec(*context_for_default, &default)
         end
         value = preference_encryptor.decrypt(value) if preference_encryptor.present?
         value
@@ -92,7 +92,7 @@ module Spree::Preferences
       end
 
       define_method preference_default_getter_method(name) do
-        default.call(*context_for_default)
+        instance_exec(*context_for_default, &default)
       end
 
       define_method preference_type_getter_method(name) do

data/lib/spree/preferences/static_model_preferences.rb

@@ -7,13 +7,8 @@ module Spree
         attr_reader :preferences
 
         def initialize(klass, hash)
-          hash = hash.symbolize_keys
-          hash.keys.each do |key|
-            if !klass.defined_preferences.include?(key)
-              raise "Preference #{key.inspect} is not defined on #{klass}"
-            end
-          end
-          @preferences = hash
+          @klass = klass
+          @preferences = hash.symbolize_keys
         end
 
         def fetch(key, &block)
@@ -27,6 +22,8 @@ module Spree
         def to_hash
           @preferences.deep_dup
         end
+
+        delegate :keys, to: :@preferences
       end
 
       def initialize
@@ -36,12 +33,32 @@ module Spree
       end
 
       def add(klass, name, preferences)
-        @store[klass.to_s][name] = Definition.new(klass, preferences)
+        @store[klass.to_s][name] = Definition.new(klass.to_s, preferences)
       end
 
       def for_class(klass)
         @store[klass.to_s]
       end
+
+      def validate!
+        @store.keys.map(&:constantize).each do |klass|
+          validate_for_class!(klass)
+        end
+      end
+
+      private
+
+      def validate_for_class!(klass)
+        for_class(klass).each do |name, preferences|
+          klass_keys = klass.defined_preferences.map(&:to_s)
+          extra_keys = preferences.keys.map(&:to_s) - klass_keys
+          next if extra_keys.empty?
+
+          raise \
+            "Unexpected keys found for #{klass} under #{name}: #{extra_keys.sort.join(', ')} " \
+            "(expected keys: #{klass_keys.sort.join(', ')})"
+        end
+      end
     end
   end
 end

data/lib/spree/rails_compatibility.rb

@@ -72,23 +72,6 @@ module Spree
       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

data/lib/spree/testing_support/common_rake.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-unless defined?(Solidus::InstallGenerator)
-  require 'generators/solidus/install/install_generator'
-end
-
 require 'generators/spree/dummy/dummy_generator'
 
 class CommonRakeTasks
@@ -13,12 +9,36 @@ class CommonRakeTasks
     namespace :common do
       task :test_app, :user_class do |_t, args|
         args.with_defaults(user_class: "Spree::LegacyUser")
-        require ENV['LIB_NAME']
+        lib_name = ENV['LIB_NAME'] or
+          raise "Please provide a library name via the LIB_NAME environment variable."
+
+        require 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]}"]
+        Spree::DummyGenerator.start [
+          "--lib-name=#{lib_name}",
+          "--quiet",
+        ]
+
+        # While the dummy app is generated the current directory
+        # within ruby is changed to that of the dummy app.
+        sh({
+          'FRONTEND' => ENV['FRONTEND'] || 'classic',
+        }, [
+          'bin/rails',
+          'generate',
+          'solidus:install',
+          Dir.pwd, # use the current dir as Rails.root
+          "--auto-accept",
+          "--authentication=none",
+          "--payment-method=none",
+          "--migrate=false",
+          "--seed=false",
+          "--sample=false",
+          "--user-class=#{args[:user_class]}",
+          "--quiet",
+        ].shelljoin)
 
         puts "Setting up dummy database..."
 

data/lib/spree/testing_support/dummy_app.rb

@@ -38,7 +38,7 @@ module DummyApp
     ENV["LIB_NAME"] = lib_name
     DummyApp::Application.config.root = File.join(gem_root, 'spec', 'dummy')
 
-    DummyApp::Application.initialize!
+    DummyApp::Application.initialize! unless DummyApp::Application.initialized?
 
     if auto_migrate
       DummyApp::Migrations.auto_migrate
@@ -116,6 +116,7 @@ module DummyApp
     end
     config.paths['db/migrate'] = migration_dirs
     ActiveRecord::Migrator.migrations_paths = migration_dirs
+    ActiveRecord::Migration.verbose = false
 
     config.assets.paths << File.expand_path('dummy_app/assets/javascripts', __dir__)
     config.assets.paths << File.expand_path('dummy_app/assets/stylesheets', __dir__)
@@ -137,7 +138,6 @@ end
 Spree.user_class = 'Spree::LegacyUser'
 Spree.load_defaults(Spree.solidus_version)
 Spree.config do |config|
-  config.mails_from = "store@example.com"
   config.use_legacy_events = ENV['USE_LEGACY_EVENTS'].present?
 
   if ENV['DISABLE_ACTIVE_STORAGE']

data/lib/spree/testing_support/factories/address_factory.rb

@@ -24,21 +24,19 @@ FactoryBot.define do
     phone { '555-555-0199' }
     alternative_phone { '555-555-0199' }
 
-    state do |address|
-      Spree::State.joins(:country).where('spree_countries.iso = (?)', country_iso_code).find_by(abbr: state_code) ||
-        address.association(
-          :state,
-          strategy: :create,
-          country_iso: country_iso_code,
-          state_code: state_code
-        )
-    end
-
     country do |address|
       if address.state
         address.state.country
       else
-        address.association(:country, strategy: :create, iso: country_iso_code)
+        Spree::Country.find_by(iso: country_iso_code) ||
+          address.association(:country, strategy: :create, iso: country_iso_code)
+      end
+    end
+
+    after(:build) do |address, evaluator|
+      if address&.country&.states_required? && address.state.nil? && address.state_name.nil?
+        address.state = address.country.states.find_by(abbr: evaluator.state_code) ||
+          create(:state, country_iso: address.country.iso, state_code: evaluator.state_code)
       end
     end
   end

data/lib/spree/testing_support/factories/calculator_factory.rb

@@ -17,6 +17,9 @@ FactoryBot.define do
   factory :default_tax_calculator, class: 'Spree::Calculator::DefaultTax' do
   end
 
+  factory :flat_fee_calculator, class: 'Spree::Calculator::FlatFee' do
+  end
+
   factory :shipping_calculator, class: 'Spree::Calculator::Shipping::FlatRate' do
     preferred_amount { 10.0 }
   end

data/lib/spree/testing_support/factories/country_factory.rb

@@ -20,7 +20,6 @@ FactoryBot.define do
     iso3 { carmen_country.alpha_3_code }
     numcode { carmen_country.numeric_code }
 
-    # FIXME: We should set states required, but it causes failing tests
-    # states_required { carmen_country.subregions? }
+    states_required { carmen_country.subregions? }
   end
 end

data/lib/spree/testing_support/factories/promotion_factory.rb

@@ -22,23 +22,40 @@ FactoryBot.define do
     end
 
     trait :with_action do
-      after(:create) do |promotion, _evaluator|
-        promotion.actions << Spree::Promotion::Actions::CreateAdjustment.new
+      transient do
+        promotion_action_class { Spree::Promotion::Actions::CreateAdjustment }
+      end
+
+      after(:create) do |promotion, evaluator|
+        promotion.actions << evaluator.promotion_action_class.new
       end
     end
 
-    trait :with_line_item_adjustment do
+    trait :with_adjustable_action do
       transient do
-        adjustment_rate { 10 }
+        preferred_amount { 10 }
+        calculator_class { Spree::Calculator::FlatRate }
+        promotion_action_class { Spree::Promotion::Actions::CreateItemAdjustments }
       end
 
       after(:create) do |promotion, evaluator|
-        calculator = Spree::Calculator::FlatRate.new
-        calculator.preferred_amount = evaluator.adjustment_rate
-        Spree::Promotion::Actions::CreateItemAdjustments.create!(calculator: calculator, promotion: promotion)
+        calculator = evaluator.calculator_class.new
+        calculator.preferred_amount = evaluator.preferred_amount
+        evaluator.promotion_action_class.create!(calculator: calculator, promotion: promotion)
       end
     end
 
+    factory :promotion_with_action_adjustment, traits: [:with_adjustable_action]
+
+    trait :with_line_item_adjustment do
+      transient do
+        adjustment_rate { 10 }
+      end
+
+      with_adjustable_action
+      preferred_amount { adjustment_rate }
+    end
+
     factory :promotion_with_item_adjustment, traits: [:with_line_item_adjustment]
 
     trait :with_free_shipping do
@@ -52,14 +69,11 @@ FactoryBot.define do
         weighted_order_adjustment_amount { 10 }
       end
 
-      after(:create) do |promotion, evaluator|
-        calculator = Spree::Calculator::FlatRate.new
-        calculator.preferred_amount = evaluator.weighted_order_adjustment_amount
-        action = Spree::Promotion::Actions::CreateAdjustment.create!(calculator: calculator)
-        promotion.actions << action
-        promotion.save!
-      end
+      with_adjustable_action
+      preferred_amount { weighted_order_adjustment_amount }
+      promotion_action_class { Spree::Promotion::Actions::CreateAdjustment }
     end
+
     factory :promotion_with_order_adjustment, traits: [:with_order_adjustment]
 
     trait :with_item_total_rule do

data/lib/spree/testing_support/factories/state_factory.rb

@@ -17,9 +17,15 @@ FactoryBot.define do
       carmen_subregion do
         carmen_country = Carmen::Country.coded(country.iso)
 
-        carmen_country.subregions.coded(state_code) ||
-          carmen_country.subregions.sort_by(&:name).first ||
+        unless carmen_country.subregions?
           fail("Country #{country.iso} has no subregions")
+        end
+
+        carmen_regions = carmen_country.subregions
+        carmen_regions = carmen_regions.flat_map(&:subregions) if carmen_regions.first.subregions?
+        region_collection = Carmen::RegionCollection.new(carmen_regions)
+
+        region_collection.coded(state_code) || region_collection.sort_by(&:name).first
       end
     end
 

data/lib/spree/testing_support/factory_bot.rb

@@ -37,7 +37,7 @@ module Spree
         Spree::Deprecation.warn(
           "Please do not cherry-pick factories, this is not well supported by FactoryBot, " \
           'follow the changelog instructions on how to migrate your current setup.',
-          callsites[index..-1]
+          callsites[index..]
         )
       end
 

data/lib/spree/testing_support/order_walkthrough.rb

@@ -34,7 +34,7 @@ module Spree
                               states
                             else
                               end_state_position = states.index(state.to_sym)
-                              states[0..end_state_position]
+                              states[..end_state_position]
                             end
 
         states_to_process.each do |state_to_process|