class RSpec::Core::Formatters::HtmlSnippetExtractor

@api private

Extracts code snippets by looking at the backtrace of the passed error and applies synax highlighting and line numbers using html.

Public Instance Methods

lines_around (file, line)

@api private

Extract lines of code centered around a particular line within a source file.

@param file [String] filename @param line [Fixnum] line number @return [String] lines around the target line within the file (2 above

and 1 below).

# File rspec-core/lib/rspec/core/formatters/html_snippet_extractor.rb, line 84
def lines_around(file, line)
  if File.file?(file)
    lines = File.read(file).split("\n")
    min = [0, line - 3].max
    max = [line + 1, lines.length - 1].min
    selected_lines = []
    selected_lines.join("\n")
    lines[min..max].join("\n")
  else
    "# Couldn't get snippet for #{file}"
  end
rescue SecurityError
  # :nocov: - SecurityError is no longer produced starting in ruby 2.7
  "# Couldn't get snippet for #{file}"
  # :nocov:
end

post_process (highlighted, offending_line)

@api private

Adds line numbers to all lines and highlights the line where the failure occurred using html ‘span` tags.

@param highlighted [String] syntax-highlighted snippet surrounding the

offending line of code

@param offending_line [Fixnum] line where failure occurred @return [String] completed snippet

# File rspec-core/lib/rspec/core/formatters/html_snippet_extractor.rb, line 110
def post_process(highlighted, offending_line)
  new_lines = []
  highlighted.split("\n").each_with_index do |line, i|
    new_line = "<span class=\"linenum\">#{offending_line + i - 2}</span>#{line}"
    new_line = "<span class=\"offending\">#{new_line}</span>" if i == 2
    new_lines << new_line
  end
  new_lines.join("\n")
end

snippet (backtrace)

@api private

Extract lines of code corresponding to a backtrace.

@param backtrace [String] the backtrace from a test failure @return [String] highlighted code snippet indicating where the test

failure occurred

@see post_process

# File rspec-core/lib/rspec/core/formatters/html_snippet_extractor.rb, line 49
def snippet(backtrace)
  raw_code, line = snippet_for(backtrace[0])
  highlighted = @@converter.convert(raw_code)
  post_process(highlighted, line)
end

snippet_for (error_line)

@api private

Create a snippet from a line of code.

@param error_line [String] file name with line number (i.e.

'foo_spec.rb:12')

@return [String] lines around the target line within the file

@see lines_around

# File rspec-core/lib/rspec/core/formatters/html_snippet_extractor.rb, line 65
def snippet_for(error_line)
  if error_line =~ /(.*):(\d+)/
    file = Regexp.last_match[1]
    line = Regexp.last_match[2].to_i
    [lines_around(file, line), line]
  else
    ["# Couldn't get snippet for #{error_line}", 1]
  end
end