exc/exception_annotation

module ExceptionAnnotator

A tool to annotate exceptions in Ruby. This is (loosely) based on a C++ library discussed by Andrei Alexandrescu at the 2002 ACCU conference.

E.g.:

  begin
    ExceptionAnnotator::operation("cleaning up...") do
      ExceptionAnnotator::operation("writing logs...") do
        ExceptionAnnotator::operation("opening log file...") do
          raise "Unknown Error"
        end
      end
    end
  rescue Exception => exc
    puts ExceptionAnnotator::annotated_mesg(exc)
  end

Will print:

  Unknown Error
    while opening log file...
    while writing logs...
    while cleaning up...

module ExceptionAnnotation

Public Methods

annotations

annotations=

annotated_mesg()

annotate(msg)

Mixins

ExceptionExtension

Public Methods

self.operation(op, &block)

self.annotated_mesg(exc, default_annotation="** No annotation **")

Requires