rspec-rails 6.0.3 → 7.1.1

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)
@@ -23,10 +22,11 @@ module RSpec
 
             # TestFixtures#fixture_path is deprecated and will be removed in Rails 7.2
             if respond_to?(:fixture_paths=)
-              fixture_paths << RSpec.configuration.fixture_path
+              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
 
@@ -37,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 RSpec.current_scope == :before_context_hook
-                  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?
@@ -112,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
@@ -140,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
 

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
 

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

@@ -14,6 +14,7 @@ module RSpec
           def initialize
             @args = []
             @queue = nil
+            @priority = nil
             @at = nil
             @block = proc { }
             set_expected_number(:exactly, 1)
@@ -30,6 +31,11 @@ module RSpec
             self
           end
 
+          def at_priority(priority)
+            @priority = priority.to_i
+            self
+          end
+
           def at(time_or_date)
             case time_or_date
             when Time then @at = Time.at(time_or_date.to_f)
@@ -71,6 +77,8 @@ module RSpec
           end
 
           def failure_message
+            return @failure_message if defined?(@failure_message)
+
             "expected to #{self.class::FAILURE_MESSAGE_EXPECTATION_ACTION} #{base_message}".tap do |msg|
               if @unmatching_jobs.any?
                 msg << "\nQueued jobs:"
@@ -101,7 +109,7 @@ module RSpec
 
           def check(jobs)
             @matching_jobs, @unmatching_jobs = jobs.partition do |job|
-              if job_match?(job) && arguments_match?(job) && queue_match?(job) && at_match?(job)
+              if matches_constraints?(job)
                 args = deserialize_arguments(job)
                 @block.call(*args)
                 true
@@ -109,6 +117,12 @@ module RSpec
                 false
               end
             end
+
+            if (signature_mismatch = detect_args_signature_mismatch(@matching_jobs))
+              @failure_message = signature_mismatch
+              return false
+            end
+
             @matching_jobs_count = @matching_jobs.size
 
             case @expectation_type
@@ -123,6 +137,7 @@ module RSpec
               msg << " with #{@args}," if @args.any?
               msg << " on queue #{@queue}," if @queue
               msg << " at #{@at.inspect}," if @at
+              msg << " with priority #{@priority}," if @priority
               msg << " but #{self.class::MESSAGE_EXPECTATION_ACTION} #{@matching_jobs_count}"
             end
           end
@@ -132,13 +147,23 @@ module RSpec
             msg_parts << "with #{deserialize_arguments(job)}" if job[:args].any?
             msg_parts << "on queue #{job[:queue]}" if job[:queue]
             msg_parts << "at #{Time.at(job[:at])}" if job[:at]
+            msg_parts <<
+              if job[:priority]
+                "with priority #{job[:priority]}"
+              else
+                "with no priority specified"
+              end
 
             "#{job[:job].name} job".tap do |msg|
               msg << " #{msg_parts.join(', ')}" if msg_parts.any?
             end
           end
 
-          def job_match?(job)
+          def matches_constraints?(job)
+            job_matches?(job) && arguments_match?(job) && queue_match?(job) && at_match?(job) && priority_match?(job)
+          end
+
+          def job_matches?(job)
             @job ? @job == job[:job] : true
           end
 
@@ -152,12 +177,48 @@ module RSpec
             end
           end
 
+          def detect_args_signature_mismatch(jobs)
+            return if skip_signature_verification?
+
+            jobs.each do |job|
+              args = deserialize_arguments(job)
+
+              if (signature_mismatch = check_args_signature_mismatch(job.fetch(:job), :perform, args))
+                return signature_mismatch
+              end
+            end
+
+            nil
+          end
+
+          def skip_signature_verification?
+            return true unless defined?(::RSpec::Mocks) && (::RSpec::Mocks.respond_to?(:configuration))
+
+            !RSpec::Mocks.configuration.verify_partial_doubles? ||
+              RSpec::Mocks.configuration.temporarily_suppress_partial_double_verification
+          end
+
+          def check_args_signature_mismatch(job_class, job_method, args)
+            signature = Support::MethodSignature.new(job_class.public_instance_method(job_method))
+            verifier = Support::StrictSignatureVerifier.new(signature, args)
+
+            unless verifier.valid?
+              "Incorrect arguments passed to #{job_class.name}: #{verifier.error_message}"
+            end
+          end
+
           def queue_match?(job)
             return true unless @queue
 
             @queue == job[:queue]
           end
 
