Module RSpec::Expectations
In: lib/rspec/expectations.rb
lib/rspec/expectations/differ.rb
lib/rspec/expectations/errors.rb
lib/rspec/expectations/extensions/object.rb
lib/rspec/expectations/fail_with.rb
lib/rspec/expectations/handler.rb
lib/rspec/expectations/version.rb

RSpec::Expectations lets you set expectations on your objects.

  result.should == 37
  team.should have(11).players_on_the_field

How Expectations work.

RSpec::Expectations adds two methods to Object:

  should(matcher=nil)
  should_not(matcher=nil)

Both methods take an optional Expression Matcher (See RSpec::Matchers).

When should receives an Expression Matcher, it calls matches?(self). If it returns true, the spec passes and execution continues. If it returns false, then the spec fails with the message returned by matcher.failure_message.

Similarly, when should_not receives a matcher, it calls matches?(self). If it returns false, the spec passes and execution continues. If it returns true, then the spec fails with the message returned by matcher.negative_failure_message.

RSpec ships with a standard set of useful matchers, and writing your own matchers is quite simple. See RSpec::Matchers for details.

Methods

differ   differ=   fail_with  

Classes and Modules

Module RSpec::Expectations::DeprecatedConstants
Module RSpec::Expectations::Version
Class RSpec::Expectations::Differ
Class RSpec::Expectations::ExpectationNotMetError
Class RSpec::Expectations::InvalidMatcherError
Class RSpec::Expectations::NegativeExpectationHandler
Class RSpec::Expectations::PositiveExpectationHandler

Public Class methods

@private

Raises an RSpec::Expectations::ExpectationNotMetError with message. @param [String] message @param [Object] expected @param [Object] actual

Adds a diff to the failure message when expected and actual are both present.

Public Instance methods

@deprecated (no replacement)

[Validate]