Refaactor to use fail_with matcher

Author: JonRowe

spec/rspec/rails/matchers/active_job_spec.rb

@@ -152,7 +152,7 @@ def perform; raise StandardError; end
     it "fails when job is not enqueued" do
       expect {
         expect { }.to have_enqueued_job
-      }.to raise_error(/expected to enqueue exactly 1 jobs, but enqueued 0/)
+      }.to fail_with(/expected to enqueue exactly 1 jobs, but enqueued 0/)
     end
 
     it "fails when too many jobs enqueued" do
@@ -161,20 +161,20 @@ def perform; raise StandardError; end
           heavy_lifting_job.perform_later
           heavy_lifting_job.perform_later
         }.to have_enqueued_job.exactly(1)
-      }.to raise_error(/expected to enqueue exactly 1 jobs, but enqueued 2/)
+      }.to fail_with(/expected to enqueue exactly 1 jobs, but enqueued 2/)
     end
 
     it "reports correct number in fail error message" do
       heavy_lifting_job.perform_later
       expect {
         expect { }.to have_enqueued_job.exactly(1)
-      }.to raise_error(/expected to enqueue exactly 1 jobs, but enqueued 0/)
+      }.to fail_with(/expected to enqueue exactly 1 jobs, but enqueued 0/)
     end
 
     it "fails when negated and job is enqueued" do
       expect {
         expect { heavy_lifting_job.perform_later }.not_to have_enqueued_job
-      }.to raise_error(/expected not to enqueue at least 1 jobs, but enqueued 1/)
+      }.to fail_with(/expected not to enqueue at least 1 jobs, but enqueued 1/)
     end
 
     it "fails when negated and several jobs enqueued" do
@@ -183,7 +183,7 @@ def perform; raise StandardError; end
           heavy_lifting_job.perform_later
           heavy_lifting_job.perform_later
         }.not_to have_enqueued_job
-      }.to raise_error(/expected not to enqueue at least 1 jobs, but enqueued 2/)
+      }.to fail_with(/expected not to enqueue at least 1 jobs, but enqueued 2/)
     end
 
     it "passes with job name" do
@@ -238,7 +238,7 @@ def perform; raise StandardError; end
     it "generates failure message with at least hint" do
       expect {
         expect { }.to have_enqueued_job.at_least(:once)
-      }.to raise_error(/expected to enqueue at least 1 jobs, but enqueued 0/)
+      }.to fail_with(/expected to enqueue at least 1 jobs, but enqueued 0/)
     end
 
     it "generates failure message with at most hint" do
@@ -247,7 +247,7 @@ def perform; raise StandardError; end
           hello_job.perform_later
           hello_job.perform_later
         }.to have_enqueued_job.at_most(:once)
-      }.to raise_error(/expected to enqueue at most 1 jobs, but enqueued 2/)
+      }.to fail_with(/expected to enqueue at most 1 jobs, but enqueued 2/)
     end
 
     it "passes with provided queue name as string" do
@@ -291,7 +291,7 @@ def perform; raise StandardError; end
       travel_to time do
         expect {
           expect { hello_job.set(wait: 5).perform_later }.to have_enqueued_job.at(time + 5)
-        }.to raise_error(/expected to enqueue exactly 1 jobs/)
+        }.to fail_with(/expected to enqueue exactly 1 jobs/)
       end
     end
 
@@ -315,7 +315,7 @@ def perform; raise StandardError; end
         expect {
           hello_job.perform_later
         }.to have_enqueued_job.at(date)
-      }.to raise_error(/expected to enqueue exactly 1 jobs, at .+ but enqueued 0/)
+      }.to fail_with(/expected to enqueue exactly 1 jobs, at .+ but enqueued 0/)
     end
 
     it "has an enqueued job when not providing at and there is a wait" do
@@ -343,21 +343,15 @@ def perform; raise StandardError; end
         expect {
           two_args_job.perform_later(1)
         }.to have_enqueued_job.with(1)
-      }.to raise_error(
-        RSpec::Expectations::ExpectationNotMetError,
-        /Incorrect arguments passed to TwoArgsJob: Wrong number of arguments/
-      )
+      }.to fail_with(/Incorrect arguments passed to TwoArgsJob: Wrong number of arguments/)
     end
 
     it "fails if the job's signature/arguments are mismatched keyword/positional arguments" do
       expect {
         expect {
           keyword_args_job.perform_later(1, 2)
         }.to have_enqueued_job.with(1, 2)
-      }.to raise_error(
-        RSpec::Expectations::ExpectationNotMetError,
-        /Incorrect arguments passed to KeywordArgsJob: Missing required keyword arguments/
-      )
+      }.to fail_with(/Incorrect arguments passed to KeywordArgsJob: Missing required keyword arguments/)
     end
 
     it "passes with provided arguments containing global id object" do
