Class: RSpec::Core::ExampleGroup

Inherits:
Object
  • Object
show all
Extended by:
Hooks, MemoizedHelpers::ClassMethods, SharedExampleGroup
Includes:
MemoizedHelpers, Pending
Defined in:
lib/rspec/core/example_group.rb

Overview

ExampleGroup and Example are the main structural elements of rspec-core. Consider this example:

RSpec.describe Thing do
  it "does something" do
  end
end

The object returned by describe Thing is a subclass of ExampleGroup. The object returned by it "does something" is an instance of Example, which serves as a wrapper for an instance of the ExampleGroup in which it is declared.

Example group bodies (e.g. describe or context blocks) are evaluated in the context of a new subclass of ExampleGroup. Individual examples are evaluated in the context of an instance of the specific ExampleGroup subclass to which they belong.

Besides the class methods defined here, there are other interesting macros defined in Hooks, MemoizedHelpers::ClassMethods and SharedExampleGroup. There are additional instance methods available to your examples defined in MemoizedHelpers and Pending.

Constant Summary collapse

WrongScopeError =

Raised when an RSpec API is called in the wrong scope, such as before being called from within an example rather than from within an example group block.

Class.new(NoMethodError)

Metadata collapse

Defining Examples collapse

Including Shared Example Groups collapse

Class Method Summary collapse

Methods included from Hooks

after, append_after, around, before, prepend_before

Methods included from MemoizedHelpers::ClassMethods

let, let!, subject, subject!

Methods included from SharedExampleGroup

shared_examples

Methods included from Pending

#pending, #skip

Methods included from MemoizedHelpers

#is_expected, #should, #should_not, #subject

Class Method Details

.add_example(example) ⇒ void

Adds an example to the example group

367
368
369
370
 
# File 'lib/rspec/core/example_group.rb', line 367
def self.add_example(example)
  reset_memoized
  examples << example
end

.currently_executing_a_context_hook? ⇒ Boolean

Returns true if a before(:context) or after(:context) hook is currently executing.

Returns:

  • (Boolean) 
542
543
544
 
# File 'lib/rspec/core/example_group.rb', line 542
def self.currently_executing_a_context_hook?
  @currently_executing_a_context_hook
end

.description ⇒ String

Returns the current example group description.

Returns:

  • (String) —

    the current example group description

85
86
87
88
 
# File 'lib/rspec/core/example_group.rb', line 85
def self.description
  description = metadata[:description]
  RSpec.configuration.format_docstrings_block.call(description)
end

.example ⇒ void .example(&example_implementation) ⇒ void .example(doc_string, *metadata) ⇒ void .example(doc_string, *metadata, &example_implementation) ⇒ void

Defines an example within a group.

Examples:

example do
end
example "does something" do
end
example "does something", :slow, :uses_js do
end
example "does something", :with => 'additional metadata' do
end
example "does something" do |ex|
  # ex is the Example object that contains metadata about the example
end

Overloads:

  • .example(&example_implementation) ⇒ void

    Parameters:

    • example_implementation (Block) —

      The implementation of the example.

  • .example(doc_string, *metadata) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

  • .example(doc_string, *metadata, &example_implementation) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

    • example_implementation (Block) —

      The implementation of the example.

Yields:

158
 
# File 'lib/rspec/core/example_group.rb', line 158
define_example_method :example

.fexample ⇒ void .fexample(&example_implementation) ⇒ void .fexample(doc_string, *metadata) ⇒ void .fexample(doc_string, *metadata, &example_implementation) ⇒ void

Shortcut to define an example with :focus => true.

Examples:

fexample do
end
fexample "does something" do
end
fexample "does something", :slow, :uses_js do
end
fexample "does something", :with => 'additional metadata' do
end
fexample "does something" do |ex|
  # ex is the Example object that contains metadata about the example
end

Overloads:

  • .fexample(&example_implementation) ⇒ void

    Parameters:

    • example_implementation (Block) —

      The implementation of the example.

  • .fexample(doc_string, *metadata) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

  • .fexample(doc_string, *metadata, &example_implementation) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

    • example_implementation (Block) —

      The implementation of the example.

Yields:

See Also:

177
 
# File 'lib/rspec/core/example_group.rb', line 177
define_example_method :fexample, :focus => true

