Class: Cucumber::Formatter::Pretty

Inherits:
Ast::Visitor show all
Includes:
Console, FileUtils
Defined in:
lib/cucumber/formatter/pretty.rb

Overview

This formatter prints features to plain text - exactly how they were parsed, just prettier. That means with proper indentation and alignment of table columns.

If the output is STDOUT (and not a file), there are bright colours to watch too.

Direct Known Subclasses

Cli::LanguageHelpFormatter

Constant Summary

Constants included from Console

Console::FORMATS

Constants included from ANSIColor

ANSIColor::ALIASES

Instance Attribute Summary collapse

Attributes inherited from Ast::Visitor

#options, #step_mother

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

Methods included from ANSIColor

#grey

Methods included from Duration

#format_duration

Methods inherited from Ast::Visitor

#announce, #matches_scenario_names?, #visit_examples, #visit_examples_array, #visit_outline_table, #visit_steps, #visit_table_cell

Constructor Details

#initialize(step_mother, io, options, delim = '|') ⇒ Pretty

Returns a new instance of Pretty.



16
17
18
19
20
21
22
23
 
# File 'lib/cucumber/formatter/pretty.rb', line 16

def initialize(step_mother, io, options, delim='|')
  super(step_mother)
  @io = io
  @options = options
  @delim = delim
  @exceptions = []
  @indent = 0
end

Instance Attribute Details

#indent=(value) ⇒ Object (writeonly)

Sets the attribute indent

Parameters:

  • value —

    the value to set the attribute indent to.



14
15
16
 
# File 'lib/cucumber/formatter/pretty.rb', line 14

def indent=(value)
  @indent = value
end

Instance Method Details

#visit_background(background) ⇒ Object 



84
85
86
87
88
89
90
91
92
 
# File 'lib/cucumber/formatter/pretty.rb', line 84

def visit_background(background)
  @indent = 2
  @scenario_indent = 2
  @in_background = true
  super
  @in_background = nil
  @io.puts
  @io.flush
end

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



94
95
96
 
# File 'lib/cucumber/formatter/pretty.rb', line 94

def visit_background_name(keyword, name, file_colon_line, source_indent)
  visit_feature_element_name(keyword, name, file_colon_line, source_indent)
end

#visit_comment(comment) ⇒ Object 



46
47
48
 
# File 'lib/cucumber/formatter/pretty.rb', line 46

def visit_comment(comment)
  comment.accept(self)
end

#visit_comment_line(comment_line) ⇒ Object 



50
51
52
53
 
# File 'lib/cucumber/formatter/pretty.rb', line 50

def visit_comment_line(comment_line)
  @io.puts(comment_line.indent(@indent)) 
  @io.flush
end

#visit_examples_name(keyword, name) ⇒ Object 



98
99
100
101
102
103
104
105
 
# File 'lib/cucumber/formatter/pretty.rb', line 98

def visit_examples_name(keyword, name)
  names = name.empty? ? [name] : name.split("\n")
  @io.puts("\n    #{keyword} #{names[0]}")
  names[1..-1].each {|s| @io.puts "      #{s}" }
  @io.flush
  @indent = 6
  @scenario_indent = 6
end

#visit_exception(exception, status) ⇒ Object 



151
152
153
154
 
# File 'lib/cucumber/formatter/pretty.rb', line 151

def visit_exception(exception, status)
  print_exception(exception, status, @indent)
  @io.flush
end

#visit_feature(feature) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/cucumber/formatter/pretty.rb', line 30

def visit_feature(feature)
  @exceptions = []
  @indent = 0
  if @options[:autoformat]
    file = File.join(@options[:autoformat], feature.file)
    dir = File.dirname(file)
    mkdir_p(dir) unless File.directory?(dir)
    File.open(file, Cucumber.file_mode('w')) do |io|
      @io = io
      super
    end
  else
    super
  end
end

#visit_feature_element(feature_element) ⇒ Object 



76
77
78
79
80
81
82
 
# File 'lib/cucumber/formatter/pretty.rb', line 76

