Module: RSpec::SleepingKingStudios::Concerns::WrapExamples

Parent Namespace

RSpec::SleepingKingStudios::Concerns

Defined In

lib/rspec/sleeping_king_studios/concerns/wrap_examples.rb

Table Of Contents

• Overview
• Instance Methods
  • fwrap_examples
  • wrap_examples
  • xwrap_examples

Overview

Methods for encapsulating shared example groups to include contexts or examples without affecting the surrounding context.

Back To Top

Instance Methods

#fwrap_examples name, *args, **kwargs, &block => Object

Also known as: fwrap_context

Includes the specified shared example group and wraps it inside a focused fdescribe block. If a block is provided, it is evaluated in the context of the fdescribe block after the example group has been included.

Parameters

• name (String) — The name of the shared example group to be wrapped.
• args (Array) — Optional array of arguments that are passed on to the shared example group.
• kwargs (Hash) — Optional hash of keyword arguments that are passed on to the shared example group.

Yields

• Additional code to run in the context of the wrapping fdescribe block, such as additional examples or memoized values.

#wrap_examples name, *args, **kwargs, &block => Object

Also known as: wrap_context

Includes the specified shared example group and wraps it inside a describe block. If a block is provided, it is evaluated in the context of the describe block after the example group has been included.

Parameters

• name (String) — The name of the shared example group to be wrapped.
• args (Array) — Optional array of arguments that are passed on to the shared example group.
• kwargs (Hash) — Optional hash of keyword arguments that are passed on to the shared example group.

Yields

• Additional code to run in the context of the wrapping describe block, such as additional examples or memoized values.

#xwrap_examples name, *args, **kwargs, &block => Object

Also known as: xwrap_context

Includes the specified shared example group and wraps it inside a skipped xdescribe block. If a block is provided, it is evaluated in the context of the xdescribe block after the example group has been included. Mostly used to temporarily disable a wrapped example group while updating or debugging a spec.

Parameters

• name (String) — The name of the shared example group to be wrapped.
• args (Array) — Optional array of arguments that are passed on to the shared example group.
• kwargs (Hash) — Optional hash of keyword arguments that are passed on to the shared example group.

Yields

• Additional code to run in the context of the wrapping fdescribe block, such as additional examples or memoized values.

Back To Top

---

Back to Documentation | Versions | 2.8 | Reference | RSpec | RSpec::SleepingKingStudios | RSpec::SleepingKingStudios::Concerns