Module: God::Configurable

Included in:
Behavior, Contact
Defined in:
lib/god/configurable.rb

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) complain(text, c = nil) 



42
43
44
45
46
47
48
49
50
 
# 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

Instance Method Details

- (Object) base_name 



33
34
35
36
 
# 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

- (Object) complain(text, c = nil) 



52
53
54
 
# File 'lib/god/configurable.rb', line 52

def complain(text, c = nil)
  Configurable.complain(text, c)
end

- (Object) friendly_name 



38
39
40
 
# File 'lib/god/configurable.rb', line 38

def friendly_name
  base_name
end

- (Object) prepare

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



8
9
10
 
# File 'lib/god/configurable.rb', line 8

def prepare
  
end

- (Object) reset 



12
13
14
 
# File 'lib/god/configurable.rb', line 12

def reset
  
end

- (Boolean) valid?

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

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/god/configurable.rb', line 29

def valid?
  true
end