@@ -384,7 +378,7 @@ def perform; raise StandardError; end
         expect {
           hello_job.perform_later(1)
         }.to have_enqueued_job(hello_job).with(42).on_queue("low").at(date).exactly(2).times
-      }.to raise_error(message)
+      }.to fail_with(message)
     end
 
     it "throws descriptive error when no test adapter set" do
@@ -490,37 +484,31 @@ def perform; raise StandardError; end
     it "fails when job is not enqueued" do
       expect {
         expect(heavy_lifting_job).to have_been_enqueued
-      }.to raise_error(/expected to enqueue exactly 1 jobs, but enqueued 0/)
+      }.to fail_with(/expected to enqueue exactly 1 jobs, but enqueued 0/)
     end
 
     it "fails if the arguments do not match the job's signature" do
       two_args_job.perform_later(1)
 
       expect {
         expect(two_args_job).to have_been_enqueued.with(1)
-      }.to raise_error(
-        RSpec::Expectations::ExpectationNotMetError,
-        /Incorrect arguments passed to TwoArgsJob: Wrong number of arguments/
-      )
+      }.to fail_with(/Incorrect arguments passed to TwoArgsJob: Wrong number of arguments/)
     end
 
     it "fails if the job's signature/arguments are mismatched keyword/positional arguments" do
       keyword_args_job.perform_later(1, 2)
 
       expect {
         expect(keyword_args_job).to have_been_enqueued.with(1, 2)
-      }.to raise_error(
-        RSpec::Expectations::ExpectationNotMetError,
-        /Incorrect arguments passed to KeywordArgsJob: Missing required keyword arguments/
-      )
+      }.to fail_with(/Incorrect arguments passed to KeywordArgsJob: Missing required keyword arguments/)
     end
 
     it "fails when negated and several jobs enqueued" do
       heavy_lifting_job.perform_later
       heavy_lifting_job.perform_later
       expect {
         expect(heavy_lifting_job).not_to have_been_enqueued
-      }.to raise_error(/expected not to enqueue at least 1 jobs, but enqueued 2/)
+      }.to fail_with(/expected not to enqueue at least 1 jobs, but enqueued 2/)
     end
 
     it "accepts composable matchers as an at date" do
@@ -569,7 +557,7 @@ def perform; raise StandardError; end
     it "fails when job is not performed" do
       expect {
         expect { }.to have_performed_job
-      }.to raise_error(/expected to perform exactly 1 jobs, but performed 0/)
+      }.to fail_with(/expected to perform exactly 1 jobs, but performed 0/)
     end
 
     it "fails when too many jobs performed" do
@@ -578,20 +566,20 @@ def perform; raise StandardError; end
           heavy_lifting_job.perform_later
           heavy_lifting_job.perform_later
         }.to have_performed_job.exactly(1)
-      }.to raise_error(/expected to perform exactly 1 jobs, but performed 2/)
+      }.to fail_with(/expected to perform exactly 1 jobs, but performed 2/)
     end
 
     it "reports correct number in fail error message" do
       heavy_lifting_job.perform_later
       expect {
         expect { }.to have_performed_job.exactly(1)
-      }.to raise_error(/expected to perform exactly 1 jobs, but performed 0/)
+      }.to fail_with(/expected to perform exactly 1 jobs, but performed 0/)
     end
 
     it "fails when negated and job is performed" do
       expect {
         expect { heavy_lifting_job.perform_later }.not_to have_performed_job
-      }.to raise_error(/expected not to perform exactly 1 jobs, but performed 1/)
+      }.to fail_with(/expected not to perform exactly 1 jobs, but performed 1/)
     end
 
     it "passes with job name" do
@@ -646,7 +634,7 @@ def perform; raise StandardError; end
     it "generates failure message with at least hint" do
       expect {
         expect { }.to have_performed_job.at_least(:once)
-      }.to raise_error(/expected to perform at least 1 jobs, but performed 0/)
+      }.to fail_with(/expected to perform at least 1 jobs, but performed 0/)
     end
 
     it "generates failure message with at most hint" do
