Class: RSpec::Core::Example

Inherits:
Object
  • Object
show all
Defined in:
lib/rspec/core/example.rb

Overview

Note:

Example blocks are evaluated in the context of an instance of an ExampleGroup, not in the context of an instance of Example.

Wrapper for an instance of a subclass of ExampleGroup. An instance of RSpec::Core::Example is returned by example definition methods such as it and is yielded to the it, before, after, around, let and subject blocks.

This allows us to provide rich metadata about each individual example without adding tons of methods directly to the ExampleGroup that users may inadvertantly redefine.

Useful for configuring logging and/or taking some action based on the state of an example's metadata.

Examples:


RSpec.configure do |config|
  config.before do |example|
    log example.description
  end

  config.after do |example|
    log example.description
  end

  config.around do |example|
    log example.description
    example.run
  end
end

shared_examples "auditable" do
  it "does something" do
    log "#{example.full_description}: #{auditable.inspect}"
    auditable.should do_something
  end
end

See Also:

Defined Under Namespace

Classes: ExecutionResult, Procsy

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Example) initialize(example_group_class, description, user_metadata, example_block = nil)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Creates a new instance of Example.



122
123
124
125
126
127
128
129
130
131
132
# File 'lib/rspec/core/example.rb', line 122

def initialize(example_group_class, description, , example_block=nil)
  @example_group_class = example_group_class
  @example_block       = example_block

  @metadata = Metadata::ExampleHash.create(
    @example_group_class., , description, example_block
  )

  @example_group_instance = @exception = nil
  @clock = RSpec::Core::Time
end

Instance Attribute Details

- (void) exception (readonly)

Returns the first exception raised in the context of running this example (nil if no exception is raised)



98
99
100
# File 'lib/rspec/core/example.rb', line 98

def exception
  @exception
end

- (void) metadata (readonly)

Returns the metadata object associated with this example.



103
104
105
# File 'lib/rspec/core/example.rb', line 103

def 
  @metadata
end

Instance Method Details

- (void) description

Returns the string submitted to example or its aliases (e.g. specify, it, etc). If no string is submitted (e.g. it { is_expected.to do_something }) it returns the message generated by the matcher if there is one, otherwise returns a message including the location of the example.



75
76
77
78
79
80
81
82
83
# File 'lib/rspec/core/example.rb', line 75

def description
  description = if [:description].to_s.empty?
                  "example at #{location}"
                else
                  [:description]
                end

  RSpec.configuration.format_docstrings_block.call(description)
end

- (void) example_group

Returns the example group class that provides the context for running this example.



136
137
138
# File 'lib/rspec/core/example.rb', line 136

def example_group
  @example_group_class
end

- (ExecutionResult) execution_result



53
# File 'lib/rspec/core/example.rb', line 53

 :execution_result

- (String) file_path



55
# File 'lib/rspec/core/example.rb', line 55

 :file_path

- (String) full_description



58
# File 'lib/rspec/core/example.rb', line 58

 :full_description

- (void) inspect_output

Returns a description of the example that always includes the location.



86
87
88
89
90
91
92
# File 'lib/rspec/core/example.rb', line 86

def inspect_output
  inspect_output = "\"#{description}\""
  unless [:description].to_s.empty?
    inspect_output << " (#{location})"
  end
  inspect_output
end

- (String) location



61
# File 'lib/rspec/core/example.rb', line 61

 :location

- (Boolean) pending Also known as: pending?



65
# File 'lib/rspec/core/example.rb', line 65

 :pending

- (void) run(example_group_instance, reporter)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

instance_execs the block passed to the constructor in the context of the instance of RSpec::Core::ExampleGroup.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
# File 'lib/rspec/core/example.rb', line 147

def run(example_group_instance, reporter)
  @example_group_instance = example_group_instance
  RSpec.current_example = self

  start(reporter)

  begin
    if skipped?
      Pending.mark_pending! self, skip
    elsif !RSpec.configuration.dry_run?
      with_around_example_hooks do
        begin
          run_before_example
          @example_group_instance.instance_exec(self, &@example_block)

          if pending?
            Pending.mark_fixed! self

            raise Pending::PendingExampleFixedError,
                  'Expected example to fail since it is pending, but it passed.',
                  [location]
          end
        rescue Pending::SkipDeclaredInExample
          # no-op, required metadata has already been set by the `skip`
          # method.
        rescue Exception => e
          set_exception(e)
        ensure
          run_after_example
        end
      end
    end
  rescue Exception => e
    set_exception(e)
  ensure
    ExampleGroup.instance_variables_for_example(@example_group_instance).each do |ivar|
      @example_group_instance.instance_variable_set(ivar, nil)
    end
    @example_group_instance = nil
  end

  finish(reporter)
ensure
  RSpec.current_example = nil
end

- (Boolean) skip Also known as: skipped?



68
# File 'lib/rspec/core/example.rb', line 68

 :skip