Module: Cucumber::Formatter::Console

Extended by:
ANSIColor
Includes:
Duration, Summary
Included in:
Pretty, Progress, Usage
Defined in:
lib/cucumber/formatter/console.rb

Overview

This module contains helper methods that are used by formatters that print output to the terminal.

FORMAT is a hash of Proc objects, keyed by step-definition types, e.g. “FORMAT”. The Proc is called for each line of the step’s output.

format_step calls format_string, format_string calls format_for to obtain the formatting Proc.

Example:

The ANSI color console formatter defines a map of step-type to output color (e.g. “passed” to “green”), then builds methods named for the step-types (e.g. “def passed”), which themselves wrap the corresponding color-named methods provided by Term::ANSIColor (e.g. “def red”).

During output, each line is processed by passing it to the formatter Proc which returns the formatted (e.g. colored) string.

Defined Under Namespace

Classes: SnippetData

Constant Summary

Constants included from ANSIColor

ANSIColor::ALIASES

Constants included from Term::ANSIColor

Term::ANSIColor::ATTRIBUTES, Term::ANSIColor::ATTRIBUTE_NAMES, Term::ANSIColor::COLORED_REGEXP

Instance Method Summary collapse

Methods included from ANSIColor

cukes, define_grey, define_real_grey, green_cukes, grey, red_cukes, yellow_cukes

Methods included from Term::ANSIColor

attributes, coloring=, coloring?, #uncolored

Methods included from Summary

#scenario_summary, #step_summary

Methods included from Duration

#format_duration

Instance Method Details

#collect_failing_scenarios(runtime) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/cucumber/formatter/console.rb', line 103

def collect_failing_scenarios(runtime)
  # TODO: brittle - stop coupling to types
  scenario_class = LegacyApi::Ast::Scenario
  example_table_class = Core::Ast::ExamplesTable

  runtime.scenarios(:failed).select do |s|
    [scenario_class, example_table_class].include?(s.class)
  end.map do |s|
    s.is_a?(example_table_class)? s.scenario_outline : s
  end
end

#collect_snippet_data(test_step, result) ⇒ Object 



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/cucumber/formatter/console.rb', line 139

def collect_snippet_data(test_step, result)
  # collect snippet data for undefined steps
  unless hook?(test_step)
    keyword = test_step.source.last.actual_keyword(@previous_step_keyword)
    @previous_step_keyword = keyword
    if result.undefined?
      @snippets_input << Console::SnippetData.new(keyword, test_step.source.last)
    end
  end
end

#embed(file, mime_type, label) ⇒ Object 



177
178
179
 
# File 'lib/cucumber/formatter/console.rb', line 177

def embed(file, mime_type, label)
  # no-op
end

#empty_messages ⇒ Object 



214
215
216
 
# File 'lib/cucumber/formatter/console.rb', line 214

def empty_messages
  @delayed_messages = []
end

#format_step(keyword, step_match, status, source_indent) ⇒ Object 



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

def format_step(keyword, step_match, status, source_indent)
  comment = if source_indent
    c = ('# ' + step_match.location.to_s).indent(source_indent)
    format_string(c, :comment)
  else
    ''
  end

  format = format_for(status, :param)
  line = keyword + step_match.format_args(format) + comment
  format_string(line, status)
end

#format_string(o, status) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/cucumber/formatter/console.rb', line 46

def format_string(o, status)
  fmt = format_for(status)
  o.to_s.split("\n").map do |line|
    if Proc === fmt
      fmt.call(line)
    else
      fmt % line
    end
  end.join("\n")
end

#linebreaks(s, max) ⇒ Object

blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/10655



134
135
136
137
 
# File 'lib/cucumber/formatter/console.rb', line 134