@@ -655,7 +643,7 @@ def perform; raise StandardError; end
           hello_job.perform_later
           hello_job.perform_later
         }.to have_performed_job.at_most(:once)
-      }.to raise_error(/expected to perform at most 1 jobs, but performed 2/)
+      }.to fail_with(/expected to perform at most 1 jobs, but performed 2/)
     end
 
     it "passes with provided queue name as string" do
@@ -707,7 +695,7 @@ def perform; raise StandardError; end
         expect {
           hello_job.perform_later(1)
         }.to have_performed_job(hello_job).with(42).on_queue("low").at(date).exactly(2).times
-      }.to raise_error(message)
+      }.to fail_with(message)
     end
 
     it "throws descriptive error when no test adapter set" do
@@ -792,7 +780,7 @@ def perform; raise StandardError; end
     it "fails when job is not performed" do
       expect {
         expect(heavy_lifting_job).to have_been_performed
-      }.to raise_error(/expected to perform exactly 1 jobs, but performed 0/)
+      }.to fail_with(/expected to perform exactly 1 jobs, but performed 0/)
     end
   end
 

spec/rspec/rails/matchers/have_enqueued_mail_spec.rb

@@ -110,7 +110,7 @@ def test_email; end
         expect {
           AnotherTestMailer.test_email.deliver_later
         }.to have_enqueued_mail(TestMailer)
-      }.to raise_error(/expected to enqueue TestMailer exactly 1 time but enqueued 0/)
+      }.to fail_with(/expected to enqueue TestMailer exactly 1 time but enqueued 0/)
     end
 
     it "counts only emails enqueued in the block" do
@@ -127,7 +127,7 @@ def test_email; end
           TestMailer.test_email.deliver_later
           TestMailer.test_email.deliver_later
         }.to have_enqueued_mail(TestMailer, :test_email).exactly(1)
-      }.to raise_error(/expected to enqueue TestMailer.test_email exactly 1 time/)
+      }.to fail_with(/expected to enqueue TestMailer.test_email exactly 1 time/)
     end
 
     it "matches based on mailer class and method name" do
@@ -149,7 +149,7 @@ def test_email; end
         expect {
           TestMailer.test_email.deliver_later
         }.not_to have_enqueued_mail(TestMailer, :test_email)
-      }.to raise_error(/expected not to enqueue TestMailer.test_email at least 1 time but enqueued 1/)
+      }.to fail_with(/expected not to enqueue TestMailer.test_email at least 1 time but enqueued 1/)
     end
 
     it "passes with :once count" do
@@ -189,19 +189,19 @@ def test_email; end
     it "generates a failure message when given 0 argument" do
       expect {
         expect { }.to have_enqueued_mail.at_least(:once)
-      }.to raise_error(/expected to enqueue ActionMailer::Base at least 1 time but enqueued 0/)
+      }.to fail_with(/expected to enqueue ActionMailer::Base at least 1 time but enqueued 0/)
     end
 
     it "generates a failure message when given only mailer argument" do
       expect {
         expect { }.to have_enqueued_mail(TestMailer).at_least(:once)
-      }.to raise_error(/expected to enqueue TestMailer at least 1 time but enqueued 0/)
+      }.to fail_with(/expected to enqueue TestMailer at least 1 time but enqueued 0/)
     end
 
     it "generates a failure message with at least hint" do
       expect {
         expect { }.to have_enqueued_mail(TestMailer, :test_email).at_least(:once)
-      }.to raise_error(/expected to enqueue TestMailer.test_email at least 1 time but enqueued 0/)
+      }.to fail_with(/expected to enqueue TestMailer.test_email at least 1 time but enqueued 0/)
     end
 
     it "generates a failure message with at most hint" do
@@ -210,7 +210,7 @@ def test_email; end
           TestMailer.test_email.deliver_later
           TestMailer.test_email.deliver_later
         }.to have_enqueued_mail(TestMailer, :test_email).at_most(:once)
-      }.to raise_error(/expected to enqueue TestMailer.test_email at most 1 time but enqueued 2/)
+      }.to fail_with(/expected to enqueue TestMailer.test_email at most 1 time but enqueued 2/)
     end
 
     it "passes for mailer methods that accept arguments when the provided argument matcher is not used" do
@@ -248,22 +248,19 @@ def test_email; end
         expect {
           TestMailer.email_with_args(1).deliver_later
         }.to have_enqueued_mail(TestMailer, :email_with_args).with(1)
