rspec-rails 6.1.5 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 794b82d1aea01113c12d4d6d6baab45e129466eb3da90a6f237f97a600489c44
-  data.tar.gz: 492866fad93a1945fdb95b6ed10b0ec1739575d8769f83845f7572b450042b2f
+  metadata.gz: e12619053ed39f2f0fed4bc0aed2b2e552e400315663632d97cf9a82e2eaa5d3
+  data.tar.gz: 7bde5b94d9f990a0d9d08143529ce3e25b9df1df2cf62c216515c0cc6e96cd4c
 SHA512:
-  metadata.gz: da28fe40ba3272d1a91e9c4be4d92a3aa88fc041ce69f904bc4e121b82e21affc6946a29df87be201bdda938a44f2057b3ac8c79dcfa20ada543bd604cbbeea7
-  data.tar.gz: 69ac337cdc6b192929d1812e69ab148154484500bf655a47bd8575d664ace8101b2ec9b8d054133f1117371099402f4e07f4bc02066666a57148a0f658a67ad6
+  metadata.gz: fa5533f32e4ffaf30b13d83677aff9170bf57c42a2c6ec9a591de3f422f73f719a6b575fb14efe8e54f7b8fbc389aa7c7e0f39710017dc8b02834f8dbb6b0aa3
+  data.tar.gz: '094c02d867dba7258ea54da266403929508f2601c0ba1e8a8c579e01c6a2b200aaa688b5a8fed58145c2bf6cd53ed4799fecba36dc9acdb23e06d75eea5b2323'

data/Changelog.md

@@ -1,5 +1,17 @@
 ### Development
