Class RSpec::Core::ExampleGroup
In: lib/rspec/core/example_group.rb
Parent: Object

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

    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.

Methods

all_apply?   ancestors   any_apply?   around_hooks_for   assign_before_all_ivars   before_all_ivars   block_not_supported   children   declaration_line_numbers   define_example_method   define_nested_shared_group_method   delegate_to_metadata   descendant_filtered_examples   descendants   describe   described_class   ensure_example_groups_are_configured   examples   fail_fast?   fail_filtered_examples   filtered_examples   find_and_eval_shared   include_context   include_examples   instance_eval_with_rescue   metadata   register   run   run_after_all_hooks   run_after_each_hooks   run_around_each_hooks   run_before_all_hooks   run_before_each_hooks   run_examples   running_example   set_it_up   set_ivars   store_before_all_ivars   subclass   superclass_metadata   top_level?   top_level_description   world  

Included Modules

Extensions::InstanceEvalWithArgs Subject::ExampleMethods Pending Let

External Aliases

description -> display_name
described_class -> describes
  @private
define_example_method -> alias_example_to
define_nested_shared_group_method -> alias_it_should_behave_like_to
describe -> context

Attributes

example  [RW]  @attr_reader Returns the [Example](Example) object that wraps this instance of `ExampleGroup`

Public Class methods

ancestors()

@private

children()

@private

describe(*args, &example_group_block)

Generates a subclass of this example group which inherits everything except the examples themselves.

## Examples 

    describe "something" do # << This describe method is defined in
                            # << RSpec::Core::DSL, included in the
                            # << global namespace
      before do
        do_something_before
      end

      let(:thing) { Thing.new }

      describe "attribute (of something)" do
        # examples in the group get the before hook
        # declared above, and can access `thing`
      end
    end

@see DSL#describe

examples()

@private

include_context(name, *args)

Includes shared content declared with `name`.

@see SharedExampleGroup

include_examples(name, *args)

Includes shared content declared with `name`.

@see SharedExampleGroup

metadata()

The [Metadata](Metadata) object associated with this group. @see Metadata

register()

@private

run(reporter)

Runs all the examples in this group

superclass_metadata()

@private @return [Metadata] belonging to the parent of a nested [ExampleGroup](ExampleGroup)

world()

@private

Public Instance methods

described_class()

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

    describe Thing do
      it "does something" do
        described_class == Thing
      end
    end
instance_eval_with_rescue(&hook)

@private instance_evals the block, capturing and reporting an exception if raised

running_example()

@deprecated use [example](ExampleGroup#example-instance_method)

[Validate]