Class: RSpec::Core::SharedExampleGroupInclusionStackFrame

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

Overview

Contains information about the inclusion site of a shared example group.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(shared_group_name, inclusion_location) ⇒ SharedExampleGroupInclusionStackFrame

Returns a new instance of SharedExampleGroupInclusionStackFrame.



668
669
670
671
 
# File 'lib/rspec/core/example_group.rb', line 668

def initialize(shared_group_name, inclusion_location)
  @shared_group_name  = shared_group_name
  @inclusion_location = inclusion_location
end

Instance Attribute Details

#inclusion_location ⇒ String (readonly)

Returns the location where the shared example was included.

Returns:

  • (String) —

    the location where the shared example was included



666
667
668
 
# File 'lib/rspec/core/example_group.rb', line 666

def inclusion_location
  @inclusion_location
end

#shared_group_name ⇒ String (readonly)

Returns the name of the shared example group.

Returns:

  • (String) —

    the name of the shared example group



664
665
666
 
# File 'lib/rspec/core/example_group.rb', line 664

def shared_group_name
  @shared_group_name
end

Instance Method Details

#description ⇒ String

Returns Description of this stack frame, in the form used by RSpec's built-in formatters.

Returns:

  • (String) —

    Description of this stack frame, in the form used by RSpec's built-in formatters.



684
685
686
687
 
# File 'lib/rspec/core/example_group.rb', line 684

def description
  @description ||= "Shared Example Group: #{shared_group_name.inspect} " \
    "called from #{formatted_inclusion_location}"
end

#formatted_inclusion_location ⇒ String

Returns The #inclusion_location, formatted for display by a formatter.

Returns:



674
675
676
677
678
679
680
 
# File 'lib/rspec/core/example_group.rb', line 674

def formatted_inclusion_location
  @formatted_inclusion_location ||= begin
    RSpec.configuration.backtrace_formatter.backtrace_line(
      inclusion_location.sub(/(:\d+):in .+$/, '\1')
    )
  end
end