-[Full Changelog](https://github.com/rspec/rspec-rails/compare/v6.1.5...6-1-maintenance)
+[Full Changelog](https://github.com/rspec/rspec-rails/compare/v7.0.0...7-0-maintenance)
+
+### 7.0.0 / 2024-09-02
+[Full Changelog](https://github.com/rspec/rspec-rails/compare/v6.1.5...v7.0.0)
+
+Enhancements:
+
+* Change default driver for system specs on Rails 7.2 to match its default.
+  (Steve Polito, #2746)
+* Verify ActiveJob arguments by comparing to the method signature. (Oli Peate, #2745)
+* Add suggestion to rails_helper.rb to skip when not in test most. (Glauco Custódio, #2751)
+* Add `at_priority` qualifier to `have_enqueued_job` set of matchers. (mbajur, #2759)
+* Add spec directories to `rails stats` on Rails main / 8.0.0. (Petrik de Heus, #2781)
 
 ### 6.1.5 / 2024-09-02
 [Full Changelog](https://github.com/rspec/rspec-rails/compare/v6.1.4...v6.1.5)

data/README.md

@@ -9,7 +9,8 @@ detailed explanations of how the application is supposed to behave,
 expressed in plain English.
 
 According to [RSpec Rails new versioning strategy][] use:
-* **[`rspec-rails` 6.x][]** for Rails 6.1 or 7.x.
+* **[`rspec-rails` 7.x][]** for Rails 7.x.
+* **[`rspec-rails` 6.x][]** for Rails 6.1.
 * **[`rspec-rails` 5.x][]** for Rails 5.2 or 6.x.
 * **[`rspec-rails` 4.x][]** for Rails from 5.x or 6.x.
 * **[`rspec-rails` 3.x][]** for Rails earlier than 5.0.
@@ -26,11 +27,12 @@ According to [RSpec Rails new versioning strategy][] use:
 [`rspec-rails` 4.x]: https://github.com/rspec/rspec-rails/tree/4-1-maintenance
 [`rspec-rails` 5.x]: https://github.com/rspec/rspec-rails/tree/5-1-maintenance
 [`rspec-rails` 6.x]: https://github.com/rspec/rspec-rails/tree/6-1-maintenance
+[`rspec-rails` 7.x]: https://github.com/rspec/rspec-rails/tree/7-0-maintenance
 [RSpec Rails new versioning strategy]: https://github.com/rspec/rspec-rails/blob/main/rfcs/versioning-strategy.md
 
 ## Installation
 
-**IMPORTANT** This README / branch refers to the 6.1.x stable release series, only bugfixes from this series will
+**IMPORTANT** This README / branch refers to the 7.0.x stable release series, only bugfixes from this series will
 be added here. See the [`main` branch on Github](https://github.com/rspec/rspec-rails/tree/main) if you want or
 require the latest unstable features.
 
@@ -40,7 +42,7 @@ require the latest unstable features.
    ```ruby
    # Run against this stable release
    group :development, :test do
-     gem 'rspec-rails', '~> 6.1.0'
+     gem 'rspec-rails', '~> 7.0.0'
    end
 
    # Or, run against the main branch
@@ -87,7 +89,7 @@ read the [`rspec-rails` upgrade notes][] to find out what to watch out for.
 
 Be sure to check the general [RSpec upgrade notes][] as well.
 
-[`rspec-rails` upgrade notes]: https://rspec.info/features/6-0/rspec-rails/upgrade
+[`rspec-rails` upgrade notes]: https://rspec.info/features/7-0/rspec-rails/upgrade
 [RSpec upgrade notes]: https://rspec.info/upgrading-from-rspec-2/
 
 ## Usage
@@ -209,22 +211,22 @@ to test the various parts of a Rails system:
 Follow the links above for examples of how each matcher is used.
 
 [the matchers that come standard in RSpec]: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers
-[`be_a_new`]: https://rspec.info/features/6-0/rspec-rails/matchers/new-record-matcher
-[`render_template`]: https://rspec.info/features/6-0/rspec-rails/matchers/render-template-matcher
-[`redirect_to`]: https://rspec.info/features/6-0/rspec-rails/matchers/redirect-to-matcher
-[`route_to`]: https://rspec.info/features/6-0/rspec-rails/routing-specs/route-to-matcher
-[`be_routable`]: https://rspec.info/features/6-0/rspec-rails/routing-specs/be-routable-matcher
-[`have_http_status`]: https://rspec.info/features/6-0/rspec-rails/matchers/have-http-status-matcher
-[`match_array`]: https://rspec.info/features/6-0/rspec-rails/matchers/relation-match-array
-[`have_been_enqueued`]: https://rspec.info/features/6-0/rspec-rails/matchers/have-been-enqueued-matcher
-[`have_enqueued_job`]: https://rspec.info/features/6-0/rspec-rails/matchers/have-enqueued-job-matcher
+[`be_a_new`]: https://rspec.info/features/7-0/rspec-rails/matchers/new-record-matcher
+[`render_template`]: https://rspec.info/features/7-0/rspec-rails/matchers/render-template-matcher
+[`redirect_to`]: https://rspec.info/features/7-0/rspec-rails/matchers/redirect-to-matcher
+[`route_to`]: https://rspec.info/features/7-0/rspec-rails/routing-specs/route-to-matcher
+[`be_routable`]: https://rspec.info/features/7-0/rspec-rails/routing-specs/be-routable-matcher
+[`have_http_status`]: https://rspec.info/features/7-0/rspec-rails/matchers/have-http-status-matcher
+[`match_array`]: https://rspec.info/features/7-0/rspec-rails/matchers/relation-match-array
+[`have_been_enqueued`]: https://rspec.info/features/7-0/rspec-rails/matchers/have-been-enqueued-matcher
+[`have_enqueued_job`]: https://rspec.info/features/7-0/rspec-rails/matchers/have-enqueued-job-matcher
 
 ### What else does RSpec Rails add?
 
 For a comprehensive look at RSpec Rails’ features,
 read the [official Cucumber documentation][].
 
-[official Cucumber documentation]: https://rspec.info/features/6-0/rspec-rails
+[official Cucumber documentation]: https://rspec.info/features/7-0/rspec-rails
 
 ## What tests should I write?
 
@@ -269,20 +271,20 @@ RSpec.describe User, type: :model do
 ...
 ```
 
-[request]: https://rspec.info/features/6-0/rspec-rails/request-specs/request-spec
-[feature]: https://rspec.info/features/6-0/rspec-rails/feature-specs/feature-spec
-[system]: https://rspec.info/features/6-0/rspec-rails/system-specs/system-specs
-[model]: https://rspec.info/features/6-0/rspec-rails/model-specs
-[controller]: https://rspec.info/features/6-0/rspec-rails/controller-specs
-[mailer]: https://rspec.info/features/6-0/rspec-rails/mailer-specs
-[job]: https://rspec.info/features/6-0/rspec-rails/job-specs/job-spec
-[view]: https://rspec.info/features/6-0/rspec-rails/view-specs/view-spec
-[routing]: https://rspec.info/features/6-0/rspec-rails/routing-specs
-[helper]: https://rspec.info/features/6-0/rspec-rails/helper-specs/helper-spec
+[request]: https://rspec.info/features/7-0/rspec-rails/request-specs/request-spec
+[feature]: https://rspec.info/features/7-0/rspec-rails/feature-specs/feature-spec
+[system]: https://rspec.info/features/7-0/rspec-rails/system-specs/system-specs
+[model]: https://rspec.info/features/7-0/rspec-rails/model-specs
+[controller]: https://rspec.info/features/7-0/rspec-rails/controller-specs
+[mailer]: https://rspec.info/features/7-0/rspec-rails/mailer-specs
+[job]: https://rspec.info/features/7-0/rspec-rails/job-specs/job-spec
+[view]: https://rspec.info/features/7-0/rspec-rails/view-specs/view-spec
+[routing]: https://rspec.info/features/7-0/rspec-rails/routing-specs
+[helper]: https://rspec.info/features/7-0/rspec-rails/helper-specs/helper-spec
 [`ActionDispatch::IntegrationTest`]: https://api.rubyonrails.org/classes/ActionDispatch/IntegrationTest.html
 [`ActionDispatch::SystemTestCase`]: https://api.rubyonrails.org/classes/ActionDispatch/SystemTestCase.html
 [`ActionController::TestCase`]: https://api.rubyonrails.org/classes/ActionController/TestCase.html
-[in the appropriate folder]: https://rspec.info/features/6-0/rspec-rails/directory-structure
+[in the appropriate folder]: https://rspec.info/features/7-0/rspec-rails/directory-structure
 
 ### System specs, feature specs, request specs–what’s the difference?
 

data/lib/generators/rspec/install/templates/spec/rails_helper.rb

@@ -4,6 +4,11 @@ ENV['RAILS_ENV'] ||= 'test'
 require_relative '../config/environment'
 # Prevent database truncation if the environment is production
 abort("The Rails environment is running in production mode!") if Rails.env.production?
+<% if RSpec::Rails::FeatureCheck.has_active_record_migration? -%>
+# Uncomment the line below in case you have `--require rails_helper` in the `.rspec` file
+# that will avoid rails generators crashing because migrations haven't been run yet
+# return unless Rails.env.test?
+<% end -%>
 require 'rspec/rails'
 # Add additional requires below this line. Rails is not loaded until this point!
 
@@ -74,7 +79,7 @@ RSpec.configure do |config|
   #     end
   #
   # The different available types are documented in the features, such as in
-  # https://rspec.info/features/6-0/rspec-rails
+  # https://rspec.info/features/7-0/rspec-rails
   config.infer_spec_type_from_file_location!
 
   # Filter lines from Rails gems in backtraces.

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

@@ -95,6 +95,14 @@ 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
@@ -137,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
 

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)

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,39 @@ module RSpec
             end
           end
 
+          def detect_args_signature_mismatch(jobs)
+            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 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

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
@@ -89,6 +91,22 @@ module RSpec
           super(job)
         end
 
+        def detect_args_signature_mismatch(jobs)
+          return if @method_name.nil?
+
+          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
@@ -157,6 +175,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

@@ -233,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/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.1.5'
+      STRING = '7.0.0'
     end
   end
 end

data/lib/rspec-rails.rb

@@ -10,6 +10,23 @@ module RSpec
       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
+          ::Rails::CodeStatistics::TEST_TYPES << "#{name} specs"
+        end
+      end
+
       generators = config.app_generators
       generators.integration_tool :rspec
       generators.test_framework :rspec

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails
 version: !ruby/object:Gem::Version
-  version: 6.1.5
+  version: 7.0.0
 platform: ruby
 authors:
 - David Chelimsky
@@ -52,42 +52,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
@@ -297,7 +297,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rspec/rspec-rails/issues
-  changelog_uri: https://github.com/rspec/rspec-rails/blob/v6.1.5/Changelog.md
+  changelog_uri: https://github.com/rspec/rspec-rails/blob/v7.0.0/Changelog.md
   documentation_uri: https://rspec.info/documentation/
   mailing_list_uri: https://groups.google.com/forum/#!forum/rspec
   source_code_uri: https://github.com/rspec/rspec-rails
@@ -310,7 +310,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="