Class: Cucumber::Formatter::Pdf

Inherits:
Object
  • Object
show all
Includes:
Console, FileUtils
Defined in:
lib/cucumber/formatter/pdf.rb

Constant Summary

Constants included from Console

Console::FORMATS

Constants included from ANSIColor

ANSIColor::ALIASES

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Console

#announce, #format_step, #format_string, #print_counts, #print_elements, #print_exception, #print_passing_wip, #print_snippets, #print_stats, #print_steps, #print_tag_limit_warnings, #record_tag_occurrences

Methods included from ANSIColor

define_grey, define_real_grey, #grey

Methods included from Duration

#format_duration

Constructor Details

#initialize(step_mother, io, options) ⇒ Pdf

Returns a new instance of Pdf.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/cucumber/formatter/pdf.rb', line 18

def initialize(step_mother, io, options)
  @step_mother = step_mother
  raise "You *must* specify --out FILE for the pdf formatter" unless File === io

  if(options[:dry_run])
    @status_colors = { :passed => BLACK, :skipped => BLACK, :undefined => BLACK, :failed => BLACK}
  else
    @status_colors = { :passed => '055902', :skipped => GREY, :undefined => 'F27405', :failed => '730202'}
  end

  @pdf = Prawn::Document.new
  @scrap = Prawn::Document.new
  @doc = @scrap
  @io = io
  @options = options
  @exceptions = []
  @indent = 0
  @buffer = []
  puts "writing to #{io.path}"
  begin
    @pdf.image open("features/support/logo.png"), :position => :center, :width => 500
  rescue
  end
  @pdf.text "\n\n\nCucumber features", :align => :center, :size => 32
  @pdf.text "Generated: #{Time.now.strftime("%Y-%m-%d %H:%M")}", :size => 10, :at => [0, 24]
  @pdf.text "Command: <code>cucumber #{ARGV.join(" ")}</code>", :size => 10, :at => [0,10]
  unless options[:dry_run]
    @pdf.bounding_box [450,100] , :width => 100 do  
      @pdf.text 'Legend', :size => 10
      @status_colors.each do |k,v|
        @pdf.fill_color v
        @pdf.text k.to_s, :size => 10
        @pdf.fill_color BLACK
      end
    end
  end
end

Instance Attribute Details

#indent=(value) ⇒ Object (writeonly)

Sets the attribute indent

Parameters:

  • value —

    the value to set the attribute indent to.



16
17
18
 
# File 'lib/cucumber/formatter/pdf.rb', line 16

def indent=(value)
  @indent = value
end

Instance Method Details

#after_background(background) ⇒ Object 



133
134
135
 
# File 'lib/cucumber/formatter/pdf.rb', line 133

def after_background(background)
  @in_background = nil
end

#after_feature(feature) ⇒ Object 



88
89
90
 
# File 'lib/cucumber/formatter/pdf.rb', line 88

def after_feature(feature)
  flush
end

#after_feature_element(feature_element) ⇒ Object 



84
85
86
 
# File 'lib/cucumber/formatter/pdf.rb', line 84

def after_feature_element(feature_element)
  flush
end

#after_features(features) ⇒ Object 



56
57
58
59
 
# File 'lib/cucumber/formatter/pdf.rb', line 56

def after_features(features)
  @pdf.render_file(@io.path)
  puts "\ndone"
end

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



172
173
174
 
# File 'lib/cucumber/formatter/pdf.rb', line 172

def background_name(keyword, name, file_colon_line, source_indent)
  feature_element_name(keyword, name)
end

#before_background(background) ⇒ Object 



129
130
131
 
# File 'lib/cucumber/formatter/pdf.rb', line 129

def before_background(background)
  @in_background = true
end

#before_feature_element(feature_element) ⇒ Object 



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

def before_feature_element(feature_element)
  record_tag_occurrences(feature_element, @options)
end

#before_multiline_arg(table) ⇒ Object 



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

def before_multiline_arg(table)
  return if @hide_this_step
  if(table.kind_of? Cucumber::Ast::Table)
    keep_with do
      @doc.table(table.rows << table.headers , :position => :center, :row_colors => ['ffffff', 'f0f0f0'])
    end
  end
end

#before_outline_table(table) ⇒ Object

using row_color hack to highlight each row correctly



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

def before_outline_table(table)
  return if @hide_this_step
  row_colors = table.example_rows.map { |r| @status_colors[r.status] unless r.status == :skipped}
  keep_with do
    @doc.table(table.rows, :headers => table.headers, :position => :center, :row_colors => row_colors)
  end
end

#before_py_string(string) ⇒ Object 



155
156
157
158
159
160
161
162
163
164
 
# File 'lib/cucumber/formatter/pdf.rb', line 155

def before_py_string(string)
  return if @hide_this_step
  s = %{"""\n#{string}\n"""}.indent(10)
  s = s.split("\n").map{|l| l =~ /^\s+$/ ? '' : l}
  s.each do |line|
    line.gsub!('<', '&lt;')
    line.gsub!('>', '&gt;')
    keep_with { @doc.text line, :size => 8 }
  end
end

#examples_name(keyword, name) ⇒ Object 



176
177
178
 
# File 'lib/cucumber/formatter/pdf.rb', line 176

def examples_name(keyword, name)
  feature_element_name(keyword, name)
end

#feature_element_name(keyword, name) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/cucumber/formatter/pdf.rb', line 92

def feature_element_name(keyword, name)
  names = name.empty? ? [name] : name.split("\n")
  print "."
  STDOUT.flush

  keep_with do
    @doc.move_down(20)
    @doc.fill_color GREY
    @doc.text("#{keyword}", :size => 8)
    @doc.fill_color BLACK
    @doc.text("#{names[0]}", :size => 16)
    names[1..-1].each { |s| @doc.text(s, :size => 12) }
    @doc.text("\n")
  end
end

#feature_name(name) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/cucumber/formatter/pdf.rb', line 61

def feature_name(name)
  @pdf.start_new_page
  name["Feature:"] = "" if name["Feature:"]
  names = name.split("\n")
  @pdf.fill_color GREY
  @pdf.text('Feature', :align => :center)
  @pdf.fill_color BLACK
  names.each_with_index do |nameline, i|
    case i
    when 0
      @pdf.text(nameline.strip, :size => 30, :align => :center )
      @pdf.text("\n")
    else
      @pdf.text(nameline.strip, :size => 12)
    end
  end
  @pdf.move_down(30)
end

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



180
181
182
 
# File 'lib/cucumber/formatter/pdf.rb', line 180

def scenario_name(keyword, name, file_colon_line, source_indent)
  feature_element_name(keyword, name)
end

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



123
124
125
126
127
 
# File 'lib/cucumber/formatter/pdf.rb', line 123

def step_name(keyword, step_match, status, source_indent, background)
  return if @hide_this_step
  line = "<b>#{keyword}</b> #{step_match.format_args("%s").gsub('<', '&lt;').gsub('>', '&gt;')}"
  colorize(line, status)
end

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/cucumber/formatter/pdf.rb', line 108

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

#tag_name(tag_name) ⇒ Object 



166
167
168
169
170
 
# File 'lib/cucumber/formatter/pdf.rb', line 166

def tag_name(tag_name)
  return if @hide_this_step
  tag = format_string(tag_name, :tag).indent(@indent)
  # TODO should we render tags at all? skipped for now. difficult to place due to page breaks
end