rspec-rails 4.0.0 → 6.1.2

data/lib/rspec/rails/example/mailbox_example_group.rb

@@ -13,7 +13,7 @@ module RSpec
         def self.create_inbound_email(arg)
           case arg
           when Hash
-            create_inbound_email_from_mail(arg)
+            create_inbound_email_from_mail(**arg)
           else
             create_inbound_email_from_source(arg.to_s)
           end
@@ -69,7 +69,7 @@ module RSpec
       #
       # @param message [Hash, Mail::Message] a mail message or hash of
       #   attributes used to build one
-      # @return [ActionMaibox::InboundMessage]
+      # @return [ActionMailbox::InboundMessage]
       def process(message)
         MailboxExampleGroup.create_inbound_email(message).tap do |mail|
           self.class.mailbox_class.receive(mail)

data/lib/rspec/rails/example/mailer_example_group.rb

@@ -21,8 +21,8 @@ if defined?(ActionMailer)
 
         included do
           include ::Rails.application.routes.url_helpers
-          options = ::Rails.configuration.action_mailer.default_url_options
-          options&.each { |key, value| default_url_options[key] = value }
+          options = ::Rails.configuration.action_mailer.default_url_options || {}
+          options.each { |key, value| default_url_options[key] = value }
         end
 
         # Class-level DSL for mailer specs.

data/lib/rspec/rails/example/rails_example_group.rb

@@ -2,6 +2,10 @@
 # suite and ammeter.
 require 'rspec/rails/matchers'
 
+if ::Rails::VERSION::MAJOR >= 7
+  require 'active_support/execution_context/test_helper'
+end
+
 module RSpec
   module Rails
     # @api public
@@ -12,6 +16,10 @@ module RSpec
       include RSpec::Rails::MinitestLifecycleAdapter
       include RSpec::Rails::MinitestAssertionAdapter
       include RSpec::Rails::FixtureSupport
+      if ::Rails::VERSION::MAJOR >= 7
+        include RSpec::Rails::TaggedLoggingAdapter
+        include ActiveSupport::ExecutionContext::TestHelper
+      end
     end
   end
 end

data/lib/rspec/rails/example/request_example_group.rb

@@ -10,10 +10,7 @@ module RSpec
       include RSpec::Rails::Matchers::RedirectTo
       include RSpec::Rails::Matchers::RenderTemplate
       include ActionController::TemplateAssertions
-
-      if ActionPack::VERSION::MAJOR >= 5
-        include ActionDispatch::IntegrationTest::Behavior
-      end
+      include ActionDispatch::IntegrationTest::Behavior
 
       # Delegates to `Rails.application`.
       def app

data/lib/rspec/rails/example/routing_example_group.rb

@@ -1,5 +1,3 @@
-require "action_dispatch/testing/assertions/routing"
-
 module RSpec
   module Rails
     # @private

data/lib/rspec/rails/example/system_example_group.rb

@@ -41,7 +41,53 @@ module RSpec
         @method_name ||= [
           self.class.name.underscore,
           RSpec.current_example.description.underscore
-        ].join("_").tr(CHARS_TO_TRANSLATE.join, "_")[0...200] + "_#{rand(1000)}"
+        ].join("_").tr(CHARS_TO_TRANSLATE.join, "_").byteslice(0...200).scrub("") + "_#{rand(1000)}"
+      end
+
+      if ::Rails::VERSION::STRING.to_f >= 7.1
+        # @private
+        # Allows failure screenshot to work whilst not exposing metadata
+        class SuppressRailsScreenshotMetadata
+          def initialize
+            @example_data = {}
+          end
+
+          def [](key)
+            if @example_data.key?(key)
+              @example_data[key]
+            else
+              raise_wrong_scope_error
+            end
+          end
+
+          def []=(key, value)
+            if key == :failure_screenshot_path
+              @example_data[key] = value
+            else
+              raise_wrong_scope_error
+            end
+          end
+
+          def method_missing(_name, *_args, &_block)
+            raise_wrong_scope_error
+          end
+
+          private
+
+          def raise_wrong_scope_error
+            raise RSpec::Core::ExampleGroup::WrongScopeError,
+                  "`metadata` is not available from within an example " \
+                  "(e.g. an `it` block) or from constructs that run in the " \
+                  "scope of an example (e.g. `before`, `let`, etc). It is " \
+                  "only available on an example group (e.g. a `describe` or "\
+                  "`context` block)"
+          end
+        end
+
+        # @private
+        def metadata
+          @metadata ||= SuppressRailsScreenshotMetadata.new
+        end
       end
 
       # Delegates to `Rails.application`.
