require 'erb'
require 'cucumber/formatter/ordered_xml_markup'
require 'cucumber/formatter/duration'
require 'cucumber/formatter/io'
module Cucumber
module Formatter
class Html
include ERB::Util # for the #h method
include Duration
include Io
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
def embed(file, mime_type)
case(mime_type)
when /^image\/(png|gif|jpg|jpeg)/
embed_image(file)
end
end
def embed_image(file)
id = file.hash
@builder.span(:class => 'embed') do |pre|
pre << %{Screenshot
}
end
end
def before_features(features)
@step_count = get_step_count(features)
#
@builder.declare!(
:DOCTYPE,
:html,
:PUBLIC,
'-//W3C//DTD XHTML 1.0 Strict//EN',
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'
)
@builder << ''
@builder.head do
@builder.meta(:content => 'text/html;charset=utf-8')
@builder.title 'Cucumber'
inline_css
inline_js
end
@builder << '
' end def after_comment(comment) @builder << '' end def comment_line(comment_line) @builder.text!(comment_line) @builder.br end def after_tags(tags) @tag_spacer = nil end def tag_name(tag_name) @builder.text!(@tag_spacer) if @tag_spacer @tag_spacer = ' ' @builder.span(tag_name, :class => 'tag') end def feature_name(keyword, name) lines = name.split(/\r?\n/) return if lines.empty? @builder.h2 do |h2| @builder.span(keyword + ': ' + 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 def before_background(background) @in_background = true @builder << '
#{@snippet_extractor.snippet(file_colon_line)}
"
end
def before_multiline_arg(multiline_arg)
return if @hide_this_step || @skip_step
if Ast::Table === multiline_arg
@builder << '([^(\/)]+)<\//m)[1]
end
@builder.pre do
@builder.text!(message)
end
end
@builder.div(:class => 'backtrace') do
@builder.pre do
backtrace = exception.backtrace
backtrace.delete_if { |x| x =~ /\/gems\/(cucumber|rspec)/ }
@builder << backtrace_line(backtrace.join("\n"))
end
end
extra = extra_failure_content(backtrace)
@builder << extra unless extra == ""
end
def set_scenario_color(status)
if status == :undefined
set_scenario_color_pending
end
if status == :failed
set_scenario_color_failed
end
end
def set_scenario_color_failed
@builder.script do
@builder.text!("makeRed('cucumber-header');") unless @header_red
@header_red = true
@builder.text!("makeRed('scenario_#{@scenario_number}');") unless @scenario_red
@scenario_red = true
end
end
def set_scenario_color_pending
@builder.script do
@builder.text!("makeYellow('cucumber-header');") unless @header_red
@builder.text!("makeYellow('scenario_#{@scenario_number}');") unless @scenario_red
end
end
def get_step_count(features)
count = 0
features = features.instance_variable_get("@features")
features.each do |feature|
#get background steps
if feature.instance_variable_get("@background")
background = feature.instance_variable_get("@background")
background.init
background_steps = background.instance_variable_get("@steps").instance_variable_get("@steps")
count += background_steps.size
end
#get scenarios
feature.instance_variable_get("@feature_elements").each do |scenario|
scenario.init
#get steps
steps = scenario.instance_variable_get("@steps").instance_variable_get("@steps")
count += steps.size
#get example table
examples = scenario.instance_variable_get("@examples_array")
unless examples.nil?
examples.each do |example|
example_matrix = example.instance_variable_get("@outline_table").instance_variable_get("@cell_matrix")
count += example_matrix.size
end
end
#get multiline step tables
steps.each do |step|
multi_arg = step.instance_variable_get("@multiline_arg")
next if multi_arg.nil?
matrix = multi_arg.instance_variable_get("@cell_matrix")
count += matrix.size unless matrix.nil?
end
end
end
return count
end
def build_step(keyword, step_match, status)
step_name = step_match.format_args(lambda{|param| %{#{param}}})
@builder.div(:class => 'step_name') do |div|
@builder.span(keyword, :class => 'keyword')
@builder.span(:class => 'step val') do |name|
name << h(step_name).gsub(/<span class="(.*?)">/, '').gsub(/<\/span>/, '')
end
end
step_file = step_match.file_colon_line
step_file.gsub(/^([^:]*\.rb):(\d*)/) do
if ENV['TM_PROJECT_DIRECTORY']
step_file = "#{$1}:#{$2} "
end
end
@builder.div(:class => 'step_file') do |div|
@builder.span do
@builder << step_file
end
end
end
def build_cell(cell_type, value, attributes)
@builder.__send__(cell_type, attributes) do
@builder.div do
@builder.span(value,:class => 'step param')
end
end
end
def inline_css
@builder.style(:type => 'text/css') do
@builder << File.read(File.dirname(__FILE__) + '/cucumber.css')
end
end
def inline_js
@builder.script(:type => 'text/javascript') do
@builder << inline_js_content
end
end
def inline_js_content
<<-EOF
function moveProgressBar(percentDone) {
document.getElementById("cucumber-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) {
document.getElementById(element_id).style.background = '#FAF834';
document.getElementById(element_id).style.color = '#000000';
}
EOF
end
def move_progress
@builder << " "
end
def percent_done
result = 100.0
if @step_count != 0
result = ((@step_number).to_f / @step_count.to_f * 1000).to_i / 10.0
end
result
end
def format_exception(exception)
(["#{exception.message}"] + exception.backtrace).join("\n")
end
def backtrace_line(line)
line.gsub(/^([^:]*\.(?:rb|feature|haml)):(\d*)/) do
if ENV['TM_PROJECT_DIRECTORY']
"#{$1}:#{$2} "
else
line
end
end
end
def print_stats(features)
@builder << ""
@builder << ""
end
def print_stat_string(features)
string = String.new
string << dump_count(@step_mother.scenarios.length, "scenario")
scenario_count = print_status_counts{|status| @step_mother.scenarios(status)}
string << scenario_count if scenario_count
string << "
"
string << dump_count(@step_mother.steps.length, "step")
step_count = print_status_counts{|status| @step_mother.steps(status)}
string << step_count if step_count
end
def print_status_counts
counts = [:failed, :skipped, :undefined, :pending, :passed].map do |status|
elements = yield status
elements.any? ? "#{elements.length} #{status.to_s}" : nil
end.compact
return " (#{counts.join(', ')})" if counts.any?
end
def dump_count(count, what, state=nil)
[count, state, "#{what}#{count == 1 ? '' : 's'}"].compact.join(" ")
end
def create_builder(io)
OrderedXmlMarkup.new(:target => io, :indent => 0)
end
class SnippetExtractor #:nodoc:
class NullConverter; def convert(code, pre); code; end; end #:nodoc:
begin; require 'syntax/convertors/html'; @@converter = Syntax::Convertors::HTML.for_syntax "ruby"; rescue LoadError => e; @@converter = NullConverter.new; end
def snippet(error)
raw_code, line = snippet_for(error[0])
highlighted = @@converter.convert(raw_code, false)
highlighted << "\n# gem install syntax to get syntax highlighting" if @@converter.is_a?(NullConverter)
post_process(highlighted, line)
end
def snippet_for(error_line)
if error_line =~ /(.*):(\d+)/
file = $1
line = $2.to_i
[lines_around(file, line), line]
else
["# Couldn't get snippet for #{error_line}", 1]
end
end
def lines_around(file, line)
if File.file?(file)
lines = File.open(file).read.split("\n")
min = [0, line-3].max
max = [line+1, lines.length-1].min
selected_lines = []
selected_lines.join("\n")
lines[min..max].join("\n")
else
"# Couldn't get snippet for #{file}"
end
end
def post_process(highlighted, offending_line)
new_lines = []
highlighted.split("\n").each_with_index do |line, i|
new_line = "#{offending_line+i-2}#{line}"
new_line = "#{new_line}" if i == 2
new_lines << new_line
end
new_lines.join("\n")
end
end
end
end
end