rspec-rails 3.8.2 → 7.0.1

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

@@ -37,37 +37,17 @@ end
 
 unless RSpec.respond_to?(:feature)
   opts = {
-    :capybara_feature => true,
-    :type => :feature,
-    :skip => <<-EOT.squish
-      Feature specs require the Capybara (http://github.com/jnicklas/capybara)
-      gem, version 2.2.0 or later. We recommend version 2.4.0 or later to avoid
-      some deprecation warnings and have support for
-      `config.expose_dsl_globally = false`.
+    capybara_feature: true,
+    type: :feature,
+    skip: <<-EOT.squish
+      Feature specs require the Capybara (https://github.com/teamcapybara/capybara)
+      gem, version 2.13.0 or later.
     EOT
   }
 
-  # Capybara's monkey patching causes us to have to jump through some hoops
-  top_level = self
-  main_feature = nil
-  if defined?(Capybara) && ::Capybara::VERSION.to_f < 2.4
-    # Capybara 2.2 and 2.3 do not use `alias_example_xyz`
-    opts[:skip] = <<-EOT.squish
-      Capybara < 2.4.0 does not support RSpec's namespace or
-      `config.expose_dsl_globally = false`. Upgrade to Capybara >= 2.4.0.
-    EOT
-    main_feature = top_level.method(:feature) if top_level.respond_to?(:feature)
-  end
-
   RSpec.configure do |c|
-    main_feature = nil unless c.expose_dsl_globally?
     c.alias_example_group_to :feature, opts
     c.alias_example_to :scenario
-    c.alias_example_to :xscenario, :skip => 'Temporarily skipped with xscenario'
+    c.alias_example_to :xscenario, skip: 'Temporarily skipped with xscenario'
   end
-
-  # Due to load order issues and `config.expose_dsl_globally?` defaulting to
-  # `true` we need to put Capybara's monkey patch method back. Otherwise,
-  # app upgrades have a high likelyhood of having all feature specs skipped.
-  top_level.define_singleton_method(:feature, &main_feature) if main_feature
 end

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

@@ -12,15 +12,8 @@ module RSpec
 
       # @private
       module ClassMethods
-        if ::Rails::VERSION::MAJOR > 3
-          def determine_constant_from_test_name(_ignore)
-            described_class if yield(described_class)
-          end
-        else
-          def determine_default_helper_class(_ignore)
-            return unless Module === described_class && !(Class === described_class)
-            described_class
-          end
+        def determine_constant_from_test_name(_ignore)
+          described_class if yield(described_class)
         end
       end
 

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

@@ -0,0 +1,80 @@
+module RSpec
+  module Rails
+    # @api public
+    # Container module for mailbox spec functionality.
+    module MailboxExampleGroup
+      extend ActiveSupport::Concern
+
+      if RSpec::Rails::FeatureCheck.has_action_mailbox?
+        require 'action_mailbox/test_helper'
+        extend ::ActionMailbox::TestHelper
+
+        # @private
+        def self.create_inbound_email(arg)
+          case arg
+          when Hash
+            create_inbound_email_from_mail(**arg)
+          else
+            create_inbound_email_from_source(arg.to_s)
+          end
+        end
+      else
+        def self.create_inbound_email(_arg)
+          raise "Could not load ActionMailer::TestHelper"
+        end
+      end
+
+      class_methods do
+        # @private
+        def mailbox_class
+          described_class
+        end
+      end
+
+      included do
+        subject { described_class }
+      end
+
+      # @api public
+      # Passes if the inbound email was delivered
+      #
+      # @example
+      #       inbound_email = process(args)
+      #       expect(inbound_email).to have_been_delivered
+      def have_been_delivered
+        satisfy('have been delivered', &:delivered?)
+      end
+
+      # @api public
+      # Passes if the inbound email bounced during processing
+      #
+      # @example
+      #       inbound_email = process(args)
+      #       expect(inbound_email).to have_bounced
+      def have_bounced
+        satisfy('have bounced', &:bounced?)
+      end
+
+      # @api public
+      # Passes if the inbound email failed to process
+      #
+      # @example
+      #       inbound_email = process(args)
+      #       expect(inbound_email).to have_failed
+      def have_failed
+        satisfy('have failed', &:failed?)
+      end
+
+      # Process an inbound email message directly, bypassing routing.
+      #
+      # @param message [Hash, Mail::Message] a mail message or hash of
+      #   attributes used to build one
+      # @return [ActionMailbox::InboundMessage]
+      def process(message)
+        MailboxExampleGroup.create_inbound_email(message).tap do |mail|
+          self.class.mailbox_class.receive(mail)
+        end
+      end
+    end
+  end
+end

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 } if options
+          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,9 @@
 # suite and ammeter.
 require 'rspec/rails/matchers'
 
+require 'active_support/current_attributes/test_helper'
+require 'active_support/execution_context/test_helper'
+
 module RSpec
   module Rails
     # @api public
@@ -9,9 +12,12 @@ module RSpec
     module RailsExampleGroup
       extend ActiveSupport::Concern
       include RSpec::Rails::SetupAndTeardownAdapter
-      include RSpec::Rails::MinitestLifecycleAdapter if ::Rails::VERSION::STRING >= '4'
+      include RSpec::Rails::MinitestLifecycleAdapter
       include RSpec::Rails::MinitestAssertionAdapter
       include RSpec::Rails::FixtureSupport
+      include RSpec::Rails::TaggedLoggingAdapter
+      include ActiveSupport::CurrentAttributes::TestHelper
+      include ActiveSupport::ExecutionContext::TestHelper
     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

@@ -15,7 +15,11 @@ module RSpec
       CHARS_TO_TRANSLATE = ['/', '.', ':', ',', "'", '"', " "].freeze
 
       # @private
-      module BlowAwayAfterTeardownHook
+      module BlowAwayTeardownHooks
+        # @private
+        def before_teardown
+        end
+
         # @private
         def after_teardown
         end
@@ -37,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`.
@@ -45,29 +95,42 @@ module RSpec
         ::Rails.application
       end
 
+      # Default driver to assign if none specified.
+      DEFAULT_DRIVER =
+        if ::Rails::VERSION::STRING.to_f >= 7.2
+          :selenium_chrome_headless
+        else
+          :selenium
+        end
+
       included do |other|
+        ActiveSupport.on_load(:action_dispatch_system_test_case) do
+          ActionDispatch::SystemTesting::Server.silence_puma = true
+        end
+
+        require 'action_dispatch/system_test_case'
+
         begin
           require 'capybara'
-          require 'action_dispatch/system_test_case'
-        # rubocop:disable Lint/HandleExceptions
         rescue LoadError => e
-          # rubocop:enable Lint/HandleExceptions
           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
 
+        original_before_teardown =
+          ::ActionDispatch::SystemTesting::TestHelpers::SetupAndTeardown.instance_method(:before_teardown)
+
         original_after_teardown =
           ::ActionDispatch::SystemTesting::TestHelpers::SetupAndTeardown.instance_method(:after_teardown)
 
-        other.include ActionDispatch::IntegrationTest::Behavior
         other.include ::ActionDispatch::SystemTesting::TestHelpers::SetupAndTeardown
         other.include ::ActionDispatch::SystemTesting::TestHelpers::ScreenshotHelper
-        other.include BlowAwayAfterTeardownHook
+        other.include BlowAwayTeardownHooks
 
         attr_reader :driver
 
@@ -78,16 +141,19 @@ module RSpec
         def initialize(*args, &blk)
           super(*args, &blk)
           @driver = nil
+
+          self.class.before do
+            # A user may have already set the driver, so only default if driver
+            # is not set
+            driven_by(DEFAULT_DRIVER) unless @driver
+          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
-          # A user may have already set the driver, so only default if driver
-          # is not set
-          driven_by(:selenium) unless @driver
           @routes = ::Rails.application.routes
         end
 
@@ -95,13 +161,19 @@ module RSpec
           orig_stdout = $stdout
           $stdout = StringIO.new
           begin
-            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

@@ -43,16 +43,13 @@ module RSpec
 
         included do
           include ::Rails.application.routes.url_helpers
-
-          if ::Rails.application.routes.respond_to?(:mounted_helpers)
-            include ::Rails.application.routes.mounted_helpers
-          end
+          include ::Rails.application.routes.mounted_helpers
         end
 
         # @overload render
-        # @overload render({:partial => path_to_file})
-        # @overload render({:partial => path_to_file}, {... locals ...})
-        # @overload render({:partial => path_to_file}, {... locals ...}) do ... end
+        # @overload render({partial: path_to_file})
+        # @overload render({partial: path_to_file}, {... locals ...})
+        # @overload render({partial: path_to_file}, {... locals ...}) do ... end
         #
         # Delegates to ActionView::Base#render, so see documentation on that
         # for more info.
@@ -62,12 +59,13 @@ module RSpec
         #
         #     describe "widgets/new.html.erb" do
         #       it "shows all the widgets" do
-        #         render # => view.render(:file => "widgets/new.html.erb")
+        #         render # => view.render(file: "widgets/new.html.erb")
         #         # ...
         #       end
         #     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
 
@@ -92,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
@@ -105,7 +103,7 @@ module RSpec
 
         # @deprecated Use `view` instead.
         def template
-          RSpec.deprecate("template", :replacement => "view")
+          RSpec.deprecate("template", replacement: "view")
           view
         end
 
@@ -128,20 +126,37 @@ module RSpec
       private
 
         def _default_render_options
-          if ::Rails::VERSION::STRING >= '3.2'
-            # pluck the handler, format, and locale out of, eg, posts/index.de.html.haml
-            template, *components   = _default_file_to_render.split('.')
-            handler, format, locale = *components.reverse
-
-            render_options = { :template => template }
-            render_options[:handlers] = [handler] if handler
-            render_options[:formats] = [format.to_sym] if format
-            render_options[:locales] = [locale] if locale
-
-            render_options
-          else
-            { :template => _default_file_to_render }
-          end
+          formats = if ActionView::Template::Types.respond_to?(:symbols)
+                      ActionView::Template::Types.symbols
+                    else
+                      [:html, :text, :js, :css, :xml, :json].map(&:to_s)
+                    end.map { |x| Regexp.escape(x) }.join("|")
+
+          handlers = ActionView::Template::Handlers.extensions.map { |x| Regexp.escape(x) }.join("|")
+          locales = "[a-z]{2}(?:-[A-Z]{2})?"
+          variants = "[^.]*"
+          path_regex = %r{
+          \A
+          (?<template>.*?)
+          (?:\.(?<locale>#{locales}))??
+            (?:\.(?<format>#{formats}))??
+            (?:\+(?<variant>#{variants}))??
+            (?:\.(?<handler>#{handlers}))?
+            \z
+          }x
+
+          # This regex should always find a match.
+          # Worst case, everything will be nil, and :template will just be
+          # the original string.
+          match = path_regex.match(_default_file_to_render)
+
+          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].to_sym] if match[:locale]
+          render_options[:variants] = [match[:variant].to_sym] if match[:variant]
+
+          render_options
         end
 
         def _path_parts
@@ -171,10 +186,7 @@ module RSpec
 
         before do
           _include_controller_helpers
-          if view.lookup_context.respond_to?(:prefixes)
-            # rails 3.1
-            view.lookup_context.prefixes << _controller_path
-          end
+          view.lookup_context.prefixes << _controller_path
 
           controller.controller_path = _controller_path
 

data/lib/rspec/rails/example.rb

@@ -9,3 +9,5 @@ require 'rspec/rails/example/model_example_group'
 require 'rspec/rails/example/job_example_group'
 require 'rspec/rails/example/feature_example_group'
 require 'rspec/rails/example/system_example_group'
+require 'rspec/rails/example/channel_example_group'
+require 'rspec/rails/example/mailbox_example_group'

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

@@ -1,16 +1,11 @@
 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)
-      # In Rails 3.0, it was AssociationProxy.
-      # In 3.1+, it's CollectionProxy.
-      const_name = [:CollectionProxy, :AssociationProxy].find do |const|
-        ActiveRecord::Associations.const_defined?(const)
-      end
-
-      proxy_class = ActiveRecord::Associations.const_get(const_name)
-
-      RSpec::Matchers.configuration.add_should_and_should_not_to proxy_class
+    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
 end

data/lib/rspec/rails/feature_check.rb

@@ -1,23 +1,8 @@
 module RSpec
   module Rails
     # @private
-    # Disable some cops until https://github.com/bbatsov/rubocop/issues/1310
-    # rubocop:disable Style/IndentationConsistency
     module FeatureCheck
-    # rubocop:disable Style/IndentationWidth
-    module_function
-      # rubocop:enable Style/IndentationWidth
-
-      def can_check_pending_migrations?
-        has_active_record_migration? &&
-          ::ActiveRecord::Migration.respond_to?(:check_pending!)
-      end
-
-      def can_maintain_test_schema?
-        has_active_record_migration? &&
-          ::ActiveRecord::Migration.respond_to?(:maintain_test_schema!)
-      end
-
+      module_function
       def has_active_job?
         defined?(::ActiveJob)
       end
@@ -38,27 +23,29 @@ module RSpec
         has_action_mailer? && defined?(::ActionMailer::Preview)
       end
 
-      def has_action_mailer_show_preview?
-        has_action_mailer_preview? &&
-          ::ActionMailer::Base.respond_to?(:show_previews=)
+      def has_action_cable_testing?
+        defined?(::ActionCable)
+      end
+
+      def has_action_mailer_parameterized?
+        has_action_mailer? && defined?(::ActionMailer::Parameterized::DeliveryJob)
+      end
+
+      def has_action_mailer_unified_delivery?
+        has_action_mailer? && defined?(::ActionMailer::MailDeliveryJob)
       end
 
-      def has_1_9_hash_syntax?
-        ::Rails::VERSION::STRING > '4.0'
+      def has_action_mailer_legacy_delivery_job?
+        defined?(ActionMailer::DeliveryJob)
       end
 
-      def has_file_fixture?
-        ::Rails::VERSION::STRING > '5.0'
+      def has_action_mailbox?
+        defined?(::ActionMailbox)
       end
 
       def type_metatag(type)
-        if has_1_9_hash_syntax?
-          "type: :#{type}"
-        else
-          ":type => :#{type}"
-        end
+        "type: :#{type}"
       end
     end
-    # rubocop:enable Style/IndentationConsistency
   end
 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

@@ -2,37 +2,42 @@ module RSpec
   module Rails
     # @private
     module FixtureFileUploadSupport
-      delegate :fixture_file_upload, :to => :rails_fixture_file_wrapper
+      delegate :fixture_file_upload, to: :rails_fixture_file_wrapper
 
     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