rspec-rails 3.0.2 → 7.1.1

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

@@ -1,41 +1,64 @@
-module RSpec::Rails::Matchers
-  # Matcher for template rendering.
-  module RenderTemplate
-    # @private
-    class RenderTemplateMatcher < RSpec::Matchers::BuiltIn::BaseMatcher
+module RSpec
+  module Rails
+    module Matchers
+      # Matcher for template rendering.
+      module RenderTemplate
+        # @private
+        class RenderTemplateMatcher < RSpec::Rails::Matchers::BaseMatcher
+          def initialize(scope, expected, message = nil)
+            @expected = Symbol === expected ? expected.to_s : expected
+            @message = message
+            @scope = scope
+            @redirect_is = nil
+          end
 
-      def initialize(scope, expected, message=nil)
-        @expected = Symbol === expected ? expected.to_s : expected
-        @message = message
-        @scope = scope
-      end
+          # @api private
+          def matches?(*)
+            match_check = match_unless_raises ActiveSupport::TestCase::Assertion do
+              @scope.assert_template expected, @message
+            end
+            check_redirect unless match_check
+            match_check
+          end
+
+          # Uses normalize_argument_to_redirection to find and format
+          # the redirect location. normalize_argument_to_redirection is private
+          # in ActionDispatch::Assertions::ResponseAssertions so we call it
+          # here using #send. This will keep the error message format consistent
+          # @api private
+          def check_redirect
+            response = @scope.response
+            return unless response.respond_to?(:redirect?) && response.redirect?
+
+            @redirect_is = @scope.send(:normalize_argument_to_redirection, response.location)
+          end
 
-      # @api private
-      def matches?(*)
-        match_unless_raises ActiveSupport::TestCase::Assertion do
-          @scope.assert_template expected, @message
+          # @api private
+          def failure_message
+            if @redirect_is
+              rescued_exception.message[/(.*?)( but|$)/, 1] +
+                " but was a redirect to <#{@redirect_is}>"
+            else
+              rescued_exception.message
+            end
+          end
+
+          # @api private
+          def failure_message_when_negated
+            "expected not to render #{expected.inspect}, but did"
+          end
         end
-      end
 
-      # @api private
-      def failure_message
-        rescued_exception.message
-      end
+        # Delegates to `assert_template`.
+        #
+        # @example
+        #     expect(response).to have_rendered("new")
+        def have_rendered(options, message = nil)
+          RenderTemplateMatcher.new(self, options, message)
+        end
 
-      # @api private
-      def failure_message_when_negated
-        "expected not to render #{expected.inspect}, but did"
+        alias_method :render_template, :have_rendered
       end
     end
-
-    # Delegates to `assert_template`.
-    #
-    # @example
-    #     expect(response).to have_rendered("new")
-    def have_rendered(options, message=nil)
-      RenderTemplateMatcher.new(self, options, message)
-    end
-
-    alias_method :render_template, :have_rendered
   end
 end

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

@@ -1,35 +1,38 @@
-module RSpec::Rails::Matchers
-  # Matcher for redirects.
-  module RedirectTo
-    # @private
-    class RedirectTo < RSpec::Matchers::BuiltIn::BaseMatcher
+module RSpec
+  module Rails
+    module Matchers
+      # Matcher for redirects.
+      module RedirectTo
+        # @private
+        class RedirectTo < RSpec::Rails::Matchers::BaseMatcher
+          def initialize(scope, expected)
+            @expected = expected
+            @scope = scope
+          end
 
-      def initialize(scope, expected)
-        @expected = expected
-        @scope = scope
-      end
+          def matches?(_)
+            match_unless_raises ActiveSupport::TestCase::Assertion do
+              @scope.assert_redirected_to(@expected)
+            end
+          end
 
-      def matches?(_)
-        match_unless_raises ActiveSupport::TestCase::Assertion do
-          @scope.assert_redirected_to(@expected)
-        end
-      end
+          def failure_message
+            rescued_exception.message
+          end
 
-      def failure_message
-        rescued_exception.message
-      end
+          def failure_message_when_negated
+            "expected not to redirect to #{@expected.inspect}, but did"
+          end
+        end
 
