rspec-rails 3.9.1 → 4.0.0

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

@@ -8,14 +8,14 @@ module RSpec
       #
       # @api private
       module ActiveJob
-        # rubocop: disable Style/ClassLength
+        # rubocop: disable Metrics/ClassLength
         # @private
         class Base < RSpec::Rails::Matchers::BaseMatcher
           def initialize
             @args = []
             @queue = nil
             @at = nil
-            @block = Proc.new {}
+            @block = proc { }
             set_expected_number(:exactly, 1)
           end
 
@@ -26,7 +26,7 @@ module RSpec
           end
 
           def on_queue(queue)
-            @queue = queue
+            @queue = queue.to_s
             self
           end
 
@@ -67,7 +67,7 @@ module RSpec
           end
 
           def failure_message
-            "expected to enqueue #{base_message}".tap do |msg|
+            "expected to #{self.class::FAILURE_MESSAGE_EXPECTATION_ACTION} #{base_message}".tap do |msg|
               if @unmatching_jobs.any?
                 msg << "\nQueued jobs:"
                 @unmatching_jobs.each do |job|
@@ -78,7 +78,7 @@ module RSpec
           end
 
           def failure_message_when_negated
-            "expected not to enqueue #{base_message}"
+            "expected not to #{self.class::FAILURE_MESSAGE_EXPECTATION_ACTION} #{base_message}"
           end
 
           def message_expectation_modifier
@@ -97,7 +97,7 @@ module RSpec
 
           def check(jobs)
             @matching_jobs, @unmatching_jobs = jobs.partition do |job|
-              if arguments_match?(job) && other_attributes_match?(job)
+              if job_match?(job) && arguments_match?(job) && queue_match?(job) && at_match?(job)
                 args = deserialize_arguments(job)
                 @block.call(*args)
                 true
@@ -119,7 +119,7 @@ module RSpec
               msg << " with #{@args}," if @args.any?
               msg << " on queue #{@queue}," if @queue
               msg << " at #{@at.inspect}," if @at
-              msg << " but enqueued #{@matching_jobs_count}"
+              msg << " but #{self.class::MESSAGE_EXPECTATION_ACTION} #{@matching_jobs_count}"
             end
           end
 
@@ -134,29 +134,32 @@ module RSpec
             end
           end
 
+          def job_match?(job)
+            @job ? @job == job[:job] : true
+          end
+
           def arguments_match?(job)
             if @args.any?
+              args = serialize_and_deserialize_arguments(@args)
               deserialized_args = deserialize_arguments(job)
-              RSpec::Mocks::ArgumentListMatcher.new(*@args).args_match?(*deserialized_args)
+              RSpec::Mocks::ArgumentListMatcher.new(*args).args_match?(*deserialized_args)
             else
               true
             end
           end
 
-          def other_attributes_match?(job)
-            serialized_attributes.all? { |key, value| value == job[key] }
-          end
+          def queue_match?(job)
+            return true unless @queue
 
-          def serialized_attributes
-            {}.tap do |attributes|
-              attributes[:at]    = serialized_at if @at
-              attributes[:queue] = @queue if @queue
-              attributes[:job]   = @job if @job
-            end
+            @queue == job[:queue]
           end
 
-          def serialized_at
-            @at == :no_wait ? nil : @at.to_f
+          def at_match?(job)
+            return true unless @at
+            return job[:at].nil? if @at == :no_wait
+            return false unless job[:at]
+
+            values_match?(@at, Time.at(job[:at]))
           end
 
           def set_expected_number(relativity, count)
@@ -169,6 +172,13 @@ module RSpec
                                end
           end
 
+          def serialize_and_deserialize_arguments(args)
+            serialized = ::ActiveJob::Arguments.serialize(args)
+            ::ActiveJob::Arguments.deserialize(serialized)
+          rescue ::ActiveJob::SerializationError
+            args
+          end
+
           def deserialize_arguments(job)
             ::ActiveJob::Arguments.deserialize(job[:args])
           rescue ::ActiveJob::DeserializationError
@@ -179,10 +189,13 @@ module RSpec
             ::ActiveJob::Base.queue_adapter
           end
         end
-        # rubocop: enable Style/ClassLength
+        # rubocop: enable Metrics/ClassLength
 
         # @private
         class HaveEnqueuedJob < Base
