solidus_core 4.2.4 → 4.3.0

data/lib/generators/solidus/install/install_generator.rb

@@ -34,11 +34,12 @@ module Solidus
     class_option :seed, type: :boolean, default: true, banner: 'Load seed data (migrations must be run)'
     class_option :sample, type: :boolean, default: true, banner: 'Load sample data (migrations and seeds must be run)'
     class_option :active_storage, type: :boolean, default: true, banner: 'Install ActiveStorage as image attachments handler for products and taxons'
-    class_option :admin_preview, type: :boolean, default: false, desc: 'Install the admin preview'
+    class_option :admin_preview, type: :boolean, default: true, desc: 'Install the admin preview'
     class_option :auto_accept, type: :boolean
     class_option :user_class, type: :string
     class_option :admin_email, type: :string
     class_option :admin_password, type: :string
+    class_option :mount_point, type: :string, desc: "Indicates where Solidus should be mounted. Defaults to '/'"
 
     class_option :frontend, type: :string, enum: FRONTENDS.map { _1[:name] }, default: nil, desc: "Indicates which frontend to install."
     class_option :authentication, type: :string, enum: AUTHENTICATIONS.map { _1[:name] }, default: nil, desc: "Indicates which authentication system to install."
@@ -87,6 +88,36 @@ module Solidus
       ENV['SOLIDUS_SKIP_MIGRATIONS_CHECK'] = 'true'
     end
 
+    def install_routes
+      if Pathname(app_path).join('config', 'routes.rb').read.include? CORE_MOUNT_ROUTE
+        say_status :route_exist, CORE_MOUNT_ROUTE, :blue
+      else
+        say_status :installing, "solidus routes"
+        mount_point = options[:mount_point] || ask_with_default(
+          desc: 'Where would you like to mount Solidus? (E.g. "/store" or "/shop")',
+          default: '/',
+        )
+
+        shell.mute do
+          route <<~RUBY
+            # This line mounts Solidus's routes at the root of your application.
+            #
+            # Unless you manually picked only a subset of Solidus components, this will mount routes for:
+            #   - solidus_backend
+            #   - solidus_api
+            # This means, any requests to URLs such as /admin/products, will go to Spree::Admin::ProductsController.
+            #
+            # If you are using the Starter Frontend as your frontend, be aware that all the storefront routes are defined
+            # separately in this file and are not part of the Solidus::Core::Engine engine.
+            #
+            # If you would like to change where this engine is mounted, simply change the :at option to something different.
+            # We ask that you don't use the :as option here, as Solidus relies on it being the default of "spree"
+            #{CORE_MOUNT_ROUTE}, at: '#{mount_point}'
+          RUBY
+        end
+      end
+    end
+
     def add_files
       template 'config/initializers/spree.rb.tt', 'config/initializers/spree.rb'
     end
@@ -134,21 +165,6 @@ module Solidus
       rake 'db:create'
     end
 
-    def install_routes
-      if Pathname(app_path).join('config', 'routes.rb').read.include? CORE_MOUNT_ROUTE
-        say_status :route_exist, CORE_MOUNT_ROUTE, :blue
-      else
-        route <<~RUBY
-          # This line mounts Solidus's routes at the root of your application.
-          # This means, any requests to URLs such as /products, will go to Spree::ProductsController.
-          # If you would like to change where this engine is mounted, simply change the :at option to something different.
-          #
-          # We ask that you don't use the :as option here, as Solidus relies on it being the default of "spree"
-          #{CORE_MOUNT_ROUTE}, at: '/'
-        RUBY
-      end
-    end
-
     def run_migrations
       if @run_migrations
         say_status :running, "migrations"
@@ -209,6 +225,27 @@ module Solidus
       Bundler.reset_paths!
     end
 
