Class: PrettyFace::Formatter::Html

Inherits:
Object
  • Object
show all
Includes:
Cucumber::Formatter::Duration, Cucumber::Formatter::Io, ViewHelper
Defined in:
lib/pretty_face/formatter/html.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ViewHelper

#failed_scenario?, #scenario_average_duration, #scenario_count, #scenarios_summary_for, #start_time, #step_average_duration, #step_count, #steps_summary_for, #total_duration

Constructor Details

#initialize(step_mother, path_or_io, options) ⇒ Html

Returns a new instance of Html.



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/pretty_face/formatter/html.rb', line 21

def initialize(step_mother, path_or_io, options)
  @path = path_or_io
  set_path_and_file(path_or_io)
  @path_to_erb = File.join(File.dirname(__FILE__), '..', 'templates')
  @step_mother = step_mother
  @options = options
  @report = Report.new
  @img_id = 0
  @logo = 'face.png'
end

Instance Attribute Details

#logo ⇒ Object (readonly)

Returns the value of attribute logo.



19
20
21
 
# File 'lib/pretty_face/formatter/html.rb', line 19

def 
  @logo
end

#report ⇒ Object (readonly)

Returns the value of attribute report.



19
20
21
 
# File 'lib/pretty_face/formatter/html.rb', line 19

def report
  @report
end

Instance Method Details

#after_background(background) ⇒ Object 



75
76
77
78
 
# File 'lib/pretty_face/formatter/html.rb', line 75

def after_background(background)
  @report.end_background
  @report.current_feature.background << ReportStep.new(background)
end

#after_feature(feature) ⇒ Object 



67
68
69
 
# File 'lib/pretty_face/formatter/html.rb', line 67

def after_feature(feature)
  @report.current_feature.close(feature)
end

#after_feature_element(feature_element) ⇒ Object 



86
87
88
89
90
 
# File 'lib/pretty_face/formatter/html.rb', line 86

def after_feature_element(feature_element)
  unless scenario_outline?(feature_element)
    process_scenario(feature_element)
  end
end

#after_features(features) ⇒ Object 



116
117
118
119
120
121
122
 
# File 'lib/pretty_face/formatter/html.rb', line 116

def after_features(features)
  @features = features
  @duration = format_duration(Time.now - @tests_started)
  copy_images
  copy_stylesheets
  generate_report
end

#after_step(step) ⇒ Object 



108
109
110
111
112
113
114
 
# File 'lib/pretty_face/formatter/html.rb', line 108

def after_step(step)
  step = process_step(step) unless step_belongs_to_outline? step
  if @cells
    step.table = @cells
    @cells = nil
  end
end

#after_table_row(example_row) ⇒ Object 



96
97
98
99
100
101
102
 
# File 'lib/pretty_face/formatter/html.rb', line 96

def after_table_row(example_row)
  unless info_row?(example_row)
    @report.current_scenario.populate(example_row)
    build_scenario_outline_steps(example_row)
  end
  populate_cells(example_row) if example_row.instance_of? Cucumber::Ast::Table::Cells
end

#before_background(background) ⇒ Object 



71
72
73
 
# File 'lib/pretty_face/formatter/html.rb', line 71

def before_background(background)
  @report.begin_background
end

#before_feature(feature) ⇒ Object 



63
64
65
 
# File 'lib/pretty_face/formatter/html.rb', line 63

def before_feature(feature)
  @report.add_feature ReportFeature.new(feature, features_summary_file)
end

#before_feature_element(feature_element) ⇒ Object 



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

def before_feature_element(feature_element)
  unless scenario_outline? feature_element
    @report.add_scenario  ReportScenario.new(feature_element)
  end
end

#before_features(features) ⇒ Object 



53
54
55
56
 
# File 'lib/pretty_face/formatter/html.rb', line 53

def before_features(features)
  make_output_directories
  @tests_started = Time.now
end

#before_step(step) ⇒ Object 



104
105
106
 
# File 'lib/pretty_face/formatter/html.rb', line 104

def before_step(step)
  @step_timer = Time.now
end

#before_table_row(example_row) ⇒ Object 



92
93
94
 
# File 'lib/pretty_face/formatter/html.rb', line 92

def before_table_row(example_row)
  @report.add_scenario ReportScenario.new(example_row) unless info_row?(example_row)
end

#custom_feature_header? ⇒ Boolean

Returns:

  • (Boolean) 


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

def custom_feature_header?
  return false unless customization_directory

  Dir.foreach(customization_directory) do |file|
    return true if file == '_feature_header.erb'
  end
  false
end

#custom_suite_header? ⇒ Boolean

Returns:

  • (Boolean) 


128
129
130
131
132
133
134
135
 
# File 'lib/pretty_face/formatter/html.rb', line 128

def custom_suite_header?
  return false unless customization_directory

  Dir.foreach(customization_directory) do |file|
    return true if file == '_suite_header.erb'
  end
  false
end

#embed(src, mime_type, label) ⇒ Object 



38
39
40
41
42
43
 
# File 'lib/pretty_face/formatter/html.rb', line 38

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

#embed_image(src, label) ⇒ Object 



45
46
47
48
49
50
51
 
# File 'lib/pretty_face/formatter/html.rb', line 45

def embed_image(src, label)
  @report.current_scenario.image = src.split('/').last
  @report.current_scenario.image_label = label
  @report.current_scenario.image_id = "img_#{@img_id}"
  @img_id += 1
  FileUtils.cp src, "#{File.dirname(@path)}/images"
end

#features ⇒ Object 



124
125
126
 
# File 'lib/pretty_face/formatter/html.rb', line 124

def features
  @report.features
end

#features_summary_file ⇒ Object 



58
59
60
61
 
# File 'lib/pretty_face/formatter/html.rb', line 58

def features_summary_file
  parts = @io.path.split('/')
  parts[parts.length - 1]
end

#set_path_and_file(path_or_io) ⇒ Object 



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

def set_path_and_file(path_or_io)
  dir = File.dirname(path_or_io)
  FileUtils.mkdir_p dir unless File.directory? dir
  @io = ensure_io(path_or_io, 'html')
end