.fit ⇒ void .fit(&example_implementation) ⇒ void .fit(doc_string, *metadata) ⇒ void .fit(doc_string, *metadata, &example_implementation) ⇒ void

Shortcut to define an example with :focus => true.

Examples:

fit do
end
fit "does something" do
end
fit "does something", :slow, :uses_js do
end
fit "does something", :with => 'additional metadata' do
end
fit "does something" do |ex|
  # ex is the Example object that contains metadata about the example
end

Overloads:

  • .fit(&example_implementation) ⇒ void

    Parameters:

    • example_implementation (Block) —

      The implementation of the example.

  • .fit(doc_string, *metadata) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

  • .fit(doc_string, *metadata, &example_implementation) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

    • example_implementation (Block) —

      The implementation of the example.

Yields:

See Also:

180
 
# File 'lib/rspec/core/example_group.rb', line 180
define_example_method :fit,      :focus => true

.focus ⇒ void .focus(&example_implementation) ⇒ void .focus(doc_string, *metadata) ⇒ void .focus(doc_string, *metadata, &example_implementation) ⇒ void

Shortcut to define an example with :focus => true.

Examples:

focus do
end
focus "does something" do
end
focus "does something", :slow, :uses_js do
end
focus "does something", :with => 'additional metadata' do
end
focus "does something" do |ex|
  # ex is the Example object that contains metadata about the example
end

Overloads:

  • .focus(&example_implementation) ⇒ void

    Parameters:

    • example_implementation (Block) —

      The implementation of the example.

  • .focus(doc_string, *metadata) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

  • .focus(doc_string, *metadata, &example_implementation) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

    • example_implementation (Block) —

      The implementation of the example.

Yields:

See Also:

174
 
# File 'lib/rspec/core/example_group.rb', line 174
define_example_method :focus,    :focus => true

.fspecify ⇒ void .fspecify(&example_implementation) ⇒ void .fspecify(doc_string, *metadata) ⇒ void .fspecify(doc_string, *metadata, &example_implementation) ⇒ void

Shortcut to define an example with :focus => true.

Examples:

fspecify do
end
fspecify "does something" do
end
fspecify "does something", :slow, :uses_js do
end
fspecify "does something", :with => 'additional metadata' do
end
fspecify "does something" do |ex|
  # ex is the Example object that contains metadata about the example
end

Overloads:

  • .fspecify(&example_implementation) ⇒ void

    Parameters:

    • example_implementation (Block) —

      The implementation of the example.

  • .fspecify(doc_string, *metadata) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

  • .fspecify(doc_string, *metadata, &example_implementation) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

    • example_implementation (Block) —

      The implementation of the example.

Yields:

See Also:

183
 
# File 'lib/rspec/core/example_group.rb', line 183
define_example_method :fspecify, :focus => true

.id ⇒ String

Returns the unique id of this example group. Pass this at the command line to re-run this exact example group.

Returns:

  • (String) —

    the unique id of this example group. Pass this at the command line to re-run this exact example group.

675
676
677
 
# File 'lib/rspec/core/example_group.rb', line 675
def self.id
  Metadata.id_from(metadata)
end

.include_context(name, *args, &block) ⇒ void

Includes shared content mapped to name directly in the group in which it is declared, as opposed to it_behaves_like, which creates a nested group. If given a block, that block is also eval'd in the current context.

See Also:

343
344
345
 
# File 'lib/rspec/core/example_group.rb', line 343
def self.include_context(name, *args, &block)
  find_and_eval_shared("context", name, caller.first, *args, &block)
end

.include_examples(name, *args, &block) ⇒ void

Includes shared content mapped to name directly in the group in which it is declared, as opposed to it_behaves_like, which creates a nested group. If given a block, that block is also eval'd in the current context.

See Also:

353
354
355
 
# File 'lib/rspec/core/example_group.rb', line 353
def self.include_examples(name, *args, &block)
  find_and_eval_shared("examples", name, caller.first, *args, &block)
end

.it ⇒ void .it(&example_implementation) ⇒ void .it(doc_string, *metadata) ⇒ void .it(doc_string, *metadata, &example_implementation) ⇒ void

Defines an example within a group. This is the primary API to define a code example.

Examples:

