Included Modules

Class/Module Index [+]

Quicksearch

Spec::Runner::Formatter::HtmlFormatter

Public Class Methods

new(options, output) click to toggle source
# File lib/spec/runner/formatter/html_formatter.rb, line 12
def initialize(options, output)
  super
  @example_group_number = 0
  @example_number = 0
  @header_red = nil
end

Public Instance Methods

dump_failure(counter, failure) click to toggle source
# File lib/spec/runner/formatter/html_formatter.rb, line 116
def dump_failure(counter, failure)
end
dump_summary(duration, example_count, failure_count, pending_count) click to toggle source
# File lib/spec/runner/formatter/html_formatter.rb, line 119
def dump_summary(duration, example_count, failure_count, pending_count)
  if dry_run?
    totals = "This was a dry-run"
  else
    totals = "#{example_count} example#{'s' unless example_count == 1}, #{failure_count} failure#{'s' unless failure_count == 1}"
    totals << ", #{pending_count} pending" if pending_count > 0  
  end
  @output.puts "<script type=\"text/javascript\">document.getElementById('duration').innerHTML = \"Finished in <strong>#{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>"
  @output.flush
end
example_failed(example, counter, failure) click to toggle source
# File lib/spec/runner/formatter/html_formatter.rb, line 67
def example_failed(example, counter, failure)
  extra = extra_failure_content(failure)
  failure_style = failure.pending_fixed? ? 'pending_fixed' : 'failed'
  @output.puts "    <script type=\"text/javascript\">makeRed('rspec-header');</script>" unless @header_red
  @header_red = true
  @output.puts "    <script type=\"text/javascript\">makeRed('example_group_#{example_group_number}');</script>" unless @example_group_red
  @example_group_red = true
  move_progress
  @output.puts "    <dd class=\"spec #{failure_style}\">"
  @output.puts "      <span class=\"failed_spec_name\">#{h(example.description)}</span>"
  @output.puts "      <div class=\"failure\" id=\"failure_#{counter}\">"
  @output.puts "        <div class=\"message\"><pre>#{h(failure.exception.message)}</pre></div>" unless failure.exception.nil?
  @output.puts "        <div class=\"backtrace\"><pre>#{format_backtrace(failure.exception.backtrace)}</pre></div>" unless failure.exception.nil?
  @output.puts extra unless extra == ""
  @output.puts "      </div>"
  @output.puts "    </dd>"
  @output.flush
end
example_group_number() click to toggle source

The number of the currently running example_group

# File lib/spec/runner/formatter/html_formatter.rb, line 20
def example_group_number
  @example_group_number
end
example_group_started(example_group) click to toggle source
# File lib/spec/runner/formatter/html_formatter.rb, line 37
def example_group_started(example_group)
  super
  @example_group_red = false
  @example_group_number += 1
  unless example_group_number == 1
    @output.puts "  </dl>"
    @output.puts "</div>"
  end
  @output.puts "<div class=\"example_group\">"
  @output.puts "  <dl>"
  @output.puts "  <dt id=\"example_group_#{example_group_number}\">#{h(example_group.description)}</dt>"
  @output.flush
end
example_number() click to toggle source

The number of the currently running example (a global counter)

# File lib/spec/runner/formatter/html_formatter.rb, line 25
def example_number
  @example_number
end
example_passed(example) click to toggle source
# File lib/spec/runner/formatter/html_formatter.rb, line 61
def example_passed(example)
  move_progress
  @output.puts "    <dd class=\"spec passed\"><span class=\"passed_spec_name\">#{h(example.description)}</span></dd>"
  @output.flush
end
example_pending(example, message, deprecated_pending_location=nil) click to toggle source
# File lib/spec/runner/formatter/html_formatter.rb, line 86
def example_pending(example, message, deprecated_pending_location=nil)
  @output.puts "    <script type=\"text/javascript\">makeYellow('rspec-header');</script>" unless @header_red
  @output.puts "    <script type=\"text/javascript\">makeYellow('example_group_#{example_group_number}');</script>" unless @example_group_red
  move_progress
  @output.puts "    <dd class=\"spec not_implemented\"><span class=\"not_implemented_spec_name\">#{h(example.description)} (PENDING: #{h(message)})</span></dd>"
  @output.flush
