Contents

# Here we show how to used nested configuration options by taking a subset
# of some common Rails configuration options. Also, descriptions can be give
# before the option or they can be given inline using Ruby hash notation. If
# both are present, then the inline description takes precedence.
#
# Multiline descriptions are provided using Ruby heredocs. Leading
# whitespace is stripped and line breaks are preserved when descriptions
# are printed using the help object.

require 'loquacious'
include Loquacious

Configuration.for(:nested) {
  root_path '.', :desc => "The application's base directory."

  desc "Configuration options for ActiveRecord::Base."
  active_record {
    colorize_logging true, :desc => <<-__
      Determines whether to use ANSI codes to colorize the logging statements committed
      by the connection adapter. These colors make it much easier to overview things
      during debugging (when used through a reader like +tail+ and on a black background),
      but may complicate matters if you use software like syslog. This is true, by default.
    __

    default_timezone :local, :desc => <<-__
      Determines whether to use Time.local (using :local) or Time.utc (using :utc)
      when pulling dates and times from the database. This is set to :local by default.
    __
  }

  log_level :info, :desc => <<-__
    The log level to use for the default Rails logger. In production mode,
    this defaults to :info. In development mode, it defaults to :debug.
  __

  log_path 'log/development.log', :desc => <<-__
    The path to the log file to use. Defaults to log/\#{environment}.log
    (e.g. log/development.log or log/production.log).
  __
}

help = Configuration.help_for :nested
help.show :values => true

Version data entries

6 entries across 6 versions & 2 rubygems

Version	Path
adhearsion-loquacious-1.9.3	examples/nested.rb
adhearsion-loquacious-1.9.2	examples/nested.rb
loquacious-1.9.1	examples/nested.rb
loquacious-1.9.0	examples/nested.rb
loquacious-1.8.1	examples/nested.rb
loquacious-1.8.0	examples/nested.rb