rspec-rails 6.0.4 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecae469592630a6ecaaa39d6f2be0e2616cb2079c044bc390e548956b823d6bc
-  data.tar.gz: f24952e5edf9bf57f6e8c94fced8c7b2d38938b4a1b250fa83043bf316c8de9c
+  metadata.gz: 4670e0b41ea2e22cb7a3fd5d28a421fe82fed0c591dbb245e011b497a1ac81f3
+  data.tar.gz: a3cf937f37a03c114b8397216d034eae1645ea8575906f6f5a444973a1626419
 SHA512:
-  metadata.gz: e50c692c774cd0a874bedd667e7c0e3997236d43a74750efb6cc215a3019ce9a4babc5437a79825c43c885b70f1c3da9c90599ce1b0bf123ba1538e77cc7884e
-  data.tar.gz: a148f034a8667af85e68c478849bd9ea33443567dec01335d0a83ad9fd44d63d7dd0780694ebaee55f2278add2fefa61032674e38dec865cf01ee1205e13d1e9
+  metadata.gz: dd476082c87a5735996ce66d0efcf7bb1f5860b81118e05b71388872b50a11bb28d6fb981a23aed71597c45585244aa4c5d53a45c6d8500a751e36fa8d4f3039
+  data.tar.gz: b996549661e01669b60767064e24b7dd7836ce79db985048856d7c98c9ed5892d04551050dbaa3727c2a358026990611559144c824f198a85b7c78c3651e3401

data/Changelog.md

@@ -1,3 +1,25 @@
+### Development
+[Full Changelog](https://github.com/rspec/rspec-rails/compare/v6.0.4...main)
+
+### 6.1.0 / 2023-11-21
+[Full Changelog](https://github.com/rspec/rspec-rails/compare/v6.0.4...v6.1.0)
+
+Enhancements:
+
+* Support for Rails 7.1
+* Minor tweak to generated `rails_helper.rb` to use `Rails.root.join`.
+  (@masato-bkn, Ryo Nakamura, #2640, #2678)
+* Add `RSpec::Rails::Configuration.fixture_paths` configuration to support
+  the matching change to `ActiveRecord::TestFixtures`, previous singular
+  form is deprecated and will be removed in Rails 7.2. (Juan Gueçaimburu, #2673)
+* Add `send_email` matcher to match emails rather than specific jobs.
+  (Andrei Kaleshka, #2670)
+* When using `render` in view specs, `:locals` will now be merged into the
+  default implicit template, allowing `render locals: {...}` style calls.
+  (Jon Rowe, #2686)
+* Add support for `Rails.config.action_mailer.preview_paths` on Rails 7.1/
+  (Jon Rowe, #2706)
+
 ### 6.0.4 / 2023-11-21
 [Full Changelog](https://github.com/rspec/rspec-rails/compare/v6.0.3...v6.0.4)
 

data/README.md

@@ -25,13 +25,14 @@ According to [RSpec Rails new versioning strategy][] use:
 [`rspec-rails` 3.x]: https://github.com/rspec/rspec-rails/tree/3-9-maintenance
 [`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-0-maintenance
+[`rspec-rails` 6.x]: https://github.com/rspec/rspec-rails/tree/6-1-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 current development build.
-See the [`6-0-maintenance` branch on Github](https://github.com/rspec/rspec-rails/tree/6-0-maintenance) if you want or require the latest stable release.
+**IMPORTANT** This README / branch refers to the 6.1.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.
 
 1. Add `rspec-rails` to **both** the `:development` and `:test` groups
    of your app’s `Gemfile`:
@@ -39,7 +40,7 @@ See the [`6-0-maintenance` branch on Github](https://github.com/rspec/rspec-rail
    ```ruby
    # Run against this stable release
    group :development, :test do
-     gem 'rspec-rails', '~> 6.0.0'
+     gem 'rspec-rails', '~> 6.1.0'
    end
 
    # Or, run against the main branch

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

@@ -20,7 +20,7 @@ require 'rspec/rails'
 # directory. Alternatively, in the individual `*_spec.rb` files, manually
 # require only the support files necessary.
 #
-# Dir[Rails.root.join('spec', 'support', '**', '*.rb')].sort.each { |f| require f }
+# Rails.root.glob('spec/support/**/*.rb').sort.each { |f| require f }
 
 <% if RSpec::Rails::FeatureCheck.has_active_record_migration? -%>
 # Checks for pending migrations and applies them before tests are run.
@@ -34,7 +34,13 @@ end
 RSpec.configure do |config|
 <% if RSpec::Rails::FeatureCheck.has_active_record? -%>
   # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
-  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+<% if ::Rails::VERSION::STRING < "7.1.0" -%>
+  config.fixture_path = Rails.root.join('spec/fixtures')
+<% else -%>
+  config.fixture_paths = [
+    Rails.root.join('spec/fixtures')
+  ]
+<% end -%>
 
   # If you're not using ActiveRecord, or you'd prefer not to run each of your
   # examples within a transaction, remove the following line or assign false
@@ -52,7 +58,7 @@ RSpec.configure do |config|
   # note if you'd prefer not to run each example within a transaction, you
   # should set use_transactional_fixtures to false.
   #
-  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  # config.fixture_path = Rails.root.join('spec/fixtures')
   # config.use_transactional_fixtures = true
 
 <% end -%>

data/lib/rspec/rails/configuration.rb

@@ -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,27 @@ 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"
+            )
+            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"
+            )
+            self.fixture_paths = Array(path)
+          end
+        end
       end
 
       add_test_type_configurations(config)

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
 

data/lib/rspec/rails/fixture_file_upload_support.rb

@@ -14,6 +14,8 @@ module RSpec
         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
@@ -26,7 +28,11 @@ module RSpec
         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

@@ -23,10 +23,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
 

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/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.4'
+      STRING = '6.1.0'
     end
   end
 end

data/lib/rspec-rails.rb

@@ -47,10 +47,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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails
 version: !ruby/object:Gem::Version
-  version: 6.0.4
+  version: 6.1.0
 platform: ruby
 authors:
 - David Chelimsky
@@ -284,6 +284,7 @@ files:
 - lib/rspec/rails/matchers/redirect_to.rb
 - lib/rspec/rails/matchers/relation_match_array.rb
 - lib/rspec/rails/matchers/routing_matchers.rb
+- lib/rspec/rails/matchers/send_email.rb
 - lib/rspec/rails/tasks/rspec.rake
 - lib/rspec/rails/vendor/capybara.rb
 - lib/rspec/rails/version.rb
@@ -296,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.0.4/Changelog.md
+  changelog_uri: https://github.com/rspec/rspec-rails/blob/v6.1.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