Module: Scribbler

Includes:

Includeables

Defined in:

lib/scribbler.rb,
lib/scribbler/base.rb,
lib/scribbler/logger.rb,
lib/scribbler/version.rb,
lib/scribbler/cli_client.rb,
lib/scribbler/executable.rb,
lib/scribbler/configurator.rb,
lib/scribbler/includeables.rb,
lib/scribbler/log_location.rb

Defined Under Namespace

Modules: Base, Includeables Classes: CLIClient, Configurator, Executable, LogLocation, Logger

Constant Summary

VERSION =

'0.3.0'

Class Method Summary

• .config ⇒ Object

  Simply returns the configurator class.

• .configure {|config| ... } ⇒ Object

  Rails style configure block with some cleanup afterwards.

Class Method Details

.config ⇒ Object

Simply returns the configurator class.

Examples:

Scribbler.config
# => Scribbler::Configurator

Returns the singleton configurator

# File 'lib/scribbler.rb', line 41

def self.config
  @config ||= Configurator.new
end

.configure {|config| ... } ⇒ Object

Rails style configure block with some cleanup afterwards. This is the main method that kicks off the module and is necessary for its operation

&block - Block is class_eval’d to give total access to the config file.

Most importantly giving access to `config` object

Examples:

Scribbler.configure do |config|
  config.logs = %w[log1 log2]
  config.application_include = true
end
# => Nothing

Returns Nothing TODO Abstract the callbacks so that we can just add them where they’re written

Yields:

• (config)

# File 'lib/scribbler.rb', line 28

def self.configure
  yield config
  include_in_application
end