class

Spectator::Node

Inherits Reference / Object

A single item in a test spec. This is commonly an Example or ExampleGroup, but can be anything that should be iterated over when running the spec.

Constants

DEFAULT_PENDING_REASON = "No reason given"

Default text used if none was given by the user for skipping a node.

Constructors

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

Creates the node. The name describes the purpose of the node. It can be a Symbol to describe a type. The location tracks where the node exists in source code. A set of metadata can be used for filtering and modifying example behavior.

Source

Instance methods

display_name

Non-nil name used to show the node name.

Source

finished?

Indicates whether the node has completed.

Source

inspect(io : IO) : Nil

Exposes information about the node useful for debugging.

Source

location

Location of the node in source code.

Source

location?

Location of the node in source code.

Source

metadata

User-defined tags and values used for filtering and behavior modification.

Source

name

User-provided name or description of the node. This does not include the group name or descriptions. Use #to_s to get the full name.

This value will be nil if no name was provided. In this case, and the node is a runnable example, the name should be set to the description of the first matcher that runs in the test case.

If this value is a Symbol, the user specified a type for the name.

Source

name?

User-provided name or description of the node. This does not include the group name or descriptions. Use #to_s to get the full name.

This value will be nil if no name was provided. In this case, and the node is a runnable example, the name should be set to the description of the first matcher that runs in the test case.

If this value is a Symbol, the user specified a type for the name.

Source

pending?

Checks if the node has been marked as pending. Pending items should be skipped during execution.

Source

pending_reason

Gets the reason the node has been marked as pending.

Source