Updated to latest rspec
[gitorious:georgyos-clone.git] / vendor / plugins / rspec / lib / spec / runner / formatter / html_formatter.rb
1 require 'erb'
2 require 'spec/runner/formatter/base_text_formatter'
3
4 module Spec
5   module Runner
6     module Formatter
7       class HtmlFormatter < BaseTextFormatter
8         include ERB::Util # for the #h method
9         
10         def initialize(options, output)
11           super
12           @example_group_number = 0
13           @example_number = 0
14         end
15         
16         def method_missing(sym, *args)
17           # no-op
18         end
19
20         # The number of the currently running example_group
21         def example_group_number
22           @example_group_number
23         end
24         
25         # The number of the currently running example (a global counter)
26         def example_number
27           @example_number
28         end
29         
30         def start(example_count)
31           @example_count = example_count
32
33           @output.puts html_header
34           @output.puts report_header
35           @output.flush
36         end
37
38         def add_example_group(example_group)
39           super
40           @example_group_red = false
41           @example_group_red = false
42           @example_group_number += 1
43           unless example_group_number == 1
44             @output.puts "  </dl>"
45             @output.puts "</div>"
46           end
47           @output.puts "<div class=\"example_group\">"
48           @output.puts "  <dl>"
49           @output.puts "  <dt id=\"example_group_#{example_group_number}\">#{h(example_group.description)}</dt>"
50           @output.flush
51         end
52
53         def start_dump
54           @output.puts "  </dl>"
55           @output.puts "</div>"
56           @output.flush
57         end
58
59         def example_started(example)
60           @example_number += 1
61         end
62
63         def example_passed(example)
64           move_progress
65           @output.puts "    <dd class=\"spec passed\"><span class=\"passed_spec_name\">#{h(example.description)}</span></dd>"
66           @output.flush
67         end
68
69         def example_failed(example, counter, failure)
70           extra = extra_failure_content(failure)
71           failure_style = failure.pending_fixed? ? 'pending_fixed' : 'failed'
72           @output.puts "    <script type=\"text/javascript\">makeRed('rspec-header');</script>" unless @header_red
73           @header_red = true
74           @output.puts "    <script type=\"text/javascript\">makeRed('example_group_#{example_group_number}');</script>" unless @example_group_red
75           @example_group_red = true
76           move_progress
77           @output.puts "    <dd class=\"spec #{failure_style}\">"
78           @output.puts "      <span class=\"failed_spec_name\">#{h(example.description)}</span>"
79           @output.puts "      <div class=\"failure\" id=\"failure_#{counter}\">"
80           @output.puts "        <div class=\"message\"><pre>#{h(failure.exception.message)}</pre></div>" unless failure.exception.nil?
81           @output.puts "        <div class=\"backtrace\"><pre>#{format_backtrace(failure.exception.backtrace)}</pre></div>" unless failure.exception.nil?
82           @output.puts extra unless extra == ""
83           @output.puts "      </div>"
84           @output.puts "    </dd>"
85           @output.flush
86         end
87
88         def example_pending(example, message)
89           @output.puts "    <script type=\"text/javascript\">makeYellow('rspec-header');</script>" unless @header_red
90           @output.puts "    <script type=\"text/javascript\">makeYellow('example_group_#{example_group_number}');</script>" unless @example_group_red
91           move_progress
92           @output.puts "    <dd class=\"spec not_implemented\"><span class=\"not_implemented_spec_name\">#{h(example.description)} (PENDING: #{h(message)})</span></dd>"
93           @output.flush
94         end
95
96         # Override this method if you wish to output extra HTML for a failed spec. For example, you
97         # could output links to images or other files produced during the specs.
98         #
99         def extra_failure_content(failure)
100           require 'spec/runner/formatter/snippet_extractor'
101           @snippet_extractor ||= SnippetExtractor.new
102           "    <pre class=\"ruby\"><code>#{@snippet_extractor.snippet(failure.exception)}</code></pre>"
103         end
104         
105         def move_progress
106           @output.puts "    <script type=\"text/javascript\">moveProgressBar('#{percent_done}');</script>"
107           @output.flush
108         end
109
110         def percent_done
111           result = 100.0
112           if @example_count != 0
113             result = ((example_number).to_f / @example_count.to_f * 1000).to_i / 10.0
114           end
115           result
116         end
117
118         def dump_failure(counter, failure)
119         end
120
121         def dump_summary(duration, example_count, failure_count, pending_count)
122           if dry_run?
123             totals = "This was a dry-run"
124           else
125             totals = "#{example_count} example#{'s' unless example_count == 1}, #{failure_count} failure#{'s' unless failure_count == 1}"
126             totals << ", #{pending_count} pending" if pending_count > 0  
127           end
128           @output.puts "<script type=\"text/javascript\">document.getElementById('duration').innerHTML = \"Finished in <strong>#{duration} seconds</strong>\";</script>"
129           @output.puts "<script type=\"text/javascript\">document.getElementById('totals').innerHTML = \"#{totals}\";</script>"
130           @output.puts "</div>"
131           @output.puts "</div>"
132           @output.puts "</body>"
133           @output.puts "</html>"
134           @output.flush
135         end
136
137         def html_header 
138           <<-EOF
139 <?xml version="1.0" encoding="UTF-8"?>
140 <!DOCTYPE html 
141   PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
142   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
143 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
144 <head>
145   <title>RSpec results</title>
146   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
147   <meta http-equiv="Expires" content="-1" />
148   <meta http-equiv="Pragma" content="no-cache" />
149   <style type="text/css">
150   body {
151     margin: 0;
152     padding: 0;
153     background: #fff;
154     font-size: 80%;
155   }
156   </style>
157 </head>
158 <body>
159 EOF
160         end
161
162         def report_header
163           <<-EOF
164 <div class="rspec-report">
165   <script type="text/javascript">
166     // <![CDATA[
167 #{global_scripts}
168     // ]]>
169   </script>
170   <style type="text/css">
171 #{global_styles}
172   </style>
173
174 <div id="rspec-header">
175   <h1>RSpec Results</h1>
176
177   <div id="summary">
178     <p id="totals">&nbsp;</p>
179     <p id="duration">&nbsp;</p>
180   </div>
181 </div>
182
183 <div class="results">
184 EOF
185         end
186
187         def global_scripts
188           <<-EOF
189 function moveProgressBar(percentDone) {
190   document.getElementById("rspec-header").style.width = percentDone +"%";
191 }
192 function makeRed(element_id) {
193   document.getElementById(element_id).style.background = '#C40D0D';
194   document.getElementById(element_id).style.color = '#FFFFFF';
195 }
196
197 function makeYellow(element_id) {
198   if (element_id == "rspec-header" && document.getElementById(element_id).style.background != '#C40D0D')
199   {
200     document.getElementById(element_id).style.background = '#FAF834';
201     document.getElementById(element_id).style.color = '#000000';
202   }
203   else
204   {
205     document.getElementById(element_id).style.background = '#FAF834';
206     document.getElementById(element_id).style.color = '#000000';
207   }
208 }
209 EOF
210         end
211         
212         def global_styles
213           <<-EOF
214 #rspec-header {
215   background: #65C400; color: #fff;
216 }
217
218 .rspec-report h1 {
219   margin: 0px 10px 0px 10px;
220   padding: 10px;
221   font-family: "Lucida Grande", Helvetica, sans-serif;
222   font-size: 1.8em;
223 }
224
225 #summary {
226   margin: 0; padding: 5px 10px;
227   font-family: "Lucida Grande", Helvetica, sans-serif;
228   text-align: right;
229   position: absolute;
230   top: 0px;
231   right: 0px;
232 }
233
234 #summary p {
235   margin: 0 0 0 2px;
236 }
237
238 #summary #totals {
239   font-size: 1.2em;
240 }
241
242 .example_group {
243   margin: 0 10px 5px;
244   background: #fff;
245 }
246
247 dl {
248   margin: 0; padding: 0 0 5px;
249   font: normal 11px "Lucida Grande", Helvetica, sans-serif;
250 }
251
252 dt {
253   padding: 3px;
254   background: #65C400;
255   color: #fff;
256   font-weight: bold;
257 }
258
259 dd {
260   margin: 5px 0 5px 5px;
261   padding: 3px 3px 3px 18px;
262 }
263
264 dd.spec.passed {
265   border-left: 5px solid #65C400;
266   border-bottom: 1px solid #65C400;
267   background: #DBFFB4; color: #3D7700;
268 }
269
270 dd.spec.failed {
271   border-left: 5px solid #C20000;
272   border-bottom: 1px solid #C20000;
273   color: #C20000; background: #FFFBD3;
274 }
275
276 dd.spec.not_implemented {
277   border-left: 5px solid #FAF834;
278   border-bottom: 1px solid #FAF834;
279   background: #FCFB98; color: #131313;
280 }
281
282 dd.spec.pending_fixed {
283   border-left: 5px solid #0000C2;
284   border-bottom: 1px solid #0000C2;
285   color: #0000C2; background: #D3FBFF;
286 }
287
288 .backtrace {
289   color: #000;
290   font-size: 12px;
291 }
292
293 a {
294   color: #BE5C00;
295 }
296
297 /* Ruby code, style similar to vibrant ink */
298 .ruby {
299   font-size: 12px;
300   font-family: monospace;
301   color: white;
302   background-color: black;
303   padding: 0.1em 0 0.2em 0;
304 }
305
306 .ruby .keyword { color: #FF6600; }
307 .ruby .constant { color: #339999; }
308 .ruby .attribute { color: white; }
309 .ruby .global { color: white; }
310 .ruby .module { color: white; }
311 .ruby .class { color: white; }
312 .ruby .string { color: #66FF00; }
313 .ruby .ident { color: white; }
314 .ruby .method { color: #FFCC00; }
315 .ruby .number { color: white; }
316 .ruby .char { color: white; }
317 .ruby .comment { color: #9933CC; }
318 .ruby .symbol { color: white; }
319 .ruby .regex { color: #44B4CC; }
320 .ruby .punct { color: white; }
321 .ruby .escape { color: white; }
322 .ruby .interp { color: white; }
323 .ruby .expr { color: white; }
324
325 .ruby .offending { background-color: gray; }
326 .ruby .linenum {
327   width: 75px;
328   padding: 0.1em 1em 0.2em 0;
329   color: #000000;
330   background-color: #FFFBD3;
331 }
332 EOF
333         end
334       end
335     end
336   end
337 end