Files

Class/Module Index [+]

Quicksearch

God::Configurable

Public Class Methods

complain(text, c = nil) click to toggle source
# File lib/god/configurable.rb, line 42
def self.complain(text, c = nil)
  watch = c.watch rescue nil
  msg = ""
  msg += "#{watch.name}: " if watch
  msg += text
  msg += " for #{c.friendly_name}" if c
  applog(watch, :error, msg)
  false
end

Public Instance Methods

base_name() click to toggle source
# File lib/god/configurable.rb, line 33
def base_name
  x = 1 # fix for MRI's local scope optimization bug DO NOT REMOVE!
  @base_name ||= self.class.name.split('::').last
end
complain(text, c = nil) click to toggle source
# File lib/god/configurable.rb, line 52
def complain(text, c = nil)
  Configurable.complain(text, c)
end
friendly_name() click to toggle source
# File lib/god/configurable.rb, line 38
def friendly_name
  base_name
end
prepare() click to toggle source

Override this method in your Configurable (optional)

Called once after the Configurable has been sent to the block and attributes have been set. Do any post-processing on attributes here

# File lib/god/configurable.rb, line 8
def prepare

end
reset() click to toggle source
# File lib/god/configurable.rb, line 12
def reset

end
valid?() click to toggle source

Override this method in your Configurable (optional)

Called once during evaluation of the config file. Return true if valid, false otherwise

A convenience method 'complain' is available that will print out a message and return false, making it easy to report multiple validation errors:

def valid?
  valid = true
  valid &= complain("You must specify the 'pid_file' attribute for :memory_usage") if self.pid_file.nil?
  valid &= complain("You must specify the 'above' attribute for :memory_usage") if self.above.nil?
  valid
end
# File lib/god/configurable.rb, line 29
def valid?
  true
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.