Class: RSpec::Core::ExampleGroup

Inherits:

Object

• Object
• RSpec::Core::ExampleGroup

show all

Extended by:

Hooks

Includes:

MemoizedHelpers, Pending, SharedExampleGroup

Defined in:

lib/rspec/core/example_group.rb

Overview

describe Thing do
  it "does something" do
  end
end

Constant Summary

Constant Summary

Constants included from Pending

Pending::NOT_YET_IMPLEMENTED, Pending::NO_REASON_GIVEN

Instance Attribute Summary (collapse)

• - (Object) example

  Returns the Example object that wraps this instance of ExampleGroup.

Class Method Summary (collapse)

• + (Object) alias_example_to(name, extra = {})

  Works like alias_method :name, :example with the added benefit of assigning default metadata to the generated example.

• + (Object) alias_it_behaves_like_to(name, *args, &block)

  Works like alias_method :name, :it_behaves_like with the added benefit of assigning default metadata to the generated example.

• + (Object) describe(*args, &example_group_block) (also: context)

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

• + (Object) description (also: display_name)
• + (Object) example

  Defines an example within a group.

• + (Object) focus

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

• + (Object) focused

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

• + (Object) include_context(name, *args, &block)

  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.

• + (Object) include_examples(name, *args, &block)

  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.

• + (Object) it

  Defines an example within a group.

• + (Object) it_behaves_like

  Generates a nested example group and includes the shared content mapped to name in the nested group.

• + (Object) it_should_behave_like

  Generates a nested example group and includes the shared content mapped to name in the nested group.

• + (Object) metadata

  The Metadata object associated with this group.

• + (Object) pending

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

• + (Object) run(reporter)

  Runs all the examples in this group.

• + (Object) specify

  Defines an example within a group.

• + (Object) xexample

  Shortcut to define an example with :pending => 'Temporarily disabled with xexample'.

• + (Object) xit

  Shortcut to define an example with :pending => 'Temporarily disabled with xit'.

• + (Object) xspecify

  Shortcut to define an example with :pending => 'Temporarily disabled with xspecify'.

Instance Method Summary (collapse)

• - (Object) described_class

  Returns the class or module passed to the describe method (or alias).

• - (Object) running_example deprecated Deprecated.

  use #example

Methods included from Hooks

after, append_after, around, before, prepend_before

Methods included from SharedExampleGroup

#share_as, #shared_example_groups, #shared_examples

Methods included from Pending

#pending

Methods included from MemoizedHelpers

#should, #should_not, #subject

443
444
445

# File 'lib/rspec/core/example_group.rb', line 443

def example
  @example
end

105
106
107

# File 'lib/rspec/core/example_group.rb', line 105

def alias_example_to name, extra={}
  (class << self; self; end).define_example_method name, extra
end

139
140
141

# File 'lib/rspec/core/example_group.rb', line 139

def alias_it_behaves_like_to name, *args, &block
  (class << self; self; end).define_nested_shared_group_method name, *args, &block
end

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

219
220
221
222
223
224
225
226
227
228
229
230
231
232

# File 'lib/rspec/core/example_group.rb', line 219

def self.describe(*args, &example_group_block)
  @_subclass_count ||= 0
  @_subclass_count += 1
  args << {} unless args.last.is_a?(Hash)
  args.last.update(:example_group_block => example_group_block)

  # TODO 2010-05-05: Because we don't know if const_set is thread-safe
  child = const_set(
    "Nested_#{@_subclass_count}",
    subclass(self, args, &example_group_block)
  )
  children << child
  child
end

45
46
47
48

# File 'lib/rspec/core/example_group.rb', line 45

def description
  description = metadata[:example_group][:description]
  RSpec.configuration.format_docstrings_block.call(description)
end

73

# File 'lib/rspec/core/example_group.rb', line 73

define_example_method :example

85

# File 'lib/rspec/core/example_group.rb', line 85

define_example_method :focus,   :focused => true, :focus => true

87

# File 'lib/rspec/core/example_group.rb', line 87

define_example_method :focused, :focused => true, :focus => true

149
150
151

# File 'lib/rspec/core/example_group.rb', line 149

def self.include_context(name, *args, &block)
  find_and_eval_shared("context", name, *args, &block)
end

158
159
160

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

def self.include_examples(name, *args, &block)
  find_and_eval_shared("examples", name, *args, &block)
end

77

# File 'lib/rspec/core/example_group.rb', line 77

define_example_method :it

127

# File 'lib/rspec/core/example_group.rb', line 127

define_nested_shared_group_method :it_behaves_like, "behaves like"

130

# File 'lib/rspec/core/example_group.rb', line 130

define_nested_shared_group_method :it_should_behave_like

188
189
190

# File 'lib/rspec/core/example_group.rb', line 188

def self.metadata
  @metadata if defined?(@metadata)
end

90

# File 'lib/rspec/core/example_group.rb', line 90

define_example_method :pending,  :pending => true

362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382

# File 'lib/rspec/core/example_group.rb', line 362

def self.run(reporter)
  if RSpec.wants_to_quit
    RSpec.clear_remaining_example_groups if top_level?
    return
  end
  reporter.example_group_started(self)

  begin
    run_before_all_hooks(new)
    result_for_this_group = run_examples(reporter)
    results_for_descendants = children.ordered.map {|child| child.run(reporter)}.all?
    result_for_this_group && results_for_descendants
  rescue Exception => ex
    RSpec.wants_to_quit = true if fail_fast?
    fail_filtered_examples(ex, reporter)
  ensure
    run_after_all_hooks(new)
    before_all_ivars.clear
    reporter.example_group_finished(self)
  end
end

82

# File 'lib/rspec/core/example_group.rb', line 82

define_example_method :specify

92

# File 'lib/rspec/core/example_group.rb', line 92

define_example_method :xexample, :pending => 'Temporarily disabled with xexample'

94

# File 'lib/rspec/core/example_group.rb', line 94

define_example_method :xit,      :pending => 'Temporarily disabled with xit'

96

# File 'lib/rspec/core/example_group.rb', line 96

define_example_method :xspecify, :pending => 'Temporarily disabled with xspecify'

describe Thing do
  it "does something" do
    described_class == Thing
  end
end

462
463
464

# File 'lib/rspec/core/example_group.rb', line 462

def described_class
  self.class.described_class
end

446
447
448
449
450

# File 'lib/rspec/core/example_group.rb', line 446

def running_example
  RSpec.deprecate("running_example",
                  :replacement => "example")
  example
end