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 inadvertently 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

#initialize(example_group_class, description, user_metadata, example_block = nil) ⇒ Example

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.

Parameters:

  • example_group_class (Class) —

    the subclass of ExampleGroup in which this Example is declared

  • description (String) —

    the String passed to the it method (or alias)

  • user_metadata (Hash) —

    additional args passed to it to be used as metadata

  • example_block (Proc) (defaults to: nil) —

    the block of code that represents the example

186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/rspec/core/example.rb', line 186
def initialize(example_group_class, description, user_metadata, example_block=nil)
  @example_group_class = example_group_class
  @example_block       = example_block
  # Register the example with the group before creating the metadata hash.
  # This is necessary since creating the metadata hash triggers
  # `when_first_matching_example_defined` callbacks, in which users can
  # load RSpec support code which defines hooks. For that to work, the
  # examples and example groups must be registered at the time the
  # support code is called or be defined afterwards.
  # Begin defined beforehand but registered afterwards causes hooks to
  # not be applied where they should.
  example_group_class.examples << self
  @metadata = Metadata::ExampleHash.create(
    @example_group_class.metadata, user_metadata,
    example_group_class.method(:next_runnable_index_for),
    description, example_block
  )
  config = RSpec.configuration
  config.apply_derived_metadata_to(@metadata)
  # This should perhaps be done in `Metadata::ExampleHash.create`,
  # but the logic there has no knowledge of `RSpec.world` and we
  # want to keep it that way. It's easier to just assign it here.
  @metadata[:last_run_status] = config.last_run_statuses[id]
  @example_group_instance = @exception = nil
  @clock = RSpec::Core::Time
  @reporter = RSpec::Core::NullReporter
end

Instance Attribute Details

#exception ⇒ void (readonly)

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

158
159
160
 
# File 'lib/rspec/core/example.rb', line 158
def exception
  @exception
end

#metadata ⇒ void (readonly)

Returns the metadata object associated with this example.

163
164
165
 
# File 'lib/rspec/core/example.rb', line 163
def metadata
  @metadata
end

#reporter ⇒ RSpec::Core::Reporter (readonly)

Returns the current reporter for the example.

Returns:

226
227
228
 
# File 'lib/rspec/core/example.rb', line 226
def reporter
  @reporter
end

Instance Method Details

#description ⇒ void

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.

76
77
78
79
80
81
82
83
84
 
# File 'lib/rspec/core/example.rb', line 76
def description
  description = if metadata[:description].to_s.empty?
                  location_description
                else
                  metadata[:description]
                end
  RSpec.configuration.format_docstrings_block.call(description)
end

#duplicate_with(metadata_overrides = {}) ⇒ Example

Duplicates the example and overrides metadata with the provided hash.

Parameters:

  • metadata_overrides (Hash) (defaults to: {}) —

    the hash to override the example metadata

Returns:

  • (Example) —

    a duplicate of the example with modified metadata

132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/rspec/core/example.rb', line 132
def duplicate_with(metadata_overrides={})
  new_metadata = metadata.clone.merge(metadata_overrides)
  RSpec::Core::Metadata::RESERVED_KEYS.each do |reserved_key|
    new_metadata.delete reserved_key
  end
  # don't clone the example group because the new example
  # must belong to the same example group (not a clone).
  #
  # block is nil in new_metadata so we have to get it from metadata.
  Example.new(example_group, description.clone,
              new_metadata, metadata[:block])
end

#example_group ⇒ void

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

230
231
232
 
# File 'lib/rspec/core/example.rb', line 230
def example_group
  @example_group_class
end

#execution_result ⇒ ExecutionResult

Returns represents the result of running this example.

Returns:

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

#file_path ⇒ String

Returns the relative path to the file where this example was defined.

Returns:

  • (String) —

    the relative path to the file where this example was defined.

56
 
# File 'lib/rspec/core/example.rb', line 56
delegate_to_metadata :file_path

#full_description ⇒ String

Returns the full description (including the docstrings of all parent example groups).

Returns:

  • (String) —

    the full description (including the docstrings of all parent example groups).

59
 
# File 'lib/rspec/core/example.rb', line 59
delegate_to_metadata :full_description

#id ⇒ String

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

Returns:

  • (String) —

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

117
118
119
 