+    def ask_with_default(desc:, default:)
+      if options[:auto_accept]
+        say_status :using, "#{default} (default)"
+        return default
+      end
+
+      default_label = " (#{set_color :default, :bold}: \"#{default}\")" if default
+
+      say_status :question, "#{desc}#{default_label}.", :yellow
+      answer = ask(set_color("answer:".rjust(13), :blue, :bold)).to_s.downcase.presence
+
+      case answer
+      when nil
+        say_status :using, "#{default} (default)"
+        default
+      else
+        say_status :using, answer
+        answer
+      end
+    end
+
     def ask_with_description(desc:, limited_to:, default:)
       loop do
         say_status :question, desc, :yellow

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

@@ -33,19 +33,19 @@ Spree.config do |config|
   # Custom logo for the admin
   # config.admin_interface_logo = "logo/solidus.svg"
 
-  # Gateway credentials can be configured statically here and referenced from
+  # Payment gateway credentials can be configured statically here and referenced from
   # the admin. They can also be fully configured from the admin.
   #
-  # Please note that you need to use the solidus_stripe gem to have
-  # Stripe working: https://github.com/solidusio-contrib/solidus_stripe
+  # Please note that the example below requires the `solidus_stripe` ~> 5.0 gem
+  # in order to work properly (see https://github.com/solidusio-contrib/solidus_stripe).
   #
   # config.static_model_preferences.add(
-  #   Spree::PaymentMethod::StripeCreditCard,
-  #   'stripe_env_credentials',
-  #   secret_key: ENV['STRIPE_SECRET_KEY'],
-  #   publishable_key: ENV['STRIPE_PUBLISHABLE_KEY'],
-  #   server: Rails.env.production? ? 'production' : 'test',
-  #   test_mode: !Rails.env.production?
+  #   'SolidusStripe::PaymentMethod',
+  #   'solidus_stripe_env_credentials',
+  #   api_key: ENV.fetch('SOLIDUS_STRIPE_API_KEY'),
+  #   publishable_key: ENV.fetch('SOLIDUS_STRIPE_PUBLISHABLE_KEY'),
+  #   test_mode: ENV.fetch('SOLIDUS_STRIPE_API_KEY').start_with?('sk_test_'),
+  #   webhook_endpoint_signing_secret: ENV.fetch('SOLIDUS_STRIPE_WEBHOOK_SIGNING_SECRET')
   # )
 end
 

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

@@ -1,113 +1,61 @@
-<% db = case ENV['DB']
-        when 'mysql'
-          'mysql'
-        when 'postgres', 'postgresql'
-          'postgres'
-        when /sqlite3?/, '', nil
-          'sqlite'
-        else
-          raise "Invalid DB specified: #{ENV['DB']}"
-        end %>
-<% db_host = case db
-             when 'mysql'
-               ENV['DB_MYSQL_HOST'] || ENV['DB_HOST']
-             when 'postgres'
-               ENV['DB_POSTGRES_HOST'] || ENV['DB_HOST']
-             else
-               ENV['DB_HOST']
-             end %>
-<% db_username = ENV['DB_USERNAME'] %>
-<% db_password = ENV['DB_PASSWORD'] %>
+<%
+  adapter =
+    case ENV['DB']
+    when 'mysql2', 'mysql' then 'mysql2'
+    when 'postgresql', 'postgres' then 'postgresql'
+    when 'sqlite3', 'sqlite', '', nil then 'sqlite3'
+    else raise "Invalid DB specified " + ENV['DB'].inspect
+    end
 
-<% case db
-  when 'mysql' %>
+  db_host =
+    case adapter
+    when 'mysql2' then ENV['DB_MYSQL_HOST'] || ENV['DB_HOST']
+    when 'postgres' then ENV['DB_POSTGRES_HOST'] || ENV['DB_HOST']
+    else ENV['DB_HOST']
+    end
+
+  db_username = ENV['DB_USERNAME']
+  db_password = ENV['DB_PASSWORD'] %>
+
+default: &default
+  adapter: <%= adapter %>
+  <% unless db_username.blank? %>username: <%= db_username %><% end %>
+  <% unless db_password.blank? %>password: <%= db_password %><% end %>
+  <% unless db_host.blank? %>host: <%= db_host %><% end %>
+  <% if adapter == 'mysql2' %>encoding: utf8<% end %>
+  <% if adapter == 'postgresql' %>min_messages: warning<% end %>
+
+<% if adapter == 'mysql2' %>
 development:
-  adapter: mysql2
+  <<: *default
   database: <%= options[:lib_name] %>_solidus_development
-  <% unless db_username.blank? %>
-  username: <%= db_username %>
-  <% end %>
-  <% unless db_password.blank? %>
-  password: <%= db_password %>
-  <% end %>
-  <% unless db_host.blank? %>
-  host: <%= db_host %>
-  <% end %>
-  encoding: utf8
 test:
-  adapter: mysql2
+  <<: *default
   database: <%= options[:lib_name] %>_solidus_test
-  <% unless db_username.blank? %>
-  username: <%= db_username %>
-  <% end %>
-  <% unless db_password.blank? %>
-  password: <%= db_password %>
-  <% end %>
-  <% unless db_host.blank? %>
-  host: <%= db_host %>
-  <% end %>
-  encoding: utf8
 production:
-  adapter: mysql2
+  <<: *default
   database: <%= options[:lib_name] %>_solidus_production
-  <% unless db_username.blank? %>
-  username: <%= db_username %>
-  <% end %>
-  <% unless db_password.blank? %>
-  password: <%= db_password %>
-  <% end %>
-  <% unless db_host.blank? %>
-  host: <%= db_host %>
-  <% end %>
-  encoding: utf8
-<% when 'postgres', 'postgresql' %>
+
+<% elsif adapter == 'postgresql' %>
 development:
-  adapter: postgresql
+  <<: *default
   database: <%= options[:lib_name] %>_solidus_development
-  <% unless db_username.blank? %>
-  username: <%= db_username %>
-  <% end %>
-  <% unless db_password.blank? %>
-  password: <%= db_password %>
-  <% end %>
-  <% unless db_host.blank? %>
-  host: <%= db_host %>
-  <% end %>
-  min_messages: warning
 test:
-  adapter: postgresql
+  <<: *default
   database: <%= options[:lib_name] %>_solidus_test
-  <% unless db_username.blank? %>
-  username: <%= db_username %>
-  <% end %>
-  <% unless db_password.blank? %>
-  password: <%= db_password %>
-  <% end %>
-  <% unless db_host.blank? %>
-  host: <%= db_host %>
-  <% end %>
-  min_messages: warning
 production:
-  adapter: postgresql
+  <<: *default
   database: <%= options[:lib_name] %>_solidus_production
-  <% unless db_username.blank? %>
-  username: <%= db_username %>
-  <% end %>
-  <% unless db_password.blank? %>
-  password: <%= db_password %>
-  <% end %>
-  <% unless db_host.blank? %>
-  host: <%= db_host %>
-  <% end %>
-  min_messages: warning
-<% when 'sqlite', '', nil %>
+
+<% elsif adapter == 'sqlite3' %>
 development:
-  adapter: sqlite3
+  <<: *default
   database: db/solidus_development.sqlite3
 test:
-  adapter: sqlite3
+  <<: *default
   database: db/solidus_test.sqlite3
 production:
-  adapter: sqlite3
+  <<: *default
   database: db/solidus_production.sqlite3
+
 <% end %>

data/lib/generators/spree/dummy/templates/rails/test.rb

@@ -18,7 +18,7 @@ Dummy::Application.configure do
   config.eager_load = false
 
   # Raise exceptions instead of rendering exception templates
-  config.action_dispatch.show_exceptions = false
+  config.action_dispatch.show_exceptions = false # Should be :none for Rails 7.1+
 
   # Disable request forgery protection in test environment
   config.action_controller.allow_forgery_protection = false

data/lib/spree/app_configuration.rb

@@ -22,8 +22,6 @@ require "spree/core/search/variant"
 require 'spree/preferences/configuration'
 require 'spree/core/environment'
 