-      }.to raise_error(
-        RSpec::Expectations::ExpectationNotMetError,
-        /Incorrect arguments passed to TestMailer: Wrong number of arguments/
-      )
+      }.to fail_with(/Incorrect arguments passed to TestMailer: Wrong number of arguments/)
     end
 
     it "generates a failure message" do
       expect {
         expect { }.to have_enqueued_email(TestMailer, :test_email)
-      }.to raise_error(/expected to enqueue TestMailer.test_email/)
+      }.to fail_with(/expected to enqueue TestMailer.test_email/)
     end
 
     it "generates a failure message with arguments" do
       expect {
         expect { }.to have_enqueued_email(TestMailer, :email_with_args).with(1, 2)
-      }.to raise_error(/expected to enqueue TestMailer.email_with_args exactly 1 time with \[1, 2\], but enqueued 0/)
+      }.to fail_with(/expected to enqueue TestMailer.email_with_args exactly 1 time with \[1, 2\], but enqueued 0/)
     end
 
     it "passes when deliver_later is called with a wait_until argument" do
@@ -281,7 +278,7 @@ def test_email; end
         expect {
           TestMailer.test_email.deliver_later(wait_until: send_time + 1)
         }.to have_enqueued_email(TestMailer, :test_email).at(send_time)
-      }.to raise_error(/expected to enqueue TestMailer.test_email exactly 1 time at #{send_time.strftime('%F %T')}/)
+      }.to fail_with(/expected to enqueue TestMailer.test_email exactly 1 time at #{send_time.strftime('%F %T')}/)
     end
 
     it "accepts composable matchers as an at date" do
@@ -304,7 +301,7 @@ def test_email; end
         expect {
           TestMailer.test_email.deliver_later(queue: 'not_urgent_mail')
         }.to have_enqueued_email(TestMailer, :test_email).on_queue('urgent_mail')
-      }.to raise_error(/expected to enqueue TestMailer.test_email exactly 1 time on queue urgent_mail/)
+      }.to fail_with(/expected to enqueue TestMailer.test_email exactly 1 time on queue urgent_mail/)
     end
 
     it "generates a failure message with unmatching enqueued mail jobs" do
@@ -327,7 +324,7 @@ def self.name; "NonMailerJob"; end
           TestMailer.test_email.deliver_later
           TestMailer.email_with_args(3, 4).deliver_later(wait_until: send_time, queue: queue)
         }.to have_enqueued_email(TestMailer, :email_with_args).with(1, 2)
-      }.to raise_error(message)
+      }.to fail_with(message)
     end
 
     it "throws descriptive error when no test adapter set" do
@@ -405,10 +402,7 @@ def self.name; "NonMailerJob"; end
           expect {
             TestMailer.with('foo' => 'bar').email_with_args(1).deliver_later
           }.to have_enqueued_mail(TestMailer, :email_with_args).with({ 'foo' => 'bar' }, 1)
-        }.to raise_error(
-          RSpec::Expectations::ExpectationNotMetError,
-          /Incorrect arguments passed to TestMailer: Wrong number of arguments/
-        )
+        }.to raise_error(/Incorrect arguments passed to TestMailer: Wrong number of arguments/)
       end
     end
 
@@ -465,10 +459,7 @@ def self.name; "NonMailerJob"; end
           }.to have_enqueued_mail(UnifiedMailer, :email_with_args).with(
             a_hash_including(params: { 'foo' => 'bar' }, args: [1])
           )
-        }.to raise_error(
-          RSpec::Expectations::ExpectationNotMetError,
-          /Incorrect arguments passed to UnifiedMailer: Wrong number of arguments/
-        )
+        }.to fail_with(/Incorrect arguments passed to UnifiedMailer: Wrong number of arguments/)
       end
     end
   end

spec/spec_helper.rb

@@ -24,6 +24,7 @@ def self.world=(world)
 
 require 'rspec/support/spec'
 require 'rspec/core/sandbox'
+require 'rspec/matchers/fail_matchers'
 require 'rspec/rails'
 require 'ammeter/init'
 
@@ -37,6 +38,9 @@ def self.run_all(reporter = nil)
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
+  # Bring in the failure matchers from rspec-expectations
+  config.include RSpec::Matchers::FailMatchers
+
   config.expect_with :rspec do |expectations|
     # include_chain_clauses_in_custom_matcher_descriptions is removed in RSpec Expectations 4
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true if expectations.respond_to?(:include_chain_clauses_in_custom_matcher_descriptions=)