it do
end
it "does something" do
end
it "does something", :slow, :uses_js do
end
it "does something", :with => 'additional metadata' do
end
it "does something" do |ex|
  # ex is the Example object that contains metadata about the example
end

Overloads:

  • .it(&example_implementation) ⇒ void

    Parameters:

    • example_implementation (Block) —

      The implementation of the example.

  • .it(doc_string, *metadata) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

  • .it(doc_string, *metadata, &example_implementation) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

    • example_implementation (Block) —

      The implementation of the example.

Yields:

161
 
# File 'lib/rspec/core/example_group.rb', line 161
define_example_method :it

.metadata ⇒ void

The Metadata object associated with this group.

See Also:

51
52
53
 
# File 'lib/rspec/core/example_group.rb', line 51
def self.metadata
  @metadata ||= nil
end

.pending ⇒ void .pending(&example_implementation) ⇒ void .pending(doc_string, *metadata) ⇒ void .pending(doc_string, *metadata, &example_implementation) ⇒ void

Shortcut to define an example with :pending => true

Examples:

pending do
end
pending "does something" do
end
pending "does something", :slow, :uses_js do
end
pending "does something", :with => 'additional metadata' do
end
pending "does something" do |ex|
  # ex is the Example object that contains metadata about the example
end

Overloads:

  • .pending(&example_implementation) ⇒ void

    Parameters:

    • example_implementation (Block) —

      The implementation of the example.

  • .pending(doc_string, *metadata) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

  • .pending(doc_string, *metadata, &example_implementation) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

    • example_implementation (Block) —

      The implementation of the example.

Yields:

See Also:

198
 
# File 'lib/rspec/core/example_group.rb', line 198
define_example_method :pending,  :pending => true

.remove_example(example) ⇒ void

Removes an example from the example group

373
374
375
376
 
# File 'lib/rspec/core/example_group.rb', line 373
def self.remove_example(example)
  reset_memoized
  examples.delete example
end

.run(reporter = RSpec::Core::NullReporter) ⇒ void

Runs all the examples in this group.

599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'lib/rspec/core/example_group.rb', line 599
def self.run(reporter=RSpec::Core::NullReporter)
  return if RSpec.world.wants_to_quit
  reporter.example_group_started(self)
  should_run_context_hooks = descendant_filtered_examples.any?
  begin
    RSpec.current_scope = :before_context_hook
    run_before_context_hooks(new('before(:context) hook')) if should_run_context_hooks
    result_for_this_group = run_examples(reporter)
    results_for_descendants = ordering_strategy.order(children).map { |child| child.run(reporter) }.all?
    result_for_this_group && results_for_descendants
  rescue Pending::SkipDeclaredInExample => ex
    for_filtered_examples(reporter) { |example| example.skip_with_exception(reporter, ex) }
    true
  rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex
    for_filtered_examples(reporter) { |example| example.fail_with_exception(reporter, ex) }
    RSpec.world.wants_to_quit = true if reporter.fail_fast_limit_met?
    false
  ensure
    RSpec.current_scope = :after_context_hook
    run_after_context_hooks(new('after(:context) hook')) if should_run_context_hooks
    reporter.example_group_finished(self)
  end
end

.skip ⇒ void .skip(&example_implementation) ⇒ void .skip(doc_string, *metadata) ⇒ void .skip(doc_string, *metadata, &example_implementation) ⇒ void

Shortcut to define an example with :skip => true

Examples:

skip do
end
skip "does something" do
end
skip "does something", :slow, :uses_js do
end
skip "does something", :with => 'additional metadata' do
end
skip "does something" do |ex|
  # ex is the Example object that contains metadata about the example
end

Overloads:

  • .skip(&example_implementation) ⇒ void

    Parameters:

    • example_implementation (Block) —

      The implementation of the example.

  • .skip(doc_string, *metadata) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

  • .skip(doc_string, *metadata, &example_implementation) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

    • example_implementation (Block) —

      The implementation of the example.

Yields:

See Also:

195
 
# File 'lib/rspec/core/example_group.rb', line 195
define_example_method :skip,     :skip => true

.specify ⇒ void .specify(&example_implementation) ⇒ void .specify(doc_string, *metadata) ⇒ void .specify(doc_string, *metadata, &example_implementation) ⇒ void

Defines an example within a group. Useful for when your docstring does not read well off of it.