-      def failure_message_when_negated
-        "expected not to redirect to #{@expected.inspect}, but did"
+        # Delegates to `assert_redirected_to`.
+        #
+        # @example
+        #     expect(response).to redirect_to(:action => "new")
+        def redirect_to(target)
+          RedirectTo.new(self, target)
+        end
       end
     end
-
-    # Delegates to `assert_redirected_to`.
-    #
-    # @example
-    #     expect(response).to redirect_to(:action => "new")
-    def redirect_to(target)
-      RedirectTo.new(self, target)
-    end
   end
 end

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

@@ -1,3 +1,3 @@
-if defined?(ActiveRecord::Relation)
+if defined?(ActiveRecord::Relation) && defined?(RSpec::Matchers::BuiltIn::OperatorMatcher) # RSpec 4 removed OperatorMatcher
   RSpec::Matchers::BuiltIn::OperatorMatcher.register(ActiveRecord::Relation, '=~', RSpec::Matchers::BuiltIn::ContainExactly)
 end

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

@@ -1,117 +1,123 @@
-module RSpec::Rails::Matchers
-  # Matchers to help with specs for routing code.
-  module RoutingMatchers
-    extend RSpec::Matchers::DSL
+module RSpec
+  module Rails
+    module Matchers
+      # Matchers to help with specs for routing code.
+      module RoutingMatchers
+        extend RSpec::Matchers::DSL
 
-    # @private
-    class RouteToMatcher < RSpec::Matchers::BuiltIn::BaseMatcher
+        # @private
+        class RouteToMatcher < RSpec::Rails::Matchers::BaseMatcher
+          def initialize(scope, *expected)
+            @scope = scope
+            @expected = expected[1] || {}
+            if Hash === expected[0]
+              @expected.merge!(expected[0])
+            else
+              controller, action = expected[0].split('#')
+              @expected.merge!(controller: controller, action: action)
+            end
+          end
 
-      def initialize(scope, *expected)
-        @scope = scope
-        @expected = expected[1] || {}
-        if Hash === expected[0]
-          @expected.merge!(expected[0])
-        else
-          controller, action = expected[0].split('#')
-          @expected.merge!(:controller => controller, :action => action)
-        end
-      end
+          def matches?(verb_to_path_map)
+            @actual = verb_to_path_map
+            # assert_recognizes does not consider ActionController::RoutingError an
+            # assertion failure, so we have to capture that and Assertion here.
+            match_unless_raises ActiveSupport::TestCase::Assertion, ActionController::RoutingError do
+              path, query = *verb_to_path_map.values.first.split('?')
+              @scope.assert_recognizes(
+                @expected,
+                { method: verb_to_path_map.keys.first, path: path },
+                Rack::Utils.parse_nested_query(query)
+              )
+            end
+          end
 
-      def matches?(verb_to_path_map)
-        @actual = @verb_to_path_map = verb_to_path_map
-        # assert_recognizes does not consider ActionController::RoutingError an
-        # assertion failure, so we have to capture that and Assertion here.
-        match_unless_raises ActiveSupport::TestCase::Assertion, ActionController::RoutingError do
-          path, query = *verb_to_path_map.values.first.split('?')
-          @scope.assert_recognizes(
-            @expected,
-            {:method => verb_to_path_map.keys.first, :path => path},
-            Rack::Utils::parse_nested_query(query)
-          )
-        end
-      end
+          def failure_message
+            rescued_exception.message
+          end
 
-      def failure_message
-        rescued_exception.message
-      end
+          def failure_message_when_negated
+            "expected #{@actual.inspect} not to route to #{@expected.inspect}"
+          end
 
-      def failure_message_when_negated
-        "expected #{@actual.inspect} not to route to #{@expected.inspect}"
-      end
-
-      def description
-        "route #{@actual.inspect} to #{@expected.inspect}"
-      end
-    end
+          def description
+            "route #{@actual.inspect} to #{@expected.inspect}"
+          end
+        end
 
