class RSpec::Core::Example

@see ExampleGroup<br>(Hooks#around-instance_method) hooks.<br>(Hooks#after-instance_method) hooks, and yielded to
examples, [before](Hooks#before-instance_method) and<br>(ExampleGroup#example-instance_method) method available in
instance of ‘Example` is returned by the
Wrapper for an instance of a subclass of [ExampleGroup](ExampleGroup). An

def self.delegate_to_metadata(*keys)

Other tags:
    Private: -
def self.delegate_to_metadata(*keys)
  keys.each do |key|
    define_method(key) {@metadata[key]}
  end
end

def self.procsy(metadata, &proc)

Other tags:
    Private: -
def self.procsy(metadata, &proc)
  Proc.new(&proc).extend(Procsy).with(metadata)
end

def all_apply?(filters)

Other tags:
    Private: -
def all_apply?(filters)
  @metadata.all_apply?(filters) || @example_group_class.all_apply?(filters)
end

def any_apply?(filters)

Other tags:
    Private: -
def any_apply?(filters)
  metadata.any_apply?(filters)
end

def around_hooks

Other tags:
    Private: -
def around_hooks
  @around_hooks ||= example_group.around_hooks_for(self)
end

def assign_auto_description

def assign_auto_description
  if description.empty? and !pending?
    if RSpec.configuration.expecting_with_rspec?
      metadata[:description] = RSpec::Matchers.generated_description
      RSpec::Matchers.clear_generated_description
    else
      raise NotImplementedError.new(
        "Generated descriptions are only supported when you use rspec-expectations.  " +
        "You must give every example an explicit description."
      )
    end
  end
end

def example_group

this example.
Returns the example group class that provides the context for running
def example_group
  @example_group_class
end

def fail_with_exception(reporter, exception)

Other tags:
    Private: -
def fail_with_exception(reporter, exception)
  start(reporter)
  set_exception(exception)
  finish(reporter)
end

def finish(reporter)

def finish(reporter)
  if @exception
    @exception.extend(NotPendingExampleFixed) unless @exception.respond_to?(:pending_fixed?)
    record_finished 'failed', :exception => @exception
    reporter.example_failed self
    false
  elsif @pending_declared_in_example
    record_finished 'pending', :pending_message => @pending_declared_in_example
    reporter.example_pending self
    true
  elsif pending
    record_finished 'pending', :pending_message => String === pending ? pending : Pending::NO_REASON_GIVEN
    reporter.example_pending self
    true
  else
    record_finished 'passed'
    reporter.example_passed self
    true
  end
end

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

Parameters:
  • example_block () -- the block of code that represents the example
  • metadata () -- additional args passed to `it` to be used as metadata
  • description () -- the String passed to the `it` method (or alias)
  • example_group_class () -- the subclass of ExampleGroup in which this Example is declared
def initialize(example_group_class, description, metadata, example_block=nil)
  @example_group_class, @options, @example_block = example_group_class, metadata, example_block
  @metadata  = @example_group_class.metadata.for_example(description, metadata)
  @exception = nil
  @pending_declared_in_example = false
end

def options

Deprecated:
  • access options via metadata instead
def options
  @options
end

def record(results={})

def record(results={})
  execution_result.update(results)
end

def record_finished(status, results={})

def record_finished(status, results={})
  finished_at = Time.now
  record results.merge(:status => status, :finished_at => finished_at, :run_time => (finished_at - execution_result[:started_at]))
end

def run(example_group_instance, reporter)

Parameters:
  • example_group_instance () -- the instance of an ExampleGroup subclass

Other tags:
    Api: - private
def run(example_group_instance, reporter)
  @example_group_instance = example_group_instance
  @example_group_instance.example = self
  start(reporter)
  begin
    unless pending
      with_around_hooks do
        begin
          run_before_each
          @example_group_instance.instance_eval(&@example_block)
        rescue Pending::PendingDeclaredInExample => e
          @pending_declared_in_example = e.message
        rescue Exception => e
          set_exception(e)
        ensure
          run_after_each
        end
      end
    end
  rescue Exception => e
    set_exception(e)
  ensure
    @example_group_instance.instance_variables.each do |ivar|
      @example_group_instance.instance_variable_set(ivar, nil)
    end
    @example_group_instance = nil
    begin
      assign_auto_description
    rescue Exception => e
      set_exception(e)
    end
  end
  finish(reporter)
end

def run_after_each

def run_after_each
  @example_group_class.run_after_each_hooks(self)
  @example_group_instance.verify_mocks_for_rspec if @example_group_instance.respond_to?(:verify_mocks_for_rspec)
ensure
  @example_group_instance.teardown_mocks_for_rspec if @example_group_instance.respond_to?(:teardown_mocks_for_rspec)
end

def run_before_each

def run_before_each
  @example_group_instance.setup_mocks_for_rspec if @example_group_instance.respond_to?(:setup_mocks_for_rspec)
  @example_group_class.run_before_each_hooks(self)
end

def set_exception(exception)

Other tags:
    Private: -
def set_exception(exception)
  @exception ||= exception
end

def start(reporter)

def start(reporter)
  reporter.example_started(self)
  record :started_at => Time.now
end

def with_around_hooks(&block)

def with_around_hooks(&block)
  if around_hooks.empty?
    yield
  else
    @example_group_class.run_around_each_hooks(self, Example.procsy(metadata, &block)).call
  end
end