Module: TestBench::Output::PrintError

Includes:
Writer::Dependency
Included in:
Controls::Output::PrintError::Example, Raw
Defined in:
lib/test_bench/output/print_error.rb

Defined Under Namespace

Modules: Defaults

Instance Attribute Summary collapse

Attributes included from Writer::Dependency

#writer

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#omit_backtrace_pattern ⇒ Object 



6
7
8
 
# File 'lib/test_bench/output/print_error.rb', line 6

def omit_backtrace_pattern
  @omit_backtrace_pattern ||= Defaults.omit_backtrace_pattern
end

#reverse_backtraces ⇒ Object 



11
12
13
14
15
 
# File 'lib/test_bench/output/print_error.rb', line 11

def reverse_backtraces
  instance_variable_defined?(:@reverse_backtraces) ?
    @reverse_backtraces :
    @reverse_backtraces = Defaults.reverse_backtraces
end

Class Method Details

.call(error, writer: nil, omit_backtrace_pattern: nil, reverse_backtraces: nil) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/test_bench/output/print_error.rb', line 22

def self.call(error, writer: nil, omit_backtrace_pattern: nil, reverse_backtraces: nil)
  writer ||= Writer.build
  omit_backtrace_pattern ||= Defaults.omit_backtrace_pattern
  reverse_backtraces = Defaults.reverse_backtraces if reverse_backtraces.nil?

  writer.escape_code(:red)

  if reverse_backtraces && error.backtrace.length > 1
    writer
      .indent
      .escape_code(:bold)
      .text("Traceback")
      .escape_code(:reset_intensity)
      .text(" (most recent call last):")
      .newline
  end

  error(error, writer: writer, omit_backtrace_pattern: omit_backtrace_pattern, reverse_backtraces: reverse_backtraces)

  writer
    .escape_code(:reset_fg)
    .sync
end

.error(error, writer: nil, omit_backtrace_pattern: nil, reverse_backtraces: nil) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/test_bench/output/print_error.rb', line 46

def self.error(error, writer: nil, omit_backtrace_pattern: nil, reverse_backtraces: nil)
  reverse_backtraces = self.reverse_backtraces if reverse_backtraces.nil?

  if reverse_backtraces
    error_cause(error, writer: writer, omit_backtrace_pattern: omit_backtrace_pattern, reverse_backtraces: reverse_backtraces)
    error_backtrace(error, writer: writer, omit_backtrace_pattern: omit_backtrace_pattern, reverse_backtraces: reverse_backtraces)
    error_message(error, writer: writer)
  else
    error_message(error, writer: writer)
    error_backtrace(error, writer: writer, omit_backtrace_pattern: omit_backtrace_pattern, reverse_backtraces: reverse_backtraces)
    error_cause(error, writer: writer, omit_backtrace_pattern: omit_backtrace_pattern, reverse_backtraces: reverse_backtraces)
  end
end

.error_backtrace(error, writer: nil, omit_backtrace_pattern: nil, reverse_backtraces: nil) ⇒ Object 



84
85
86
87
88
89
90
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/test_bench/output/print_error.rb', line 84

def self.error_backtrace(error, writer: nil, omit_backtrace_pattern: nil, reverse_backtraces: nil)
  writer ||= self.writer
  omit_backtrace_pattern ||= self.omit_backtrace_pattern
  reverse_backtraces = self.reverse_backtraces if reverse_backtraces.nil?

  omitting = false

  backtrace = error.backtrace[1..-1]

  unless reverse_backtraces
    backtrace_iterator = backtrace.each.with_index
  else
    frame_count = backtrace.count

    number_width = frame_count.to_s.each_char.count

    backtrace_iterator = backtrace.reverse_each.map.with_index do |location, index|
      ordinal = frame_count - index

      ordinal = ordinal.to_s.rjust(number_width, ' ')

      [location, ordinal]
    end
  end

  backtrace_iterator.each do |location, ordinal|
    omit = omit_backtrace_pattern.match?(location)

    next if omit && omitting

    writer
      .text("\t")
      .indent

    if omit
      omitting = true

      if reverse_backtraces
        ordinal.gsub!(/[[:digit:]]/, '?')

        writer.text("#{ordinal}: ")
      end

      writer
        .escape_code(:faint)
        .escape_code(:italic)
        .text('*omitted*')
        .escape_code(:reset_italic)
        .escape_code(:reset_intensity)

    else
      omitting = false

      if reverse_backtraces
        writer.text("#{ordinal}: ")
      end

      writer.text("from #{location}")
    end

    writer.newline
  end
end

.error_cause(error, **args) ⇒ Object 



60
61
62
 
# File 'lib/test_bench/output/print_error.rb', line 60

def self.error_cause(error, **args)
  error(error.cause, **args) unless error.cause.nil?
end

.error_message(error, writer: nil) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/test_bench/output/print_error.rb', line 64

def self.error_message(error, writer: nil)
  caller_location = error.backtrace[0]

  message = error.message

  error_class = error.class.name

  writer
    .indent
    .text("#{caller_location}: ")
    .escape_code(:bold)
    .text("#{message} (")
    .escape_code(:underline)
    .text(error_class)
    .escape_code(:reset_underline)
    .text(")")
    .escape_code(:reset_intensity)
    .newline
end

Instance Method Details



18
19
20
 
# File 'lib/test_bench/output/print_error.rb', line 18

def print_error(error)
  PrintError.(error, writer: writer, omit_backtrace_pattern: omit_backtrace_pattern, reverse_backtraces: reverse_backtraces)
end