+          FAILURE_MESSAGE_EXPECTATION_ACTION = 'enqueue'.freeze
+          MESSAGE_EXPECTATION_ACTION = 'enqueued'.freeze
+
           def initialize(job)
             super()
             @job = job
@@ -207,6 +220,9 @@ module RSpec
 
         # @private
         class HaveBeenEnqueued < Base
+          FAILURE_MESSAGE_EXPECTATION_ACTION = 'enqueue'.freeze
+          MESSAGE_EXPECTATION_ACTION = 'enqueued'.freeze
+
           def matches?(job)
             @job = job
             check(queue_adapter.enqueued_jobs)
@@ -218,6 +234,38 @@ module RSpec
             !matches?(proc)
           end
         end
+
+        # @private
+        class HavePerformedJob < Base
+          FAILURE_MESSAGE_EXPECTATION_ACTION = 'perform'.freeze
+          MESSAGE_EXPECTATION_ACTION = 'performed'.freeze
+
+          def initialize(job)
+            super()
+            @job = job
+          end
+
+          def matches?(proc)
+            raise ArgumentError, "have_performed_job only supports block expectations" unless Proc === proc
+
+            original_performed_jobs_count = queue_adapter.performed_jobs.count
+            proc.call
+            in_block_jobs = queue_adapter.performed_jobs.drop(original_performed_jobs_count)
+
+            check(in_block_jobs)
+          end
+        end
+
+        # @private
+        class HaveBeenPerformed < Base
+          FAILURE_MESSAGE_EXPECTATION_ACTION = 'perform'.freeze
+          MESSAGE_EXPECTATION_ACTION = 'performed'.freeze
+
+          def matches?(job)
+            @job = job
+            check(queue_adapter.performed_jobs)
+          end
+        end
       end
 
       # @api public
@@ -305,11 +353,85 @@ module RSpec
         ActiveJob::HaveBeenEnqueued.new
       end
 
+      # @api public
+      # Passes if a job has been performed inside block. May chain at_least, at_most or exactly to specify a number of times.
+      #
+      # @example
+      #     expect {
+      #       perform_jobs { HeavyLiftingJob.perform_later }
+      #     }.to have_performed_job
+      #
+      #     expect {
+      #       perform_jobs {
+      #         HelloJob.perform_later
+      #         HeavyLiftingJob.perform_later
+      #       }
+      #     }.to have_performed_job(HelloJob).exactly(:once)
+      #
+      #     expect {
+      #       perform_jobs { 3.times { HelloJob.perform_later } }
+      #     }.to have_performed_job(HelloJob).at_least(2).times
+      #
+      #     expect {
+      #       perform_jobs { HelloJob.perform_later }
+      #     }.to have_performed_job(HelloJob).at_most(:twice)
+      #
+      #     expect {
+      #       perform_jobs {
+      #         HelloJob.perform_later
+      #         HeavyLiftingJob.perform_later
+      #       }
+      #     }.to have_performed_job(HelloJob).and have_performed_job(HeavyLiftingJob)
+      #
+      #     expect {
+      #       perform_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)
+      def have_performed_job(job = nil)
+        check_active_job_adapter
+        ActiveJob::HavePerformedJob.new(job)
+      end
+      alias_method :perform_job, :have_performed_job
+
+      # @api public
+      # Passes if a job has been performed. May chain at_least, at_most or exactly to specify a number of times.
+      #
+      # @example
+      #     before do
+      #       ActiveJob::Base.queue_adapter.performed_jobs.clear
+      #       ActiveJob::Base.queue_adapter.perform_enqueued_jobs = true
+      #       ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = true
+      #     end
+      #
+      #     HeavyLiftingJob.perform_later
+      #     expect(HeavyLiftingJob).to have_been_performed
+      #
+      #     HelloJob.perform_later
+      #     HeavyLiftingJob.perform_later
+      #     expect(HeavyLiftingJob).to have_been_performed.exactly(:once)
+      #
+      #     3.times { HelloJob.perform_later }
+      #     expect(HelloJob).to have_been_performed.at_least(2).times
+      #
+      #     HelloJob.perform_later
+      #     HeavyLiftingJob.perform_later
+      #     expect(HelloJob).to have_been_performed
+      #     expect(HeavyLiftingJob).to have_been_performed
+      #
+      #     HelloJob.set(wait_until: Date.tomorrow.noon, queue: "low").perform_later(42)
+      #     expect(HelloJob).to have_been_performed.with(42).on_queue("low").at(Date.tomorrow.noon)
+      def have_been_performed
+        check_active_job_adapter
+        ActiveJob::HaveBeenPerformed.new
+      end
+
     private
 
       # @private
       def check_active_job_adapter
         return if ::ActiveJob::QueueAdapters::TestAdapter === ::ActiveJob::Base.queue_adapter
