Class: RSpec::Core::Formatters::HtmlPrinter

Inherits:
Object
  • Object
show all
Includes:
ERB::Util
Defined in:
lib/rspec/core/formatters/html_printer.rb

Constant Summary

REPORT_HEADER = 
<<-EOF
<div class="rspec-report">
<div id="rspec-header">
  <div id="label">
    <h1>RSpec Code Examples</h1>
  </div>
  <div id="display-filters">
    <input id="passed_checkbox"  name="passed_checkbox"  type="checkbox" checked="checked" onchange="apply_filters()" value="1" /> <label for="passed_checkbox">Passed</label>
    <input id="failed_checkbox"  name="failed_checkbox"  type="checkbox" checked="checked" onchange="apply_filters()" value="2" /> <label for="failed_checkbox">Failed</label>
    <input id="pending_checkbox" name="pending_checkbox" type="checkbox" checked="checked" onchange="apply_filters()" value="3" /> <label for="pending_checkbox">Pending</label>
  </div>
  <div id="summary">
    <p id="totals">&#160;</p>
    <p id="duration">&#160;</p>
  </div>
</div>
<div class="results">
EOF
GLOBAL_SCRIPTS = 
<<-EOF

function addClass(element_id, classname) {
  document.getElementById(element_id).className += (" " + classname);
}
function removeClass(element_id, classname) {
  var elem = document.getElementById(element_id);
  var classlist = elem.className.replace(classname,'');
  elem.className = classlist;
}
function moveProgressBar(percentDone) {
  document.getElementById("rspec-header").style.width = percentDone +"%";
}
function makeRed(element_id) {
  removeClass(element_id, 'passed');
  removeClass(element_id, 'not_implemented');
  addClass(element_id,'failed');
}
function makeYellow(element_id) {
  var elem = document.getElementById(element_id);
  if (elem.className.indexOf("failed") == -1) {  // class doesn't includes failed
    if (elem.className.indexOf("not_implemented") == -1) { // class doesn't include not_implemented
      removeClass(element_id, 'passed');
      addClass(element_id,'not_implemented');
    }
  }
}
function apply_filters() {
  var passed_filter = document.getElementById('passed_checkbox').checked;
  var failed_filter = document.getElementById('failed_checkbox').checked;
  var pending_filter = document.getElementById('pending_checkbox').checked;
  assign_display_style("example passed", passed_filter);
  assign_display_style("example failed", failed_filter);
  assign_display_style("example not_implemented", pending_filter);
  assign_display_style_for_group("example_group passed", passed_filter);
  assign_display_style_for_group("example_group not_implemented", pending_filter, pending_filter || passed_filter);
  assign_display_style_for_group("example_group failed", failed_filter, failed_filter || pending_filter || passed_filter);
}
function get_display_style(display_flag) {
  var style_mode = 'none';
  if (display_flag == true) {
    style_mode = 'block';
  }
  return style_mode;
}
function assign_display_style(classname, display_flag) {
  var style_mode = get_display_style(display_flag);
  var elems = document.getElementsByClassName(classname)
  for (var i=0; i<elems.length;i++) {
    elems[i].style.display = style_mode;
  }
}
function assign_display_style_for_group(classname, display_flag, subgroup_flag) {
  var display_style_mode = get_display_style(display_flag);
  var subgroup_style_mode = get_display_style(subgroup_flag);
  var elems = document.getElementsByClassName(classname)
  for (var i=0; i<elems.length;i++) {
    var style_mode = display_style_mode;
    if ((display_flag != subgroup_flag) && (elems[i].getElementsByTagName('dt')[0].innerHTML.indexOf(", ") != -1)) {
      elems[i].style.display = subgroup_style_mode;
    } else {
      elems[i].style.display = display_style_mode;
    }
  }
}
EOF
GLOBAL_STYLES = 
<<-EOF
#rspec-header {
  background: #65C400; color: #fff; height: 4em;
}
.rspec-report h1 {
  margin: 0px 10px 0px 10px;
  padding: 10px;
  font-family: "Lucida Grande", Helvetica, sans-serif;
  font-size: 1.8em;
  position: absolute;
}
#label {
  float:left;
}
#display-filters {
  float:left;
  padding: 28px 0 0 40%;
  font-family: "Lucida Grande", Helvetica, sans-serif;
}
#summary {
  float:right;
  padding: 5px 10px;
  font-family: "Lucida Grande", Helvetica, sans-serif;
  text-align: right;
}
#summary p {
  margin: 0 0 0 2px;
}
#summary #totals {
  font-size: 1.2em;
}
.example_group {
  margin: 0 10px 5px;
  background: #fff;
}
dl {
  margin: 0; padding: 0 0 5px;
  font: normal 11px "Lucida Grande", Helvetica, sans-serif;
}
dt {
  padding: 3px;
  background: #65C400;
  color: #fff;
  font-weight: bold;
}
dd {
  margin: 5px 0 5px 5px;
  padding: 3px 3px 3px 18px;
}
dd .duration {
  padding-left: 5px;
  text-align: right;
  right: 0px;
  float:right;
}
dd.example.passed {
  border-left: 5px solid #65C400;
  border-bottom: 1px solid #65C400;
  background: #DBFFB4; color: #3D7700;
}
dd.example.not_implemented {
  border-left: 5px solid #FAF834;
  border-bottom: 1px solid #FAF834;
  background: #FCFB98; color: #131313;
}
dd.example.pending_fixed {
  border-left: 5px solid #0000C2;
  border-bottom: 1px solid #0000C2;
  color: #0000C2; background: #D3FBFF;
}
dd.example.failed {
  border-left: 5px solid #C20000;
  border-bottom: 1px solid #C20000;
  color: #C20000; background: #FFFBD3;
}
dt.not_implemented {
  color: #000000; background: #FAF834;
}
dt.pending_fixed {
  color: #FFFFFF; background: #C40D0D;
}
dt.failed {
  color: #FFFFFF; background: #C40D0D;
}
#rspec-header.not_implemented {
  color: #000000; background: #FAF834;
}
#rspec-header.pending_fixed {
  color: #FFFFFF; background: #C40D0D;
}
#rspec-header.failed {
  color: #FFFFFF; background: #C40D0D;
}
.backtrace {
  color: #000;
  font-size: 12px;
}
a {
  color: #BE5C00;
}
/* Ruby code, style similar to vibrant ink */
.ruby {
  font-size: 12px;
  font-family: monospace;
  color: white;
  background-color: black;
  padding: 0.1em 0 0.2em 0;
}
.ruby .keyword { color: #FF6600; }
.ruby .constant { color: #339999; }
.ruby .attribute { color: white; }
.ruby .global { color: white; }
.ruby .module { color: white; }
.ruby .class { color: white; }
.ruby .string { color: #66FF00; }
.ruby .ident { color: white; }
.ruby .method { color: #FFCC00; }
.ruby .number { color: white; }
.ruby .char { color: white; }
.ruby .comment { color: #9933CC; }
.ruby .symbol { color: white; }
.ruby .regex { color: #44B4CC; }
.ruby .punct { color: white; }
.ruby .escape { color: white; }
.ruby .interp { color: white; }
.ruby .expr { color: white; }
.ruby .offending { background-color: gray; }
.ruby .linenum {
  width: 75px;
  padding: 0.1em 1em 0.2em 0;
  color: #000000;
  background-color: #FFFBD3;
}
EOF
HTML_HEADER = 
<<-EOF
<!DOCTYPE html>
<html lang='en'>
<head>
  <title>RSpec results</title>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta http-equiv="Expires" content="-1" />
  <meta http-equiv="Pragma" content="no-cache" />
  <style type="text/css">
  body {
    margin: 0;
    padding: 0;
    background: #fff;
    font-size: 80%;
  }
  </style>
  <script type="text/javascript">
    // <![CDATA[
#{GLOBAL_SCRIPTS}
    // ]]>
  </script>
  <style type="text/css">
#{GLOBAL_STYLES}
  </style>
</head>
<body>
EOF

Instance Method Summary (collapse)

Constructor Details

- (HtmlPrinter) initialize(output)

A new instance of HtmlPrinter

8
9
10
 
# File 'lib/rspec/core/formatters/html_printer.rb', line 8
def initialize(output)
  @output = output
end

Instance Method Details

- (Object) flush 

77
78
79
 
# File 'lib/rspec/core/formatters/html_printer.rb', line 77
def flush
  @output.flush
end

- (Object) make_example_group_header_red(group_id) 

94
95
96
97
 
# File 'lib/rspec/core/formatters/html_printer.rb', line 94
def make_example_group_header_red(group_id)
  @output.puts "    <script type=\"text/javascript\">makeRed('div_group_#{group_id}');</script>"
  @output.puts "    <script type=\"text/javascript\">makeRed('example_group_#{group_id}');</script>"
end

- (Object) make_example_group_header_yellow(group_id) 

99
100
101
102
 
# File 'lib/rspec/core/formatters/html_printer.rb', line 99
def make_example_group_header_yellow(group_id)
  @output.puts "    <script type=\"text/javascript\">makeYellow('div_group_#{group_id}');</script>"
  @output.puts "    <script type=\"text/javascript\">makeYellow('example_group_#{group_id}');</script>"
end

- (Object) make_header_red 

86
87
88
 
# File 'lib/rspec/core/formatters/html_printer.rb', line 86
def make_header_red
  @output.puts "    <script type=\"text/javascript\">makeRed('rspec-header');</script>"
end

- (Object) make_header_yellow 

90
91
92
 
# File 'lib/rspec/core/formatters/html_printer.rb', line 90
def make_header_yellow
  @output.puts "    <script type=\"text/javascript\">makeYellow('rspec-header');</script>"
end

- (Object) move_progress(percent_done) 

81
82
83
84
 
# File 'lib/rspec/core/formatters/html_printer.rb', line 81
def move_progress( percent_done )
  @output.puts "    <script type=\"text/javascript\">moveProgressBar('#{percent_done}');</script>"
  @output.flush
end

- (Object) print_example_failed(pending_fixed, description, run_time, failure_id, exception, extra_content, escape_backtrace = false) 

33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/rspec/core/formatters/html_printer.rb', line 33
def print_example_failed( pending_fixed, description, run_time, failure_id, exception, extra_content, escape_backtrace = false )
  formatted_run_time = sprintf("%.5f", run_time)
  @output.puts "    <dd class=\"example #{pending_fixed ? 'pending_fixed' : 'failed'}\">"
  @output.puts "      <span class=\"failed_spec_name\">#{h(description)}</span>"
  @output.puts "      <span class=\"duration\">#{formatted_run_time}s</span>"
  @output.puts "      <div class=\"failure\" id=\"failure_#{failure_id}\">"
  if exception
    @output.puts "        <div class=\"message\"><pre>#{h(exception[:message])}</pre></div>"
    if escape_backtrace
      @output.puts "        <div class=\"backtrace\"><pre>#{h exception[:backtrace]}</pre></div>"
    else
      @output.puts "        <div class=\"backtrace\"><pre>#{exception[:backtrace]}</pre></div>"
    end
  end
  @output.puts extra_content if extra_content
  @output.puts "      </div>"
  @output.puts "    </dd>"
end

- (Object) print_example_group_end 

17
18
19
20
 
# File 'lib/rspec/core/formatters/html_printer.rb', line 17
def print_example_group_end
  @output.puts "  </dl>"
  @output.puts "</div>"
end

- (Object) print_example_group_start(group_id, description, number_of_parents) 

22
23
24
25
26
 
# File 'lib/rspec/core/formatters/html_printer.rb', line 22
def print_example_group_start( group_id, description, number_of_parents  )
  @output.puts "<div id=\"div_group_#{group_id}\" class=\"example_group passed\">"
  @output.puts "  <dl #{indentation_style(number_of_parents)}>"
  @output.puts "  <dt id=\"example_group_#{group_id}\" class=\"passed\">#{h(description)}</dt>"
end

- (Object) print_example_passed(description, run_time) 

28
29
30
31
 
# File 'lib/rspec/core/formatters/html_printer.rb', line 28
def print_example_passed( description, run_time )
  formatted_run_time = sprintf("%.5f", run_time)
  @output.puts "    <dd class=\"example passed\"><span class=\"passed_spec_name\">#{h(description)}</span><span class='duration'>#{formatted_run_time}s</span></dd>"
end

- (Object) print_example_pending(description, pending_message) 

53
54
55
 
# File 'lib/rspec/core/formatters/html_printer.rb', line 53
def print_example_pending( description, pending_message )
  @output.puts "    <dd class=\"example not_implemented\"><span class=\"not_implemented_spec_name\">#{h(description)} (PENDING: #{h(pending_message)})</span></dd>"
end

- (Object) print_html_start 

12
13
14
15
 
# File 'lib/rspec/core/formatters/html_printer.rb', line 12
def print_html_start
  @output.puts HTML_HEADER
  @output.puts REPORT_HEADER
end

- (Object) print_summary(was_dry_run, duration, example_count, failure_count, pending_count) 

57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/rspec/core/formatters/html_printer.rb', line 57
def print_summary( was_dry_run, duration, example_count, failure_count, pending_count )
  # TODO - kill dry_run?
  if was_dry_run
    totals = "This was a dry-run"
  else
    totals =  "#{example_count} example#{'s' unless example_count == 1}, "
    totals << "#{failure_count} failure#{'s' unless failure_count == 1}"
    totals << ", #{pending_count} pending" if pending_count > 0
  end
  formatted_duration = sprintf("%.5f", duration)
  @output.puts "<script type=\"text/javascript\">document.getElementById('duration').innerHTML = \"Finished in <strong>#{formatted_duration} seconds</strong>\";</script>"
  @output.puts "<script type=\"text/javascript\">document.getElementById('totals').innerHTML = \"#{totals}\";</script>"
  @output.puts "</div>"
  @output.puts "</div>"
  @output.puts "</body>"
  @output.puts "</html>"
end