+          def priority_match?(job)
+            return true unless @priority
+
+            @priority == job[:priority]
+          end
+
           def at_match?(job)
             return true unless @at
             return job[:at].nil? if @at == :no_wait
@@ -384,33 +445,33 @@ module RSpec
       #
       # @example
       #     expect {
-      #       perform_jobs { HeavyLiftingJob.perform_later }
+      #       perform_enqueued_jobs { HeavyLiftingJob.perform_later }
       #     }.to have_performed_job
       #
       #     expect {
-      #       perform_jobs {
+      #       perform_enqueued_jobs {
       #         HelloJob.perform_later
       #         HeavyLiftingJob.perform_later
       #       }
       #     }.to have_performed_job(HelloJob).exactly(:once)
       #
       #     expect {
-      #       perform_jobs { 3.times { HelloJob.perform_later } }
+      #       perform_enqueued_jobs { 3.times { HelloJob.perform_later } }
       #     }.to have_performed_job(HelloJob).at_least(2).times
       #
       #     expect {
-      #       perform_jobs { HelloJob.perform_later }
+      #       perform_enqueued_jobs { HelloJob.perform_later }
       #     }.to have_performed_job(HelloJob).at_most(:twice)
       #
       #     expect {
-      #       perform_jobs {
+      #       perform_enqueued_jobs {
       #         HelloJob.perform_later
       #         HeavyLiftingJob.perform_later
       #       }
       #     }.to have_performed_job(HelloJob).and have_performed_job(HeavyLiftingJob)
       #
       #     expect {
-      #       perform_jobs {
+      #       perform_enqueued_jobs {
       #         HelloJob.set(wait_until: Date.tomorrow.noon, queue: "low").perform_later(42)
       #       }
       #     }.to have_performed_job.with(42).on_queue("low").at(Date.tomorrow.noon)

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

@@ -41,6 +41,8 @@ module RSpec
         end
 
         def failure_message
+          return @failure_message if defined?(@failure_message)
+
           "expected to enqueue #{base_message}".tap do |msg|
             msg << "\n#{unmatching_mail_jobs_message}" if unmatching_mail_jobs.any?
           end
@@ -70,7 +72,7 @@ module RSpec
           @mailer_class ? @mailer_class.name : 'ActionMailer::Base'
         end
 
-        def job_match?(job)
+        def job_matches?(job)
           legacy_mail?(job) || parameterized_mail?(job) || unified_mail?(job)
         end
 
@@ -89,6 +91,23 @@ module RSpec
           super(job)
         end
 
+        def detect_args_signature_mismatch(jobs)
+          return if @method_name.nil?
+          return if skip_signature_verification?
+
+          mailer_class = mailer_class_name.constantize
+
+          jobs.each do |job|
+            mailer_args = extract_args_without_parameterized_params(job)
+
+            if (signature_mismatch = check_args_signature_mismatch(mailer_class, @method_name, mailer_args))
+              return signature_mismatch
+            end
+          end
+
+          nil
+        end
+
         def base_mailer_args
           [mailer_class_name, @method_name.to_s, MAILER_JOB_METHOD]
         end
@@ -105,18 +124,18 @@ module RSpec
 
         def unmatching_mail_jobs
           @unmatching_jobs.select do |job|
-            job_match?(job)
+            job_matches?(job)
           end
         end
 
         def unmatching_mail_jobs_message
-          msg = "Queued deliveries:"
+          messages = ["Queued deliveries:"]
 
           unmatching_mail_jobs.each do |job|
-            msg << "\n  #{mail_job_message(job)}"
+            messages << "  #{mail_job_message(job)}"
           end
 
-          msg
+          messages.join("\n")
         end
 
         def mail_job_message(job)
