Class: Cucumber::Formatter::Html

Inherits:
Object
  • Object
show all
Includes:
Duration, Io, ERB::Util
Defined in:
lib/cucumber/formatter/html.rb

Instance Method Summary collapse

Methods included from Io

#ensure_dir, #ensure_file, #ensure_io

Methods included from Duration

#format_duration

Constructor Details

#initialize(step_mother, path_or_io, options) ⇒ Html

Returns a new instance of Html.



12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/cucumber/formatter/html.rb', line 12

def initialize(step_mother, path_or_io, options)
  @io = ensure_io(path_or_io, "html")
  @step_mother = step_mother
  @options = options
  @buffer = {}
  @builder = create_builder(@io)
  @feature_number = 0
  @scenario_number = 0
  @step_number = 0
  @header_red = nil
end

Instance Method Details

#after_background(background) ⇒ Object 



131
132
133
134
 
# File 'lib/cucumber/formatter/html.rb', line 131

def after_background(background)
  @in_background = nil
  @builder << '</div>'
end

#after_comment(comment) ⇒ Object 



93
94
95
 
# File 'lib/cucumber/formatter/html.rb', line 93

def after_comment(comment)
  @builder << '</pre>'
end

#after_examples(examples) ⇒ Object 



183
184
185
 
# File 'lib/cucumber/formatter/html.rb', line 183

def after_examples(examples)
  @builder << '</div>'
end

#after_feature(feature) ⇒ Object 



85
86
87
 
# File 'lib/cucumber/formatter/html.rb', line 85

def after_feature(feature)
  @builder << '</div>'
end

#after_feature_element(feature_element) ⇒ Object 



155
156
157
158
 
# File 'lib/cucumber/formatter/html.rb', line 155

def after_feature_element(feature_element)
  @builder << '</div>'
  @open_step_list = true
end

#after_features(features) ⇒ Object 



73
74
75
76
77
78
 
# File 'lib/cucumber/formatter/html.rb', line 73

def after_features(features)
  print_stats(features)
  @builder << '</div>'
  @builder << '</body>'
  @builder << '</html>'
end

#after_multiline_arg(multiline_arg) ⇒ Object 



272
273
274
275
276
277
 
# File 'lib/cucumber/formatter/html.rb', line 272

def after_multiline_arg(multiline_arg)
  return if @hide_this_step || @skip_step
  if Ast::Table === multiline_arg
    @builder << '</table>'
  end
end

#after_outline_table(outline_table) ⇒ Object 



174
175
176
177
 
# File 'lib/cucumber/formatter/html.rb', line 174

def after_outline_table(outline_table)
  @builder << '</table>'
  @outline_row = nil
end

#after_step(step) ⇒ Object 



209
210
211
 
# File 'lib/cucumber/formatter/html.rb', line 209

def after_step(step)
  move_progress
end

#after_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background) ⇒ Object 



233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/cucumber/formatter/html.rb', line 233

def after_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background)
  return if @hide_this_step
  # print snippet for undefined steps
  if status == :undefined
    step_multiline_class = @step.multiline_arg ? @step.multiline_arg.class : nil
    @builder.pre do |pre|
      pre << @step_mother.snippet_text(@step.actual_keyword,step_match.instance_variable_get("@name") || '',step_multiline_class)
    end
  end
  @builder << '</li>'
end

#after_steps(steps) ⇒ Object 



199
200
201
 
# File 'lib/cucumber/formatter/html.rb', line 199

def after_steps(steps)
  @builder << '</ol>'
end

#after_table_row(table_row) ⇒ Object 



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/cucumber/formatter/html.rb', line 294

def after_table_row(table_row)
  return if @hide_this_step
  @builder << '</tr>'
  if table_row.exception
    @builder.tr do
      @builder.td(:colspan => @col_index.to_s, :class => 'failed') do
        @builder.pre do |pre|
          pre << format_exception(table_row.exception)
        end
      end
    end
    set_scenario_color_failed
  end
  if @outline_row
    @outline_row += 1
  end
  @step_number += 1
  move_progress
end

#after_tags(tags) ⇒ Object 



102
103
104
 
# File 'lib/cucumber/formatter/html.rb', line 102

def after_tags(tags)
  @tag_spacer = nil
end

#announce(announcement) ⇒ Object 



325
326
327
 
# File 'lib/cucumber/formatter/html.rb', line 325

def announce(announcement)
  @builder.pre(announcement, :class => 'announcement')
end

#background_name(keyword, name, file_colon_line, source_indent) ⇒ Object 