@@ -54,23 +100,22 @@ module RSpec
           ActionDispatch::SystemTesting::Server.silence_puma = true
         end
 
+        require 'action_dispatch/system_test_case'
+
         begin
           require 'capybara'
-          require 'action_dispatch/system_test_case'
         rescue LoadError => e
           abort """
             LoadError: #{e.message}
-            System test integration requires Rails >= 5.1 and has a hard
+            System test integration has a hard
             dependency on a webserver and `capybara`, please add capybara to
             your Gemfile and configure a webserver (e.g. `Capybara.server =
-            :webrick`) before attempting to use system specs.
+            :puma`) before attempting to use system specs.
           """.gsub(/\s+/, ' ').strip
         end
 
-        if ::Rails::VERSION::STRING >= '6.0'
-          original_before_teardown =
-            ::ActionDispatch::SystemTesting::TestHelpers::SetupAndTeardown.instance_method(:before_teardown)
-        end
+        original_before_teardown =
+          ::ActionDispatch::SystemTesting::TestHelpers::SetupAndTeardown.instance_method(:before_teardown)
 
         original_after_teardown =
           ::ActionDispatch::SystemTesting::TestHelpers::SetupAndTeardown.instance_method(:after_teardown)
@@ -96,8 +141,8 @@ module RSpec
           end
         end
 
-        def driven_by(*args, &blk)
-          @driver = ::ActionDispatch::SystemTestCase.driven_by(*args, &blk).tap(&:use)
+        def driven_by(driver, **driver_options, &blk)
+          @driver = ::ActionDispatch::SystemTestCase.driven_by(driver, **driver_options, &blk).tap(&:use)
         end
 
         before do
@@ -108,16 +153,19 @@ module RSpec
           orig_stdout = $stdout
           $stdout = StringIO.new
           begin
-            if ::Rails::VERSION::STRING >= '6.0'
-              original_before_teardown.bind(self).call
-            end
-            original_after_teardown.bind(self).call
+            original_before_teardown.bind(self).call
           ensure
             myio = $stdout
-            RSpec.current_example.metadata[:extra_failure_lines] = myio.string
+            myio.rewind
+            RSpec.current_example.metadata[:extra_failure_lines] = myio.readlines
             $stdout = orig_stdout
           end
         end
+
+        around do |example|
+          example.run
+          original_after_teardown.bind(self).call
+        end
       end
     end
   end

data/lib/rspec/rails/example/view_example_group.rb

@@ -65,6 +65,7 @@ module RSpec
         #     end
         def render(options = {}, local_assigns = {}, &block)
           options = _default_render_options if Hash === options && options.empty?
+          options = options.merge(_default_render_options) if Hash === options && options.keys == [:locals]
           super(options, local_assigns, &block)
         end
 
@@ -89,7 +90,7 @@ module RSpec
         #
         #     stub_template("widgets/_widget.html.erb" => "This content.")
         def stub_template(hash)
-          view.view_paths.unshift(StubResolverCache.resolver_for(hash))
+          controller.prepend_view_path(StubResolverCache.resolver_for(hash))
         end
 
         # Provides access to the params hash that will be available within the
@@ -149,11 +150,11 @@ module RSpec
           # the original string.
           match = path_regex.match(_default_file_to_render)
 
-          render_options = {template: match[:template]}
-          render_options[:handlers] = [match[:handler]] if match[:handler]
+          render_options = { template: match[:template] }
+          render_options[:handlers] = [match[:handler].to_sym] if match[:handler]
           render_options[:formats] = [match[:format].to_sym] if match[:format]
-          render_options[:locales] = [match[:locale]] if match[:locale]
-          render_options[:variants] = [match[:variant]] if match[:variant]
+          render_options[:locales] = [match[:locale].to_sym] if match[:locale]
+          render_options[:variants] = [match[:variant].to_sym] if match[:variant]
 
           render_options
         end