-require 'uri'
-
 module Spree
   class AppConfiguration < Preferences::Configuration
     # Preferences (alphabetized to more easily lookup particular preferences)
@@ -367,6 +365,22 @@ module Spree
     #   Spree::OrderUpdater.
     class_name_attribute :order_recalculator_class, default: 'Spree::OrderUpdater'
 
+    # Allows providing a different coupon code handler.
+    # @!attribute [rw] coupon_code_handler_class
+    # @see Spree::PromotionHandler::Coupon
+    # @return [Class] an object that conforms to the API of
+    #   the standard coupon code handler class
+    #   Spree::PromotionHandler::Coupon.
+    class_name_attribute :coupon_code_handler_class, default: 'Spree::PromotionHandler::Coupon'
+
+    # Allows providing a different shipping promotion handler.
+    # @!attribute [rw] shipping_promotion_handler_class
+    # @see Spree::PromotionHandler::Shipping
+    # @return [Class] an object that conforms to the API of
+    #   the standard shipping promotion handler class
+    #   Spree::PromotionHandler::Coupon.
+    class_name_attribute :shipping_promotion_handler_class, default: 'Spree::PromotionHandler::Shipping'
+
     # Allows providing your own Mailer for promotion code batch mailer.
     #
     # @!attribute [rw] promotion_code_batch_mailer_class
@@ -667,6 +681,7 @@ module Spree
           Spree::Promotion::Rules::UserLoggedIn
           Spree::Promotion::Rules::OneUsePerUser
           Spree::Promotion::Rules::Taxon
+          Spree::Promotion::Rules::MinimumQuantity
           Spree::Promotion::Rules::NthOrder
           Spree::Promotion::Rules::OptionValue
           Spree::Promotion::Rules::FirstRepeatPurchaseSince

data/lib/spree/core/engine.rb

@@ -67,12 +67,14 @@ module Spree
       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'
+      initializer "spree.core.action_mailer.set_preview_path", after: "action_mailer.set_autoload_paths" do
+        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
+        if ActionMailer::Base.respond_to? :preview_paths # Rails 7.1+
+          ActionMailer::Base.preview_paths << solidus_preview_path.to_s
+        else
+          ActionMailer::Base.preview_path = "{#{ActionMailer::Base.preview_path},#{solidus_preview_path}}"
+        end
       end
 
       initializer "spree.deprecator" do |app|

data/lib/spree/core/version.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module Spree
-  VERSION = "4.2.4"
+  VERSION = "4.3.0"
 
   def self.solidus_version
     VERSION
   end
 
   def self.previous_solidus_minor_version
-    '4.1'
+    '4.2'
   end
 
   def self.solidus_gem_version

data/lib/spree/core.rb

@@ -21,6 +21,8 @@ require 'paperclip'
 require 'ransack'
 require 'state_machines-activerecord'
 
+require_relative './ransack_4_1_patch'
+
 # 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

data/lib/spree/permitted_attributes.rb

