solidus_core 2.11.10 → 3.3.1

data/lib/spree/rails_compatibility.rb

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

data/lib/spree/testing_support/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 = ['http://fonts.googleapis.com']
+          browser.url_blacklist = ['https://fonts.googleapis.com']
         end
       end
     end

data/lib/spree/testing_support/bus_helpers.rb

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

data/lib/spree/testing_support/capybara_ext.rb

@@ -35,18 +35,6 @@ module Spree
         find("td:nth-of-type(#{num})").text
       end
 
-      def fill_in_quantity(table_column, selector, quantity)
-        Spree::Deprecation.warn <<-WARN.strip_heredoc
-          fill_in_quantity is deprecated. Instead use:
-            within(#{table_column.inspect}) do
-              fill_in #{selector.inspect}, with: #{quantity.inspect}
-            end
-        WARN
-        within(table_column) do
-          fill_in selector, with: quantity
-        end
-      end
-
       def select2_search(value, options)
         options = {
           search: value, # by default search for the value
@@ -122,21 +110,6 @@ module Spree
         # find the original.
         find('label:not(.select2-offscreen)', text: /#{Regexp.escape(text)}/i, match: :one)
       end
-
-      def wait_for_ajax
-        Spree::Deprecation.warn <<-WARN.squish, caller
-          wait_for_ajax has been deprecated.
-          Please refer to the capybara documentation on how to properly wait for asyncronous behavior:
-          https://github.com/teamcapybara/capybara#asynchronous-javascript-ajax-and-friends
-        WARN
-
-        counter = 0
-        while page.evaluate_script("typeof($) === 'undefined' || $.active > 0")
-          counter += 1
-          sleep(0.1)
-          raise "AJAX request took longer than 5 seconds." if counter >= 50
-        end
-      end
     end
   end
 end
@@ -156,9 +129,6 @@ RSpec::Matchers.define :have_meta do |name, expected|
   end
 end
 
-# @private
-CapybaraExt = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('CapybaraExt', 'Spree::TestingSupport::CapybaraExt')
-
 RSpec.configure do |c|
   c.include Spree::TestingSupport::CapybaraExt
 end

data/lib/spree/testing_support/common_rake.rb

@@ -1,38 +1,86 @@
 # frozen_string_literal: true
 
-unless defined?(Solidus::InstallGenerator)
-  require 'generators/solidus/install/install_generator'
-end
-
 require 'generators/spree/dummy/dummy_generator'
 
-namespace :common do
-  task :test_app, :user_class do |_t, args|
-    args.with_defaults(user_class: "Spree::LegacyUser")
-    require ENV['LIB_NAME']
+class CommonRakeTasks
+  include Rake::DSL
 
-    ENV["RAILS_ENV"] = 'test'
+  def initialize
+    namespace :common do
+      task :test_app, :user_class do |_t, args|
+        args.with_defaults(user_class: "Spree::LegacyUser")
+        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",
+        ]
 
-    puts "Setting up dummy database..."
+        # 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)
 
-    sh "bin/rails db:environment:set RAILS_ENV=test"
-    sh "bin/rails db:drop db:create db:migrate VERBOSE=false RAILS_ENV=test"
+        puts "Setting up dummy database..."
 
-    begin
-      require "generators/#{ENV['LIB_NAME']}/install/install_generator"
-      puts 'Running extension installation generator...'
-      "#{ENV['LIB_NAMESPACE'] || ENV['LIB_NAME'].camelize}::Generators::InstallGenerator".constantize.start(["--auto-run-migrations"])
-    rescue LoadError
-      # No extension generator to run
+        sh "bin/rails db:environment:set RAILS_ENV=test"
+        sh "bin/rails db:drop db:create db:migrate VERBOSE=false RAILS_ENV=test"
+
+        if extension_installation_generator_exists?
+          puts 'Running extension installation generator...'
+          sh "bin/rails generate #{rake_generator_namespace}:install --auto-run-migrations"
+        end
+      end
+
+      task :seed do |_t, _args|
+        puts "Seeding ..."
+
+        sh "bundle exec rake db:seed RAILS_ENV=test"
+      end
     end
   end
 
-  task :seed do |_t, _args|
-    puts "Seeding ..."
+  private
 
-    sh "bundle exec rake db:seed RAILS_ENV=test"
+  def force_rails_environment_to_test
+    ENV["RAILS_ENV"] = 'test'
+    Rails.env = 'test'
+  end
+
+  def extension_installation_generator_exists?
+    require "generators/#{generator_namespace}/install/install_generator"
+
+    true
+  rescue LoadError
+    false
+  end
+
+  def generator_namespace
+    "#{ENV['LIB_NAMESPACE']&.underscore || ENV['LIB_NAME']}"
+  end
+
+  def rake_generator_namespace
+    generator_namespace.gsub("/", ":")
   end
 end
+
+CommonRakeTasks.new

data/lib/spree/testing_support/controller_requests.rb

@@ -2,23 +2,12 @@
 
 module Spree
   module TestingSupport
-    # A module providing convenience methods to test Solidus controllers
-    # in Rails controller/functional tests. Possibly from inside an
-    # application with a mounted Solidus engine.
-    #
     # *There is generaly no need* to use this module. Instead, in
     # a functional/controller test against a Spree controller, just
     # use standard Rails functionality by including:
     #
     #   routes { Spree::Core::Engine.routes }
     #
-    # And then use standard Rails test `get`, `post` etc methods.
-    #
-    # But some legacy code uses this ControllerRequests helper. It must
-    # be included only in tests against Spree controllers, it will interfere
-    # with tests against local app or other engine controllers, resulting
-    # in ActionController::UrlGenerationError.
-    #
     # To use this module, inside your spec_helper.rb, include this module inside
     # the RSpec.configure block by:
     #
@@ -26,83 +15,12 @@ module Spree
     #   RSpec.configure do |c|
     #     c.include Spree::TestingSupport::ControllerRequests, spree_controller: true
     #   end
-    #
-    # Then, in your controller tests against spree controllers, you can access
-    # tag to use this module, and access spree routes like this:
-    #
-    #   require 'spec_helper'
-    #
-    #   describe Spree::ProductsController, :spree_controller do
-    #     it "can see all the products" do
-    #       spree_get :index
-    #     end
-    #   end
-    #
-    # Use spree_get, spree_post, spree_put or spree_delete to make requests to
-    # the Spree engine, and use regular get, post, put or delete to make
-    # requests to your application.
     module ControllerRequests
       extend ActiveSupport::Concern
 
       included do
         routes { Spree::Core::Engine.routes }
       end
-
-      def spree_get(action, parameters = nil, session = nil, flash = nil)
-        process_spree_action(action, parameters, session, flash, "GET")
-      end
-      deprecate spree_get: :get, deprecator: Spree::Deprecation
-
-      # Executes a request simulating POST HTTP method and set/volley the response
-      def spree_post(action, parameters = nil, session = nil, flash = nil)
-        process_spree_action(action, parameters, session, flash, "POST")
-      end
-      deprecate spree_post: :post, deprecator: Spree::Deprecation
-
-      # Executes a request simulating PUT HTTP method and set/volley the response
-      def spree_put(action, parameters = nil, session = nil, flash = nil)
-        process_spree_action(action, parameters, session, flash, "PUT")
-      end
-      deprecate spree_put: :put, deprecator: Spree::Deprecation
-
-      # Executes a request simulating DELETE HTTP method and set/volley the response
-      def spree_delete(action, parameters = nil, session = nil, flash = nil)
-        process_spree_action(action, parameters, session, flash, "DELETE")
-      end
-      deprecate spree_delete: :delete, deprecator: Spree::Deprecation
-
-      def spree_xhr_get(action, parameters = nil, session = nil, flash = nil)
-        process_spree_xhr_action(action, parameters, session, flash, :get)
-      end
-      deprecate spree_xhr_get: :get, deprecator: Spree::Deprecation
-
-      def spree_xhr_post(action, parameters = nil, session = nil, flash = nil)
-        process_spree_xhr_action(action, parameters, session, flash, :post)
-      end
-      deprecate spree_xhr_post: :post, deprecator: Spree::Deprecation
-
-      def spree_xhr_put(action, parameters = nil, session = nil, flash = nil)
-        process_spree_xhr_action(action, parameters, session, flash, :put)
-      end
-      deprecate spree_xhr_put: :put, deprecator: Spree::Deprecation
-
-      def spree_xhr_delete(action, parameters = nil, session = nil, flash = nil)
-        process_spree_xhr_action(action, parameters, session, flash, :delete)
-      end
-      deprecate spree_xhr_delete: :delete, deprecator: Spree::Deprecation
-
-      private
-
-      def process_spree_action(action, parameters = nil, session = nil, flash = nil, method = "GET")
-        parameters ||= {}
-        process(action, method, parameters, session, flash)
-      end
-
-      def process_spree_xhr_action(action, parameters = nil, session = nil, flash = nil, method = :get)
-        parameters ||= {}
-        parameters.reverse_merge!(format: :json)
-        xml_http_request(method, action, parameters, session, flash)
-      end
     end
   end
 end

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

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

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

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

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

@@ -1,34 +1,54 @@
-<%
-database_prefix = ENV['LIB_NAME'].presence || "solidus"
-%>
-<% case ENV['DB']
+<% 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' %>
 test:
   adapter: mysql2
-  <% if ENV['CI'] %>
-  username: root
-  password:
+  database: <%= db_prefix %>_test
+  <% unless db_username.blank? %>
+  username: <%= db_username %>
   <% end %>
-  database: <%= database_prefix %>_test
-  encoding: utf8
-  <% unless ENV['DB_HOST'].blank? %>
-  host: <%= ENV['DB_HOST'] %>
+  <% unless db_password.blank? %>
+  password: <%= db_password %>
+  <% end %>
+  <% unless db_host.blank? %>
+  host: <%= db_host %>
   <% end %>
-<% when 'postgres', 'postgresql' %>
-<% db_host = ENV['DB_HOST'] %>
+  encoding: utf8
+<% when 'postgres' %>
 test:
   adapter: postgresql
-  database: <%= database_prefix %>_test
-  username: postgres
-  min_messages: warning
-<% unless db_host.blank? %>
+  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 %>
-<% when 'sqlite', '', nil %>
+  <% end %>
+  min_messages: warning
+<% when 'sqlite' %>
 test:
   adapter: sqlite3
-  database: db/<%= database_prefix %>_test.sqlite3
+  database: db/<%= db_prefix %>_test.sqlite3
   timeout: 10000
-<% else %>
-  <% raise "Invalid DB specified: #{ENV['DB']}" %>
 <% end %>

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

@@ -27,9 +27,6 @@ module DummyApp
         ActiveRecord::Base.remove_connection
 
         sh 'rake db:reset VERBOSE=false'
-        if ENV['ENABLE_ACTIVE_STORAGE']
-          sh 'rake active_storage:install db:migrate VERBOSE=false'
-        end
 
         # We have a brand new database, so we must re-establish our connection
         ActiveRecord::Base.establish_connection