data/lib/rspec/rails/extensions/active_record/proxy.rb

@@ -1,7 +1,10 @@
 RSpec.configure do |rspec|
   # Delay this in order to give users a chance to configure `expect_with`...
   rspec.before(:suite) do
-    if defined?(RSpec::Matchers) && RSpec::Matchers.configuration.syntax.include?(:should) && defined?(ActiveRecord::Associations)
+    if defined?(RSpec::Matchers) &&
+        RSpec::Matchers.configuration.respond_to?(:syntax) && # RSpec 4 dropped support for monkey-patching `should` syntax
+        RSpec::Matchers.configuration.syntax.include?(:should) &&
+        defined?(ActiveRecord::Associations)
       RSpec::Matchers.configuration.add_should_and_should_not_to ActiveRecord::Associations::CollectionProxy
     end
   end

data/lib/rspec/rails/feature_check.rb

@@ -24,17 +24,21 @@ module RSpec
       end
 
       def has_action_cable_testing?
-        defined?(::ActionCable) && ActionCable::VERSION::MAJOR >= 6
+        defined?(::ActionCable)
       end
 
       def has_action_mailer_parameterized?
-        has_action_mailer? && defined?(::ActionMailer::Parameterized)
+        has_action_mailer? && defined?(::ActionMailer::Parameterized::DeliveryJob)
       end
 
       def has_action_mailer_unified_delivery?
         has_action_mailer? && defined?(::ActionMailer::MailDeliveryJob)
       end
 
+      def has_action_mailer_legacy_delivery_job?
+        defined?(ActionMailer::DeliveryJob)
+      end
+
       def has_action_mailbox?
         defined?(::ActionMailbox)
       end

data/lib/rspec/rails/file_fixture_support.rb

@@ -1,15 +1,16 @@
-if ::Rails::VERSION::STRING > '5'
-  require 'active_support/testing/file_fixtures'
+require 'active_support/testing/file_fixtures'
 
-  module RSpec
-    module Rails
-      # @private
-      module FileFixtureSupport
-        extend ActiveSupport::Concern
-        include ActiveSupport::Testing::FileFixtures
+module RSpec
+  module Rails
+    # @private
+    module FileFixtureSupport
+      extend ActiveSupport::Concern
+      include ActiveSupport::Testing::FileFixtures
 
-        included do
-          self.file_fixture_path = RSpec.configuration.file_fixture_path
+      included do
+        self.file_fixture_path = RSpec.configuration.file_fixture_path
+        if defined?(ActiveStorage::FixtureSet)
+          ActiveStorage::FixtureSet.file_fixture_path = RSpec.configuration.file_fixture_path
         end
       end
     end

data/lib/rspec/rails/fixture_file_upload_support.rb

@@ -6,33 +6,38 @@ module RSpec
 
     private
 
+      # In Rails 7.0 fixture file path needs to be relative to `file_fixture_path` instead, this change
+      # was brought in with a deprecation warning on 6.1. In Rails 7.0 expect to rework this to remove
+      # the old accessor.
       def rails_fixture_file_wrapper
-        RailsFixtureFileWrapper.fixture_path = nil
-        resolved_fixture_path = (fixture_path || RSpec.configuration.fixture_path || '').to_s
-        RailsFixtureFileWrapper.fixture_path = File.join(resolved_fixture_path, '') unless resolved_fixture_path.strip.empty?
+        RailsFixtureFileWrapper.file_fixture_path = nil
+        resolved_fixture_path =
+          if respond_to?(:file_fixture_path) && !file_fixture_path.nil?
+            file_fixture_path.to_s
+          elsif respond_to?(:fixture_paths)
+            (RSpec.configuration.fixture_paths&.first || '').to_s
+          else
+            (RSpec.configuration.fixture_path || '').to_s
+          end
+        RailsFixtureFileWrapper.file_fixture_path = File.join(resolved_fixture_path, '') unless resolved_fixture_path.strip.empty?
         RailsFixtureFileWrapper.instance
       end
 
       class RailsFixtureFileWrapper
         include ActionDispatch::TestProcess if defined?(ActionDispatch::TestProcess)
