123456789_123456789_123456789_123456789_123456789_

Module: RSpec::Matchers::FailMatchers

Relationships & Source Files
Defined in: rspec-expectations/lib/rspec/matchers/fail_matchers.rb

Overview

::RSpec::Matchers for testing ::RSpec matchers. Include them with:

require 'rspec/matchers/fail_matchers'
RSpec.configure do |config|
  config.include RSpec::Matchers::FailMatchers
end

Instance Method Summary

Instance Method Details

#fail(&block)

Matches if an expectation fails

Examples:

expect { some_expectation }.to fail
[ GitHub ]

  
# File 'rspec-expectations/lib/rspec/matchers/fail_matchers.rb', line 17

def fail(&block)
  raise_error(RSpec::Expectations::ExpectationNotMetError, &block)
end

#fail_including(*snippets)

Matches if an expectation fails including the provided message

Examples:

expect { some_expectation }.to fail_including("portion of some failure message")
[ GitHub ]

  
# File 'rspec-expectations/lib/rspec/matchers/fail_matchers.rb', line 34

def fail_including(*snippets)
  raise_error(
    RSpec::Expectations::ExpectationNotMetError,
    a_string_including(*snippets)
  )
end

#fail_with(message)

Matches if an expectation fails with the provided message

Examples:

expect { some_expectation }.to fail_with("some failure message")
expect { some_expectation }.to fail_with(/some failure message/)
[ GitHub ]

  
# File 'rspec-expectations/lib/rspec/matchers/fail_matchers.rb', line 26

def fail_with(message)
  raise_error(RSpec::Expectations::ExpectationNotMetError, message)
end