+
         raise StandardError, "To use ActiveJob matchers set `ActiveJob::Base.queue_adapter = :test`"
       end
     end

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

@@ -1,7 +1,9 @@
 module RSpec
   module Rails
     module Matchers
-      # @ api private
+      # @api private
+      #
+      # Base class to build matchers. Should not be instantiated directly.
       class BaseMatcher
         include RSpec::Matchers::Composable
 
@@ -114,19 +116,12 @@ module RSpec
 
         def assert_ivars(*expected_ivars)
           return unless (expected_ivars - present_ivars).any?
+
           ivar_list = RSpec::Matchers::EnglishPhrasing.list(expected_ivars)
           raise "#{self.class.name} needs to supply#{ivar_list}"
         end
 
-        if RUBY_VERSION.to_f < 1.9
-          # :nocov:
-          def present_ivars
-            instance_variables.map(&:to_sym)
-          end
-          # :nocov:
-        else
-          alias present_ivars instance_variables
-        end
+        alias present_ivars instance_variables
 
         # @private
         module HashFormatting

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

@@ -1,4 +1,7 @@
-require "rspec/mocks"
+# We require the minimum amount of rspec-mocks possible to avoid
+# conflicts with other mocking frameworks.
+# See: https://github.com/rspec/rspec-rails/issues/2252
+require "rspec/mocks/argument_matchers"
 require "rspec/rails/matchers/active_job"
 
 module RSpec
@@ -6,33 +9,32 @@ module RSpec
     module Matchers
       # Matcher class for `have_enqueued_mail`. Should not be instantiated directly.
       #
-      # rubocop: disable Style/ClassLength
       # @private
       # @see RSpec::Rails::Matchers#have_enqueued_mail
       class HaveEnqueuedMail < ActiveJob::HaveEnqueuedJob
         MAILER_JOB_METHOD = 'deliver_now'.freeze
 
-        include RSpec::Mocks::ExampleMethods
+        include RSpec::Mocks::ArgumentMatchers
 
         def initialize(mailer_class, method_name)
-          super(mailer_job)
+          super(nil)
           @mailer_class = mailer_class
           @method_name = method_name
           @mail_args = []
-          @args = mailer_args
         end
 
         def description
-          "enqueues #{@mailer_class.name}.#{@method_name}"
+          "enqueues #{mailer_class_name}.#{@method_name}"
         end
 
         def with(*args, &block)
           @mail_args = args
-          block.nil? ? super(*mailer_args) : super(*mailer_args, &yield_mail_args(block))
+          block.nil? ? super : super(&yield_mail_args(block))
         end
 
         def matches?(block)
           raise ArgumentError, 'have_enqueued_mail and enqueue_mail only work with block arguments' unless block.respond_to?(:call)
+
           check_active_job_adapter
           super
         end
@@ -50,7 +52,7 @@ module RSpec
         private
 
         def base_message
-          "#{@mailer_class.name}.#{@method_name}".tap do |msg|
+          [mailer_class_name, @method_name].compact.join('.').tap do |msg|
             msg << " #{expected_count_message}"
             msg << " with #{@mail_args}," if @mail_args.any?
             msg << " on queue #{@queue}," if @queue
@@ -63,38 +65,46 @@ module RSpec
           "#{message_expectation_modifier} #{@expected_number} #{@expected_number == 1 ? 'time' : 'times'}"
         end
 
-        def mailer_args
-          if @mail_args.any?
-            base_mailer_args + @mail_args
-          else
-            mailer_method_arity = @mailer_class.instance_method(@method_name).arity
+        def mailer_class_name
+          @mailer_class ? @mailer_class.name : 'ActionMailer::Base'
+        end
 
