Module: Exception2MessageMapper
- Defined in:
- lib/e2mmap.rb
Overview
ā
e2mmap.rb - for Ruby 1.1
$Release Version: 2.0$
$Revision: 1.10 $
by Keiju ISHITSUKA
++
Helper module for easily defining exceptions with predefined messages.
Usage
1.
class Foo
extend Exception2MessageMapper
def_e2message ExistingExceptionClass, "message..."
def_exception :NewExceptionClass, "message..."[, superclass]
...
end
2.
module Error
extend Exception2MessageMapper
def_e2message ExistingExceptionClass, "message..."
def_exception :NewExceptionClass, "message..."[, superclass]
...
end
class Foo
include Error
...
end
foo = Foo.new
foo.Fail ....
3.
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...
Constant Summary collapse
- E2MM =
:nodoc:
Exception2MessageMapper
Class Method Summary collapse
-
.def_e2message(k, c, m) ⇒ Object
E2MM.def_e2message(k, e, m) k: class to define exception under.
-
.def_exception(k, n, m, s = StandardError) ⇒ Object
E2MM.def_exception(k, n, m, s) k: class to define exception under.
- .e2mm_message(klass, exp) ⇒ Object (also: message)
- .extend_object(cl) ⇒ Object
-
.Raise(klass = E2MM, err = nil, *rest) ⇒ Object
(also: Fail)
Fail(klass, err, *rest) klass: class to define exception under.
Instance Method Summary collapse
- #bind(cl) ⇒ Object
-
#def_e2message(c, m) ⇒ Object
def_e2message(c, m) c: exception m: message_form define exception c with message m.
-
#def_exception(n, m, s = StandardError) ⇒ Object
def_exception(n, m, s) n: exception_name m: message_form s: superclass(default: StandardError) define exception named ācā with message m.
-
#Fail ⇒ Object
Fail(err, *rest) err: exception rest: message arguments.
-
#fail ⇒ Object
Fail(err, *rest) err: exception rest: message arguments.
-
#Raise(err = nil, *rest) ⇒ Object
Fail(err, *rest) err: exception rest: message arguments.
Class Method Details
.def_e2message(k, c, m) ⇒ Object
E2MM.def_e2message(k, e, m)
k: class to define exception under.
e: exception
m: message_form
define exception c with message m.
118 119 120 121 |
# File 'lib/e2mmap.rb', line 118 def E2MM.(k, c, m) E2MM.instance_eval{@MessageMap[[k, c]] = m} c end |
.def_exception(k, n, m, s = StandardError) ⇒ Object
E2MM.def_exception(k, n, m, s)
k: class to define exception under.
n: exception_name
m: message_form
s: superclass(default: StandardError)
define exception named ``c'' with message m.
130 131 132 133 134 135 |
# File 'lib/e2mmap.rb', line 130 def E2MM.def_exception(k, n, m, s = StandardError) n = n.id2name if n.kind_of?(Fixnum) e = Class.new(s) E2MM.instance_eval{@MessageMap[[k, e]] = m} k.const_set(n, e) end |
.e2mm_message(klass, exp) ⇒ Object Also known as: message
157 158 159 160 161 162 163 164 165 166 |
# File 'lib/e2mmap.rb', line 157 def E2MM.(klass, exp) for c in klass.ancestors if mes = @MessageMap[[c,exp]] #p mes m = klass.instance_eval('"' + mes + '"') return m end end nil end |
.extend_object(cl) ⇒ Object
59 60 61 62 |
# File 'lib/e2mmap.rb', line 59 def E2MM.extend_object(cl) super cl.bind(self) unless cl < E2MM end |
.Raise(klass = E2MM, err = nil, *rest) ⇒ Object Also known as: Fail
Fail(klass, err, *rest)
klass: class to define exception under.
err: exception
rest: message arguments
142 143 144 145 146 147 148 149 150 151 152 |
# File 'lib/e2mmap.rb', line 142 def E2MM.Raise(klass = E2MM, err = nil, *rest) if form = (klass, err) b = $@.nil? ? caller(1) : $@ #p $@ #p __FILE__ b.shift if b[0] =~ /^#{Regexp.quote(__FILE__)}:/ raise err, sprintf(form, *rest), b else E2MM.Fail E2MM, ErrNotRegisteredException, err.inspect end end |
Instance Method Details
#bind(cl) ⇒ Object
64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/e2mmap.rb', line 64 def bind(cl) self.module_eval %[ 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) ⇒ Object
def_e2message(c, m)
c: exception
m: message_form
define exception c with message m.
92 93 94 |
# File 'lib/e2mmap.rb', line 92 def (c, m) E2MM.(self, c, m) end |
#def_exception(n, m, s = StandardError) ⇒ Object
def_exception(n, m, s)
n: exception_name
m: message_form
s: superclass(default: StandardError)
define exception named ``c'' with message m.
102 103 104 |
# File 'lib/e2mmap.rb', line 102 def def_exception(n, m, s = StandardError) E2MM.def_exception(self, n, m, s) end |
#Fail ⇒ Object
Fail(err, *rest)
err: exception
rest: message arguments
84 85 86 |
# File 'lib/e2mmap.rb', line 84 def Raise(err = nil, *rest) E2MM.Raise(self, err, *rest) end |