Examples:

RSpec.describe MyClass do
  specify "#do_something is deprecated" do
    # ...
  end
end
specify do
end
specify "does something" do
end
specify "does something", :slow, :uses_js do
end
specify "does something", :with => 'additional metadata' do
end
specify "does something" do |ex|
  # ex is the Example object that contains metadata about the example
end

Overloads:

  • .specify(&example_implementation) ⇒ void

    Parameters:

    • example_implementation (Block) —

      The implementation of the example.

  • .specify(doc_string, *metadata) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

  • .specify(doc_string, *metadata, &example_implementation) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

    • example_implementation (Block) —

      The implementation of the example.

Yields:

170
 
# File 'lib/rspec/core/example_group.rb', line 170
define_example_method :specify

.xexample ⇒ void .xexample(&example_implementation) ⇒ void .xexample(doc_string, *metadata) ⇒ void .xexample(doc_string, *metadata, &example_implementation) ⇒ void

Shortcut to define an example with :skip => 'Temporarily skipped with xexample'.

Examples:

xexample do
end
xexample "does something" do
end
xexample "does something", :slow, :uses_js do
end
xexample "does something", :with => 'additional metadata' do
end
xexample "does something" do |ex|
  # ex is the Example object that contains metadata about the example
end

Overloads:

  • .xexample(&example_implementation) ⇒ void

    Parameters:

    • example_implementation (Block) —

      The implementation of the example.

  • .xexample(doc_string, *metadata) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

  • .xexample(doc_string, *metadata, &example_implementation) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

    • example_implementation (Block) —

      The implementation of the example.

Yields:

See Also:

186
 
# File 'lib/rspec/core/example_group.rb', line 186
define_example_method :xexample, :skip => 'Temporarily skipped with xexample'

.xit ⇒ void .xit(&example_implementation) ⇒ void .xit(doc_string, *metadata) ⇒ void .xit(doc_string, *metadata, &example_implementation) ⇒ void

Shortcut to define an example with :skip => 'Temporarily skipped with xit'.

Examples:

xit do
end
xit "does something" do
end
xit "does something", :slow, :uses_js do
end
xit "does something", :with => 'additional metadata' do
end
xit "does something" do |ex|
  # ex is the Example object that contains metadata about the example
end

Overloads:

  • .xit(&example_implementation) ⇒ void

    Parameters:

    • example_implementation (Block) —

      The implementation of the example.

  • .xit(doc_string, *metadata) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

  • .xit(doc_string, *metadata, &example_implementation) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

    • example_implementation (Block) —

      The implementation of the example.

Yields:

See Also:

189
 
# File 'lib/rspec/core/example_group.rb', line 189
define_example_method :xit,      :skip => 'Temporarily skipped with xit'

.xspecify ⇒ void .xspecify(&example_implementation) ⇒ void .xspecify(doc_string, *metadata) ⇒ void .xspecify(doc_string, *metadata, &example_implementation) ⇒ void

Shortcut to define an example with :skip => 'Temporarily skipped with xspecify'.

Examples:

xspecify do
end
xspecify "does something" do
end
xspecify "does something", :slow, :uses_js do
end
xspecify "does something", :with => 'additional metadata' do
end
xspecify "does something" do |ex|
  # ex is the Example object that contains metadata about the example
end

Overloads:

  • .xspecify(&example_implementation) ⇒ void

    Parameters:

    • example_implementation (Block) —

      The implementation of the example.

  • .xspecify(doc_string, *metadata) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

  • .xspecify(doc_string, *metadata, &example_implementation) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Array<Symbol>, Hash) —

      Metadata for the example. Symbols will be transformed into hash entries with true values.

    • example_implementation (Block) —

      The implementation of the example.

Yields:

See Also:

192
 
# File 'lib/rspec/core/example_group.rb', line 192
define_example_method :xspecify, :skip => 'Temporarily skipped with xspecify'

Instance Method Details

#described_class ⇒ void

Returns the class or module passed to the describe method (or alias). Returns nil if the subject is not a class or module.

Examples:

RSpec.describe Thing do
  it "does something" do
    described_class == Thing
  end
end
99
100
101
 
# File 'lib/rspec/core/example_group.rb', line 99
def described_class
  self.class.described_class
end