module Exception2MessageMapper

Helper module for easily defining exceptions with predefined messages.

Usage¶ ↑

class Foo
  extend Exception2MessageMapper
  def_e2message ExistingExceptionClass, "message..."
  def_exception :NewExceptionClass, "message..."[, superclass]
  ...
end

module Error
  extend Exception2MessageMapper
  def_e2message ExistingExceptionClass, "message..."
  def_exception :NewExceptionClass, "message..."[, superclass]
  ...
end
class Foo
  include Error
  ...
end

foo = Foo.new
foo.Fail ....

module Error
  extend Exception2MessageMapper
  def_e2message ExistingExceptionClass, "message..."
  def_exception :NewExceptionClass, "message..."[, superclass]
  ...
end
class Foo
  extend Exception2MessageMapper
  include Error
  ...
end

Foo.Fail NewExceptionClass, arg...
Foo.Fail ExistingExceptionClass, arg...

Public Instance Methods

Fail(err = nil, *rest)

Alias for: Raise

Raise(err = nil, *rest) click to toggle source

Fail(err, *rest)

err:    exception
rest:   message arguments

# File lib/e2mmap.rb, line 81
def Raise(err = nil, *rest)
  E2MM.Raise(self, err, *rest)
end

Also aliased as: Fail, fail

bind(cl) click to toggle source

# File lib/e2mmap.rb, line 64
def bind(cl)
  self.module_eval %Q[
    def Raise(err = nil, *rest)
      Exception2MessageMapper.Raise(self.class, err, *rest)
    end
    alias Fail Raise

    def self.included(mod)
      mod.extend Exception2MessageMapper
    end
  ]
end

def_e2message(c, m) click to toggle source

#def_e2message(c, m)

    c:  exception
    m:  message_form
define exception c with message m.

# File lib/e2mmap.rb, line 92
def def_e2message(c, m)
  E2MM.def_e2message(self, c, m)
end

def_exception(n, m, s = StandardError) click to toggle source

#def_exception(n, m, s)

    n:  exception_name
    m:  message_form
    s:  superclass(default: StandardError)
define exception named ``c'' with message m.

# File lib/e2mmap.rb, line 102
def def_exception(n, m, s = StandardError)
  E2MM.def_exception(self, n, m, s)
end

fail(err = nil, *rest)

Alias for: Raise