@@ -140,6 +140,7 @@ module Spree
 
     @@checkout_address_attributes = [
       :use_billing,
+      :use_shipping,
       :email,
       bill_address_attributes: address_attributes,
       ship_address_attributes: address_attributes

data/lib/spree/preferences/persistable.rb

@@ -7,7 +7,13 @@ module Spree
 
       included do
         include Spree::Preferences::Preferable
-        serialize :preferences, Hash
+
+        if method(:serialize).parameters.include?([:key, :type]) # Rails 7.1+
+          serialize :preferences, type: Hash, coder: YAML
+        else
+          serialize :preferences, Hash, coder: YAML
+        end
+
         after_initialize :initialize_preference_defaults
       end
 

data/lib/spree/ransack_4_1_patch.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "ransack/version"
+
+return unless Ransack::VERSION.start_with?("4.1.")
+
+module RansackNodeConditionPatch
+  private
+
+  # Waiting for https://github.com/activerecord-hackery/ransack/pull/1468
+  def casted_array?(predicate)
+    predicate.is_a?(Arel::Nodes::Casted) && predicate.value.is_a?(Array)
+  end
+
+  Ransack::Nodes::Condition.prepend(self)
+end

data/lib/spree/testing_support/dummy_app/database.yml

@@ -1,54 +1,45 @@
-<% db = case ENV['DB']
-        when 'mysql'
-          'mysql'
-        when 'postgres', 'postgresql'
-          'postgres'
-        when 'sqlite', '', nil
-          'sqlite'
-        else
-          raise "Invalid DB specified: #{ENV['DB']}"
-        end %>
-<% db_host = case db
-             when 'mysql'
-               ENV['DB_MYSQL_HOST'] || ENV['DB_HOST']
-             when 'postgres'
-               ENV['DB_POSTGRES_HOST'] || ENV['DB_HOST']
-             else
-               ENV['DB_HOST']
-             end %>
-<% db_prefix = ENV['LIB_NAME'].presence || "solidus" %>
-<% db_username = ENV['DB_USERNAME'] %>
-<% db_password = ENV['DB_PASSWORD'] %>
-<% case db
-when 'mysql' %>
+<%
+  adapter =
+    case ENV['DB']
+    when 'mysql2', 'mysql' then 'mysql2'
+    when 'postgresql', 'postgres' then 'postgresql'
+    when 'sqlite3', 'sqlite', '', nil then 'sqlite3'
+    else raise "Invalid DB specified " + ENV['DB'].inspect
+    end
+
+  db_host =
+    case adapter
+    when 'mysql' then ENV['DB_MYSQL_HOST'] || ENV['DB_HOST']
+    when 'postgres' then ENV['DB_POSTGRES_HOST'] || ENV['DB_HOST']
+    else ENV['DB_HOST']
+    end
+
+  db_prefix = ENV['LIB_NAME'].presence || "solidus"
+  db_username = ENV['DB_USERNAME']
+  db_password = ENV['DB_PASSWORD'] %>
+
+default: &default
+  adapter: <%= adapter %>
+  <% unless db_username.blank? %>username: <%= db_username %><% end %>
+  <% unless db_password.blank? %>password: <%= db_password %><% end %>
+  <% unless db_host.blank? %>host: <%= db_host %><% end %>
+  <% if adapter == 'mysql2' %>encoding: utf8<% end %>
+  <% if adapter == 'postgresql' %>min_messages: warning<% end %>
+
+<% if adapter == 'mysql2' %>
 test:
-  adapter: mysql2
+  <<: *default
   database: <%= db_prefix %>_test
-  <% unless db_username.blank? %>
-  username: <%= db_username %>
-  <% end %>
-  <% unless db_password.blank? %>
-  password: <%= db_password %>
-  <% end %>
-  <% unless db_host.blank? %>
-  host: <%= db_host %>
-  <% end %>
-  encoding: utf8
-<% when 'postgres' %>
+
+<% elsif adapter == 'postgresql' %>
 test:
-  adapter: postgresql
+  <<: *default
   database: <%= db_prefix %>_test
-  username: <%= db_username.presence || "postgres" %>
-  <% unless db_password.blank? %>
-  password: <%= db_password %>
-  <% end %>
-  <% unless db_host.blank? %>
-  host: <%= db_host %>
-  <% end %>
-  min_messages: warning
-<% when 'sqlite' %>
+
+<% elsif adapter == 'sqlite3' %>
 test:
-  adapter: sqlite3
+  <<: *default
   database: db/<%= db_prefix %>_test.sqlite3
   timeout: 10000
+
 <% end %>

data/lib/spree/testing_support/dummy_app/rake_tasks.rb

@@ -38,10 +38,7 @@ namespace :db do
     # railties:install:migrations and then db:migrate.
     # Migrations should be run one directory at a time
     ActiveRecord::Migrator.migrations_paths.each do |path|
-      ActiveRecord::MigrationContext.new(
-        [path],
-        ActiveRecord::SchemaMigration
-      ).migrate
+      ActiveRecord::MigrationContext.new([path]).migrate
     end
 
     ActiveRecord::Base.clear_cache!

data/lib/spree/testing_support/dummy_app.rb

@@ -45,6 +45,12 @@ module DummyApp
 
   class Application < ::Rails::Application
     config.load_defaults("#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}")
+
+    if Rails.gem_version >= Gem::Version.new('7.1')
+      config.action_controller.raise_on_missing_callback_actions = true
+      config.action_dispatch.show_exceptions = :none
+    end
+
     # Make the test environment more production-like:
     config.action_controller.allow_forgery_protection = false
     config.action_controller.default_protect_from_forgery = false
@@ -63,7 +69,7 @@ module DummyApp
 
     # Make debugging easier:
     config.consider_all_requests_local = true
-    config.action_dispatch.show_exceptions = false
+    config.action_dispatch.show_exceptions = false # Should be :none for Rails 7.1+
     config.active_support.deprecation = :stderr
     config.log_level = :debug
 
@@ -82,22 +88,24 @@ module DummyApp
     config.secret_key_base = 'SECRET_TOKEN'
 
     # Set the preview path within the dummy app:
-    config.action_mailer.preview_path = File.expand_path('dummy_app/mailer_previews', __dir__)
+    if ActionMailer::Base.respond_to? :preview_paths # Rails 7.1+
+      config.action_mailer.preview_paths << File.expand_path('dummy_app/mailer_previews', __dir__)
+    else
+      config.action_mailer.preview_path = File.expand_path('dummy_app/mailer_previews', __dir__)
+    end
 
     config.active_record.dump_schema_after_migration = false
 
     # Configure active storage to use storage within tmp folder
-    unless (ENV['DISABLE_ACTIVE_STORAGE'] == 'true')
-      initializer 'solidus.active_storage' do
-        config.active_storage.service_configurations = {
-          test: {
-            service: 'Disk',
-            root: Rails.root.join('tmp', 'storage')
-          }
+    initializer 'solidus.active_storage' do
+      config.active_storage.service_configurations = {
+        test: {
+          service: 'Disk',
+          root: Rails.root.join('tmp', 'storage')
         }
-        config.active_storage.service = :test
-        config.active_storage.variant_processor = ENV.fetch('ACTIVE_STORAGE_VARIANT_PROCESSOR', :vips).to_sym
-      end
+      }
+      config.active_storage.service = :test
+      config.active_storage.variant_processor = ENV.fetch('ACTIVE_STORAGE_VARIANT_PROCESSOR', :vips).to_sym
     end
 
     # Avoid issues if an old spec/dummy still exists
@@ -117,6 +125,7 @@ module DummyApp
 
     config.assets.paths << File.expand_path('dummy_app/assets/javascripts', __dir__)
     config.assets.paths << File.expand_path('dummy_app/assets/stylesheets', __dir__)
+    config.assets.css_compressor = nil
 
     config.paths["config/database"] = File.expand_path('dummy_app/database.yml', __dir__)
     config.paths['config/routes.rb'] = File.expand_path('dummy_app/routes.rb', __dir__)

data/solidus_core.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
     actionmailer actionpack actionview activejob activemodel activerecord
     activestorage activesupport railties
   ].each do |rails_dep|
-    s.add_dependency rails_dep, ['>= 7.0', '< 7.1']
+    s.add_dependency rails_dep, ['>= 7.0', '< 7.2']
   end
 
   s.add_dependency 'activemerchant', '~> 1.66'
@@ -43,7 +43,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'monetize', '~> 1.8'
   s.add_dependency 'kt-paperclip', ['>= 6.3', '< 8']
   s.add_dependency 'psych', ['>= 4.0.1', '< 5.0']
-  s.add_dependency 'ransack', '~> 2.0'
+  s.add_dependency 'ransack', '~> 4.0'
   s.add_dependency 'sprockets-rails'
   s.add_dependency 'state_machines-activerecord', '~> 0.6'
   s.add_dependency 'omnes', '~> 0.2.2'