-            number_of_args = if mailer_method_arity < 0
-                               (mailer_method_arity + 1).abs
-                             else
-                               mailer_method_arity
-                             end
+        def job_match?(job)
+          legacy_mail?(job) || parameterized_mail?(job) || unified_mail?(job)
+        end
 
-            base_mailer_args + Array.new(number_of_args) { anything }
-          end
+        def arguments_match?(job)
+          @args =
+            if @mail_args.any?
+              base_mailer_args + @mail_args
+            elsif @mailer_class && @method_name
+              base_mailer_args + [any_args]
+            elsif @mailer_class
+              [mailer_class_name, any_args]
+            else
+              []
+            end
+
+          super(job)
         end
 
         def base_mailer_args
-          [@mailer_class.name, @method_name.to_s, MAILER_JOB_METHOD]
+          [mailer_class_name, @method_name.to_s, MAILER_JOB_METHOD]
         end
 
         def yield_mail_args(block)
-          Proc.new { |*job_args| block.call(*(job_args - base_mailer_args)) }
+          proc { |*job_args| block.call(*(job_args - base_mailer_args)) }
         end
 
         def check_active_job_adapter
           return if ::ActiveJob::QueueAdapters::TestAdapter === ::ActiveJob::Base.queue_adapter
+
           raise StandardError, "To use HaveEnqueuedMail matcher set `ActiveJob::Base.queue_adapter = :test`"
         end
 
         def unmatching_mail_jobs
           @unmatching_jobs.select do |job|
-            job[:job] == mailer_job
+            job_match?(job)
           end
         end
 
@@ -120,12 +130,18 @@ module RSpec
           "#{mailer_method} #{msg_parts.join(', ')}".strip
         end
 
-        def mailer_job
-          ActionMailer::DeliveryJob
+        def legacy_mail?(job)
+          job[:job] == ActionMailer::DeliveryJob
+        end
+
+        def parameterized_mail?(job)
+          RSpec::Rails::FeatureCheck.has_action_mailer_parameterized? && job[:job] == ActionMailer::Parameterized::DeliveryJob
         end
-      end
-      # rubocop: enable Style/ClassLength
 
+        def unified_mail?(job)
+          RSpec::Rails::FeatureCheck.has_action_mailer_unified_delivery? && job[:job] == ActionMailer::MailDeliveryJob
+        end
+      end
       # @api public
       # Passes if an email has been enqueued inside block.
       # May chain with to specify expected arguments.
@@ -136,6 +152,14 @@ module RSpec
       # @example
       #     expect {
       #       MyMailer.welcome(user).deliver_later
+      #     }.to have_enqueued_mail
+      #
+      #     expect {
+      #       MyMailer.welcome(user).deliver_later
+      #     }.to have_enqueued_mail(MyMailer)
+      #
+      #     expect {
+      #       MyMailer.welcome(user).deliver_later
       #     }.to have_enqueued_mail(MyMailer, :welcome)
       #
       #     # Using alias
@@ -163,7 +187,7 @@ module RSpec
       #     expect {
       #       MyMailer.welcome(user).deliver_later(queue: :urgent_mail)
       #     }.to have_enqueued_mail(MyMailer, :welcome).on_queue(:urgent_mail)
-      def have_enqueued_mail(mailer_class, mail_method_name)
+      def have_enqueued_mail(mailer_class = nil, mail_method_name = nil)
         HaveEnqueuedMail.new(mailer_class, mail_method_name)
       end
       alias_method :have_enqueued_email, :have_enqueued_mail

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

@@ -59,6 +59,7 @@ module RSpec
         #   `@invalid_response` is present, `nil` otherwise
         def invalid_response_type_message
           return unless @invalid_response
+
           "expected a response object, but an instance of " \
           "#{@invalid_response.class} was received"
         end
@@ -72,7 +73,7 @@ module RSpec
         # @example
         #   expect(response).to have_http_status(404)
         #
-        # @see RSpec::Rails::Matchers.have_http_status
+        # @see RSpec::Rails::Matchers#have_http_status
         class NumericCode < RSpec::Rails::Matchers::BaseMatcher
           include HaveHttpStatus
 
@@ -122,7 +123,7 @@ module RSpec
         # @example
         #   expect(response).to have_http_status(:created)
         #
