Module: Cucumber::Formatter::Console

Extended by:
ANSIColor
Includes:
Duration
Included in:
ConsoleCounts, ConsoleIssues, Pretty, Progress, Summary
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, red_cukes, yellow_cukes

Methods included from Term::ANSIColor

attributes, coloring=, coloring?, included, #uncolored

Methods included from Duration

#format_duration

Instance Method Details

#collect_snippet_data(test_step, result) ⇒ Object


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

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

#do_print_passing_wip(passed_messages) ⇒ Object


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

def do_print_passing_wip(passed_messages)
  if passed_messages.any?
    @io.puts format_string("\nThe --wip switch was used, so I didn't expect anything to pass. These scenarios passed:", :failed)
    print_element_messages(passed_messages, :passed, 'scenarios')
  else
    @io.puts format_string("\nThe --wip switch was used, so the failures were expected. All is good.\n", :passed)
  end
end

#do_print_profile_information(profiles) ⇒ Object


210
211
212
213
214
215
# File 'lib/cucumber/formatter/console.rb', line 210

def do_print_profile_information(profiles)
  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

#do_print_snippets(snippet_text_proc) ⇒ Object


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

def do_print_snippets(snippet_text_proc)
  snippets = @snippets_input.map do |data|
    snippet_text_proc.call(data.actual_keyword, data.step.text, 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

#embed(file, mime_type, label) ⇒ Object


164
165
166
# File 'lib/cucumber/formatter/console.rb', line 164

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

#empty_messagesObject


201
202
203
# File 'lib/cucumber/formatter/console.rb', line 201

def empty_messages
  @delayed_messages = []
end

#exception_message_string(e, indent) ⇒ Object


104
105
106
107
108
109
# File 'lib/cucumber/formatter/console.rb', line 104

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

  "#{message}\n#{e.backtrace.join("\n")}".indent(indent)
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


112
113
114
115
# File 'lib/cucumber/formatter/console.rb', line 112

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

68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/cucumber/formatter/console.rb', line 68

def print_element_messages(element_messages, status, kind)
  if element_messages.any?
    @io.puts(format_string("(::) #{status} #{kind} (::)", status))
    @io.puts
    @io.flush
  end

  element_messages.each do |message|
    @io.puts(format_string(message, status))
    @io.puts
    @io.flush
  end
end

61
62
63
64
65
66
# File 'lib/cucumber/formatter/console.rb', line 61

def print_elements(elements, status, kind)
  return if elements.empty?

  element_messages = element_messages(elements, status)
  print_element_messages(element_messages, status, kind)
end

99
100
101
102
# File 'lib/cucumber/formatter/console.rb', line 99

def print_exception(e, status, indent)
  string = exception_message_string(e, indent)
  @io.puts(format_string(string, status))
end

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

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

184
185
186
187
# File 'lib/cucumber/formatter/console.rb', line 184

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

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

def print_passing_wip(options)
  return unless options[:wip]
  passed_messages = element_messages(runtime.scenarios(:passed), :passed)
  do_print_passing_wip(passed_messages)
end

205
206
207
208
# File 'lib/cucumber/formatter/console.rb', line 205

def print_profile_information
  return if @options[:skip_profile_information] || @options[:profiles].nil? || @options[:profiles].empty?
  do_print_profile_information(@options[:profiles])
end

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

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

  snippet_text_proc = lambda do |step_keyword, step_name, multiline_arg|
    runtime.snippet_text(step_keyword, step_name, multiline_arg)
  end
  do_print_snippets(snippet_text_proc)
end

82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/cucumber/formatter/console.rb', line 82

def print_statistics(duration, config, counts, issues)
  if issues.any?
    @io.puts issues.to_s
    @io.puts
  end

  @io.puts counts.to_s
  @io.puts(format_duration(duration)) if duration && config.duration?

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

  @io.flush
end

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

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

189
190
191
192
193
194
# File 'lib/cucumber/formatter/console.rb', line 189

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


170
171
172
173
174
175
176
177
178
179
180
181
182
# File 'lib/cucumber/formatter/console.rb', line 170

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