Class: Spec::Runner::Formatter::HtmlFormatter

Inherits:
BaseTextFormatter show all
Includes:
ERB::Util
Defined in:
lib/spec/runner/formatter/html_formatter.rb

Instance Attribute Summary

Attributes inherited from BaseTextFormatter

#dry_run

Instance Method Summary collapse

Methods inherited from BaseTextFormatter

#close, #colour=, #colourise, #dump_pending, #format_backtrace

Methods inherited from BaseFormatter

#close, #dump_pending

Constructor Details

#initialize(output) ⇒ HtmlFormatter

Returns a new instance of HtmlFormatter.



9
10
11
12
13
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 9

def initialize(output)
  super
  @current_behaviour_number = 0
  @current_example_number = 0
end

Instance Method Details

#add_behaviour(name) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 33

def add_behaviour(name)
  @behaviour_red = false
  @behaviour_red = false
  @current_behaviour_number += 1
  unless current_behaviour_number == 1
    @output.puts "  </dl>"
    @output.puts "</div>"
  end
  @output.puts "<div class=\"behaviour\">"
  @output.puts "  <dl>"
  @output.puts "  <dt id=\"behaviour_#{current_behaviour_number}\">#{h(name)}</dt>"
  @output.flush
end

#current_behaviour_number ⇒ Object

The number of the currently running behaviour



16
17
18
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 16

def current_behaviour_number
  @current_behaviour_number
end

#current_example_number ⇒ Object

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



21
22
23
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 21

def current_example_number
  @current_example_number
end

#dump_failure(counter, failure) ⇒ Object 



103
104
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 103

def dump_failure(counter, failure)
end

#dump_summary(duration, example_count, failure_count, pending_count) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 106

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 63

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('behaviour_#{current_behaviour_number}');</script>" unless @behaviour_red
  @behaviour_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_passed(example) ⇒ Object 



57
58
59
60
61
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 57

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(behaviour_name, example_name, message) ⇒ Object 



82
83
84
85
86
87
88
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 82

def example_pending(behaviour_name, example_name, message)
  @output.puts "    <script type=\"text/javascript\">makeYellow('rspec-header');</script>" unless @header_red
  @output.puts "    <script type=\"text/javascript\">makeYellow('behaviour_#{current_behaviour_number}');</script>" unless @behaviour_red
  move_progress
  @output.puts "    <dd class=\"spec not_implemented\"><span class=\"not_implemented_spec_name\">#{h(example_name)}</span></dd>"
  @output.flush
end

#example_started(example) ⇒ Object 



53
54
55
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 53

def example_started(example)
  @current_example_number = example.number
end

#extra_failure_content(failure) ⇒ Object

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.



93
94
95
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 93

def extra_failure_content(failure)
  "    <pre class=\"ruby\"><code>#{@snippet_extractor.snippet(failure.exception)}</code></pre>"
end

#global_scripts ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 173

def global_scripts
  <<-EOF
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';
  }
}
EOF
end

#global_styles ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 198

def global_styles
  <<-EOF
#rspec-header {
  background: #65C400; color: #fff;
}

.rspec-report h1 {
  margin: 0px 10px 0px 10px;
  padding: 10px;
  font-family: "Lucida Grande", Helvetica, sans-serif;
  font-size: 1.8em;
}

#summary {
  margin: 0; padding: 5px 10px;
  font-family: "Lucida Grande", Helvetica, sans-serif;
  text-align: right;
  position: absolute;
  top: 0px;
  right: 0px;
}

#summary p {
  margin: 0 0 0 2px;
}

#summary #totals {
  font-size: 1.2em;
}

.behaviour {
  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;
}
EOF
end

#html_header ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 122

def html_header 
  <<-EOF
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.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=iso-8859-1" />
  <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>
</head>
<body>
EOF
end

#move_progress ⇒ Object 



97
98
99
100
101
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 97

def move_progress
  percent_done = @example_count == 0 ? 100.0 : ((current_example_number + 1).to_f / @example_count.to_f * 1000).to_i / 10.0
  @output.puts "    <script type=\"text/javascript\">moveProgressBar('#{percent_done}');</script>"
  @output.flush
end

#report_header ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 148

def report_header
  <<-EOF
<div class="rspec-report">
  <script type="text/javascript">
    // <![CDATA[
#{global_scripts}
    // ]]>
  </script>
  <style type="text/css">
#{global_styles}
  </style>

<div id="rspec-header">
  <h1>RSpec Results</h1>

  <div id="summary">
    <p id="totals">&nbsp;</p>
    <p id="duration">&nbsp;</p>
  </div>
</div>

<div class="results">
EOF
end

#start(example_count) ⇒ Object 



25
26
27
28
29
30
31
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 25

def start(example_count)
  @example_count = example_count

  @output.puts html_header
  @output.puts report_header
  @output.flush
end

#start_dump ⇒ Object 



47
48
49
50
51
 
# File 'lib/spec/runner/formatter/html_formatter.rb', line 47

def start_dump
  @output.puts "  </dl>"
  @output.puts "</div>"
  @output.flush
end