Module: HookR

Defined in:
lib/hookr.rb

Overview

HookR is a library providing “hooks”, aka “signals and slots”, aka “events” to your Ruby classes.

Defined Under Namespace

Modules: Hooks Classes: BasicCallback, BlockCallback, Callback, CallbackSet, Event, ExternalCallback, Hook, HookSet, InternalCallback, MethodCallback, NullHook

Constant Summary collapse

VERSION =

No need to document the boilerplate convenience methods defined by Mr. Bones. :stopdoc:

'1.1.0'
LIBPATH = 
::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
PATH = 
::File.dirname(LIBPATH) + ::File::SEPARATOR

Class Method Summary collapse

Class Method Details

.libpath(*args) ⇒ Object

Returns the library path for the module. If any arguments are given, they will be joined to the end of the libray path using File.join.



34
35
36
 
# File 'lib/hookr.rb', line 34

def self.libpath( *args )
  args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
end

.path(*args) ⇒ Object

Returns the lpath for the module. If any arguments are given, they will be joined to the end of the path using File.join.



42
43
44
 
# File 'lib/hookr.rb', line 42

def self.path( *args )
  args.empty? ? PATH : ::File.join(PATH, args.flatten)
end

.require_all_libs_relative_to(fname, dir = nil) ⇒ Object

Utility method used to rquire all files ending in .rb that lie in the directory below this file that has the same name as the filename passed in. Optionally, a specific directory name can be passed in such that the filename does not have to be equivalent to the directory.



51
52
53
54
55
56
57
 
# File 'lib/hookr.rb', line 51

def self.require_all_libs_relative_to( fname, dir = nil )
  dir ||= ::File.basename(fname, '.*')
  search_me = ::File.expand_path(
      ::File.join(::File.dirname(fname), dir, '*', '*.rb'))

  Dir.glob(search_me).sort.each {|rb| require rb}
end

.version ⇒ Object

Returns the version string for the library.



26
27
28
 
# File 'lib/hookr.rb', line 26

def self.version
  VERSION
end