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.cr

Macro Summary

• be_a(type)

  Creates an Expectation that passes if actual is of type type (is_a?).

Instance 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 or false).

• #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 (neither nil nor false).

• #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 : String | Regex | Nil = nil, file = __FILE__, line = __LINE__, &) forall T
• #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 Detail

Instance Method Detail