Class: Closer::Formatter::Html

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

Defined Under Namespace

Classes: SnippetExtractor

Constant Summary collapse

AST_CLASSES =

TODO: remove coupling to types

{
  Cucumber::Core::Ast::Scenario        => 'scenario',
  Cucumber::Core::Ast::ScenarioOutline => 'scenario outline'
}
AST_DATA_TABLE = 
::Cucumber::Formatter::LegacyApi::Ast::MultilineArg::DataTable

Instance Method Summary collapse

Methods included from CloserHtml

#current_time_string, #display_keyword, #feature_dir, #feature_id, #gem_dir, #indent_size, #magic_comment?, #ruby_version_dir, #should_expand

Constructor Details

#initialize(runtime, path_or_io, options) ⇒ Html

Returns a new instance of Html.



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/closer/formatter/html.rb', line 24

def initialize(runtime, path_or_io, options)
  @io = ensure_io(path_or_io)
  @runtime = runtime
  @options = options
  @buffer = {}
  @builder = create_builder(@io)
  @feature_number = 0
  @scenario_number = 0
  @step_number = 0
  @header_red = nil
  @delayed_messages = []
  @img_id = 0
  @text_id = 0
  @inside_outline = false
  @previous_step_keyword = nil
end

Instance Method Details

#after_background(background) ⇒ Object 



181
182
183
184
 
# File 'lib/closer/formatter/html.rb', line 181

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

#after_comment(comment) ⇒ Object 



138
139
140
 
# File 'lib/closer/formatter/html.rb', line 138

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

#after_examples(examples) ⇒ Object 



254
255
256
 
# File 'lib/closer/formatter/html.rb', line 254

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

#after_feature(feature) ⇒ Object 



130
131
132
 
# File 'lib/closer/formatter/html.rb', line 130

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

#after_feature_element(feature_element) ⇒ Object 



203
204
205
206
207
208
209
210
 
# File 'lib/closer/formatter/html.rb', line 203

def after_feature_element(feature_element)
  unless @in_scenario_outline
    print_messages
    @builder << '</ol>'
  end
  @builder << '</div>'
  @in_scenario_outline = nil
end

#after_features(features) ⇒ Object 



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

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

#after_multiline_arg(multiline_arg) ⇒ Object 



374
375
376
377
378
379
 
# File 'lib/closer/formatter/html.rb', line 374

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

#after_outline_table(outline_table) ⇒ Object 



244
245
246
247
248
 
# File 'lib/closer/formatter/html.rb', line 244

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

#after_step(step) ⇒ Object 



282
283
284
 
# File 'lib/closer/formatter/html.rb', line 282

def after_step(step)
  move_progress
end

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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/closer/formatter/html.rb', line 311

def after_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background, file_colon_line)
  return if @hide_this_step
  # print snippet for undefined steps
  unless outline_step?(@step)
    keyword = @step.actual_keyword(@previous_step_keyword)
    @previous_step_keyword = keyword
  end
  if status == :undefined
    @builder.pre do |pre|
      # TODO: snippet text should be an event sent to the formatter so we don't 
      # have this couping to the runtime.
      pre << @runtime.snippet_text(keyword,step_match.instance_variable_get("@name") || '', @step.multiline_arg)
    end
  end
  @builder << '</li>'

  unless status == :undefined
    step_file = step_match.file_colon_line
    step_contents = "<div class=\"step_contents\"><pre>"
    step_file.gsub(/^([^:]*\.rb):(\d*)/) do
      line_index = $2.to_i - 1

      file = $1.force_encoding('UTF-8')
      file = File.join(gem_dir, file) unless File.exist?(file)
      File.readlines(file)[line_index..-1].each do |line|
        step_contents << line
        break if line.chop == 'end' or line.chop.start_with?('end ')
      end
    end
    step_contents << "</pre></div>"
    @builder << step_contents
  end

  print_messages
end

#after_steps(steps) ⇒ Object 



270
271
272
273
 
# File 'lib/closer/formatter/html.rb', line 270

def after_steps(steps)
  print_messages
  @builder << '</ol>' if @in_background or @in_scenario_outline
end

#after_table_row(table_row) ⇒ Object 



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/closer/formatter/html.rb', line 395

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

#after_tags(tags) ⇒ Object 



149
150
151
 
# File 'lib/closer/formatter/html.rb', line 149

def after_tags(tags)
  @tag_spacer = nil