-    # Delegates to `assert_recognizes`. Supports short-hand controller/action
-    # declarations (e.g. `"controller#action"`).
-    #
-    # @example
-    #
-    #     expect(:get => "/things/special").to route_to(
-    #       :controller => "things",
-    #       :action     => "special"
-    #     )
-    #
-    #     expect(:get => "/things/special").to route_to("things#special")
-    #
-    # @see http://api.rubyonrails.org/classes/ActionDispatch/Assertions/RoutingAssertions.html#method-i-assert_recognizes
-    def route_to(*expected)
-      RouteToMatcher.new(self, *expected)
-    end
+        # Delegates to `assert_recognizes`. Supports short-hand controller/action
+        # declarations (e.g. `"controller#action"`).
+        #
+        # @example
+        #
+        #     expect(get: "/things/special").to route_to(
+        #       controller: "things",
+        #       action:     "special"
+        #     )
+        #
+        #     expect(get: "/things/special").to route_to("things#special")
+        #
+        # @see https://api.rubyonrails.org/classes/ActionDispatch/Assertions/RoutingAssertions.html#method-i-assert_recognizes
+        def route_to(*expected)
+          RouteToMatcher.new(self, *expected)
+        end
 
-    # @private
-    class BeRoutableMatcher < RSpec::Matchers::BuiltIn::BaseMatcher
+        # @private
+        class BeRoutableMatcher < RSpec::Rails::Matchers::BaseMatcher
+          def initialize(scope)
+            @scope = scope
+          end
 
-      def initialize(scope)
-        @scope = scope
-      end
+          def matches?(path)
+            @actual = path
+            match_unless_raises ActionController::RoutingError do
+              @routing_options = @scope.routes.recognize_path(
+                path.values.first, method: path.keys.first
+              )
+            end
+          end
 
-      def matches?(path)
-        @actual = path
-        match_unless_raises ActionController::RoutingError do
-          @routing_options = @scope.routes.recognize_path(
-            path.values.first, :method => path.keys.first
-          )
-        end
-      end
+          def failure_message
+            "expected #{@actual.inspect} to be routable"
+          end
 
-      def failure_message
-        "expected #{@actual.inspect} to be routable"
-      end
+          def failure_message_when_negated
+            "expected #{@actual.inspect} not to be routable, but it routes to #{@routing_options.inspect}"
+          end
 
-      def failure_message_when_negated
-        "expected #{@actual.inspect} not to be routable, but it routes to #{@routing_options.inspect}"
-      end
-    end
+          def description
+            "be routable"
+          end
+        end
 
-    # Passes if the route expression is recognized by the Rails router based on
-    # the declarations in `config/routes.rb`. Delegates to
-    # `RouteSet#recognize_path`.
-    #
-    # @example You can use route helpers provided by rspec-rails.
-    #     expect(:get  => "/a/path").to be_routable
-    #     expect(:post => "/another/path").to be_routable
-    #     expect(:put  => "/yet/another/path").to be_routable
-    def be_routable
-      BeRoutableMatcher.new(self)
-    end
+        # Passes if the route expression is recognized by the Rails router based on
+        # the declarations in `config/routes.rb`. Delegates to
+        # `RouteSet#recognize_path`.
+        #
+        # @example You can use route helpers provided by rspec-rails.
+        #     expect(get:  "/a/path").to be_routable
+        #     expect(post: "/another/path").to be_routable
+        #     expect(put:  "/yet/another/path").to be_routable
+        def be_routable
+          BeRoutableMatcher.new(self)
+        end
 
-    # Helpers for matching different route types.
-    module RouteHelpers
-      # @!method get
-      # @!method post
-      # @!method put
-      # @!method patch
-      # @!method delete
-      # @!method options
-      # @!method head
-      #
-      # Shorthand method for matching this type of route.
-      %w(get post put patch delete options head).each do |method|
-        define_method method do |path|
-          { method.to_sym => path }
+        # Helpers for matching different route types.
+        module RouteHelpers
+          # @!method get
+          # @!method post
+          # @!method put
+          # @!method patch
+          # @!method delete
+          # @!method options
+          # @!method head
+          #
+          # Shorthand method for matching this type of route.
+          %w[get post put patch delete options head].each do |method|
+            define_method method do |path|
+              { method.to_sym => path }
+            end
+          end
         end
       end
     end

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

