adhearsion-loquacious 1.9.2

data/.gitignore

@@ -0,0 +1,23 @@
+# Gem related stuff
+*.gem
+pkg
+.bundle
+Gemfile.lock
+vendor
+
+# Testing stuff
+coverage
+spec/reports
+example.log
+
+# RBX stuff
+*~
+.*.sw?
+nbproject
+/.rbx/
+
+# General
+.DS_Store
+.rvmrc
+.yardoc
+doc

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2, :cli => '--format documentation' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec/" }
+end

data/History.txt

@@ -0,0 +1,127 @@
+== 1.9.1 / 2011-12-15
+
+Bug Fixes
+- Properly generate accessor method when merging
+
+== 1.9.0 / 2011-09-13
+
+Enhancements
+- Iterator now skips Undefined values
+- Method to convert Configuration objects to a hash [mcmire]
+
+== 1.8.1 / 2011-06-09
+
+Bug Fixes
+- Assignment methods now mirror one another in their return values
+
+== 1.8.0 / 2011-06-03
+
+Enhancements
+- Support for defalut values on configuration properties
+
+== 1.7.1 / 2011-02-11
+
+Bug Fixes
+- Fixing the "alias instance_eval" warning on JRuby
+
+== 1.7.0 / 2010-08-16
+
+Enhancements
+- Adding a "copy" function for configuration objects
+Bug Fixes
+- Fixing warnings
+
+== 1.6.4 / 2010-06-08
+
+Bug Fixes
+- Extending a configuration was not working properly
+- Descriptions were being overwritten when extending a configuration
+
+== 1.6.3 / 2010-06-07
+
+Bug Fixes
+- Assign a nil description when none is given [Nathan Witmer]
+
+== 1.6.2 / 2010-06-01
+
+Bug Fixes
+- Compatibility with Ruby 1.9.2
+
+== 1.6.1 / 2010-04-19
+
+Bug Fixes
+- Allow interrogative methods on configuration objects (nil?)
+
+== 1.6.0 / 2010-04-18
+
+Enhancements
+- Added a default "undefined" value
+
+== 1.5.2 / 2010-04-06
+
+Bug Fixes
+- Accidentally undefining the initialize method for the DSL
+
+== 1.5.1 / 2010-04-06
+
+Bug Fixes
+- Private methods were accessible in the configuration objects
+
+== 1.5.0 / 2010-03-11
+
+Enhancements
+- Adding support for evaluation of Proc objects
+- Upgrading to the latest Mr Bones
+
+
+== 1.4.2 / 2010-02-01
+
+Bug Fixes
+- Resolving some circular dependencies
+
+== 1.4.1 / 2009-11-29
+
+Bug Fixes
+- Fixing warning message from jRuby
+- Kernel methods can now be used as configuration attributes
+
+== 1.4.0 / 2009-11-07
+
+Enhancements
+- Added a help option to hide nesting configuration atrributes
+- Update to Mr Bones 3.0.0
+
+== 1.3.1 / 2009-10-30
+
+Enhancements
+- Added a remove method to clobber unwanted methods in the configuration
+Bug Fixes
+- Could not assign false as a default value
+
+== 1.3.0 / 2009-04-05
+
+Enhancements
+- Adding colorization options to the Help object
+
+== 1.2.0 / 2009-04-05
+
+Enhancements
+- Help#show now matches using a regular expression
+
+== 1.1.1 / 2009-04-05
+
+Bug Fixes
+- You can no longer use object_id as a configuration value
+  (Ruby 1.9 is very cranky if object_id gets undefined)
+
+== 1.1.0 / 2009-04-05
+
+Enhancements
+- Added hash accessor methods for configuration attributes
+Bug Fixes
+- Hash values were not being handeld properly by the DSL
+
+== 1.0.0 / 2009-04-04
+
+Enhancements
+- Birthday!

data/README.rdoc