-        # @see RSpec::Rails::Matchers.have_http_status
+        # @see RSpec::Rails::Matchers#have_http_status
         # @see https://github.com/rack/rack/blob/master/lib/rack/utils.rb `Rack::Utils::SYMBOL_TO_STATUS_CODE`
         class SymbolicStatus < RSpec::Rails::Matchers::BaseMatcher
           include HaveHttpStatus
@@ -174,6 +175,7 @@ module RSpec
           # @return [Symbol] representing the actual http numeric code
           def actual_status
             return unless actual
+
             @actual_status ||= compute_status_from(actual)
           end
 
@@ -234,8 +236,8 @@ module RSpec
         #   expect(response).to have_http_status(:missing)
         #   expect(response).to have_http_status(:redirect)
         #
-        # @see RSpec::Rails::Matchers.have_http_status
-        # @see ActionDispatch::TestResponse
+        # @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`
         class GenericStatus < RSpec::Rails::Matchers::BaseMatcher
           include HaveHttpStatus
 
@@ -254,6 +256,7 @@ module RSpec
             unless self.class.valid_statuses.include?(type)
               raise ArgumentError, "Invalid generic HTTP status: #{type.inspect}"
             end
+
             @expected = type
             @actual = nil
             @invalid_response = nil
@@ -290,9 +293,9 @@ module RSpec
         protected
 
           RESPONSE_METHODS = {
-            :success => 'successful',
-            :error => 'server_error',
-            :missing => 'not_found'
+            success: 'successful',
+            error: 'server_error',
+            missing: 'not_found'
           }.freeze
 
           def check_expected_status(test_response, expected)
@@ -374,6 +377,7 @@ module RSpec
       # @see https://github.com/rack/rack/blob/master/lib/rack/utils.rb `Rack::Utils::SYMBOL_TO_STATUS_CODE`
       def have_http_status(target)
         raise ArgumentError, "Invalid HTTP status: nil" unless target
+
         HaveHttpStatus.matcher_for_status(target)
       end
     end

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

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

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

@@ -14,7 +14,7 @@ module RSpec
               @expected.merge!(expected[0])
             else
               controller, action = expected[0].split('#')
-              @expected.merge!(:controller => controller, :action => action)
+              @expected.merge!(controller: controller, action: action)
             end
           end
 
@@ -26,7 +26,7 @@ module RSpec
               path, query = *verb_to_path_map.values.first.split('?')
               @scope.assert_recognizes(
                 @expected,
-                { :method => verb_to_path_map.keys.first, :path => path },
+                {method: verb_to_path_map.keys.first, path: path},
                 Rack::Utils.parse_nested_query(query)
               )
             end
@@ -50,14 +50,14 @@ module RSpec
         #
         # @example
         #
-        #     expect(:get => "/things/special").to route_to(
-        #       :controller => "things",
-        #       :action     => "special"
+        #     expect(get: "/things/special").to route_to(
+        #       controller: "things",
+        #       action:     "special"
         #     )
         #
-        #     expect(:get => "/things/special").to route_to("things#special")
+        #     expect(get: "/things/special").to route_to("things#special")
         #
-        # @see http://api.rubyonrails.org/classes/ActionDispatch/Assertions/RoutingAssertions.html#method-i-assert_recognizes
+        # @see https://api.rubyonrails.org/classes/ActionDispatch/Assertions/RoutingAssertions.html#method-i-assert_recognizes
         def route_to(*expected)
           RouteToMatcher.new(self, *expected)
         end
@@ -72,7 +72,7 @@ module RSpec
             @actual = path
             match_unless_raises ActionController::RoutingError do
               @routing_options = @scope.routes.recognize_path(
-                path.values.first, :method => path.keys.first
+                path.values.first, method: path.keys.first
               )
             end
           end
@@ -95,9 +95,9 @@ module RSpec
         # `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
+        #     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
@@ -115,7 +115,7 @@ module RSpec
           # 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 }
+              {method.to_sym => path}
             end
           end
         end

data/lib/rspec/rails/matchers.rb

@@ -20,7 +20,16 @@ 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'
+
 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,19 @@ if default = Rake.application.instance_variable_get('@tasks')['default']
   default.prerequisites.delete('test')
 end
 
-task :default => :spec
+task default: :spec
 
-task :stats => "spec:statsetup"
+task stats: "spec:statsetup"
 
 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 +35,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|