end

#after_test_case(test_case, result) ⇒ Object 



462
463
464
465
466
 
# File 'lib/closer/formatter/html.rb', line 462

def after_test_case(test_case, result)
  if result.failed? and not @scenario_red
    set_scenario_color_failed
  end
end

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



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

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

#before_background(background) ⇒ Object 



176
177
178
179
 
# File 'lib/closer/formatter/html.rb', line 176

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

#before_comment(comment) ⇒ Object 



134
135
136
 
# File 'lib/closer/formatter/html.rb', line 134

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

#before_examples(examples) ⇒ Object 



250
251
252
 
# File 'lib/closer/formatter/html.rb', line 250

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

#before_feature(feature) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/closer/formatter/html.rb', line 113

def before_feature(feature)
  dir = feature_dir(feature)
  unless dir.empty?
    if @feature_dir != dir
      @builder << '<div class="feature_dir"><span class="val" onclick="toggle_feature_dir(this);">'
      @builder << dir
      @builder << '</span></div>'
    end

    @feature_dir = dir
  end

  @feature = feature
  @exceptions = []
  @builder << "<div id=\"#{feature_id}\" class=\"feature\">"
end

#before_feature_element(feature_element) ⇒ Object 



195
196
197
198
199
200
201
 
# File 'lib/closer/formatter/html.rb', line 195

def before_feature_element(feature_element)
  @scenario_number+=1
  @scenario_red = false
  css_class = AST_CLASSES[feature_element.class]
  @builder << "<div class='#{css_class}'>"
  @in_scenario_outline = feature_element.class == Cucumber::Core::Ast::ScenarioOutline
end

#before_features(features) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/closer/formatter/html.rb', line 76

def before_features(features)
  @step_count = features && features.step_count || 0 #TODO: Make this work with core!

  @builder.declare!(:DOCTYPE, :html)

  @builder << '<html>'
    @builder.head do
    @builder.meta('http-equiv' => 'Content-Type', :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')
      @builder.div(:id => 'expand-collapse') do
        @builder.p('Expand All', :id => 'expander', :style => 'cursor: pointer;')
        @builder.p('Collapse All', :id => 'collapser', :style => 'cursor: pointer;')
      end
    end
  end
end

#before_multiline_arg(multiline_arg) ⇒ Object 



367
368
369
370
371
372
 
# File 'lib/closer/formatter/html.rb', line 367

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

#before_outline_table(outline_table) ⇒ Object 



238
239
240
241
242
 
# File 'lib/closer/formatter/html.rb', line 238

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

#before_step(step) ⇒ Object 



275
276
277
278
279
280
 
# File 'lib/closer/formatter/html.rb', line 275

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

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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/closer/formatter/html.rb', line 286

def before_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background, file_colon_line)
  @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)

  if ! @delayed_messages.empty? and status == :passed
    @builder << "<li id='#{@step_id}' class='step #{status} expand'>"
  else
    @builder << "<li id='#{@step_id}' class='step #{status}'>"
  end
end

#before_steps(steps) ⇒ Object 



266
267
268
 
# File 'lib/closer/formatter/html.rb', line 266

def before_steps(steps)
  @builder << '<ol style="display: none;">'
end

#before_table_row(table_row) ⇒ Object 



388
389
390
391
392
393
 
# File 'lib/closer/formatter/html.rb', line 388

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 



142
143
144
145
146
147
 
# File 'lib/closer/formatter/html.rb', line 142

def comment_line(comment_line)
  unless magic_comment?(comment_line)
    @builder.text!(comment_line)
    @builder.br
  end
end

#doc_string(string) ⇒ Object 



381
382
383
384
385
386
 
# File 'lib/closer/formatter/html.rb', line 381

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

#embed(src, mime_type, label) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/closer/formatter/html.rb', line 41

def embed(src, mime_type, label)
  case(mime_type)
  when /^image\/(png|gif|jpg|jpeg)/
    unless File.file?(src) or src =~ /^data:image\/(png|gif|jpg|jpeg);base64,/
      type = mime_type =~ /;base[0-9]+$/ ? mime_type : mime_type + ";base64"
      src = "data:" + type + "," + src
    end
    embed_image(src, label)
  when /^text\/plain/
    embed_text(src, label)
  end
end

#embed_image(src, label) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/closer/formatter/html.rb', line 54

