module Bones

Public Class Methods

config click to toggle source
config { block }

Returns the configuration object for setting up Mr Bones options.

# File lib/bones.rb, line 72
def self.config( &block )
  Loquacious.configuration_for('Bones', &block)
end
help click to toggle source

Returns a help object that can be used to show the current Mr Bones configuration and descriptions for the various configuration attributes.

# File lib/bones.rb, line 82
def self.help
  Loquacious.help_for('Bones', :colorize => config.colorize, :nesting_nodes => false)
end
libpath( *args ) { || ... } click to toggle source

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

# File lib/bones.rb, line 53
def self.libpath( *args )
  rv =  args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
  if block_given?
    begin
      $LOAD_PATH.unshift LIBPATH
      rv = yield
    ensure
      $LOAD_PATH.shift
    end
  end
  return rv
end
path( *args ) { || ... } click to toggle source

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

# File lib/bones.rb, line 37
def self.path( *args )
  rv = args.empty? ? PATH : ::File.join(PATH, args.flatten)
  if block_given?
    begin
      $LOAD_PATH.unshift PATH
      rv = yield
    ensure
      $LOAD_PATH.shift
    end
  end
  return rv
end
version() click to toggle source

Returns the version of the Mr Bones library.

# File lib/bones.rb, line 30
def self.version
  VERSION
end