def linebreaks(s, max)
  return s unless max && max > 0
  s.gsub(/.{1,#{max}}(?:\s|\Z)/){($& + 5.chr).gsub(/\n\005/,"\n").gsub(/\005/,"\n")}.rstrip
end

#print_elements(elements, status, kind) ⇒ Object 



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

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
      message = linebreaks(element.backtrace_line, ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
      @io.puts(format_string(message, status))
    end
    @io.puts
    @io.flush
  end
end

#print_exception(e, status, indent) ⇒ Object 



125
126
127
128
129
130
131
 
# File 'lib/cucumber/formatter/console.rb', line 125

def print_exception(e, status, indent)
  message = "#{e.message} (#{e.class})".force_encoding("UTF-8")
  message = linebreaks(message, ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)

  string = "#{message}\n#{e.backtrace.join("\n")}".indent(indent)
  @io.puts(format_string(string, status))
end

#print_failing_scenarios(failures, custom_profiles, given_source) ⇒ Object 



115
116
117
118
119
120
121
122
123
 
# File 'lib/cucumber/formatter/console.rb', line 115

def print_failing_scenarios(failures, custom_profiles, given_source)
  @io.puts format_string("Failing Scenarios:", :failed)
  failures.each do |failure|
    profiles_string = custom_profiles.empty? ? '' : (custom_profiles.map{|profile| "-p #{profile}" }).join(' ') + ' '
    source = given_source ? format_string(" # " + failure.name, :comment) : ''
    @io.puts format_string("cucumber #{profiles_string}" + failure.location, :failed) + source
  end
  @io.puts
end

#print_message(message) ⇒ Object 



209
210
211
212
 
# File 'lib/cucumber/formatter/console.rb', line 209

def print_message(message)
  @io.puts(format_string(message, :tag).indent(@indent))
  @io.flush
end

#print_messages ⇒ Object 



197
198
199
200
 
# File 'lib/cucumber/formatter/console.rb', line 197

def print_messages
  @delayed_messages.each {|message| print_message(message)}
  empty_messages
end

#print_passing_wip(options) ⇒ Object 



166
167
168
169
170
171
172
173
174
175
 
# File 'lib/cucumber/formatter/console.rb', line 166

def print_passing_wip(options)
  return unless options[:wip]
  passed = runtime.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_profile_information ⇒ Object 



218
219
220
221
222
223
224
225
226
 
# File 'lib/cucumber/formatter/console.rb', line 218

def print_profile_information
  return if @options[:skip_profile_information] || @options[:profiles].nil? || @options[:profiles].empty?
  profiles = @options[:profiles]
  profiles_sentence = ''
  profiles_sentence = profiles.size == 1 ? profiles.first :
    "#{profiles[0...-1].join(', ')} and #{profiles.last}"

  @io.puts "Using the #{profiles_sentence} profile#{'s' if profiles.size> 1}..."
end

#print_snippets(options) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/cucumber/formatter/console.rb', line 150

def print_snippets(options)
  return unless options[:snippets]
  return if runtime.steps(:undefined).empty?

  snippets = @snippets_input.map do |data|
    @runtime.snippet_text(data.actual_keyword, data.step.name, data.step.multiline_arg)
  end.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)

  @io.puts
  @io.flush
end

#print_statistics(duration, options) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/cucumber/formatter/console.rb', line 85

def print_statistics(duration, options)
  failures = collect_failing_scenarios(runtime)
  if !failures.empty?
    print_failing_scenarios(failures, options.custom_profiles, options[:source])
  end

  @io.puts scenario_summary(runtime) {|status_count, status| format_string(status_count, status)}
  @io.puts step_summary(runtime) {|status_count, status| format_string(status_count, status)}
  @io.puts(format_duration(duration)) if duration && options[:duration]

  if runtime.configuration.randomize?
    @io.puts
    @io.puts "Randomized with seed #{runtime.configuration.seed}"
  end

  @io.flush
end

#print_stats(features, options) ⇒ Object 



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

def print_stats(features, options)
  duration = features ? features.duration : nil
  print_statistics(duration, options)
end

#print_steps(status) ⇒ Object 



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

def print_steps(status)
  print_elements(runtime.steps(status), status, 'steps')
end

#print_table_row_messages ⇒ Object 



202
203
204
205
206
207
 
# File 'lib/cucumber/formatter/console.rb', line 202

def print_table_row_messages
  return if @delayed_messages.empty?
  @io.print(format_string(@delayed_messages.join(', '), :tag).indent(2))
  @io.flush
  empty_messages
end

#puts(*messages) ⇒ Object

define @delayed_messages = [] in your Formatter if you want to activate this feature



183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/cucumber/formatter/console.rb', line 183

def puts(*messages)
  if @delayed_messages
    @delayed_messages += messages
  else
    if @io
      @io.puts
      messages.each do |message|
        @io.puts(format_string(message, :tag))
      end
      @io.flush
    end
  end
end