+        include ActiveSupport::Testing::FileFixtures
 
         class << self
-          attr_reader :fixture_path
+          if ::Rails::VERSION::STRING < "7.1.0"
+            attr_accessor :fixture_path
+          else
+            attr_accessor :fixture_paths
+          end
 
           # Get instance of wrapper
           def instance
             @instance ||= new
           end
-
-          # Override fixture_path set
-          # to support Rails 3.0->3.1 using ActionController::TestCase class to resolve fixture_path
-          # see https://apidock.com/rails/v3.0.0/ActionDispatch/TestProcess/fixture_file_upload
-          def fixture_path=(value)
-            if ActionController::TestCase.respond_to?(:fixture_path)
-              ActionController::TestCase.fixture_path = value
-            end
-            @fixture_path = value
-          end
         end
       end
     end

data/lib/rspec/rails/fixture_support.rb

@@ -9,16 +9,26 @@ module RSpec
         include RSpec::Rails::MinitestAssertionAdapter
         include ActiveRecord::TestFixtures
 
+        # @private prevent ActiveSupport::TestFixtures to start a DB transaction.
+        # Monkey patched to avoid collisions with 'let(:name)' in Rails 6.1 and after
+        # and let(:method_name) before Rails 6.1.
+        def run_in_transaction?
+          current_example_name = (RSpec.current_example && RSpec.current_example.metadata[:description])
+          use_transactional_tests && !self.class.uses_transaction?(current_example_name)
+        end
+
         included do
           if RSpec.configuration.use_active_record?
             include Fixtures
 
-            self.fixture_path = RSpec.configuration.fixture_path
-            if ::Rails::VERSION::STRING > '5'
-              self.use_transactional_tests = RSpec.configuration.use_transactional_fixtures
+            # TestFixtures#fixture_path is deprecated and will be removed in Rails 7.2
+            if respond_to?(:fixture_paths=)
+              self.fixture_paths = RSpec.configuration.fixture_paths
             else
-              self.use_transactional_fixtures = RSpec.configuration.use_transactional_fixtures
+              self.fixture_path = RSpec.configuration.fixture_path
             end
+
+            self.use_transactional_tests = RSpec.configuration.use_transactional_fixtures
             self.use_instantiated_fixtures = RSpec.configuration.use_instantiated_fixtures
 
             fixtures RSpec.configuration.global_fixtures if RSpec.configuration.global_fixtures
@@ -28,35 +38,50 @@ module RSpec
         module Fixtures
           extend ActiveSupport::Concern
 
+          # rubocop:disable Metrics/BlockLength
           class_methods do
-            def fixtures(*args)
-              orig_methods = private_instance_methods
-              super.tap do
-                new_methods = private_instance_methods - orig_methods
-                new_methods.each do |method_name|
-                  proxy_method_warning_if_called_in_before_context_scope(method_name)
+            if ::Rails.version.to_f >= 7.1
+              def fixtures(*args)
+                super.tap do
+                  fixture_sets.each_pair do |method_name, fixture_name|
+                    proxy_method_warning_if_called_in_before_context_scope(method_name, fixture_name)
+                  end
                 end
               end
-            end
 
-            def proxy_method_warning_if_called_in_before_context_scope(method_name)
-              orig_implementation = instance_method(method_name)
-              define_method(method_name) do |*args, &blk|
-                if inspect.include?("before(:context)")
-                  RSpec.warn_with("Calling fixture method in before :context ")
-                else
-                  orig_implementation.bind(self).call(*args, &blk)
+              def proxy_method_warning_if_called_in_before_context_scope(method_name, fixture_name)
+                define_method(method_name) do |*args, **kwargs, &blk|
+                  if RSpec.current_scope == :before_context_hook
+                    RSpec.warn_with("Calling fixture method in before :context ")
+                  else
+                    access_fixture(fixture_name, *args, **kwargs, &blk)
+                  end
+                end
+              end
+            else
+              def fixtures(*args)
+                orig_methods = private_instance_methods
+                super.tap do
+                  new_methods = private_instance_methods - orig_methods
+                  new_methods.each do |method_name|
+                    proxy_method_warning_if_called_in_before_context_scope(method_name)
+                  end
                 end
               end
