class Spectator::ExampleHook

Overview

Information about a hook tied to an example and a proc to invoke it.

Defined in:

spectator/example_hook.cr

Constructors

Instance Method Summary

Instance methods inherited from class Object

should(matcher : Spectator::Matchers::TypeMatcher(U), message = nil, *, _file = __FILE__, _line = __LINE__) forall U
should(matcher, message = nil, *, _file = __FILE__, _line = __LINE__) should, should_eventually(matcher, message = nil, *, _file = __FILE__, _line = __LINE__) should_eventually, should_never(matcher, message = nil, *, _file = __FILE__, _line = __LINE__) should_never, should_not(matcher : Spectator::Matchers::TypeMatcher(U), message = nil, *, _file = __FILE__, _line = __LINE__) forall U
should_not(matcher : Spectator::Matchers::NilMatcher, message = nil, *, _file = __FILE__, _line = __LINE__)
should_not(matcher, message = nil, *, _file = __FILE__, _line = __LINE__) should_not

Constructor Detail

def self.new(proc : Proc, *, location : Location | Nil = nil, label : Label = nil) #

Creates the hook with a proc. The proc will be called when the hook is invoked. A location and label can be provided for debugging.


[View source]
def self.new(*, location : Location | Nil = nil, label : Label = nil, &block : Proc) #

Creates the hook with a block. The block must take a single argument - the current example. The block will be executed when the hook is invoked. A location and label can be provided for debugging.


[View source]

Instance Method Detail

def call(example : Example) : Nil #

Invokes the hook. The example refers to the current example.


[View source]
def label : Label #

User-defined description of the hook.


[View source]
def label? : Label | Nil #

User-defined description of the hook.


[View source]
def location : Location #

Location of the hook in source code.


[View source]
def location? : Location | Nil #

Location of the hook in source code.


[View source]
def to_s(io : IO) : Nil #

Produces the string representation of the hook. Includes the location and label if they're not nil.


[View source]