# File 'lib/rspec/core/example.rb', line 117
def id
  @id ||= Metadata.id_from(metadata)
end

#inspect ⇒ void Also known as: to_s

Provide a human-readable representation of this class

220
221
222
 
# File 'lib/rspec/core/example.rb', line 220
def inspect
  "#<#{self.class.name} #{description.inspect}>"
end

#inspect_output ⇒ void

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

87
88
89
90
91
92
93
 
# File 'lib/rspec/core/example.rb', line 87
def inspect_output
  inspect_output = "\"#{description}\""
  unless metadata[:description].to_s.empty?
    inspect_output += " (#{location})"
  end
  inspect_output
end

#location ⇒ String

Returns the exact source location of this example in a form like ./path/to/spec.rb:17.

Returns:

  • (String) —

    the exact source location of this example in a form like ./path/to/spec.rb:17

62
 
# File 'lib/rspec/core/example.rb', line 62
delegate_to_metadata :location

#location_rerun_argument ⇒ void

Returns the location-based argument that can be passed to the rspec command to rerun this example.

96
97
98
99
100
101
102
103
104
 
# File 'lib/rspec/core/example.rb', line 96
def location_rerun_argument
  @location_rerun_argument ||= begin
    loaded_spec_files = RSpec.configuration.loaded_spec_files
    Metadata.ascending(metadata) do |meta|
      return meta[:location] if loaded_spec_files.include?(meta[:absolute_file_path])
    end
  end
end

#pending ⇒ Boolean

Returns flag that indicates that the example is not expected to pass. It will be run and will either have a pending result (if a failure occurs) or a failed result (if no failure occurs).

Returns:

  • (Boolean) —

    flag that indicates that the example is not expected to pass. It will be run and will either have a pending result (if a failure occurs) or a failed result (if no failure occurs).

66
 
# File 'lib/rspec/core/example.rb', line 66
delegate_to_metadata :pending

#pending? ⇒ Boolean

Returns:

  • (Boolean) 
234
235
236
 
# File 'lib/rspec/core/example.rb', line 234
def pending?
  !!pending
end

#rerun_argument ⇒ void

Deprecated.

Use #location_rerun_argument instead.

Note:

If there are multiple examples identified by this location, they will use #id to rerun instead, but this method will still return the location (that's why it is deprecated!).

Returns the location-based argument that can be passed to the rspec command to rerun this example.

111
112
113
 
# File 'lib/rspec/core/example.rb', line 111
def rerun_argument
  location_rerun_argument
end

#run(example_group_instance, reporter) ⇒ void

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.

Parameters:

  • example_group_instance —

    the instance of an ExampleGroup subclass

246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/rspec/core/example.rb', line 246
def run(example_group_instance, reporter)
  @example_group_instance = example_group_instance
  @reporter = reporter
  RSpec.configuration.configure_example(self, hooks)
  RSpec.current_example = self
  start(reporter)
  Pending.mark_pending!(self, pending) if pending?
  begin
    if skipped?
      Pending.mark_pending! self, skip
    elsif !RSpec.configuration.dry_run?
      with_around_and_singleton_context_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 => _
          # The "=> _" is normally useless but on JRuby it is a workaround
          # for a bug that prevents us from getting backtraces:
          # https://github.com/jruby/jruby/issues/4467
          #
          # no-op, required metadata has already been set by the `skip`
          # method.
        rescue AllExceptionsExcludingDangerousOnesOnRubiesThatAllowIt => e
          set_exception(e)
        ensure
          run_after_example
        end
      end
    end
  rescue Support::AllExceptionsExceptOnesWeMustNotRescue => e
    set_exception(e)
  ensure
    @example_group_instance = nil # if you love something... let it go
  end
  finish(reporter)
ensure
  execution_result.ensure_timing_set(clock)
  RSpec.current_example = nil
end

#skip ⇒ Boolean

Returns flag that will cause the example to not run. The ExecutionResult status will be :pending.

Returns:

  • (Boolean) —

    flag that will cause the example to not run. The ExecutionResult status will be :pending.

69
 
# File 'lib/rspec/core/example.rb', line 69
delegate_to_metadata :skip

#skipped? ⇒ Boolean

Returns:

  • (Boolean) 
238
239
240
 
# File 'lib/rspec/core/example.rb', line 238
def skipped?
  !!skip
end