136
137
138
139
140
141
142
143
 
# File 'lib/cucumber/formatter/html.rb', line 136

def background_name(keyword, name, file_colon_line, source_indent)
  @listing_background = true
  @builder.h3 do |h3|
    @builder.span(keyword, :class => 'keyword')
    @builder.text!(' ')
    @builder.span(name, :class => 'val')
  end
end

#before_background(background) ⇒ Object 



126
127
128
129
 
# File 'lib/cucumber/formatter/html.rb', line 126

def before_background(background)
  @in_background = true
  @builder << '<div class="background">'
end

#before_comment(comment) ⇒ Object 



89
90
91
 
# File 'lib/cucumber/formatter/html.rb', line 89

def before_comment(comment)
  @builder << '<pre class="comment">'
end

#before_examples(examples) ⇒ Object 



179
180
181
 
# File 'lib/cucumber/formatter/html.rb', line 179

def before_examples(examples)
   @builder << '<div class="examples">'
end

#before_feature(feature) ⇒ Object 



80
81
82
83
 
# File 'lib/cucumber/formatter/html.rb', line 80

def before_feature(feature)
  @exceptions = []
  @builder << '<div class="feature">'
end

#before_feature_element(feature_element) ⇒ Object 



145
146
147
148
149
150
151
152
153
 
# File 'lib/cucumber/formatter/html.rb', line 145

def before_feature_element(feature_element)
  @scenario_number+=1
  @scenario_red = false
  css_class = {
    Ast::Scenario        => 'scenario',
    Ast::ScenarioOutline => 'scenario outline'
  }[feature_element.class]      
  @builder << "<div class='#{css_class}'>"
end

#before_features(features) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/cucumber/formatter/html.rb', line 40

def before_features(features)
  @step_count = get_step_count(features)

  # <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  @builder.declare!(
    :DOCTYPE,
    :html, 
    :PUBLIC, 
    '-//W3C//DTD XHTML 1.0 Strict//EN',
    'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'
  )

  @builder << '<html xmlns ="http://www.w3.org/1999/xhtml">'
    @builder.head do
    @builder.meta(:content => 'text/html;charset=utf-8')
    @builder.title 'Cucumber'
    inline_css
    inline_js
  end
  @builder << '<body>'
  @builder << "<!-- Step count #{@step_count}-->"
  @builder << '<div class="cucumber">'
  @builder.div(:id => 'cucumber-header') do
    @builder.div(:id => 'label') do
      @builder.h1('Cucumber Features')
    end
    @builder.div(:id => 'summary') do
      @builder.p('',:id => 'totals')
      @builder.p('',:id => 'duration')
    end
  end
end

#before_multiline_arg(multiline_arg) ⇒ Object 



265
266
267
268
269
270
 
# File 'lib/cucumber/formatter/html.rb', line 265

def before_multiline_arg(multiline_arg)
  return if @hide_this_step || @skip_step
  if Ast::Table === multiline_arg
    @builder << '<table>'
  end
end

#before_outline_table(outline_table) ⇒ Object 



169
170
171
172
 
# File 'lib/cucumber/formatter/html.rb', line 169

def before_outline_table(outline_table)
  @outline_row = 0
  @builder << '<table>'
end

#before_step(step) ⇒ Object 



203
204
205
206
207
 
# File 'lib/cucumber/formatter/html.rb', line 203

def before_step(step)
  @step_id = step.dom_id
  @step_number += 1
  @step = step
end

#before_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background) ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/cucumber/formatter/html.rb', line 213

def before_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background)
  @step_match = step_match
  @hide_this_step = false
  if exception
    if @exceptions.include?(exception)
      @hide_this_step = true
      return
    end
    @exceptions << exception
  end
  if status != :failed && @in_background ^ background
    @hide_this_step = true
    return
  end
  @status = status
  return if @hide_this_step
  set_scenario_color(status)      
  @builder << "<li id='#{@step_id}' class='step #{status}'>"            
end

#before_steps(steps) ⇒ Object 



195
196
197
 
# File 'lib/cucumber/formatter/html.rb', line 195

def before_steps(steps)
  @builder << '<ol>'
end

#before_table_row(table_row) ⇒ Object 



287
288
289
290
291
292
 
# File 'lib/cucumber/formatter/html.rb', line 287

def before_table_row(table_row)
  @row_id = table_row.dom_id
  @col_index = 0
  return if @hide_this_step
  @builder << "<tr class='step' id='#{@row_id}'>"
end

