Class: Herb::Errors::UnexpectedError

Inherits:
Error
  • Object
show all
Includes:
Colors
Defined in:
lib/herb/errors.rb,
sig/herb/errors.rbs,
ext/herb/error_helpers.c

Constant Summary

Constants included from Colors

Colors::CLEAR_SCREEN, Colors::HIDE_CURSOR, Colors::SHOW_CURSOR

Instance Attribute Summary collapse

Attributes inherited from Error

#location, #message, #type

Instance Method Summary collapse

Methods included from Colors

bold, bright_magenta, cyan, dimmed, enabled?, fg, fg_bg, green, magenta, red, #self?.bold, #self?.bright_magenta, #self?.cyan, #self?.dimmed, #self?.enabled?, #self?.fg, #self?.fg_bg, #self?.green, #self?.magenta, #self?.red, #self?.white, #self?.yellow, white, yellow

Methods inherited from Error

#class_name, #error_name, #to_json

Constructor Details

#initialize(type, location, message, description, expected, found) ⇒ UnexpectedError

: (String, Location?, String, String, String, String) -> void

Parameters:

  • (String)
  • (Location, nil)
  • (String)
  • (String)
  • (String)
  • (String) 


69
70
71
72
73
74
 
# File 'lib/herb/errors.rb', line 69

def initialize(type, location, message, description, expected, found)
  super(type, location, message)
  @description = description
  @expected = expected
  @found = found
end

Instance Attribute Details

#description ⇒ String? (readonly)

| description: String?, | expected: String?, | found: String?, | }

Returns:

  • (String, nil) 


64
65
66
 
# File 'lib/herb/errors.rb', line 64

def description
  @description
end

#expected ⇒ String? (readonly)

: String?

Returns:

  • (String, nil) 


65
66
67
 
# File 'lib/herb/errors.rb', line 65

def expected
  @expected
end

#found ⇒ String? (readonly)

: String?

Returns:

  • (String, nil) 


66
67
68
 
# File 'lib/herb/errors.rb', line 66

def found
  @found
end

Instance Method Details

#inspect ⇒ String

: () -> String

Returns:

  • (String) 


77
78
79
 
# File 'lib/herb/errors.rb', line 77

def inspect
  tree_inspect.rstrip.gsub(/\s+$/, "")
end

#to_hash ⇒ serialized_unexpected_error

: () -> serialized_unexpected_error

Returns:

  • (serialized_unexpected_error) 


82
83
84
85
86
87
88
 
# File 'lib/herb/errors.rb', line 82

def to_hash
  super.merge(
    description: description,
    expected: expected,
    found: found
  ) #: Herb::serialized_unexpected_error
end

#tree_inspect(indent: 0, depth: 0, depth_limit: 25) ⇒ String

: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String

Parameters:

  • indent: (Integer) (defaults to: 0)
  • depth: (Integer) (defaults to: 0)
  • depth_limit: (Integer) (defaults to: 25)

Returns:

  • (String) 


91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/herb/errors.rb', line 91

def tree_inspect(indent: 0, depth: 0, depth_limit: 25)
  output = +""

  output += white("@ #{bold(red(error_name))} #{dimmed("(location: #{location&.tree_inspect})\n")}")
  output += white("├── message: #{green(message.inspect)}\n")
  output += white("├── description: #{green(description.inspect)}\n")
  output += white("├── expected: #{green(expected.inspect)}\n")
  output += white("└── found: #{green(found.inspect)}\n")
  output += %(\n)

  output.gsub(/^/, "    " * indent)
end