Module: RSpec::SleepingKingStudios::Deferred::Consumer::ClassMethods

Parent Namespace

RSpec::SleepingKingStudios::Deferred::Consumer

Defined In

lib/rspec/sleeping_king_studios/deferred/consumer.rb

Table Of Contents

• Overview
• Instance Methods
  • finclude_deferred
  • fwrap_deferred
  • include_deferred
  • wrap_deferred
  • xinclude_deferred
  • xwrap_deferred

Overview

Class methods for registering deferred examples.

Back To Top

Instance Methods

#finclude_deferred(description, *arguments, **keywords, &block) => Object

Includes the deferred examples inside a focused example group.

Parameters

• description (String) — the name of the deferred examples.
• arguments (Array) — arguments passed to the deferred examples.
• keywords (Hash) — keywords passed to the deferred examples.
• block (Block) — a block passed to the deferred examples.

#fwrap_deferred(description, *arguments, **keywords, &block) => Object

Includes the deferred examples inside a focused example group.

Unlike #include_deferred, a block parameter will be included in the created example group, not passed to the deferred examples. To wrap deferred examples that require a block, create the example group separately and call #include_deferred.

Parameters

• description (String) — the name of the deferred examples.
• arguments (Array) — arguments passed to the deferred examples.
• keywords (Hash) — keywords passed to the deferred examples.
• block (Block) — additional examples to be evaluated inside the example group.

#include_deferred(description, *arguments, **keywords, &block) => Object

Includes the deferred examples with the given definition.

Parameters

• description (String) — the name of the deferred examples.
• arguments (Array) — arguments passed to the deferred examples.
• keywords (Hash) — keywords passed to the deferred examples.
• block (Block) — a block passed to the deferred examples.

#wrap_deferred(description, *arguments, **keywords, &block) => Object

Includes the deferred examples inside an example group.

Unlike #include_deferred, a block parameter will be included in the created example group, not passed to the deferred examples. To wrap deferred examples that require a block, create the example group separately and call #include_deferred.

Parameters

• description (String) — the name of the deferred examples.
• arguments (Array) — arguments passed to the deferred examples.
• keywords (Hash) — keywords passed to the deferred examples.
• block (Block) — additional examples to be evaluated inside the example group.

#xinclude_deferred(description, *arguments, **keywords, &block) => Object

Includes the deferred examples inside a skipped example group.

Parameters

• description (String) — the name of the deferred examples.
• arguments (Array) — arguments passed to the deferred examples.
• keywords (Hash) — keywords passed to the deferred examples.
• block (Block) — a block passed to the deferred examples.

#xwrap_deferred(description, *arguments, **keywords, &block) => Object

Includes the deferred examples inside a skipped example group.

Unlike #include_deferred, a block parameter will be included in the created example group, not passed to the deferred examples. To wrap deferred examples that require a block, create the example group separately and call #include_deferred.

Parameters

• description (String) — the name of the deferred examples.
• arguments (Array) — arguments passed to the deferred examples.
• keywords (Hash) — keywords passed to the deferred examples.
• block (Block) — additional examples to be evaluated inside the example group.

Back To Top

---

Back to Documentation | Versions | 2.8 | Reference | RSpec | RSpec::SleepingKingStudios | RSpec::SleepingKingStudios::Deferred | RSpec::SleepingKingStudios::Deferred::Consumer