Module: Observr

Defined in:
lib/observr.rb,
lib/observr/script.rb,
lib/observr/version.rb,
lib/observr/controller.rb,
lib/observr/event_handlers/base.rb,
lib/observr/event_handlers/unix.rb,
lib/observr/event_handlers/darwin.rb,
lib/observr/event_handlers/portable.rb

Defined Under Namespace

Modules: EventHandler Classes: Controller, Script

Constant Summary collapse

VERSION = 
'1.0.3'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.handler ⇒ Class

Detect current OS and return appropriate handler.

Examples:


Config::CONFIG['host_os'] #=> 'linux-gnu'
Observr.handler #=> Observr::EventHandler::Unix

Config::CONFIG['host_os'] #=> 'cygwin'
Observr.handler #=> Observr::EventHandler::Portable

ENV['HANDLER'] #=> 'unix'
Observr.handler #=> Observr::EventHandler::Unix

ENV['HANDLER'] #=> 'portable'
Observr.handler #=> Observr::EventHandler::Portable

Returns:

  • (Class) —

    handler class for current architecture



108
109
110
 
# File 'lib/observr.rb', line 108

def handler
  @handler
end

.options ⇒ Struct

Options proxy.

Currently supported options:

  • debug Debugging state. More verbose.

Examples:


Observr.options.debug #=> false
Observr.options.debug = true

Returns:

  • (Struct) —

    options proxy.



65
66
67
 
# File 'lib/observr.rb', line 65

def options
  @options
end

Class Method Details

.debug(msg) ⇒ nil

Outputs formatted debug statement to stdout, only if ‘::options.debug` is true

Examples:


Observr.options.debug = true
Observr.debug('im in ur codes, notifayinin u')

#outputs: "[observr debug] im in ur codes, notifayinin u"

Parameters:

  • message (String) —

    debug message to print

Returns:

  • (nil) 


85
86
87
 
# File 'lib/observr.rb', line 85

def debug(msg)
  puts "[observr debug] #{msg}" if options.debug
end

.version ⇒ Object

Deprecated. 


47
48
49
 
# File 'lib/observr.rb', line 47

def version #:nodoc:
  Observr::VERSION
end