Module: RSpec::SleepingKingStudios::Deferred::Dsl::Examples

Parent Namespace

RSpec::SleepingKingStudios::Deferred::Dsl

Extended Modules

RSpec::SleepingKingStudios::Deferred::Dsl::Examples::Macros

Defined In

lib/rspec/sleeping_king_studios/deferred/dsl/examples.rb

Table Of Contents

• Overview
• Class Methods
  • define_example_method
• Instance Methods
  • example
  • fexample
  • fit
  • focus
  • fspecify
  • it
  • pending
  • skip
  • specify
  • xexample
  • xit
  • xspecify

Overview

Methods for defining deferred examples.

Back To Top

Defined Under Namespace

Modules

Macros

Back To Top

Class Methods

.define_example_method(method_name) => void

Inherited From

RSpec::SleepingKingStudios::Deferred::Dsl::Examples::Macros

Registers a method for deferring an example.

Parameters

• method_name (String, Symbol) — the name of the deferred method.

Returns

• (void)

Back To Top

Instance Methods

#example(doc_string = nil, *flags, **metadata, &block) => void

Defines a deferred example using the example method.

Parameters

• doc_string (String) — the example's doc string.
• flags (Array<Symbol>) — metadata flags for the example. Will be transformed into metadata entries with true values.
• metadata (Hash) — metadata for the example.
• block (Proc) — the implementation of the example.

Returns

• (void)

#fexample(doc_string = nil, *flags, **metadata, &block) => void

Defines a deferred example using the fexample method.

Parameters

• doc_string (String) — the example's doc string.
• flags (Array<Symbol>) — metadata flags for the example. Will be transformed into metadata entries with true values.
• metadata (Hash) — metadata for the example.
• block (Proc) — the implementation of the example.

Returns

• (void)

#fit(doc_string = nil, *flags, **metadata, &block) => void

Defines a deferred example using the fit method.

Parameters

• doc_string (String) — the example's doc string.
• flags (Array<Symbol>) — metadata flags for the example. Will be transformed into metadata entries with true values.
• metadata (Hash) — metadata for the example.
• block (Proc) — the implementation of the example.

Returns

• (void)

#focus(doc_string = nil, *flags, **metadata, &block) => void

Defines a deferred example using the focus method.

Parameters

• doc_string (String) — the example's doc string.
• flags (Array<Symbol>) — metadata flags for the example. Will be transformed into metadata entries with true values.
• metadata (Hash) — metadata for the example.
• block (Proc) — the implementation of the example.

Returns

• (void)

#fspecify(doc_string = nil, *flags, **metadata, &block) => void

Defines a deferred example using the fspecify method.

Parameters

• doc_string (String) — the example's doc string.
• flags (Array<Symbol>) — metadata flags for the example. Will be transformed into metadata entries with true values.
• metadata (Hash) — metadata for the example.
• block (Proc) — the implementation of the example.

Returns

• (void)

#it(doc_string = nil, *flags, **metadata, &block) => void

Defines a deferred example using the it method.

Parameters

• doc_string (String) — the example's doc string.
• flags (Array<Symbol>) — metadata flags for the example. Will be transformed into metadata entries with true values.
• metadata (Hash) — metadata for the example.
• block (Proc) — the implementation of the example.

Returns

• (void)

#pending(doc_string = nil, *flags, **metadata, &block) => void

Defines a deferred example using the pending method.

Parameters

• doc_string (String) — the example's doc string.
• flags (Array<Symbol>) — metadata flags for the example. Will be transformed into metadata entries with true values.
• metadata (Hash) — metadata for the example.
• block (Proc) — the implementation of the example.

Returns

• (void)

#skip(doc_string = nil, *flags, **metadata, &block) => void

Defines a deferred example using the skip method.

Parameters

• doc_string (String) — the example's doc string.
• flags (Array<Symbol>) — metadata flags for the example. Will be transformed into metadata entries with true values.
• metadata (Hash) — metadata for the example.
• block (Proc) — the implementation of the example.

Returns

• (void)

#specify(doc_string = nil, *flags, **metadata, &block) => void

Defines a deferred example using the specify method.

Parameters

• doc_string (String) — the example's doc string.
• flags (Array<Symbol>) — metadata flags for the example. Will be transformed into metadata entries with true values.
• metadata (Hash) — metadata for the example.
• block (Proc) — the implementation of the example.

Returns

• (void)

#xexample(doc_string = nil, *flags, **metadata, &block) => void

Defines a deferred example using the xexample method.

Parameters

• doc_string (String) — the example's doc string.
• flags (Array<Symbol>) — metadata flags for the example. Will be transformed into metadata entries with true values.
• metadata (Hash) — metadata for the example.
• block (Proc) — the implementation of the example.

Returns

• (void)

#xit(doc_string = nil, *flags, **metadata, &block) => void

Defines a deferred example using the xit method.

Parameters

• doc_string (String) — the example's doc string.
• flags (Array<Symbol>) — metadata flags for the example. Will be transformed into metadata entries with true values.
• metadata (Hash) — metadata for the example.
• block (Proc) — the implementation of the example.

Returns

• (void)

#xspecify(doc_string = nil, *flags, **metadata, &block) => void

Defines a deferred example using the xspecify method.

Parameters

• doc_string (String) — the example's doc string.
• flags (Array<Symbol>) — metadata flags for the example. Will be transformed into metadata entries with true values.
• metadata (Hash) — metadata for the example.
• block (Proc) — the implementation of the example.

Returns

• (void)

Back To Top

---

Back to Documentation | Versions | 2.8.1 | Reference | RSpec | RSpec::SleepingKingStudios | RSpec::SleepingKingStudios::Deferred | RSpec::SleepingKingStudios::Deferred::Dsl