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 bySpec::ObjectExtensions#should andSpec::ObjectExtensions#should_not.

Defined in:

spec/expectations.cr

Macro Summary

be_a(type)
Creates anExpectation that passes if actual is of typetype (is_a?).

Instance Method Summary

#be(value)
Creates anExpectation that passes if actual andvalue are identical (.same?).
#be
Returns a factory to create a comparisonExpectation that:
#be_close(expected, delta)
Creates anExpectation that passes if actual is withindelta ofexpected.
#be_empty
Creates anExpectation that passes if actual is empty (.empty?).
#be_false
Creates anExpectation that passes if actual is false (== false).
#be_falsey
Creates anExpectation that passes if actual is falsy (nil orfalse).
#be_nil
Creates anExpectation that passes if actual is nil (Object#nil?).
#be_true
Creates anExpectation that passes if actual is true (== true).
#be_truthy
Creates anExpectation that passes if actual is truthy (neithernil norfalse).
#contain(expected)
Creates anExpectation that passes if actual includesexpected (.includes?).
#end_with(expected)
Creates anExpectation that passes if actual ends withexpected (.ends_with?).
#eq(value)
Creates anExpectation that passes if actual equalsvalue (==).
#expect_raises(klass : T.class, message : String | Regex | Nil = nil, file = __FILE__, line = __LINE__, &) forall T
#match(value)
Creates anExpectation that passes if actual matchesvalue (=~).
#start_with(expected)
Creates anExpectation that passes if actual starts withexpected (.starts_with?).

Macro Detail

macro be_a(type) #

Creates anExpectation that passes if actual is of typetype (is_a?).

Instance Method Detail

def be(value) #

Creates anExpectation that passes if actual andvalue are identical (.same?).

def be #

Returns a factory to create a comparisonExpectation that:

passes if actual is lesser thanvalue:be < value
passes if actual is lesser than or equalvalue:be <= value
passes if actual is greater thanvalue:be > value
passes if actual is greater than or equalvalue:be >= value

def be_close(expected, delta) #

Creates anExpectation that passes if actual is withindelta ofexpected.

def be_empty #

Creates anExpectation that passes if actual is empty (.empty?).

def be_false #

Creates anExpectation that passes if actual is false (== false).

def be_falsey #

Creates anExpectation that passes if actual is falsy (nil orfalse).

def be_nil #

Creates anExpectation that passes if actual is nil (Object#nil?).

def be_true #

Creates anExpectation that passes if actual is true (== true).

def be_truthy #

Creates anExpectation that passes if actual is truthy (neithernil norfalse).

def contain(expected) #

Creates anExpectation that passes if actual includesexpected (.includes?). Works on collections andString.

def end_with(expected) #

Creates anExpectation that passes if actual ends withexpected (.ends_with?). Works onString.

def eq(value) #

Creates anExpectation that passes if actual equalsvalue (==).

def expect_raises(klass : T.class, message : String | Regex | Nil = nil, file = __FILE__, line = __LINE__, &) forall T #

def match(value) #

Creates anExpectation that passes if actual matchesvalue (=~).

def start_with(expected) #

Creates anExpectation that passes if actual starts withexpected (.starts_with?). Works onString.