class

Spectator::ExampleGroup

Inherits Indexable / Enumerable / Iterable / Spectator::Hooks / Spectator::Node / Reference / Object

Collection of examples and sub-groups.

Constructors

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

Creates the example group. The name describes the purpose of the group. It can be a Symbol to describe a type. The location tracks where the group exists in source code. This group will be assigned to the parent group if it is provided. A set of metadata can be used for filtering and modifying example behavior.

Instance methods

<<(node : Node)

Adds the specified node to the group. Assigns the node to this group. If the node already belongs to a group, it will be removed from the previous group before adding it to this group.

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.

ascend

Yields this group and all parent groups.

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.

delete(node : Node)

Removes the specified node from the group. The node will be unassigned from this group.

finished?

Checks if all examples and sub-groups have finished.

group

Parent group this group belongs to.

group?

Parent group this group belongs to.

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.

size(*args, **options)

size(*args, **options, &)

to_s(io : IO, *, nested = false) : Nil

Constructs the full name or description of the example group. This prepends names of groups this group is part of.

unsafe_fetch(*args, **options)

unsafe_fetch(*args, **options, &)