rspec-rails 5.1.2 → 7.1.1

data/lib/generators/rspec/scaffold/templates/show_spec.rb

@@ -3,7 +3,7 @@ require 'rails_helper'
 <% output_attributes = attributes.reject{|attribute| [:datetime, :timestamp, :time, :date].index(attribute.type) } -%>
 RSpec.describe "<%= ns_table_name %>/show", <%= type_metatag(:view) %> do
   before(:each) do
-    @<%= ns_file_name %> = assign(:<%= ns_file_name %>, <%= class_name %>.create!(<%= '))' if output_attributes.empty? %>
+    assign(:<%= singular_table_name %>, <%= class_name %>.create!(<%= '))' if output_attributes.empty? %>
 <% output_attributes.each_with_index do |attribute, attribute_index| -%>
       <%= attribute.name %>: <%= value_for(attribute) %><%= attribute_index == output_attributes.length - 1 ? '' : ','%>
 <% end -%>

data/lib/generators/rspec/system/system_generator.rb

@@ -9,7 +9,7 @@ module Rspec
       def generate_system_spec
         return unless options[:system_specs]
 
-        template template_name, File.join('spec/system', class_path, filename)
+        template template_name, target_path('system', class_path, filename)
       end
 
       def template_name

data/lib/generators/rspec/view/view_generator.rb

@@ -9,12 +9,12 @@ module Rspec
       class_option :template_engine, desc: "Template engine to generate view files"
 
       def create_view_specs
-        empty_directory File.join("spec", "views", file_path)
+        empty_directory target_path("views", file_path)
 
         actions.each do |action|
           @action = action
           template 'view_spec.rb',
-                   File.join("spec", "views", file_path, "#{@action}.html.#{options[:template_engine]}_spec.rb")
+                   target_path("views", file_path, "#{@action}.html.#{options[:template_engine]}_spec.rb")
         end
       end
     end

data/lib/generators/rspec.rb

@@ -1,8 +1,9 @@
 require 'rails/generators/named_base'
+require 'rspec/core'
 require 'rspec/rails/feature_check'
 
 # @private
-# Weirdly named generators namespace (should be `RSpec`) for compatability with
+# Weirdly named generators namespace (should be `RSpec`) for compatibility with
 # rails loading.
 module Rspec
   # @private
@@ -18,6 +19,22 @@ module Rspec
           @_rspec_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'rspec', generator_name, 'templates'))
         end
       end
+
+      # @private
+      # Load configuration from RSpec to ensure `--default-path` is set
+      def self.configuration
+        @configuration ||=
+          begin
+            configuration = RSpec.configuration
+            options = RSpec::Core::ConfigurationOptions.new({})
+            options.configure(configuration)
+            configuration
+          end
+      end
+
+      def target_path(*paths)
+        File.join(self.class.configuration.default_path, *paths)
+      end
     end
   end
 end

data/lib/rspec/rails/adapters.rb

@@ -181,5 +181,16 @@ module RSpec
     #
     # @private
     TestUnitAssertionAdapter = MinitestAssertionAdapter
+
+    # @private
+    module TaggedLoggingAdapter
+      private
+      # Vendored from activesupport/lib/active_support/testing/tagged_logging.rb
+      # This implements the tagged_logger method where it is expected, but
+      # doesn't call `name` or set it up like Rails does.
+      def tagged_logger
+        @tagged_logger ||= (defined?(Rails.logger) && Rails.logger)
+      end
+    end
   end
 end

data/lib/rspec/rails/configuration.rb

@@ -26,19 +26,19 @@ module RSpec
     #
     # @api private
     DIRECTORY_MAPPINGS = {
-      channel:    %w[spec channels],
+      channel: %w[spec channels],
       controller: %w[spec controllers],
-      generator:  %w[spec generator],
-      helper:     %w[spec helpers],
-      job:        %w[spec jobs],
-      mailer:     %w[spec mailers],
-      model:      %w[spec models],
-      request:    %w[spec (requests|integration|api)],
-      routing:    %w[spec routing],
-      view:       %w[spec views],
-      feature:    %w[spec features],
-      system:     %w[spec system],
-      mailbox:    %w[spec mailboxes]
+      generator: %w[spec generator],
+      helper: %w[spec helpers],
+      job: %w[spec jobs],
+      mailer: %w[spec mailers],
+      model: %w[spec models],
+      request: %w[spec (requests|integration|api)],
+      routing: %w[spec routing],
+      view: %w[spec views],
+      feature: %w[spec features],
+      system: %w[spec system],
+      mailbox: %w[spec mailboxes]
     }
 
     # Sets up the different example group modules for the different spec types
@@ -57,7 +57,7 @@ module RSpec
     end
 
     # @private
-    def self.initialize_configuration(config) # rubocop:disable Metrics/MethodLength,Metrics/CyclomaticComplexity
+    def self.initialize_configuration(config) # rubocop:disable Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/AbcSize,Metrics/PerceivedComplexity
       config.backtrace_exclusion_patterns << /vendor\//
       config.backtrace_exclusion_patterns << %r{lib/rspec/rails}
 
@@ -69,7 +69,13 @@ module RSpec
       config.add_setting :use_transactional_fixtures, alias_with: :use_transactional_examples
       config.add_setting :use_instantiated_fixtures
       config.add_setting :global_fixtures
-      config.add_setting :fixture_path
+
+      if ::Rails::VERSION::STRING < "7.1.0"
+        config.add_setting :fixture_path
+      else
+        config.add_setting :fixture_paths
+      end
+
       config.include RSpec::Rails::FixtureSupport, :use_fixtures
 
       # We'll need to create a deprecated module in order to properly report to
@@ -157,6 +163,29 @@ module RSpec
           filter_gems_from_backtrace "activemodel", "activerecord",
                                      "activesupport", "activejob"
         end
+
+        # @deprecated TestFixtures#fixture_path is deprecated and will be removed in Rails 7.2
+        if ::Rails::VERSION::STRING >= "7.1.0"
+          def fixture_path
+            RSpec.deprecate(
+              "config.fixture_path",
+              replacement: "config.fixture_paths",
+              message: "Rails 7.1 has deprecated the singular fixture_path in favour of an array." \
+              "You should migrate to plural:"
+            )
+            fixture_paths&.first
+          end
+
+          def fixture_path=(path)
+            RSpec.deprecate(
+              "config.fixture_path = #{path.inspect}",
+              replacement: "config.fixture_paths = [#{path.inspect}]",
+              message: "Rails 7.1 has deprecated the singular fixture_path in favour of an array." \
+              "You should migrate to plural:"
+            )
+            self.fixture_paths = Array(path)
+          end
+        end
       end
 
       add_test_type_configurations(config)

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

@@ -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/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
@@ -12,6 +15,9 @@ module RSpec
       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/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

@@ -44,33 +44,86 @@ module RSpec
         ].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`.
       def app
         ::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'
         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)
@@ -92,7 +145,7 @@ module RSpec
           self.class.before do
             # A user may have already set the driver, so only default if driver
             # is not set
-            driven_by(:selenium) unless @driver
+            driven_by(DEFAULT_DRIVER) unless @driver
           end
         end
 
@@ -108,10 +161,7 @@ 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
             myio.rewind
@@ -119,6 +169,11 @@ module RSpec
             $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/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

@@ -9,6 +9,9 @@ module RSpec
 
       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
   end

data/lib/rspec/rails/fixture_file_upload_support.rb

@@ -6,44 +6,33 @@ module RSpec
 
     private
 
-      # In Rails 6.2 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 6.2 expect to rework this to remove
+      # 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.
-      if ::Rails.version.to_f >= 6.1
-        def rails_fixture_file_wrapper
-          RailsFixtureFileWrapper.file_fixture_path = nil
-          resolved_fixture_path =
-            if respond_to?(:file_fixture_path) && !file_fixture_path.nil?
-              file_fixture_path.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
-      else
-        def rails_fixture_file_wrapper
-          RailsFixtureFileWrapper.fixture_path = nil
-          resolved_fixture_path =
-            if respond_to?(:fixture_path) && !fixture_path.nil?
-              fixture_path.to_s
-            else
-              (RSpec.configuration.fixture_path || '').to_s
-            end
-          RailsFixtureFileWrapper.fixture_path = File.join(resolved_fixture_path, '') unless resolved_fixture_path.strip.empty?
-          RailsFixtureFileWrapper.instance
-        end
+      def rails_fixture_file_wrapper
+        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)
-
-        if ::Rails.version.to_f >= 6.1
-          include ActiveSupport::Testing::FileFixtures
-        end
+        include ActiveSupport::Testing::FileFixtures
 
         class << self
-          attr_accessor :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

data/lib/rspec/rails/fixture_support.rb

@@ -10,8 +10,7 @@ module RSpec
         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.
+        # Monkey patched to avoid collisions with 'let(:name)' since 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)
@@ -21,7 +20,13 @@ module RSpec
           if RSpec.configuration.use_active_record?
             include Fixtures
 
-            self.fixture_path = RSpec.configuration.fixture_path
+            # 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.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
 
@@ -32,28 +37,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
+
+              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
 
-            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)
+                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

@@ -51,6 +51,10 @@ module RSpec
             exactly(:thrice)
           end
 
+          def description
+            "have broadcasted #{base_description}"
+          end
+
           def failure_message
             "expected to broadcast #{base_message}".tap do |msg|
               if @unmatching_msgs.any?
@@ -96,8 +100,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 +116,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
@@ -137,18 +144,21 @@ module RSpec
               end
           end
 
-          def base_message
+          def base_description
             "#{message_expectation_modifier} #{@expected_number} messages to #{stream}".tap do |msg|
               msg << " with #{data_description(@data)}" unless @data.nil?
-              msg << ", but broadcast #{@matching_msgs_count}"
             end
           end
 
+          def base_message
+            "#{base_description}, but broadcast #{@matching_msgs_count}"
+          end
+
           def data_description(data)
             if data.is_a?(RSpec::Matchers::Composable)
               data.description
             else
-              data
+              data.inspect
             end
           end
 
@@ -159,7 +169,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_cable.rb

@@ -3,6 +3,8 @@ require "rspec/rails/matchers/action_cable/have_broadcasted_to"
 module RSpec
   module Rails
     module Matchers
+      extend RSpec::Matchers::DSL
+
       # Namespace for various implementations of ActionCable features
       #
       # @api private
@@ -50,7 +52,10 @@ module RSpec
 
         ActionCable::HaveBroadcastedTo.new(target, channel: described_class)
       end
-      alias_method :broadcast_to, :have_broadcasted_to
+
+      alias_matcher :broadcast_to, :have_broadcasted_to do |desc|
+        desc.gsub("have broadcasted", "broadcast")
+      end
 
     private