#comment_line(comment_line) ⇒ Object 



97
98
99
100
 
# File 'lib/cucumber/formatter/html.rb', line 97

def comment_line(comment_line)
  @builder.text!(comment_line)
  @builder.br
end

#embed(file, mime_type) ⇒ Object 



24
25
26
27
28
29
 
# File 'lib/cucumber/formatter/html.rb', line 24

def embed(file, mime_type)
  case(mime_type)
  when /^image\/(png|gif|jpg|jpeg)/
    embed_image(file)
  end
end

#embed_image(file) ⇒ Object 



31
32
33
34
35
36
37
 
# File 'lib/cucumber/formatter/html.rb', line 31

def embed_image(file)
  id = file.hash
  @builder.span(:class => 'embed') do |pre|
    pre << %{<a href="" onclick="img=document.getElementById('#{id}'); img.style.display = (img.style.display == 'none' ? 'block' : 'none');return false">Screenshot</a><br>&nbsp;
    <img id="#{id}" style="display: none" src="#{file}"/>}
  end
end

#examples_name(keyword, name) ⇒ Object 



187
188
189
190
191
192
193
 
# File 'lib/cucumber/formatter/html.rb', line 187

def examples_name(keyword, name)
  @builder.h4 do
    @builder.span(keyword, :class => 'keyword')
    @builder.text!(' ')
    @builder.span(name, :class => 'val')
  end
end

#exception(exception, status) ⇒ Object 



256
257
258
 
# File 'lib/cucumber/formatter/html.rb', line 256

def exception(exception, status)
  build_exception_detail(exception)
end

#extra_failure_content(file_colon_line) ⇒ Object 



260
261
262
263
 
# File 'lib/cucumber/formatter/html.rb', line 260

def extra_failure_content(file_colon_line)
  @snippet_extractor ||= SnippetExtractor.new
  "<pre class=\"ruby\"><code>#{@snippet_extractor.snippet(file_colon_line)}</code></pre>"
end

#feature_name(name) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/cucumber/formatter/html.rb', line 112

def feature_name(name)
  lines = name.split(/\r?\n/)
  return if lines.empty?
  @builder.h2 do |h2|
    @builder.span(lines[0], :class => 'val')
  end
  @builder.p(:class => 'narrative') do
    lines[1..-1].each do |line|
      @builder.text!(line.strip)
      @builder.br
    end
  end
end

#py_string(string) ⇒ Object 



279
280
281
282
283
284
 
# File 'lib/cucumber/formatter/html.rb', line 279

def py_string(string)
  return if @hide_this_step
  @builder.pre(:class => 'val') do |pre|
    @builder << string.gsub("\n", '&#x000A;')
  end
end

#scenario_name(keyword, name, file_colon_line, source_indent) ⇒ Object 



160
161
162
163
164
165
166
167
 
# File 'lib/cucumber/formatter/html.rb', line 160

def scenario_name(keyword, name, file_colon_line, source_indent)
  @listing_background = false
  @builder.h3(:id => "scenario_#{@scenario_number}") do
    @builder.span(keyword, :class => 'keyword')
    @builder.text!(' ')
    @builder.span(name, :class => 'val')
  end
end

#step_name(keyword, step_match, status, source_indent, background) ⇒ Object 



245
246
247
248
249
250
251
252
253
254
 
# File 'lib/cucumber/formatter/html.rb', line 245

def step_name(keyword, step_match, status, source_indent, background)
  @step_matches ||= []
  background_in_scenario = background && !@listing_background
  @skip_step = @step_matches.index(step_match) || background_in_scenario
  @step_matches << step_match

  unless @skip_step
    build_step(keyword, step_match, status)
  end
end

#table_cell_value(value, status) ⇒ Object 



314
315
316
317
318
319
320
321
322
323
 
# File 'lib/cucumber/formatter/html.rb', line 314

def table_cell_value(value, status)
  return if @hide_this_step
  
  @cell_type = @outline_row == 0 ? :th : :td
  attributes = {:id => "#{@row_id}_#{@col_index}", :class => 'step'}
  attributes[:class] += " #{status}" if status
  build_cell(@cell_type, value, attributes)
  set_scenario_color(status)
  @col_index += 1
end

#tag_name(tag_name) ⇒ Object 



106
107
108
109
110
 
# File 'lib/cucumber/formatter/html.rb', line 106

def tag_name(tag_name)
  @builder.text!(@tag_spacer) if @tag_spacer
  @tag_spacer = ' '
  @builder.span(tag_name, :class => 'tag')
end