Class: RSpec::Core::Formatters::SnippetExtractor

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

Overview

This class extracts code snippets by looking at the backtrace of the passed error

Defined Under Namespace

Classes: NullConverter

Instance Method Summary collapse

Instance Method Details

#lines_around(file, line) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/rspec/core/formatters/snippet_extractor.rb', line 26

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
end

#post_process(highlighted, offending_line) ⇒ Object 



39
40
41
42
43
44
45
46
47
 
# File 'lib/rspec/core/formatters/snippet_extractor.rb', line 39

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(error) ⇒ Object 



9
10
11
12
13
14
 
# File 'lib/rspec/core/formatters/snippet_extractor.rb', line 9

def snippet(error)
  raw_code, line = snippet_for(error.backtrace[0])
  highlighted = @@converter.convert(raw_code, false)
  highlighted << "\n<span class=\"comment\"># gem install syntax to get syntax highlighting</span>" if @@converter.is_a?(NullConverter)
  post_process(highlighted, line)
end

#snippet_for(error_line) ⇒ Object 



16
17
18
19
20
21
22
23
24
 
# File 'lib/rspec/core/formatters/snippet_extractor.rb', line 16

def snippet_for(error_line)
  if error_line =~ /(.*):(\d+)/
    file = $1
    line = $2.to_i
    [lines_around(file, line), line]
  else
    ["# Couldn't get snippet for #{error_line}", 1]
  end
end