@@ -1,22 +1,17 @@
 require 'rspec/core/warnings'
 require 'rspec/expectations'
+require 'rspec/rails/feature_check'
 
-module RSpec::Rails
-  module Matchers
-  end
-end
-
-begin
-  require 'test/unit/assertionfailederror'
-rescue LoadError
-  module Test
-    module Unit
-      class AssertionFailedError < StandardError
-      end
+module RSpec
+  module Rails
+    # @api public
+    # Container module for Rails specific matchers.
+    module Matchers
     end
   end
 end
 
+require 'rspec/rails/matchers/base_matcher'
 require 'rspec/rails/matchers/have_rendered'
 require 'rspec/rails/matchers/redirect_to'
 require 'rspec/rails/matchers/routing_matchers'
@@ -25,3 +20,17 @@ 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'
+  require 'rspec/rails/matchers/have_enqueued_mail'
+end
+
+if RSpec::Rails::FeatureCheck.has_action_cable_testing?
+  require 'rspec/rails/matchers/action_cable'
+end
+
+if RSpec::Rails::FeatureCheck.has_action_mailbox?
+  require 'rspec/rails/matchers/action_mailbox'
+end

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

@@ -3,19 +3,21 @@ if default = Rake.application.instance_variable_get('@tasks')['default']
   default.prerequisites.delete('test')
 end
 
-task :default => :spec
+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")
+RSpec::Core::RakeTask.new(spec: "spec:prepare")
 
 namespace :spec do
   types = begin
-            dirs = Dir['./spec/**/*_spec.rb'].
-              map { |f| f.sub(/^\.\/(spec\/\w+)\/.*/, '\\1') }.
-              uniq.
-              select { |f| File.directory?(f) }
+            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] }]
           end
 
@@ -35,16 +37,6 @@ namespace :spec do
     end
   end
 
-  # RCov task only enabled for Ruby 1.8
-  if RUBY_VERSION < '1.9'
-    desc "Run all specs with rcov"
-    RSpec::Core::RakeTask.new(:rcov => "spec:prepare") do |t|
-      t.rcov = true
-      t.pattern = "./spec/**/*_spec.rb"
-      t.rcov_opts = '--exclude /gems/,/Library/,/usr/,lib/tasks,.bundle,config,/lib/rspec/,/lib/rspec-,spec'
-    end
-  end
-
   task :statsetup do
     require 'rails/code_statistics'
     types.each do |type, dir|

data/lib/rspec/rails/vendor/capybara.rb

@@ -9,25 +9,24 @@ rescue LoadError
 end
 
 if defined?(Capybara)
-  require 'rspec/support/version_checker'
-  RSpec::Support::VersionChecker.new('capybara', Capybara::VERSION, '2.2.0').check_version!
-
   RSpec.configure do |c|
     if defined?(Capybara::DSL)
-      c.include Capybara::DSL, :type => :feature
+      c.include Capybara::DSL, type: :feature
+      c.include Capybara::DSL, type: :system
     end
 
     if defined?(Capybara::RSpecMatchers)
-      c.include Capybara::RSpecMatchers, :type => :view
-      c.include Capybara::RSpecMatchers, :type => :helper
-      c.include Capybara::RSpecMatchers, :type => :mailer
-      c.include Capybara::RSpecMatchers, :type => :controller
-      c.include Capybara::RSpecMatchers, :type => :feature
+      c.include Capybara::RSpecMatchers, type: :view
+      c.include Capybara::RSpecMatchers, type: :helper
+      c.include Capybara::RSpecMatchers, type: :mailer
+      c.include Capybara::RSpecMatchers, type: :controller
+      c.include Capybara::RSpecMatchers, type: :feature
+      c.include Capybara::RSpecMatchers, type: :system
     end
 
     unless defined?(Capybara::RSpecMatchers) || defined?(Capybara::DSL)
-      c.include Capybara, :type => :request
-      c.include Capybara, :type => :controller
+      c.include Capybara, type: :request
+      c.include Capybara, type: :controller
     end
   end
 end

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 = '3.0.2'
+      STRING = '7.1.1'
     end
   end
 end