-            end
-          end
 
-          if ::Rails.version.to_f >= 6.1
-            # @private return the example name for TestFixtures
-            def name
-              @example
+              def proxy_method_warning_if_called_in_before_context_scope(method_name)
+                orig_implementation = instance_method(method_name)
+                define_method(method_name) do |*args, &blk|
+                  if RSpec.current_scope == :before_context_hook
+                    RSpec.warn_with("Calling fixture method in before :context ")
+                  else
+                    orig_implementation.bind(self).call(*args, &blk)
+                  end
+                end
+              end
             end
           end
+          # rubocop:enable Metrics/BlockLength
         end
       end
     end

data/lib/rspec/rails/matchers/action_cable/have_broadcasted_to.rb

@@ -96,8 +96,11 @@ module RSpec
         private
 
           def stream
-            @stream ||= if @target.is_a?(String)
+            @stream ||= case @target
+                        when String
                           @target
+                        when Symbol
+                          @target.to_s
                         else
                           check_channel_presence
                           @channel.broadcasting_for(@target)
@@ -109,7 +112,7 @@ module RSpec
               decoded = ActiveSupport::JSON.decode(msg)
               decoded = decoded.with_indifferent_access if decoded.is_a?(Hash)
 
-              if @data.nil? || @data === decoded
+              if @data.nil? || values_match?(@data, decoded)
                 @block.call(decoded)
                 true
               else
@@ -159,7 +162,7 @@ module RSpec
           def check_channel_presence
             return if @channel.present? && @channel.respond_to?(:channel_name)
 
-            error_msg = "Broadcasting channel can't be infered. Please, specify it with `from_channel`"
+            error_msg = "Broadcasting channel can't be inferred. Please, specify it with `from_channel`"
             raise ArgumentError, error_msg
           end
         end

data/lib/rspec/rails/matchers/action_mailbox.rb

@@ -22,11 +22,20 @@ module RSpec
             @inbound_email = create_inbound_email(message)
           end
 
-          def matches?(mailbox)
-            @mailbox  = mailbox
-            @receiver = ApplicationMailbox.router.send(:match_to_mailbox, inbound_email)
+          if defined?(::ApplicationMailbox) && ::ApplicationMailbox.router.respond_to?(:mailbox_for)
+            def matches?(mailbox)
+              @mailbox  = mailbox
+              @receiver = ApplicationMailbox.router.mailbox_for(inbound_email)
 
-            @receiver == @mailbox
+              @receiver == @mailbox
+            end
+          else
+            def matches?(mailbox)
+              @mailbox  = mailbox
+              @receiver = ApplicationMailbox.router.send(:match_to_mailbox, inbound_email)
+
+              @receiver == @mailbox
+            end
           end
 
           def failure_message
@@ -41,7 +50,7 @@ module RSpec
             "expected #{describe_inbound_email} not to route to #{mailbox}"
           end
 
-        private
+          private
 
           attr_reader :inbound_email, :mailbox, :receiver
 

data/lib/rspec/rails/matchers/active_job.rb

@@ -30,8 +30,12 @@ module RSpec
             self
           end
 
-          def at(date)
-            @at = date
+          def at(time_or_date)
+            case time_or_date
+            when Time then @at = Time.at(time_or_date.to_f)
+            else
+              @at = time_or_date
+            end
             self
           end
 
@@ -159,7 +163,29 @@ module RSpec
             return job[:at].nil? if @at == :no_wait
             return false unless job[:at]
 
-            values_match?(@at, Time.at(job[:at]))
+            scheduled_at = Time.at(job[:at])
+            values_match?(@at, scheduled_at) || check_for_inprecise_value(scheduled_at)
+          end
+
+          def check_for_inprecise_value(scheduled_at)
+            return unless Time === @at && values_match?(@at.change(usec: 0), scheduled_at)
+
+            RSpec.warn_with((<<-WARNING).gsub(/^\s+\|/, '').chomp)
+            |[WARNING] Your expected `at(...)` value does not match the job scheduled_at value
+            |unless microseconds are removed. This precision error often occurs when checking
+            |values against `Time.current` / `Time.now` which have usec precision, but Rails
+            |uses `n.seconds.from_now` internally which has a usec count of `0`.
+            |
+            |Use `change(usec: 0)` to correct these values. For example:
+            |
+            |`Time.current.change(usec: 0)`
+            |
+            |Note: RSpec cannot do this for you because jobs can be scheduled with usec
+            |precision and we do not know whether it is on purpose or not.
+            |
+            |
+            WARNING
+            false
           end
 
           def set_expected_number(relativity, count)