@@ -0,0 +1,229 @@
+= Loquacious
+    by Tim Pease
+    http://rubygems.org/gems/loquacious
+
+== DESCRIPTION:
+
+Descriptive configuration files for Ruby written in Ruby.
+
+Loquacious provides a very open configuration system written in ruby and
+descriptions for each configuration attribute. The attributes and descriptions
+can be iterated over allowing for helpful information about those attributes to
+be displayed to the user.
+
+In the simple case we have a file something like
+
+  Loquacious.configuration_for('app') {
+    name 'value', :desc => "Defines the name"
+    foo  'bar',   :desc => "FooBar"
+    id   42,      :desc => "Ara T. Howard"
+  }
+
+Which can be loaded via the standard Ruby loading mechanisms
+
+  Kernel.load 'config/app.rb'
+
+The attributes and their descriptions can be printed by using a Help object
+
+  help = Loquacious.help_for('app')
+  help.show :values => true        # show the values for the attributes, too
+
+Descriptions are optional, and configurations can be nested arbitrarily deep.
+
+  Loquacious.configuration_for('nested') {
+    desc "The outermost level"
+    a {
+      desc "One more level in"
+      b {
+        desc "Finally, a real value"
+        c 'value'
+      }
+    }
+  }
+
+  config = Loquacious.configuration_for('nested')
+
+  p config.a.b.c  #=> "value"
+
+And as you can see, descriptions can either be given inline after the value or
+they can appear above the attribute and value on their own line.
+
+== INSTALL:
+
+* sudo gem install loquacious
+
+== EXAMPLES:
+
+==== example/simple.rb
+  # A simple example that configures three options (a b c) along with
+  # descriptions for each option. The descriptions along with the
+  # values for the configuration options are printed to the terminal.
+
+  require 'loquacious'
+  include Loquacious
+
+  Configuration.for(:simple) {
+    desc 'Your first configuration option'
+    a "value for 'a'"
+
+    desc 'To be or not to be'
+    b "William Shakespeare"
+
+    desc 'The underpinings of Ruby'
+    c 42
+  }
+
+  help = Configuration.help_for :simple
+  help.show :values => true
+
+  ====== output ======
+   Your first configuration option
+    - a => "value for 'a'"
+
+   To be or not to be
+    - b => "William Shakespeare"
+
+   The underpinings of Ruby
+    - c => 42
+
+==== examples/nested.rb
+  # 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
+
+  ====== output ======
+   Configuration options for ActiveRecord::Base.
+    - active_record
+
+   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.
+    - active_record.colorize_logging => true
+
+   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.
+    - active_record.default_timezone => :local
+
+   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_level                      => :info
+
+   The path to the log file to use. Defaults to log/#{environment}.log
+   (e.g. log/development.log or log/production.log).
+    - log_path                       => "log/development.log"
+
+   The application's base directory.
+    - root_path                      => "."
+
+==== examples/gutters.rb
+  # Using Ruby heredocs for descriptions, the Loquacious configuration will
+  # strip out leading whitespace but preserve line breaks. Gutter lines can be
+  # used to mark where leading whitespace should be preserved. This is useful
+  # is you need to provide example code in your descriptions.
+
+  require 'loquacious'
+  include Loquacious
+
+  Configuration.for(:gutters) {
+    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).
+      |
+      |  config.log_path = File.join(ROOT, "log", "\#{environment}.log
+      |
+    __
+
+    log_level :warn, :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.
+      |
+      |  config.log_level = 'debug'
+      |  config.log_level = :warn
+      |
+    __
+  }
+
+  help = Configuration.help_for :gutters
+  help.show :values => true
+
+  ====== output ======
+   The log level to use for the default Rails logger. In production mode,
+   this defaults to :info. In development mode, it defaults to :debug.
+
+     config.log_level = 'debug'
+     config.log_level = :warn
+
+    - log_level => :warn
+
+   The path to the log file to use. Defaults to log/#{environment}.log
+   (e.g. log/development.log or log/production.log).
+
+     config.log_path = File.join(ROOT, "log", "#{environment}.log
+
+    - log_path  => "log/development.log"
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009-2011
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,30 @@
+
+begin
+  require 'bones'
+rescue LoadError
+  abort '### please install the "bones" gem ###'
+end
+
+task :default => 'spec:run'
+task 'gem:release' => 'spec:run'
+
+Bones {
+  name         'adhearsion-loquacious'
+  authors      'Tim Pease', 'Adhearsion Team'
+  email        'tim.pease@gmail.com', 'all@adhearsion.com'
+  url          'http://rubygems.org/gems/adhearsion-loquacious'
+  readme_file  'README.rdoc'
+  spec.opts << '--color'
+  use_gmail
+
+  depend_on 'rspec', '~> 2.6', :development => true
+}
+
+task 'ann:prereqs' do
+  Bones.config.name = 'Adhearsion-Loquacious'
+end
+
+# depending on bones (even as a development dependency) creates a circular
+# reference that prevents the auto install of loquacious when instsalling
+# bones
+::Bones.config.gem._spec.dependencies.delete_if {|d| d.name == 'bones'}

data/adhearsion-loquacious.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "adhearsion-loquacious"
+  s.version = "1.9.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tim Pease", "Adhearsion Team"]
+  s.date = "2012-01-18"
+  s.description = "Descriptive configuration files for Ruby written in Ruby.\n\nLoquacious provides a very open configuration system written in ruby and\ndescriptions for each configuration attribute. The attributes and descriptions\ncan be iterated over allowing for helpful information about those attributes to\nbe displayed to the user.\n\nIn the simple case we have a file something like\n\n  Loquacious.configuration_for('app') {\n    name 'value', :desc => \"Defines the name\"\n    foo  'bar',   :desc => \"FooBar\"\n    id   42,      :desc => \"Ara T. Howard\"\n  }\n\nWhich can be loaded via the standard Ruby loading mechanisms\n\n  Kernel.load 'config/app.rb'\n\nThe attributes and their descriptions can be printed by using a Help object\n\n  help = Loquacious.help_for('app')\n  help.show :values => true        # show the values for the attributes, too\n\nDescriptions are optional, and configurations can be nested arbitrarily deep.\n\n  Loquacious.configuration_for('nested') {\n    desc \"The outermost level\"\n    a {\n      desc \"One more level in\"\n      b {\n        desc \"Finally, a real value\"\n        c 'value'\n      }\n    }\n  }\n\n  config = Loquacious.configuration_for('nested')\n\n  p config.a.b.c  #=> \"value\"\n\nAnd as you can see, descriptions can either be given inline after the value or\nthey can appear above the attribute and value on their own line."
+  s.email = ["tim.pease@gmail.com", "all@adhearsion.com"]
+  s.extra_rdoc_files = ["History.txt", "README.rdoc"]
+  s.files = [".gitignore", "Guardfile", "History.txt", "README.rdoc", "Rakefile", "examples/gutters.rb", "examples/nested.rb", "examples/simple.rb", "lib/loquacious.rb", "lib/loquacious/configuration.rb", "lib/loquacious/configuration/help.rb", "lib/loquacious/configuration/iterator.rb", "lib/loquacious/core_ext/string.rb", "lib/loquacious/undefined.rb", "lib/loquacious/utility.rb", "loquacious.gemspec", "spec/configuration_spec.rb", "spec/help_spec.rb", "spec/iterator_spec.rb", "spec/loquacious_spec.rb", "spec/spec_helper.rb", "spec/string_spec.rb", "spec/utility_spec.rb", "version.txt"]
+  s.homepage = "http://rubygems.org/gems/adhearsion-loquacious"
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "adhearsion-loquacious"
+  s.rubygems_version = "1.8.10"
+  s.summary = "Descriptive configuration files for Ruby written in Ruby."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.6"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.6"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.6"])
+  end
+end