Module: Cucumber::Formatter::Console
Overview
This module contains helper methods that are used by formatters that print output to the terminal.
Constant Summary
collapse
- FORMATS =
Hash.new{|hash, format| hash[format] = method(format).to_proc}
Constants included
from ANSIColor
ANSIColor::ALIASES
Instance Method Summary
collapse
Methods included from ANSIColor
define_grey, define_real_grey, grey
Methods included from Duration
#format_duration
Instance Method Details
#announce(announcement) ⇒ Object
153
154
155
156
157
|
# File 'lib/cucumber/formatter/console.rb', line 153
def announce(announcement)
@io.puts
@io.puts(format_string(announcement, :tag))
@io.flush
end
|
14
15
16
17
18
19
20
21
22
23
24
25
|
# File 'lib/cucumber/formatter/console.rb', line 14
def format_step(keyword, step_match, status, source_indent)
= if source_indent
c = (' # ' + step_match.file_colon_line).indent(source_indent)
format_string(c, :comment)
else
''
end
format = format_for(status, :param)
line = keyword + " " + step_match.format_args(format) +
format_string(line, status)
end
|
27
28
29
30
31
32
33
34
|
# File 'lib/cucumber/formatter/console.rb', line 27
def format_string(string, status)
fmt = format_for(status)
if Proc === fmt
fmt.call(string)
else
fmt % string
end
end
|
#print_counts ⇒ Object
58
59
60
61
|
# File 'lib/cucumber/formatter/console.rb', line 58
def print_counts
STDERR.puts("The #print_counts method is deprecated and will be removed in 0.4. Use #print_stats instead")
print_stats(nil)
end
|
#print_elements(elements, status, kind) ⇒ Object
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
# File 'lib/cucumber/formatter/console.rb', line 40
def print_elements(elements, status, kind)
if elements.any?
@io.puts(format_string("(::) #{status} #{kind} (::)", status))
@io.puts
@io.flush
end
elements.each_with_index do |element, i|
if status == :failed
print_exception(element.exception, status, 0)
else
@io.puts(format_string(element.backtrace_line, status))
end
@io.puts
@io.flush
end
end
|
#print_exception(e, status, indent) ⇒ Object
87
88
89
|
# File 'lib/cucumber/formatter/console.rb', line 87
def print_exception(e, status, indent)
@io.puts(format_string("#{e.message} (#{e.class})\n#{e.backtrace.join("\n")}".indent(indent), status))
end
|
#print_passing_wip(options) ⇒ Object
117
118
119
120
121
122
123
124
125
126
|
# File 'lib/cucumber/formatter/console.rb', line 117
def print_passing_wip(options)
return unless options[:wip]
passed = step_mother.scenarios(:passed)
if passed.any?
@io.puts format_string("\nThe --wip switch was used, so I didn't expect anything to pass. These scenarios passed:", :failed)
print_elements(passed, :passed, "scenarios")
else
@io.puts format_string("\nThe --wip switch was used, so the failures were expected. All is good.\n", :passed)
end
end
|
#print_snippets(options) ⇒ Object
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
# File 'lib/cucumber/formatter/console.rb', line 91
def print_snippets(options)
return unless options[:snippets]
undefined = step_mother.steps(:undefined)
return if undefined.empty?
unknown_programming_language = step_mother.unknown_programming_language?
snippets = undefined.map do |step|
step_name = Undefined === step.exception ? step.exception.step_name : step.name
step_multiline_class = step.multiline_arg ? step.multiline_arg.class : nil
snippet = @step_mother.snippet_text(step.actual_keyword, step_name, step_multiline_class)
snippet
end.compact.uniq
text = "\nYou can implement step definitions for undefined steps with these snippets:\n\n"
text += snippets.join("\n\n")
@io.puts format_string(text, :undefined)
if unknown_programming_language
@io.puts format_string("\nIf you want snippets in a different programming language, just make sure a file\n" +
"with the appropriate file extension exists where cucumber looks for step definitions.", :failed)
end
@io.puts
@io.flush
end
|
#print_stats(features) ⇒ Object
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
# File 'lib/cucumber/formatter/console.rb', line 63
def print_stats(features)
@failures = step_mother.scenarios(:failed).select { |s| s.is_a?(Cucumber::Ast::Scenario) }
if !@failures.empty?
@io.puts format_string("Failing Scenarios:", :failed)
@failures.each do |failure|
@io.puts format_string("cucumber " + failure.file_colon_line, :failed) +
format_string(" # Scenario: " + failure.name, :comment)
end
@io.puts
end
@io.print dump_count(step_mother.scenarios.length, "scenario")
print_status_counts{|status| step_mother.scenarios(status)}
@io.print dump_count(step_mother.steps.length, "step")
print_status_counts{|status| step_mother.steps(status)}
@io.puts(format_duration(features.duration)) if features && features.duration
@io.flush
end
|
#print_steps(status) ⇒ Object
36
37
38
|
# File 'lib/cucumber/formatter/console.rb', line 36
def print_steps(status)
print_elements(step_mother.steps(status), status, 'steps')
end
|
#print_tag_limit_warnings(options) ⇒ Object
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
# File 'lib/cucumber/formatter/console.rb', line 128
def print_tag_limit_warnings(options)
first_tag = true
options[:tag_names].each do |tag_name, limit|
unless Ast::Tags.exclude_tag?(tag_name)
tag_frequnecy = @tag_occurences[tag_name].size
if limit && tag_frequnecy > limit
@io.puts if first_tag
first_tag = false
@io.puts format_string("#{tag_name} occurred #{tag_frequnecy} times, but the limit was set to #{limit}", :failed)
@tag_occurences[tag_name].each {|location| @io.puts format_string(" #{location}", :failed)}
@io.flush
end
end
end
end
|
#record_tag_occurrences(feature_element, options) ⇒ Object
144
145
146
147
148
149
150
151
|
# File 'lib/cucumber/formatter/console.rb', line 144
def record_tag_occurrences(feature_element, options)
@tag_occurences ||= Hash.new{|k,v| k[v] = []}
options[:tag_names].each do |tag_name, limit|
if !Ast::Tags.exclude_tag?(tag_name) && feature_element.tag_count(tag_name) > 0
@tag_occurences[tag_name] << feature_element.file_colon_line
end
end
end
|