end
example_started(example) click to toggle source
# File lib/spec/runner/formatter/html_formatter.rb, line 57
def example_started(example)
  @example_number += 1
end
extra_failure_content(failure) click to toggle source

Override this method if you wish to output extra HTML for a failed spec. For example, you could output links to images or other files produced during the specs.

# File lib/spec/runner/formatter/html_formatter.rb, line 97
def extra_failure_content(failure)
  require 'spec/runner/formatter/snippet_extractor'
  @snippet_extractor ||= SnippetExtractor.new
  "    <pre class=\"ruby\"><code>#{@snippet_extractor.snippet(failure.exception)}</code></pre>"
end
global_scripts() click to toggle source
# File lib/spec/runner/formatter/html_formatter.rb, line 187
def global_scripts
  function moveProgressBar(percentDone) {  document.getElementById("rspec-header").style.width = percentDone +"%";}function makeRed(element_id) {  document.getElementById(element_id).style.background = '#C40D0D';  document.getElementById(element_id).style.color = '#FFFFFF';}function makeYellow(element_id) {  if (element_id == "rspec-header" && document.getElementById(element_id).style.background != '#C40D0D')  {    document.getElementById(element_id).style.background = '#FAF834';    document.getElementById(element_id).style.color = '#000000';  }  else  {    document.getElementById(element_id).style.background = '#FAF834';    document.getElementById(element_id).style.color = '#000000';  }}
end
global_styles() click to toggle source
# File lib/spec/runner/formatter/html_formatter.rb, line 212
def global_styles
  #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;}#summary {  margin: 0; padding: 5px 10px;  font-family: "Lucida Grande", Helvetica, sans-serif;  text-align: right;  top: 0px;  right: 0px;  float: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.spec.passed {  border-left: 5px solid #65C400;  border-bottom: 1px solid #65C400;  background: #DBFFB4; color: #3D7700;}dd.spec.failed {  border-left: 5px solid #C20000;  border-bottom: 1px solid #C20000;  color: #C20000; background: #FFFBD3;}dd.spec.not_implemented {  border-left: 5px solid #FAF834;  border-bottom: 1px solid #FAF834;  background: #FCFB98; color: #131313;}dd.spec.pending_fixed {  border-left: 5px solid #0000C2;  border-bottom: 1px solid #0000C2;  color: #0000C2; background: #D3FBFF;}.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;}
end
html_header() click to toggle source
# File lib/spec/runner/formatter/html_formatter.rb, line 135
def html_header 
  <?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html   PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" 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>
end
move_progress() click to toggle source
# File lib/spec/runner/formatter/html_formatter.rb, line 103
def move_progress
  @output.puts "    <script type=\"text/javascript\">moveProgressBar('#{percent_done}');</script>"
  @output.flush
end
percent_done() click to toggle source
# File lib/spec/runner/formatter/html_formatter.rb, line 108
def percent_done
  result = 100.0
  if @example_count != 0
    result = ((example_number).to_f / @example_count.to_f * 1000).to_i / 10.0
  end
  result
end
report_header() click to toggle source
# File lib/spec/runner/formatter/html_formatter.rb, line 168
def report_header
  <div class="rspec-report"><div id="rspec-header">  <div id="label">    <h1>RSpec Code Examples</h1>  </div>  <div id="summary">    <p id="totals">&nbsp;</p>    <p id="duration">&nbsp;</p>  </div></div><div class="results">
end
start(example_count) click to toggle source
# File lib/spec/runner/formatter/html_formatter.rb, line 29
def start(example_count)
  @example_count = example_count

  @output.puts html_header
  @output.puts report_header
  @output.flush
end
start_dump() click to toggle source
# File lib/spec/runner/formatter/html_formatter.rb, line 51
def start_dump
  @output.puts "  </dl>"
  @output.puts "</div>"
  @output.flush
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.