def visit_feature_element(feature_element)
  @indent = 2
  @scenario_indent = 2
  super
  @io.puts
  @io.flush
end

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



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

def visit_feature_element_name(keyword, name, file_colon_line, source_indent)
  @io.puts if @scenario_indent == 6
  names = name.empty? ? [name] : name.split("\n")
  line = "#{keyword} #{names[0]}".indent(@scenario_indent)
  @io.print(line)
  if @options[:source]
    line_comment = " # #{file_colon_line}".indent(source_indent)
    @io.print(format_string(line_comment, :comment))
  end
  @io.puts
  names[1..-1].each {|s| @io.puts "    #{s}"}
  @io.flush
end

#visit_feature_name(name) ⇒ Object 



70
71
72
73
74
 
# File 'lib/cucumber/formatter/pretty.rb', line 70

def visit_feature_name(name)
  @io.puts(name)
  @io.puts
  @io.flush
end

#visit_features(features) ⇒ Object 



25
26
27
28
 
# File 'lib/cucumber/formatter/pretty.rb', line 25

def visit_features(features)
  super
  print_summary(features) unless @options[:autoformat]
end

#visit_multiline_arg(multiline_arg) ⇒ Object 



146
147
148
149
 
# File 'lib/cucumber/formatter/pretty.rb', line 146

def visit_multiline_arg(multiline_arg)
  return if @options[:no_multiline]
  super
end

#visit_py_string(string) ⇒ Object 



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

def visit_py_string(string)
  s = %{"""\n#{string}\n"""}.indent(@indent)
  s = s.split("\n").map{|l| l =~ /^\s+$/ ? '' : l}.join("\n")
  @io.puts(format_string(s, @status))
  @io.flush
end

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



107
108
109
 
# File 'lib/cucumber/formatter/pretty.rb', line 107

def visit_scenario_name(keyword, name, file_colon_line, source_indent)
  visit_feature_element_name(keyword, name, file_colon_line, source_indent)
end

#visit_step(step) ⇒ Object 



125
126
127
128
 
# File 'lib/cucumber/formatter/pretty.rb', line 125

def visit_step(step)
  @indent = 6
  super
end

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



140
141
142
143
144
 
# File 'lib/cucumber/formatter/pretty.rb', line 140

def visit_step_name(keyword, step_match, status, source_indent, background)
  source_indent = nil unless @options[:source]
  formatted_step_name = format_step(keyword, step_match, status, source_indent)
  @io.puts(formatted_step_name.indent(@scenario_indent + 2))
end

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



130
131
132
133
134
135
136
137
138
 
# File 'lib/cucumber/formatter/pretty.rb', line 130

def visit_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background)
  if exception
    return if @exceptions.index(exception)
    @exceptions << exception
  end
  return if status != :failed && @in_background ^ background
  @status = status
  super
end

#visit_table_cell_value(value, width, status) ⇒ Object 



172
173
174
175
176
 
# File 'lib/cucumber/formatter/pretty.rb', line 172

def visit_table_cell_value(value, width, status)
  status ||= @status || :passed
  @io.print(' ' + format_string((value.to_s || '').ljust(width), status) + ::Term::ANSIColor.reset(" #{@delim}"))
  @io.flush
end

#visit_table_row(table_row) ⇒ Object 



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

def visit_table_row(table_row)
  @io.print @delim.indent(@indent)
  super
  @io.puts
  if table_row.exception && !@exceptions.index(table_row.exception)
    print_exception(table_row.exception, :failed, @indent) 
  end
end

#visit_tag_name(tag_name) ⇒ Object 



63
64
65
66
67
68
 
# File 'lib/cucumber/formatter/pretty.rb', line 63

def visit_tag_name(tag_name)
  tag = format_string("@#{tag_name}", :tag).indent(@indent)
  @io.print(tag)
  @io.flush
  @indent = 1
end

#visit_tags(tags) ⇒ Object 



55
56
57
58
59
60
61
 
# File 'lib/cucumber/formatter/pretty.rb', line 55

def visit_tags(tags)
  tags.accept(self)
  if @indent == 1
    @io.puts 
    @io.flush
  end
end