def embed_image(src, label)
  id = "img_#{@img_id}"
  @img_id += 1
  if @io.respond_to?(:path) and File.file?(src)
    out_dir = Pathname.new(File.dirname(File.absolute_path(@io.path)))
    src = Pathname.new(File.absolute_path(src)).relative_path_from(out_dir)
  end        
  @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">#{label}</a><br>&nbsp;
    <img id="#{id}" style="display: none" src="#{src}"/>}
  end
end

#embed_text(src, label) ⇒ Object 



67
68
69
70
71
72
73
 
# File 'lib/closer/formatter/html.rb', line 67

def embed_text(src, label)
  id = "text_#{@text_id}"
  @text_id += 1
  @builder.span(:class => 'embed') do |pre|
    pre << %{<a id="#{id}" href="#{src}" title="#{label}">#{label}</a>}
  end
end

#empty_messages ⇒ Object 



458
459
460
 
# File 'lib/closer/formatter/html.rb', line 458

def empty_messages
  @delayed_messages = []
end

#examples_name(keyword, name) ⇒ Object 



258
259
260
261
262
263
264
 
# File 'lib/closer/formatter/html.rb', line 258

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 



356
357
358
359
360
 
# File 'lib/closer/formatter/html.rb', line 356

def exception(exception, status)
  return if @hide_this_step
  print_messages
  build_exception_detail(exception)
end

#extra_failure_content(file_colon_line) ⇒ Object 



362
363
364
365
 
# File 'lib/closer/formatter/html.rb', line 362

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(keyword, name) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/closer/formatter/html.rb', line 159

def feature_name(keyword, name)
  title = feature_dir(@feature, true) + @feature.file.split('/').last.gsub(/\.feature/, '')
  lines = name.split(/\r?\n/)
  return if lines.empty?
  @builder.h2 do |h2|
    @builder.span(:class => 'val') do
      @builder << title
    end
  end

  if lines.size > 1
    @builder.div(:class => 'narrative') do
      @builder << lines[1..-1].join("\n")
    end
  end
end

#print_messages ⇒ Object 



436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/closer/formatter/html.rb', line 436

def print_messages
  return if @delayed_messages.empty?

  #@builder.ol do
    @delayed_messages.each do |ann|
      @builder.li(:class => 'message', :style => 'display: none;') do
        @builder << ann
      end
    end
  #end
  empty_messages
end

#print_table_row_messages ⇒ Object 



449
450
451
452
453
454
455
456
 
# File 'lib/closer/formatter/html.rb', line 449

def print_table_row_messages
  return if @delayed_messages.empty?

  @builder.td(:class => 'message') do
    @builder << @delayed_messages.join(", ")
  end
  empty_messages
end

#puts(message) ⇒ Object 



431
432
433
434
 
# File 'lib/closer/formatter/html.rb', line 431

def puts(message)
  @delayed_messages << message
  #@builder.pre(message, :class => 'message')
end

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



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
 
# File 'lib/closer/formatter/html.rb', line 212

def scenario_name(keyword, name, file_colon_line, source_indent)
  @builder.span(:class => 'scenario_file', :style => 'display: none;') do
    @builder << file_colon_line
  end
  @listing_background = false
  scenario_id = "scenario_#{@scenario_number}"
  if @inside_outline
    @outline_row += 1
    scenario_id += "_#{@outline_row}"
    @scenario_red = false
  end

  lines = name.split("\n")
  title = lines.shift
  @builder.h3(:id => scenario_id) do
    @builder.span(title, :class => 'val', :style => 'cursor: pointer;')
  end

  if lines.size > 0
    @builder.pre(:class => 'narrative', :style => 'display: none;') do
      trim_size = indent_size(lines.first)
      @builder << lines.map{|line| line[trim_size..-1] }.join("\n")
    end
  end
end

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



347
348
349
350
351
352
353
354
 
# File 'lib/closer/formatter/html.rb', line 347

def step_name(keyword, step_match, status, source_indent, background, file_colon_line)
  background_in_scenario = background && !@listing_background
  @skip_step = background_in_scenario

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

#table_cell_value(value, status) ⇒ Object 



420
421
422
423
424
425
426
427
428
429
 
# File 'lib/closer/formatter/html.rb', line 420

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) if @inside_outline
  @col_index += 1
end

#tag_name(tag_name) ⇒ Object 



153
154
155
156
157
 
# File 'lib/closer/formatter/html.rb', line 153

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