@@ -157,6 +176,19 @@ module RSpec
           end
         end
 
+        def extract_args_without_parameterized_params(job)
+          args = deserialize_arguments(job)
+          mailer_args = args - base_mailer_args
+
+          if parameterized_mail?(job)
+            mailer_args = mailer_args[1..-1] # ignore parameterized params
+          elsif mailer_args.last.is_a?(Hash) && mailer_args.last.key?(:args)
+            mailer_args = args.last[:args]
+          end
+
+          mailer_args
+        end
+
         def legacy_mail?(job)
           RSpec::Rails::FeatureCheck.has_action_mailer_legacy_delivery_job? && job[:job] <= ActionMailer::DeliveryJob
         end

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

@@ -33,7 +33,7 @@ module RSpec
         # @param obj [Object] object to convert to a response
         # @return [ActionDispatch::TestResponse]
         def as_test_response(obj)
-          if ::ActionDispatch::Response === obj
+          if ::ActionDispatch::Response === obj || ::Rack::MockResponse === obj
             ::ActionDispatch::TestResponse.from_response(obj)
           elsif ::ActionDispatch::TestResponse === obj
             obj
@@ -216,11 +216,7 @@ module RSpec
           # @see Rack::Utils::SYMBOL_TO_STATUS_CODE
           # @raise [ArgumentError] if an associated code could not be found
           def set_expected_code!
-            @expected ||=
-              Rack::Utils::SYMBOL_TO_STATUS_CODE.fetch(expected_status) do
-                raise ArgumentError,
-                      "Invalid HTTP status: #{expected_status.inspect}"
-              end
+            @expected ||= Rack::Utils.status_code(expected_status)
           end
         end
 
@@ -237,7 +233,7 @@ module RSpec
         #   expect(response).to have_http_status(:redirect)
         #
         # @see RSpec::Rails::Matchers#have_http_status
-        # @see https://github.com/rails/rails/blob/6-0-stable/actionpack/lib/action_dispatch/testing/test_response.rb `ActionDispatch::TestResponse`
+        # @see https://github.com/rails/rails/blob/7-2-stable/actionpack/lib/action_dispatch/testing/test_response.rb `ActionDispatch::TestResponse`
         class GenericStatus < RSpec::Rails::Matchers::BaseMatcher
           include HaveHttpStatus
 

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

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Rails
+    module Matchers
+      # @api private
+      #
+      # Matcher class for `send_email`. Should not be instantiated directly.
+      #
+      # @see RSpec::Rails::Matchers#send_email
+      class SendEmail < RSpec::Rails::Matchers::BaseMatcher
+        # @api private
+        # Define the email attributes that should be included in the inspection output.
+        INSPECT_EMAIL_ATTRIBUTES = %i[subject from to cc bcc].freeze
+
+        def initialize(criteria)
+          @criteria = criteria
+        end
+
+        # @api private
+        def supports_value_expectations?
+          false
+        end
+
+        # @api private
+        def supports_block_expectations?
+          true
+        end
+
+        def matches?(block)
+          define_matched_emails(block)
+
+          @matched_emails.one?
+        end
+
+        # @api private
+        # @return [String]
+        def failure_message
+          result =
+            if multiple_match?
+              "More than 1 matching emails were sent."
+            else
+              "No matching emails were sent."
+            end
+          "#{result}#{sent_emails_message}"
+        end
+
+        # @api private
+        # @return [String]
+        def failure_message_when_negated
+          "Expected not to send an email but it was sent."
+        end
+
+        private
+
+        def diffable?
+          true
+        end
+
+        def deliveries
+          ActionMailer::Base.deliveries
+        end
+
+        def define_matched_emails(block)
+          before = deliveries.dup
+
+          block.call
+
+          after = deliveries
+
+          @diff = after - before
+          @matched_emails = @diff.select(&method(:matched_email?))
+        end
+
+        def matched_email?(email)
+          @criteria.all? do |attr, value|
+            expected =
+              case attr
+              when :to, :from, :cc, :bcc then Array(value)
+              else
+                value
+              end
+
+            values_match?(expected, email.public_send(attr))
+          end
+        end
+
+        def multiple_match?
+          @matched_emails.many?
+        end
+
+        def sent_emails_message
+          if @diff.empty?
+            "\n\nThere were no any emails sent inside the expectation block."
+          else
+            sent_emails =
+              @diff.map do |email|
+                inspected = INSPECT_EMAIL_ATTRIBUTES.map { |attr| "#{attr}: #{email.public_send(attr)}" }.join(", ")
+                "- #{inspected}"
+              end.join("\n")
+            "\n\nThe following emails were sent:\n#{sent_emails}"
+          end
+        end
+      end
+
+      # @api public
+      # Check email sending with specific parameters.
+      #
+      # @example Positive expectation
+      #   expect { action }.to send_email
+      #
+      # @example Negative expectations
+      #   expect { action }.not_to send_email
+      #
+      # @example More precise expectation with attributes to match
+      #   expect { action }.to send_email(to: 'test@example.com', subject: 'Confirm email')
+      def send_email(criteria = {})
+        SendEmail.new(criteria)
+      end
+    end
+  end
+end

