module Spec::Expectations
Overview
This module defines a number of methods to create expectations, which are automatically included into the top level namespace.
Expectations are used by Spec::ObjectExtensions#should
and Spec::ObjectExtensions#should_not
.
Defined in:
spec/expectations.crInstance Method Summary
-
#be(value)
Creates an
Expectation
that passes if actual and value are identical (.same?
). -
#be
Returns a factory to create a comparison
Expectation
that: -
#be_close(expected, delta)
Creates an
Expectation
that passes if actual is within delta of expected. -
#be_empty
Creates an
Expectation
that passes if actual is empty (.empty?
). -
#be_false
Creates an
Expectation
that passes if actual is false (== false
). -
#be_falsey
Creates an
Expectation
that passes if actual is falsy (nil
orfalse
). -
#be_nil
Creates an
Expectation
that passes if actual is nil (== nil
). -
#be_true
Creates an
Expectation
that passes if actual is true (== true
). -
#be_truthy
Creates an
Expectation
that passes if actual is truthy (neithernil
norfalse
). -
#contain(expected)
Creates an
Expectation
that passes if actual includes expected (.includes?
). -
#end_with(expected)
Creates an
Expectation
that passes if actual ends with expected (.ends_with?
). -
#eq(value)
Creates an
Expectation
that passes if actual equals value (==
). -
#expect_raises(klass : T.class, message = nil, file = __FILE__, line = __LINE__, &) forall T
Runs the block and passes if it raises an exception of type klass and the error message matches.
-
#match(value)
Creates an
Expectation
that passes if actual matches value (=~
). -
#start_with(expected)
Creates an
Expectation
that passes if actual starts with expected (.starts_with?
).
Macro Summary
-
be_a(type)
Creates an
Expectation
that passes if actual is of type type (is_a?
).
Instance Method Detail
Returns a factory to create a comparison Expectation
that:
- passes if actual is lesser than value:
be < value
- passes if actual is lesser than or equal value:
be <= value
- passes if actual is greater than value:
be > value
- passes if actual is greater than or equal value:
be >= value
Creates an Expectation
that passes if actual is within delta of expected.
Creates an Expectation
that passes if actual includes expected (.includes?
).
Works on collections and String
.
Creates an Expectation
that passes if actual ends with expected (.ends_with?
).
Works on String
.
Runs the block and passes if it raises an exception of type klass and the error message matches.
If message is a string, it matches if the exception's error message contains that string. If message is a regular expression, it is used to match the error message.
It returns the rescued exception.
Creates an Expectation
that passes if actual starts with expected (.starts_with?
).
Works on String
.