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.crMacro Summary
-
be_a(type)
Creates an
Expectationthat passes if actual is of type type (is_a?).
Instance Method Summary
-
#be(value)
Creates an
Expectationthat passes if actual and value are identical (.same?). -
#be
Returns a factory to create a comparison
Expectationthat: -
#be_close(expected, delta)
Creates an
Expectationthat passes if actual is within delta of expected. -
#be_empty
Creates an
Expectationthat passes if actual is empty (.empty?). -
#be_false
Creates an
Expectationthat passes if actual is false (== false). -
#be_falsey
Creates an
Expectationthat passes if actual is falsy (nilorfalse). -
#be_nil
Creates an
Expectationthat passes if actual is nil (== nil). -
#be_true
Creates an
Expectationthat passes if actual is true (== true). -
#be_truthy
Creates an
Expectationthat passes if actual is truthy (neithernilnorfalse). -
#contain(expected)
Creates an
Expectationthat passes if actual includes expected (.includes?). -
#end_with(expected)
Creates an
Expectationthat passes if actual ends with expected (.ends_with?). -
#eq(value)
Creates an
Expectationthat passes if actual equals value (==). - #expect_raises(klass : T.class, message : String | Regex | Nil = nil, file = __FILE__, line = __LINE__, &) forall T
-
#match(value)
Creates an
Expectationthat passes if actual matches value (=~). -
#start_with(expected)
Creates an
Expectationthat passes if actual starts with expected (.starts_with?).
Macro Detail
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.