class

Spectator::ExampleGroupBuilder

Inherits Spectator::Hooks / Spectator::NodeBuilder / Reference / Object

Progressively constructs an example group. Hooks and builders for child nodes can be added over time to this builder. When done, call #build to produce an ExampleGroup.

Constructors

new(name : Label = nil, location : Location | Nil = nil, metadata : Metadata | Nil = nil)

Creates the builder. Initially, the builder will have no children and no hooks. The name, location, and metadata will be applied to the ExampleGroup produced by #build.

Instance methods

<<(builder)

Adds a child builder to the group. The builder will have NodeBuilder#build called on it from within #build. The new example group will be passed to it.

after_all(hook : ExampleGroupHook) : Nil

Registers a new "after_all" hook. The hook will be prepended to the list.

after_all(*args, **kwargs) : Nil

Registers a new "after_all" hook. The hook will be prepended to the list. A new hook will be created by passing args to ExampleGroupHook.new.

after_all(*args, **kwargs, &block) : Nil

Registers a new "after_all" hook. The hook will be prepended to the list. A new hook will be created by passing args to ExampleGroupHook.new.

after_each(hook : ExampleHook) : Nil

Registers a new "after_each" hook. The hook will be prepended to the list.

after_each(*args, **kwargs) : Nil

Registers a new "after_each" hook. The hook will be prepended to the list. A new hook will be created by passing args to ExampleHook.new.

after_each(*args, **kwargs, &block) : Nil

Registers a new "after_each" hook. The hook will be prepended to the list. A new hook will be created by passing args to ExampleHook.new.

around_each(hook : ExampleProcsyHook) : Nil

Registers a new "around_each" hook. The hook will be appended to the list.

around_each(*args, **kwargs) : Nil

Registers a new "around_each" hook. The hook will be appended to the list. A new hook will be created by passing args to ExampleProcsyHook.new.

around_each(*args, **kwargs, &block) : Nil

Registers a new "around_each" hook. The hook will be appended to the list. A new hook will be created by passing args to ExampleProcsyHook.new.

before_all(hook : ExampleGroupHook) : Nil

Registers a new "before_all" hook. The hook will be appended to the list.

before_all(*args, **kwargs) : Nil

Registers a new "before_all" hook. The hook will be appended to the list. A new hook will be created by passing args to ExampleGroupHook.new.

before_all(*args, **kwargs, &block) : Nil

Registers a new "before_all" hook. The hook will be appended to the list. A new hook will be created by passing args to ExampleGroupHook.new.

before_each(hook : ExampleHook) : Nil

Registers a new "before_each" hook. The hook will be appended to the list.

before_each(*args, **kwargs) : Nil

Registers a new "before_each" hook. The hook will be appended to the list. A new hook will be created by passing args to ExampleHook.new.

before_each(*args, **kwargs, &block) : Nil

Registers a new "before_each" hook. The hook will be appended to the list. A new hook will be created by passing args to ExampleHook.new.

build(parent = nil)

Constructs an example group with previously defined attributes, children, and hooks. The parent is an already constructed example group to nest the new example group under. It can be nil if the new example group won't have a parent.

post_condition(hook : ExampleHook) : Nil

Registers a new "post_condition" hook. The hook will be prepended to the list.

post_condition(*args, **kwargs) : Nil

Registers a new "post_condition" hook. The hook will be prepended to the list. A new hook will be created by passing args to ExampleHook.new.

post_condition(*args, **kwargs, &block) : Nil

Registers a new "post_condition" hook. The hook will be prepended to the list. A new hook will be created by passing args to ExampleHook.new.

pre_condition(hook : ExampleHook) : Nil

Registers a new "pre_condition" hook. The hook will be appended to the list.

pre_condition(*args, **kwargs) : Nil

Registers a new "pre_condition" hook. The hook will be appended to the list. A new hook will be created by passing args to ExampleHook.new.

pre_condition(*args, **kwargs, &block) : Nil

Registers a new "pre_condition" hook. The hook will be appended to the list. A new hook will be created by passing args to ExampleHook.new.