Class: Lucid::Formatter::Standard

Inherits:
Object
  • Object
show all
Includes:
FileUtils, Gherkin::Formatter::Escaping, Console, Io
Defined in:
lib/lucid/formatter/standard.rb

Direct Known Subclasses

Condensed

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 Attribute Summary collapse

Instance Method Summary collapse

Methods included from Io

#ensure_dir, #ensure_file, #ensure_io

Methods included from Console

#embed, #empty_messages, #format_step, #format_string, #linebreaks, #print_elements, #print_exception, #print_failing_strict, #print_matchers, #print_message, #print_messages, #print_passing_wip, #print_profile_information, #print_stats, #print_steps, #print_table_row_messages, #puts

Methods included from ANSIColor

define_grey, define_real_grey, #green_lucid, #grey, #lucid, #red_lucid, #yellow_lucid

Methods included from Term::ANSIColor

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

Methods included from Summary

#scenario_summary, #step_summary

Methods included from Duration

#format_duration

Constructor Details

#initialize(runtime, path_or_io, options) ⇒ Standard

Returns a new instance of Standard.



17
18
19
20
21
22
23
 
# File 'lib/lucid/formatter/standard.rb', line 17

def initialize(runtime, path_or_io, options)
  @runtime, @io, @options = runtime, ensure_io(path_or_io, "standard"), options
  @exceptions = []
  @indent = 0
  @prefixes = options[:prefixes] || {}
  @delayed_messages = []
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/lucid/formatter/standard.rb', line 14

def indent=(value)
  @indent = value
end

#runtime ⇒ Object (readonly)

Returns the value of attribute runtime.



15
16
17
 
# File 'lib/lucid/formatter/standard.rb', line 15

def runtime
  @runtime
end

Instance Method Details

#after_background(background) ⇒ Object 



79
80
81
82
83
 
# File 'lib/lucid/formatter/standard.rb', line 79

def after_background(background)
  @in_background = nil
  @io.puts
  @io.flush
end

#after_feature_element(feature_element) ⇒ Object 



68
69
70
71
 
# File 'lib/lucid/formatter/standard.rb', line 68

def after_feature_element(feature_element)
  @io.puts
  @io.flush
end

#after_features(features) ⇒ Object 



29
30
31
 
# File 'lib/lucid/formatter/standard.rb', line 29

def after_features(features)
  print_summary(features)
end

#after_multiline_arg(multiline_arg) ⇒ Object 



167
168
169
 
# File 'lib/lucid/formatter/standard.rb', line 167

def after_multiline_arg(multiline_arg)
  @table = nil
end

#after_outline_table(outline_table) ⇒ Object 



110
111
112
113
 
# File 'lib/lucid/formatter/standard.rb', line 110

def after_outline_table(outline_table)
  @table = nil
  @indent = 4
end

#after_table_cell(cell) ⇒ Object 



186
187
188
189
 
# File 'lib/lucid/formatter/standard.rb', line 186

def after_table_cell(cell)
  return unless @table
  @col_index += 1
end

#after_table_row(table_row) ⇒ Object 



177
178
179
180
181
182
183
184
 
# File 'lib/lucid/formatter/standard.rb', line 177

def after_table_row(table_row)
  return if !@table || @hide_this_step
  print_table_row_messages
  @io.puts
  if table_row.exception && !@exceptions.include?(table_row.exception)
    print_exception(table_row.exception, table_row.status, @indent)
  end
end

#after_tags(tags) ⇒ Object 



43
44
45
46
47
48
 
# File 'lib/lucid/formatter/standard.rb', line 43

def after_tags(tags)
  if @indent == 1
    @io.puts
    @io.flush
  end
end

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



85
86
87
 
# File 'lib/lucid/formatter/standard.rb', line 85

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

#before_background(background) ⇒ Object 



73
74
75
76
77
 
# File 'lib/lucid/formatter/standard.rb', line 73

def before_background(background)
  @indent = 2
  @scenario_indent = 2
  @in_background = true
end

#before_examples_array(examples_array) ⇒ Object 



89
90
91
92
93
 
# File 'lib/lucid/formatter/standard.rb', line 89

def before_examples_array(examples_array)
  @indent = 4
  @io.puts
  @visiting_first_example_name = true
end

#before_feature(feature) ⇒ Object 



33
34
35
36
 
# File 'lib/lucid/formatter/standard.rb', line 33

def before_feature(feature)
  @exceptions = []
  @indent = 0
