Module Loquacious
In: lib/loquacious/undefined.rb
lib/loquacious/configuration.rb
lib/loquacious.rb

Methods

Classes and Modules

Class Loquacious::Configuration
Class Loquacious::Undefined

External Aliases

configuration_for -> configuration
configuration_for -> config_for
configuration_for -> config
defaults_for -> defaults
help_for -> help

Public Class methods

Returns the configuration associated with the given name. If a block is given, then it will be used to create the configuration.

The same name can be used multiple times with different configuration blocks. Each different block will be used to add to the configuration; i.e. the configurations are additive.

A helper method that will create a deep copy of a given Configuration object. This method accepts either a Configuration instance or a name that can be used to lookup the Configuration instance (via the "Loquacious.configuration_for" method).

  Loquacious.copy(config)
  Loquacious.copy('name')

Optionally a block can be given. It will be used to modify the returned copy with the given values. The Configuration object being copied is never modified by this method.

  Loquacious.copy(config) {
    foo 'bar'
    baz 'buz'
  }

Set the default properties for the configuration associated with the given name. A block must be provided to this method.

The same name can be used multiple times with different configuration blocks. Each block will add or modify the configuration; i.e. the configurations are additive.

Returns a Help instance for the configuration associated with the given name. See the Help#initialize method for the options that can be used with this method.

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.

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

This is merely a convenience method to remove methods from the Loquacious::Configuration class. Some ruby gems add lots of crap to the Kernel module, and this interferes with the configuration system. The remove method should be used to anihilate unwanted methods from the configuration class as needed.

  Loquacious.remove :gem           # courtesy of rubygems
  Loquacious.remove :test, :file   # courtesy of rake
  Loquacious.remove :main          # courtesy of main
  Loquacious.remove :timeout       # courtesy of timeout

Returns the version string for the library.

[Validate]