data/lib/rspec/rails/matchers.rb

@@ -20,6 +20,7 @@ require 'rspec/rails/matchers/be_a_new'
 require 'rspec/rails/matchers/relation_match_array'
 require 'rspec/rails/matchers/be_valid'
 require 'rspec/rails/matchers/have_http_status'
+require 'rspec/rails/matchers/send_email'
 
 if RSpec::Rails::FeatureCheck.has_active_job?
   require 'rspec/rails/matchers/active_job'

data/lib/rspec/rails/tasks/rspec.rake

@@ -5,7 +5,9 @@ end
 
 task default: :spec
 
-task stats: "spec:statsetup"
+if ::Rails::VERSION::STRING < "8.0.0"
+  task stats: "spec:statsetup"
+end
 
 desc "Run all specs in spec directory (excluding plugin specs)"
 RSpec::Core::RakeTask.new(spec: "spec:prepare")

data/lib/rspec/rails/version.rb

@@ -3,7 +3,7 @@ module RSpec
     # Version information for RSpec Rails.
     module Version
       # Current version of RSpec Rails, in semantic versioning format.
-      STRING = '6.0.3'
+      STRING = '7.1.1'
     end
   end
 end

data/lib/rspec-rails.rb

@@ -9,6 +9,23 @@ module RSpec
       # As of Rails 5.1.0 you can register directories to work with `rake notes`
       require 'rails/source_annotation_extractor'
       ::Rails::SourceAnnotationExtractor::Annotation.register_directories("spec")
+
+      # As of Rails 8.0.0 you can register directories to work with `rails stats`
+      if ::Rails::VERSION::STRING >= "8.0.0"
+        require 'rails/code_statistics'
+
+        dirs = Dir['./spec/**/*_spec.rb']
+          .map { |f| f.sub(/^\.\/(spec\/\w+)\/.*/, '\\1') }
+          .uniq
+          .select { |f| File.directory?(f) }
+
+        Hash[dirs.map { |d| [d.split('/').last, d] }].each do |type, dir|
+          name = type.singularize.capitalize
+
+          ::Rails::CodeStatistics.register_directory "#{name} specs", dir, test_directory: true
+        end
+      end
+
       generators = config.app_generators
       generators.integration_tool :rspec
       generators.test_framework :rspec
@@ -47,10 +64,18 @@ module RSpec
         end
       end
 
-      def config_default_preview_path(options)
-        return unless options.preview_path.blank?
+      if ::Rails::VERSION::STRING >= "7.1.0"
+        def config_default_preview_path(options)
+          return unless options.preview_paths.empty?
 
-        options.preview_path = "#{::Rails.root}/spec/mailers/previews"
+          options.preview_paths << "#{::Rails.root}/spec/mailers/previews"
+        end
+      else
+        def config_default_preview_path(options)
+          return unless options.preview_path.blank?
+
+          options.preview_path = "#{::Rails.root}/spec/mailers/previews"
+        end
       end
 
       def supports_action_mailer_previews?(config)