end

#before_feature_element(feature_element) ⇒ Object 



63
64
65
66
 
# File 'lib/lucid/formatter/standard.rb', line 63

def before_feature_element(feature_element)
  @indent = 2
  @scenario_indent = 2
end

#before_features(features) ⇒ Object 



25
26
27
 
# File 'lib/lucid/formatter/standard.rb', line 25

def before_features(features)
  print_profile_information
end

#before_multiline_arg(multiline_arg) ⇒ Object 



162
163
164
165
 
# File 'lib/lucid/formatter/standard.rb', line 162

def before_multiline_arg(multiline_arg)
  return if @options[:no_multiline] || @hide_this_step
  @table = multiline_arg
end

#before_outline_table(outline_table) ⇒ Object 



106
107
108
 
# File 'lib/lucid/formatter/standard.rb', line 106

def before_outline_table(outline_table)
  @table = outline_table
end

#before_step(step) ⇒ Object 



119
120
121
122
 
# File 'lib/lucid/formatter/standard.rb', line 119

def before_step(step)
  @current_step = step
  @indent = 6
end

#before_step_result(step_result) ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/lucid/formatter/standard.rb', line 124

def before_step_result(step_result)
  @hide_this_step = false
  if step_result.exception
    if @exceptions.include?(step_result.exception)
      @hide_this_step = true
      return
    end
    @exceptions << step_result.exception
  end
  if step_result.status != :failed && @in_background ^ step_result.background
    @hide_this_step = true
    return
  end
  @status = step_result.status
end

#before_table_row(table_row) ⇒ Object 



171
172
173
174
175
 
# File 'lib/lucid/formatter/standard.rb', line 171

def before_table_row(table_row)
  return if !@table || @hide_this_step
  @col_index = 0
  @io.print '  |'.indent(@indent-2)
end

#comment_line(comment_line) ⇒ Object 



38
39
40
41
 
# File 'lib/lucid/formatter/standard.rb', line 38

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

#doc_string(string) ⇒ Object 



148
149
150
151
152
153
154
 
# File 'lib/lucid/formatter/standard.rb', line 148

def doc_string(string)
  return if @options[:no_multiline] || @hide_this_step
  s = %{"""\n#{string}\n"""}.indent(@indent)
  s = s.split("\n").map{|l| l =~ /^\s+$/ ? '' : l}.join("\n")
  @io.puts(format_string(s, @current_step.status))
  @io.flush
end

#examples_name(keyword, name) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
 
# File 'lib/lucid/formatter/standard.rb', line 95

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

#exception(exception, status) ⇒ Object 



156
157
158
159
160
 
# File 'lib/lucid/formatter/standard.rb', line 156

def exception(exception, status)
  return if @hide_this_step
  print_exception(exception, status, @indent)
  @io.flush
end

#feature_name(keyword, name) ⇒ Object 



57
58
59
60
61
 
# File 'lib/lucid/formatter/standard.rb', line 57

def feature_name(keyword, name)
  @io.puts("#{keyword}: #{name}")
  @io.puts
  @io.flush
end

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



115
116
117
 
# File 'lib/lucid/formatter/standard.rb', line 115

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

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



140
141
142
143
144
145
146
 
# File 'lib/lucid/formatter/standard.rb', line 140

def step_name(keyword, step_match, status, source_indent, background, file_colon_line)
  return if @hide_this_step
  source_indent = nil unless @options[:source]
  name_to_report = format_step(keyword, step_match, status, source_indent)
  @io.puts(name_to_report.indent(@scenario_indent + 2))
  print_messages
end

#table_cell_value(value, status) ⇒ Object 



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/lucid/formatter/standard.rb', line 191

def table_cell_value(value, status)
  return if !@table || @hide_this_step
  status ||= @status || :passed
  width = @table.col_width(@col_index)
  cell_text = escape_cell(value.to_s || '')
  padded = cell_text + (' ' * (width - cell_text.unpack('U*').length))
  prefix = cell_prefix(status)
  @io.print(' ' + format_string("#{prefix}#{padded}", status) + ::Lucid::Term::ANSIColor.reset(" |"))
  @io.flush
end

#tag_name(tag_name) ⇒ Object 



50
51
52
53
54
55
 
# File 'lib/lucid/formatter/standard.rb', line 50

def tag_name(tag_name)
  tag = format_string(tag_name, :tag).indent(@indent)
  @io.print(tag)
  @io.flush
  @indent = 1
end