@@ -204,11 +230,11 @@ module RSpec
           def matches?(proc)
             raise ArgumentError, "have_enqueued_job and enqueue_job only support block expectations" unless Proc === proc
 
-            original_enqueued_jobs_count = queue_adapter.enqueued_jobs.count
+            original_enqueued_jobs = Set.new(queue_adapter.enqueued_jobs)
             proc.call
-            in_block_jobs = queue_adapter.enqueued_jobs.drop(original_enqueued_jobs_count)
+            enqueued_jobs = Set.new(queue_adapter.enqueued_jobs)
 
-            check(in_block_jobs)
+            check(enqueued_jobs - original_enqueued_jobs)
           end
 
           def does_not_match?(proc)

data/lib/rspec/rails/matchers/have_enqueued_mail.rb

@@ -4,6 +4,7 @@
 require "rspec/mocks/argument_matchers"
 require "rspec/rails/matchers/active_job"
 
+# rubocop: disable Metrics/ClassLength
 module RSpec
   module Rails
     module Matchers
@@ -119,9 +120,11 @@ module RSpec
         end
 
         def mail_job_message(job)
-          mailer_method = job[:args][0..1].join('.')
+          job_args = deserialize_arguments(job)
+
+          mailer_method = job_args[0..1].join('.')
+          mailer_args = job_args[3..-1]
 
-          mailer_args = job[:args][3..-1]
           msg_parts = []
           msg_parts << "with #{mailer_args}" if mailer_args.any?
           msg_parts << "on queue #{job[:queue]}" if job[:queue] && job[:queue] != 'mailers'
@@ -130,18 +133,43 @@ module RSpec
           "#{mailer_method} #{msg_parts.join(', ')}".strip
         end
 
+        # Ruby 3.1 changed how params were serialized on Rails 6.1
+        # so we override the active job implementation and customize it here.
+        def deserialize_arguments(job)
+          args = super
+
+          return args unless Hash === args.last
+
+          hash = args.pop
+
+          if hash.key?("_aj_ruby2_keywords")
+            keywords = hash["_aj_ruby2_keywords"]
+
+            original_hash = keywords.each_with_object({}) { |keyword, new_hash| new_hash[keyword.to_sym] = hash[keyword] }
+
+            args + [original_hash]
+          elsif hash.key?(:args) && hash.key?(:params)
+            args + [hash]
+          elsif hash.key?(:args)
+            args + hash[:args]
+          else
+            args + [hash]
+          end
+        end
+
         def legacy_mail?(job)
-          job[:job] == ActionMailer::DeliveryJob
+          RSpec::Rails::FeatureCheck.has_action_mailer_legacy_delivery_job? && job[:job] <= ActionMailer::DeliveryJob
         end
 
         def parameterized_mail?(job)
-          RSpec::Rails::FeatureCheck.has_action_mailer_parameterized? && job[:job] == ActionMailer::Parameterized::DeliveryJob
+          RSpec::Rails::FeatureCheck.has_action_mailer_parameterized? && job[:job] <= ActionMailer::Parameterized::DeliveryJob
         end
 
         def unified_mail?(job)
-          RSpec::Rails::FeatureCheck.has_action_mailer_unified_delivery? && job[:job] == ActionMailer::MailDeliveryJob
+          RSpec::Rails::FeatureCheck.has_action_mailer_unified_delivery? && job[:job] <= ActionMailer::MailDeliveryJob
         end
       end
+
       # @api public
       # Passes if an email has been enqueued inside block.
       # May chain with to specify expected arguments.
@@ -196,3 +224,4 @@ module RSpec
     end
   end
 end
+# rubocop: enable Metrics/ClassLength