solidus_core 4.6.2 → 4.7.1

data/lib/spree/testing_support/authorization_helpers.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-require 'cancan'
+require "cancan"
 
 module Spree
   module TestingSupport
     module AuthorizationHelpers
       module CustomAbility
         def build_ability(&block)
-          block ||= proc{ |_u| can :manage, :all }
+          block ||= proc { |_u| can :manage, :all }
           Class.new do
             include CanCan::Ability
+
             define_method(:initialize, block)
           end
         end
@@ -41,9 +42,9 @@ module Spree
           end
 
           before do
-            allow(Spree.user_class).to receive(:find_by).
-                                         with(hash_including(:spree_api_key)).
-                                         and_return(Spree.user_class.new)
+            allow(Spree.user_class).to receive(:find_by)
+              .with(hash_including(:spree_api_key))
+              .and_return(Spree.user_class.new)
           end
         end
 

data/lib/spree/testing_support/blacklist_urls.rb

@@ -5,7 +5,7 @@ module Spree
     module BlacklistUrls
       def setup_url_blacklist(browser)
         if browser.respond_to?(:url_blacklist)
-          browser.url_blacklist = ['https://fonts.googleapis.com']
+          browser.url_blacklist = ["https://fonts.googleapis.com"]
         end
       end
     end

data/lib/spree/testing_support/bus_helpers.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'spree/bus'
+require "spree/bus"
 
 module Spree
   module TestingSupport

data/lib/spree/testing_support/capybara_driver.rb

@@ -6,4 +6,4 @@ require "capybara-screenshot"
 Capybara::Screenshot.register_driver(:selenium_headless) do |driver, path|
   driver.browser.save_screenshot(path)
 end
-Capybara.javascript_driver = (ENV['CAPYBARA_DRIVER'] || :selenium_headless).to_sym
+Capybara.javascript_driver = (ENV["CAPYBARA_DRIVER"] || :selenium_headless).to_sym

data/lib/spree/testing_support/capybara_ext.rb

@@ -4,11 +4,19 @@ module Spree
   module TestingSupport
     module CapybaraExt
       def click_icon(type)
-        find(".fa-#{type}").click
+        el = find(".fa-#{type}", visible: :all)
+        begin
+          el.click
+        rescue Selenium::WebDriver::Error::ElementClickInterceptedError
+          # When a floating element (eg. tooltips/overlays) intercepts the click,
+          # scroll the target into view and dispatch a click via JS to keep tests stable.
+          page.execute_script('arguments[0].scrollIntoView({block: "center"});', el.native)
+          page.execute_script("arguments[0].click();", el.native)
+        end
       end
 
       def eventually_fill_in(field, options = {})
-        expect(page).to have_css('#' + field)
+        expect(page).to have_css("#" + field)
         fill_in field, options
       end
 
@@ -42,7 +50,7 @@ module Spree
         }.merge(options)
         label = find_label_by_text(options[:from])
         within label.first(:xpath, ".//..") do
-          options[:from] = "##{find('.select2-container')['id']}"
+          options[:from] = "##{find(".select2-container")["id"]}"
         end
         select2_search_without_selection(options[:search], from: options[:from])
         select_select2_result(value) if options[:select]
@@ -65,14 +73,14 @@ module Spree
       # document. Can be used to 'escape' from within the context of another within
       # block.
       def within_entire_page(&block)
-        within(:xpath, '//body', &block)
+        within(:xpath, "//body", &block)
       end
 
       def select2(value, options)
         label = find_label_by_text(options[:from])
 
         within label.first(:xpath, ".//..") do
-          options[:from] = "##{find('.select2-container')['id']}"
+          options[:from] = "##{find(".select2-container")["id"]}"
         end
         targetted_select2(value, options)
       end
@@ -89,16 +97,16 @@ module Spree
 
       def targetted_select2(value, options)
         # find select2 element and click it
-        find(options[:from]).find('a').click
+        find(options[:from]).find("a").click
         select_select2_result(value)
       end
 
       def select_select2_result(value)
         # results are in a div appended to the end of the document
         within_entire_page do
