class Console::Event::Failure

Represents a failure of some kind, usually with an attached exception.

“‘ruby begin

raise "Something went wrong!"

rescue => exception

Console::Event::Failure.log("Something went wrong!", exception)

end “‘

Generally, you should use the {Console.error} method to log failures, as it will automatically create a failure event for you.

Attributes

exception [R]

@attribute [Exception] The exception which caused the failure.

Public Class Methods

default_root ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/event/failure.rb, line 27
def self.default_root
        Dir.getwd
rescue # e.g. Errno::EMFILE
        nil
end

For the purpose of efficiently formatting backtraces, we need to know the root directory of the project.

@returns [String | Nil] The root directory of the project, or nil if it could not be determined.

for (exception)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/event/failure.rb, line 36
def self.for(exception)
        self.new(exception, self.default_root)
end

Create a new failure event for the given exception.

@parameter exception [Exception] The exception to log.

log (subject, exception, **options)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/event/failure.rb, line 45
def self.log(subject, exception, **options)
        Console.error(subject, **self.for(exception).to_hash, **options)
end

Log a failure event with the given exception.

@parameter subject [String] The subject of the log message. @parameter exception [Exception] The exception to log. @parameter options [Hash] Additional options pass to the logger output.

new (exception, root = self.class.default_root)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/event/failure.rb, line 56
def initialize(exception, root = self.class.default_root)
        @exception = exception
        @root = root
end

Create a new failure event for the given exception.

@parameter exception [Exception] The exception to log. @parameter root [String] The root directory of the project.

Public Instance Methods

emit (*arguments, **options)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/event/failure.rb, line 76
def emit(*arguments, **options)
        options[:severity] ||= :error
        
        super
end

Log the failure event.

@parameter arguments [Array] The arguments to log. @parameter options [Hash] Additional options to pass to the logger output.

Calls superclass method

to_hash ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/event/failure.rb, line 64
def to_hash
        Hash.new.tap do |hash|
                hash[:type] = :failure
                hash[:root] = @root if @root
                extract(@exception, hash)
        end
end

Convert the failure event to a hash.

@returns [Hash] The hash representation of the failure event.