-          expect(page).to have_selector('.select2-result-label', visible: true)
+          expect(page).to have_selector(".select2-result-label", visible: true)
           find("div.select2-result-label", text: /#{Regexp.escape(value)}/i, match: :prefer_exact).click
-          expect(page).not_to have_selector('.select2-result-label')
+          expect(page).not_to have_selector(".select2-result-label")
         end
       end
 
@@ -108,17 +116,17 @@ module Spree
         # We need to select labels which are not .select2-offscreen, as select2
         # makes a duplicate label with the same text, and we want to be sure to
         # find the original.
-        find('label:not(.select2-offscreen)', text: /#{Regexp.escape(text)}/i, match: :one)
+        find("label:not(.select2-offscreen)", text: /#{Regexp.escape(text)}/i, match: :one)
       end
 
-      def dialog(parent: 'body', **options)
+      def dialog(parent: "body", **options)
         within(parent) do
-          find('dialog', visible: :all, **options)
+          find("dialog", visible: :all, **options)
         end
       end
 
       def turbo_frame_modal
-        dialog(parent: find('turbo-frame', visible: :all))
+        dialog(parent: find("turbo-frame", visible: :all))
       end
     end
   end
@@ -144,4 +152,4 @@ RSpec.configure do |c|
 end
 
 # A workaround for https://github.com/rspec/rspec-rails/issues/1897
-Capybara.server = :puma, { Silent: true }
+Capybara.server = :puma, {Silent: true}

data/lib/spree/testing_support/common_rake.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-require 'generators/spree/dummy/dummy_generator'
-require 'logger'
+require "generators/spree/dummy/dummy_generator"
+require "logger"
 
 class CommonRakeTasks
   include Rake::DSL
+
   attr_reader :logger
 
   def initialize
@@ -12,7 +13,7 @@ class CommonRakeTasks
     namespace :common do
       task :test_app, :user_class do |_t, args|
         args.with_defaults(user_class: "Spree::LegacyUser")
-        lib_name = ENV['LIB_NAME'] or
+        lib_name = ENV["LIB_NAME"] or
           raise "Please provide a library name via the LIB_NAME environment variable."
 
         require lib_name
@@ -21,30 +22,30 @@ class CommonRakeTasks
 
         Spree::DummyGenerator.start [
           "--lib-name=#{lib_name}",
-          "--quiet",
+          "--quiet"
         ]
 
         # While the dummy app is generated the current directory
         # within ruby is changed to that of the dummy app.
         sh({
-          'FRONTEND' => ENV['FRONTEND'] || 'none',
+          "FRONTEND" => ENV["FRONTEND"] || "none"
         }, [
-          'bin/rails',
-          'generate',
-          'solidus:install',
+          "bin/rails",
+          "generate",
+          "solidus:install",
           Dir.pwd, # use the current dir as Rails.root
           "--auto-accept",
-          "--admin-preview=#{ENV.fetch('ADMIN_PREVIEW', 'false')}",
+          "--admin-preview=#{ENV.fetch("ADMIN_PREVIEW", "false")}",
           "--authentication=none",
           "--payment-method=none",
           "--migrate=false",
           "--seed=false",
           "--sample=false",
           "--user-class=#{args[:user_class]}",
-          "--quiet",
+          "--quiet"
         ].shelljoin)
 
-        if Bundler.locked_gems.dependencies['solidus_frontend']
+        if Bundler.locked_gems.dependencies["solidus_frontend"]
           sh "bin/rails g solidus_frontend:install --auto-accept"
         end
 
@@ -54,7 +55,7 @@ class CommonRakeTasks
         sh "bin/rails db:drop db:create db:migrate VERBOSE=false RAILS_ENV=test"
 
         if extension_installation_generator_exists?
-          logger.info 'Running extension installation generator...'
+          logger.info "Running extension installation generator..."
           sh "bin/rails generate #{rake_generator_namespace}:install --auto-run-migrations"
         end
       end
@@ -70,8 +71,8 @@ class CommonRakeTasks
   private
 
   def force_rails_environment_to_test
-    ENV["RAILS_ENV"] = 'test'
-    Rails.env = 'test'
+    ENV["RAILS_ENV"] = "test"
+    Rails.env = "test"
   end
 
   def extension_installation_generator_exists?
@@ -83,11 +84,11 @@ class CommonRakeTasks
   end
 
   def generator_namespace
-    "#{ENV['LIB_NAMESPACE']&.underscore || ENV['LIB_NAME']}"
+    (ENV["LIB_NAMESPACE"]&.underscore || ENV["LIB_NAME"]).to_s
   end
 
   def rake_generator_namespace
-    generator_namespace.gsub("/", ":")
+    generator_namespace.tr("/", ":")
   end
 end
 

data/lib/spree/testing_support/dummy_ability.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'cancan'
+require "cancan"
 
 class DummyAbility
   include CanCan::Ability

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

@@ -11,7 +11,7 @@ module DummyApp
         # Disconnect to avoid "database is being accessed by other users" on postgres
         ActiveRecord::Base.remove_connection
 
-        sh 'rake db:reset VERBOSE=false'
+        sh "rake db:reset VERBOSE=false"
 
         # We have a brand new database, so we must re-establish our connection
         ActiveRecord::Base.establish_connection

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

@@ -6,9 +6,9 @@ module DummyApp
 
     def initialize(gem_root:, lib_name:)
       task :dummy_environment do
-        ENV['RAILS_ENV'] = 'test'
+        ENV["RAILS_ENV"] = "test"
         require lib_name
-        require 'spree/testing_support/dummy_app'
+        require "spree/testing_support/dummy_app"
         DummyApp.setup(
           gem_root:,
           lib_name:,
@@ -45,12 +45,12 @@ namespace :db do
   end
 
   desc "Recreates the test database and re-runs all migrations"
-  task reset: ['db:drop', 'db:create', 'db:migrate']
+  task reset: ["db:drop", "db:create", "db:migrate"]
 end
 
 desc "Open a sandboxed console in the test environment"
 task console: :dummy_environment do
-  require 'rails/commands'
-  require 'rails/commands/console/console_command'
+  require "rails/commands"
+  require "rails/commands/console/console_command"
   Rails::Console.new(Rails.application, sandbox: true, environment: "test").start
 end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 DummyApp::Application.routes.draw do
-  mount Spree::Core::Engine, at: '/'
+  mount Spree::Core::Engine, at: "/"
 end

data/lib/spree/testing_support/dummy_app.rb

@@ -1,17 +1,29 @@
 # frozen_string_literal: true
 
-ENV['RAILS_ENV'] = 'test'
-ENV['DISABLE_DATABASE_ENVIRONMENT_CHECK'] = '1'
+ENV["RAILS_ENV"] = "test"
+ENV["DISABLE_DATABASE_ENVIRONMENT_CHECK"] = "1"
+
+# Speed up the sqlite runs: `fast_sqlite` patches SQLite3::Database#initialize to
+# set `PRAGMA synchronous = OFF` and `journal_mode = MEMORY`, trading durability we
+# don't need for a database the suite recreates anyway.
+#
+# NOTE: The gem is declared `require: false`, and only when DB is sqlite, so it is
+# genuinely absent for the mysql and postgres runs.
+begin
+  require "fast_sqlite"
+rescue LoadError
+  # Not running against sqlite, nothing to speed up.
+end
 
-require 'rails'
-require 'active_record/railtie'
-require 'action_controller/railtie'
-require 'action_mailer/railtie'
-require 'active_storage/engine'
+require "rails"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "active_storage/engine"
 
-Rails.env = 'test'
+Rails.env = "test"
 
-require 'solidus_core'
+require "solidus_core"
 
 # @private
 class ApplicationController < ActionController::Base
@@ -39,7 +51,7 @@ end
 module DummyApp
   def self.setup(gem_root:, lib_name:, auto_migrate: true)
     ENV["LIB_NAME"] = lib_name
-    root = Pathname(gem_root).join('spec/dummy')
+    root = Pathname(gem_root).join("spec/dummy")
     root.join("app/assets/config").mkpath
     root.join("app/assets/config/manifest.js").write("// Intentionally empty\n")
 
@@ -48,7 +60,7 @@ module DummyApp
 
     # Raise on deprecation warnings.
     # NOTE: This needs to happen after the application is initialized.
-    if ENV['SOLIDUS_RAISE_DEPRECATIONS'].present?
+    if ENV["SOLIDUS_RAISE_DEPRECATIONS"].present?
       Spree.deprecator.behavior = :raise
     end
 
@@ -77,19 +89,19 @@ module DummyApp
     config.cache_classes = true
 
     # Make debugging easier:
-    if Rails.gem_version >= Gem::Version.new('7.1')
+    if Rails.gem_version >= Gem::Version.new("7.1")
       config.action_controller.raise_on_missing_callback_actions = true
       config.action_dispatch.show_exceptions = :none
     else
       config.action_dispatch.show_exceptions = false
     end
     config.consider_all_requests_local = true
-    config.active_support.deprecation = ENV['RAILS_DEPRECATIONS_BEHAVIOR'].presence&.to_sym || :stderr
+    config.active_support.deprecation = ENV["RAILS_DEPRECATIONS_BEHAVIOR"].presence&.to_sym || :stderr
     config.log_level = :debug
 
     # Improve test suite performance:
     config.eager_load = false
-    config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
+    config.public_file_server.headers = {"Cache-Control" => "public, max-age=3600"}
     config.cache_store = :memory_store
 
     # We don't use a web server, so we let Rails serve assets.
@@ -102,66 +114,69 @@ module DummyApp
     config.active_job.queue_adapter = :test
 
     # No need to use credentials file in a test environment.
-    config.secret_key_base = 'SECRET_TOKEN'
+    config.secret_key_base = "SECRET_TOKEN"
 
     # Set the preview path within the dummy app:
     if ActionMailer::Base.respond_to? :preview_paths # Rails 7.1+
-      config.action_mailer.preview_paths << File.expand_path('dummy_app/mailer_previews', __dir__)
+      # Some Rails versions return a frozen array here; assign a new array
+      # to avoid FrozenError when augmenting the paths.
+      existing = Array(config.action_mailer.preview_paths)
+      config.action_mailer.preview_paths = existing + [File.expand_path("dummy_app/mailer_previews", __dir__)]
     else
-      config.action_mailer.preview_path = File.expand_path('dummy_app/mailer_previews', __dir__)
+      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
-    initializer 'solidus.active_storage' do
+    initializer "solidus.active_storage" do
       config.active_storage.service_configurations = {
         test: {
-          service: 'Disk',
-          root: Rails.root.join('tmp', 'storage')
+          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
+      config.active_storage.variant_processor = ENV.fetch("ACTIVE_STORAGE_VARIANT_PROCESSOR", :vips).to_sym
     end
 
     # Avoid issues if an old spec/dummy still exists
-    config.paths['config/initializers'] = []
-    config.paths['config/environments'] = []
+    config.paths["config/initializers"] = []
+    config.paths["config/environments"] = []
 
     migration_dirs = Rails.application.migration_railties.flat_map do |engine|
       if engine.respond_to?(:paths)
-        engine.paths['db/migrate'].to_a
+        engine.paths["db/migrate"].to_a
       else
         []
       end
     end
-    config.paths['db/migrate'] = migration_dirs
+    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__)
+    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__)
+    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__)
 
     ActionMailer::Base.default from: "store@example.com"
   end
 end
 
-require 'spree/testing_support/dummy_app/migrations'
+require "spree/testing_support/dummy_app/migrations"
 
 ActiveSupport.on_load(:action_controller) do
   wrap_parameters format: [:json]
 end
 
-Spree.user_class = 'Spree::LegacyUser'
+Spree.user_class = "Spree::LegacyUser"
 Spree.load_defaults(Spree.solidus_version)
 Spree.config do |config|
-  if (ENV['DISABLE_ACTIVE_STORAGE'] == 'true')
-    config.image_attachment_module = 'Spree::Image::PaperclipAttachment'
-    config.taxon_attachment_module = 'Spree::Taxon::PaperclipAttachment'
+  if ENV["DISABLE_ACTIVE_STORAGE"] == "true"
+    config.image_attachment_module = "Spree::Image::PaperclipAttachment"
+    config.taxon_attachment_module = "Spree::Taxon::PaperclipAttachment"
   end
 end

data/lib/spree/testing_support/extension_rake.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/common_rake'
+require "spree/testing_support/common_rake"
 
 desc "Generates a dummy app for testing an extension"
 namespace :extension do
   task :test_app, [:user_class] do |_t, args|
     Spree::DummyGeneratorHelper.inject_extension_requirements = true
-    Rake::Task['common:test_app'].invoke(args[:user_class])
+    Rake::Task["common:test_app"].invoke(args[:user_class])
   end
 end

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

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
 FactoryBot.define do
-  factory :address, class: 'Spree::Address' do
+  factory :address, class: "Spree::Address" do
     transient do
       # There's `Spree::Address#country_iso=`, prohibiting me from using `country_iso` here
-      country_iso_code { 'US' }
-      state_code { 'AL' }
+      country_iso_code { "US" }
+      state_code { "AL" }
     end
 
-    name { 'John Von Doe' }
-    company { 'Company' }
-    address1 { '10 Lovely Street' }
-    address2 { 'Northwest' }
-    city { 'Herndon' }
+    name { "John Von Doe" }
+    company { "Company" }
+    address1 { "10 Lovely Street" }
+    address2 { "Northwest" }
+    city { "Herndon" }
     sequence(:zipcode, 10001) { |i| i.to_s }
-    phone { '555-555-0199' }
-    alternative_phone { '555-555-0199' }
+    phone { "555-555-0199" }
+    alternative_phone { "555-555-0199" }
 
     country do |address|
       if address.state
@@ -35,10 +35,10 @@ FactoryBot.define do
   end
 
   factory :ship_address, parent: :address do
-    address1 { 'A Different Road' }
+    address1 { "A Different Road" }
   end
 
   factory :bill_address, parent: :address do
-    address1 { 'PO Box 1337' }
+    address1 { "PO Box 1337" }
   end
 end

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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 FactoryBot.define do
-  factory :adjustment, class: 'Spree::Adjustment' do
+  factory :adjustment, class: "Spree::Adjustment" do
     order
     adjustable { order }
     amount { 100.0 }
-    label { 'Shipping' }
+    label { "Shipping" }
     association(:source, factory: :tax_rate)
 
     after(:build) do |adjustment|
@@ -15,19 +15,19 @@ FactoryBot.define do
       end
     end
 
-    factory :tax_adjustment, class: 'Spree::Adjustment' do
+    factory :tax_adjustment, class: "Spree::Adjustment" do
       order { adjustable.order }
       association(:adjustable, factory: :line_item)
       amount { 10.0 }
-      label { 'VAT 5%' }
+      label { "VAT 5%" }
 
       after(:create) do |adjustment|
         # Set correct tax category, so that adjustment amount is not 0
         if adjustment.adjustable.is_a?(Spree::LineItem)
-          if adjustment.adjustable.tax_category.present?
-            adjustment.source.tax_categories = [adjustment.adjustable.tax_category]
+          adjustment.source.tax_categories = if adjustment.adjustable.tax_category.present?
+            [adjustment.adjustable.tax_category]
           else
-            adjustment.source.tax_categories = []
+            []
           end
           adjustment.source.save
           adjustment.update!(amount: adjustment.source.compute_amount(adjustment.adjustable))

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 FactoryBot.define do
-  factory :adjustment_reason, class: 'Spree::AdjustmentReason' do
+  factory :adjustment_reason, class: "Spree::AdjustmentReason" do
     sequence(:name) { |n| "Refund for return ##{n}" }
     sequence(:code) { |n| "Code #{n}" }
   end

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

@@ -1,25 +1,25 @@
 # frozen_string_literal: true
 
 FactoryBot.define do
-  factory :flat_rate_calculator, aliases: [:calculator], class: 'Spree::Calculator::FlatRate' do
+  factory :flat_rate_calculator, aliases: [:calculator], class: "Spree::Calculator::FlatRate" do
     preferred_amount { 10.0 }
   end
 
-  factory :no_amount_calculator, class: 'Spree::Calculator::FlatRate' do
+  factory :no_amount_calculator, class: "Spree::Calculator::FlatRate" do
     preferred_amount { 0 }
   end
 
-  factory :default_tax_calculator, class: 'Spree::Calculator::DefaultTax' do
+  factory :default_tax_calculator, class: "Spree::Calculator::DefaultTax" do
   end
 
-  factory :flat_fee_calculator, class: 'Spree::Calculator::FlatFee' do
+  factory :flat_fee_calculator, class: "Spree::Calculator::FlatFee" do
   end
 
-  factory :shipping_calculator, class: 'Spree::Calculator::Shipping::FlatRate' do
+  factory :shipping_calculator, class: "Spree::Calculator::Shipping::FlatRate" do
     preferred_amount { 10.0 }
   end
 
-  factory :shipping_no_amount_calculator, class: 'Spree::Calculator::Shipping::FlatRate' do
+  factory :shipping_no_amount_calculator, class: "Spree::Calculator::Shipping::FlatRate" do
     preferred_amount { 0 }
   end
 end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 FactoryBot.define do
-  factory :carton, class: 'Spree::Carton' do
+  factory :carton, class: "Spree::Carton" do
     address
     stock_location
     shipping_method

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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'carmen'
+require "carmen"
 
 FactoryBot.define do
-  factory :country, class: 'Spree::Country' do
-    iso { 'US' }
+  factory :country, class: "Spree::Country" do
+    iso { "US" }
 
     transient do
       carmen_country { Carmen::Country.coded(iso) || fail("Unknown country iso code: #{iso.inspect}") }