configurability 1.0.6 → 1.0.7

data/ChangeLog

@@ -0,0 +1,280 @@
+2011-10-13  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v1.0.7 for changeset 4e605f137155
+	[0f391f680b61] [tip]
+
+	* .hgsigs:
+	Added signature for changeset 605036b92217
+	[4e605f137155] [v1.0.7]
+
+	* History.rdoc, lib/configurability.rb:
+	Update history and bump patch version.
+	[605036b92217] [github/master]
+
+	* lib/configurability.rb, lib/configurability/config.rb,
+	lib/configurability/deferredconfig.rb:
+	Cleaned up Yard debris.
+	[6f4aa8deae60]
+
+	* History.md, History.rdoc, Manifest.txt, README.md, README.rdoc,
+	Rakefile:
+	Converted Markdown to RDoc.
+	[4ee71cc44d22]
+
+2011-04-26  Michael Granger  <ged@FaerieMUD.org>
+
+	* Rakefile:
+	Merged with c9b7b76e4792
+	[cae88e472706]
+
+	* Rakefile:
+	Cleaning up the Rakefile a bit
+	[c9b7b76e4792]
+
+2011-03-03  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v1.0.6 for changeset c2c677e0f5ca
+	[5b0587aa9b49]
+
+	* .hgsigs:
+	Added signature for changeset feb106dcbc29
+	[c2c677e0f5ca] [v1.0.6]
+
+	* History.md:
+	Updating the History.
+	[feb106dcbc29]
+
+	* lib/configurability.rb, lib/configurability/config.rb,
+	spec/configurability/config_spec.rb:
+	Fixing predicate methods for missing sections/values; bumping patch
+	version.
+	[631fd470522c]
+
+2011-02-08  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/configurability/config.rb, spec/configurability/config_spec.rb:
+	Adding nil safeguard to Configurability::Config::Struct#member?
+	[8f0c899cce82]
+
+	* .hgignore, Rakefile, spec/lib/helpers.rb:
+	Adding coverage generation
+	[91c699ea9aa3]
+
+	* .hgtags:
+	Added tag v1.0.5 for changeset 34062406d690
+	[739461bf952c]
+
+	* .hgsigs:
+	Added signature for changeset 12fda25efd84
+	[34062406d690] [v1.0.5]
+
+	* History.md, lib/configurability.rb:
+	Bumped version and updated History.
+	[12fda25efd84]
+
+	* .hgsigs, .hgsubstate, .hgtags, README.md:
+	Merged with 37:f3c29856fbe0
+	[9c22d746add7]
+
+	* .hgtags:
+	Removed tag v1.0.4
+	[1ef1012b278c]
+
+	* .hgtags:
+	Added tag v1.0.4 for changeset 84718f122b7b
+	[99d382b750f6]
+
+	* .hgsigs:
+	Added signature for changeset eef299ea1d29
+	[84718f122b7b]
+
+	* lib/configurability.rb, lib/configurability/config.rb,
+	spec/configurability/config_spec.rb:
+	Fix for config files with nil keys (fixes #1)
+	[eef299ea1d29]
+
+	* .hgsub, .hgsubstate, .hgsubstate, History.md, LICENSE, Manifest.txt,
+	README.md, Rakefile, project.yml:
+	Converted to Hoe.
+	[fb024df77138]
+
+2010-11-29  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgsub:
+	Modifying rake subrepo to the read-only URL
+	[f3c29856fbe0]
+
+	* .hgtags:
+	Added tag v1.0.4 for changeset 8553632dca62
+	[e89c09b5e32a]
+
+	* .hgsigs:
+	Added signature for changeset a8a6a67e2ede
+	[8553632dca62] [v1.0.4]
+
+	* .hgsubstate, lib/configurability.rb:
+	Bumping version to 1.0.4 for corrected release
+	[a8a6a67e2ede]
+
+	* README.md:
+	Adding Github mirror to the README
+	[bb8f2829eb37]
+
+	* .hgtags:
+	Added tag v1.0.3 for changeset 910ae8ac082f
+	[a2ae16f86c98]
+
+	* .hgsigs:
+	Added signature for changeset 49e98e6334dd
+	[910ae8ac082f] [v1.0.3]
+
+	* Merged with 24:7aec5228c2b0
+	[49e98e6334dd]
+
+	* .hgsubstate, lib/configurability.rb,
+	lib/configurability/deferredconfig.rb,
+	spec/configurability/deferredconfig_spec.rb,
+	spec/configurability_spec.rb, spec/lib/helpers.rb:
+	Propagate the installed config to objects that add Configurability
+	after the config is loaded.
+	[ec3f030074dc]
+
+2010-10-29  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag 1.0.2 for changeset ba2c849fde0d
+	[7aec5228c2b0]
+
+	* .hgsigs:
+	Added signature for changeset 8718e7f4ea1f
+	[ba2c849fde0d] [1.0.2]
+
+2010-11-29  Michael Granger  <ged@FaerieMUD.org>
+
+	* Rakefile, project.yml:
+	Updated build system
+	[58cbefcef526]
+
+2010-10-29  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgsubstate, spec/configurability/config_spec.rb,
+	spec/configurability_spec.rb:
+	Fixes for specs under 1.9.2.
+	[8718e7f4ea1f]
+
+	* Merged with 17:e2bf2e43bccf
+	[17a6999c08b9]
+
+2010-10-25  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/configurability/behavior.rb:
+	Fixed require for RSpec 2 in the shared behavior.
+	[e2bf2e43bccf]
+
+	* .hgsubstate, Rakefile, lib/configurability.rb,
+	lib/configurability/behavior.rb, project.yml,
+	spec/configurability/config_spec.rb, spec/configurability_spec.rb:
+	Converted tests to RSpec 2.
+	[5d18e28e387b]
+
+2010-08-08  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag 1.0.1 for changeset e3605ccbe057
+	[4bff6d5f7b6e]
+
+	* .hgsigs:
+	Added signature for changeset 41bc1de0bf36
+	[e3605ccbe057] [1.0.1]
+
+2010-08-04  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgignore, README.md, lib/configurability/config.rb,
+	spec/configurability/config_spec.rb:
+	More Configurability::Config work
+	 * More docs
+	 * Made #reload's behaviour match its documentation
+	[41bc1de0bf36]
+
+	* README.md, examples/config.yml, lib/configurability/config.rb,
+	spec/configurability/config_spec.rb:
+	More work on Configurability::Config
+	 * More documentation
+	 * Move hash-access in the Struct into explicit index operator methods
+	and change the lambdas to be implemented in terms of them for more-
+	consistent behavior, String/Symbol normalization, etc.
+	[44db952eb824]
+
+	* README.md, lib/configurability/config.rb,
+	spec/configurability/config_spec.rb:
+	Finishing up Configurability::Config.
+	 * Started documentation
+	 * Fleshed out the specs for better coverage, fixing some bugs
+	uncovered by same.
+	 * Nicer inspect output
+	[2323bf260e7c]
+
+	* .hgsubstate, Rakefile:
+	Build system updates.
+	[9e0bab83afd5]
+
+	* lib/configurability/behavior.rb:
+	Add an rspec shared behavior for testing classes with
+	Configurability
+	[cba63cef2f7f]
+
+2010-07-16  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/configurability/config.rb, spec/configurability/config_spec.rb:
+	Adding a Configurability::Config class for YAML config loading.
+	[4ffdde3f7a2f]
+
+	* .hgignore, .irbrc, README.md, Rakefile, project.yml:
+	Updating README, project metadata, adding .irbrc
+	[d225cef4269e]
+
+	* lib/configurability.rb:
+	Version bump; debugging log
+	[9da882b82786]
+
+2010-07-12  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag 1.0.0 for changeset 74b5dd9a89c9
+	[ecf5d4565338]
+
+	* .hgsigs:
+	Added signature for changeset e0fef8dabba4
+	[74b5dd9a89c9] [1.0.0]
+
+	* README.md, lib/configurability.rb:
+	README formatting, YARD tag fix.
+	[e0fef8dabba4]
+
+	* .hgignore, README, README.md, spec/configurability_spec.rb:
+	Documentation, added a test for classname normalization.
+	[4d7044641f87]
+
+	* README, lib/configurability.rb, spec/configurability_spec.rb:
+	Added some stuff to the README, made String config keys work.
+	[0b395dbf657f]
+
+	* examples/basicconfig.rb:
+	Adding an example.
+	[9531380cc3f2]
+
+2010-07-11  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgsubstate, LICENSE, README, Rakefile, lib/configurability.rb,
+	lib/configurability/logformatter.rb, project.yml,
+	spec/configurability_spec.rb, spec/lib/helpers.rb:
+	Initial version.
+	[982ba9fe2e6e]
+
+2010-07-10  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgsub, .hgsubstate:
+	Adding rake subrepo
+	[ac34a9d6c913]

data/{History.md → History.rdoc}

@@ -1,4 +1,9 @@
-## 1.0.6 [2011-03-03] Michael Granger <ged@FaerieMUD.org>
+== v1.0.7 [2011-10-13] Michael Granger <ged@FaerieMUD.org>
+
+- De-Yard and fix some other documentation/packaging issues.
+
+
+== v1.0.6 [2011-03-03] Michael Granger <ged@FaerieMUD.org>
 
 Bugfixes:
 
@@ -6,19 +11,19 @@ Bugfixes:
   `true` as well.
 
 
-## 1.0.5 [2011-02-08] Michael Granger <ged@FaerieMUD.org>
+== v1.0.5 [2011-02-08] Michael Granger <ged@FaerieMUD.org>
 
 Bugfixes:
 
 * Now handles config files with nil keys correctly.
 
 
-## 1.0.4 [2010-11-29] Michael Granger <ged@FaerieMUD.org>
+== v1.0.4 [2010-11-29] Michael Granger <ged@FaerieMUD.org>
 
 Packaging fix.
 
 
-## 1.0.3 [2010-11-29] Michael Granger <ged@FaerieMUD.org>
+== v1.0.3 [2010-11-29] Michael Granger <ged@FaerieMUD.org>
 
 Enchancements:
 
@@ -26,14 +31,14 @@ Enchancements:
   config is loaded.
 
 
-## 1.0.2 [2010-11-29] Michael Granger <ged@FaerieMUD.org>
+== v1.0.2 [2010-11-29] Michael Granger <ged@FaerieMUD.org>
 
 Bugfixes:
 
 * Fixes for specs under 1.9.2.
 
 
-## 1.0.1 [2010-08-08] Michael Granger <ged@FaerieMUD.org>
+== v1.0.1 [2010-08-08] Michael Granger <ged@FaerieMUD.org>
 
 Enhancements:
 
@@ -42,7 +47,7 @@ Enhancements:
 * Converted tests to RSpec 2.
 
 
-## 1.0.0 [2010-07-12] Michael Granger <ged@FaerieMUD.org>
+== v1.0.0 [2010-07-12] Michael Granger <ged@FaerieMUD.org>
 
 Initial release
 

data/Manifest.txt

@@ -0,0 +1,17 @@
+ChangeLog
+History.rdoc
+LICENSE
+Manifest.txt
+README.rdoc
+Rakefile
+examples/basicconfig.rb
+examples/config.yml
+lib/configurability.rb
+lib/configurability/behavior.rb
+lib/configurability/config.rb
+lib/configurability/deferredconfig.rb
+lib/configurability/logformatter.rb
+spec/configurability/config_spec.rb
+spec/configurability/deferredconfig_spec.rb
+spec/configurability_spec.rb
+spec/lib/helpers.rb

data/{README.md → README.rdoc}

@@ -1,9 +1,9 @@
-# Configurability
+= Configurability
 
 * http://bitbucket.org/ged/configurability
 
 
-## Description
+== Description
 
 Configurability is a mixin that allows you to add configurability to one or
 more objects or classes. You can assign them each a subsection of the
@@ -11,12 +11,12 @@ configuration, and then later, when the configuration is loaded, the
 configuration is split up and sent to the objects that will use it.
 
 
-## Installation
+== Installation
 
     gem install configurability
 
 
-## Usage
+== Usage
 
 To add configurability to a class, just require the library and extend
 the class:
@@ -64,13 +64,13 @@ to the appropriate section of the config object for each object that has
 been extended with Configurability.
 
 
-## Customization
+== Customization
 
 The default behavior above is just provided as a reasonable default; it is
 expected that you'll want to customize at least one or two things about
 how configuration is handled in your objects.
 
-### Setting a Custom Config Key
+=== Setting a Custom Config Key
 
 The first thing you might want to do is change the config section that
 corresponds to your object. You can do that by declaring a different
@@ -91,7 +91,7 @@ as a Symbol:
         end
     end
 
-### Changing How an Object Is Configured
+=== Changing How an Object Is Configured
 
 You can also change what happens when an object is configured by implementing
 a `#configure` method that takes the config section as an argument:
@@ -107,15 +107,17 @@ a `#configure` method that takes the config section as an argument:
         end
     end
 
-If you still want the `@config` variable to be set, just `super` from your implementation; don't if you don't want it to be set.
+If you still want the `@config` variable to be set, just `super` from your
+implementation; don't if you don't want it to be set.
 
 
-## Configuration Objects
+== Configuration Objects
 
 Configurability also includes `Configurability::Config`, a fairly simple
 configuration object class that can be used to load a YAML configuration file,
 and then present both a Hash-like and a Struct-like interface for reading
-configuration sections and values; it's meant to be used in tandem with Configurability, but it's also useful on its own.
+configuration sections and values; it's meant to be used in tandem with
+Configurability, but it's also useful on its own.
 
 Here's a quick example to demonstrate some of its features. Suppose you have a
 config file that looks like this:
@@ -199,11 +201,13 @@ loaded it:
     config.changed?
     # => true
 
-If it has changed (or even if it hasn't), you can reload it, which automatically re-installs it via the Configurability interface:
+If it has changed (or even if it hasn't), you can reload it, which
+automatically re-installs it via the Configurability interface:
 
     config.reload
 
-You can make modifications via the same Struct- or Hash-like interfaces and write the modified config back out to the same file:
+You can make modifications via the same Struct- or Hash-like interfaces and
+write the modified config back out to the same file:
 
     config.database.testing.adapter = 'mysql'
     config[:database]['testing'].database = 't_fixedassets'
@@ -225,11 +229,13 @@ or write it back to the file it was loaded from:
 	config.write
 
 
-## Development
+== Development
 
-You can submit bug reports, suggestions, clone it with Mercurial, and read
-more about future plans at [the project page][projectpage]. If you prefer Git,
-there is also a [Github mirror][gitmirror].
+You can submit bug reports, suggestions, clone it with Mercurial, and
+read more about future plans at 
+{the project page}[http://bitbucket.org/ged/configurability]. If you 
+prefer Git, there is also a 
+{Github mirror}[https://github.com/ged/configurability].
 
 After checking out the source, run:
 
@@ -239,7 +245,7 @@ This task will install any missing dependencies, run the tests/specs,
 and generate the API documentation.
 
 
-## License
+== License
 
 Copyright (c) 2010, 2011  Michael Granger
 All rights reserved.
@@ -270,6 +276,3 @@ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
-[projectpage]:http://bitbucket.org/ged/configurability
-[gitmirror]:https://github.com/ged/configurability
-

data/Rakefile

@@ -15,75 +15,24 @@ Hoe.plugins.delete :rubyforge
 
 
 hoespec = Hoe.spec 'configurability' do
-	self.readme_file = 'README.md'
-	self.history_file = 'History.md'
+	self.readme_file = 'README.rdoc'
+	self.history_file = 'History.rdoc'
+	self.extra_rdoc_files = Rake::FileList[ '*.rdoc' ]
 
 	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
 
-	self.extra_dev_deps.push *{
-		'rspec'     => '~> 2.4',
-		'simplecov' => '~> 0.3',
-	}
+	self.dependency 'rspec', '~> 2.4', :developer
+	self.dependency 'simplecov', '~> 0.3', :developer
 
 	self.spec_extras[:licenses] = ["BSD"]
-	self.spec_extras[:post_install_message] = %{
-
-		New!
-		
-	}.gsub( /^\t{2}/, '' )
-
-	self.spec_extras[:signing_key] = '/Volumes/Keys/ged-private_gem_key.pem'
-
 	self.require_ruby_version( '>= 1.8.7' )
 
 	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
-	self.yard_opts = [ '--protected', '--verbose' ] if self.respond_to?( :yard_opts= )
-
 	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
 end
 
 ENV['VERSION'] ||= hoespec.spec.version.to_s
 
 # Ensure the specs pass before checking in
-task 'hg:precheckin' => :spec
-
-begin
-	include Hoe::MercurialHelpers
-
-	### Task: prerelease
-	desc "Append the package build number to package versions"
-	task :pre do
-		rev = get_numeric_rev()
-		trace "Current rev is: %p" % [ rev ]
-		hoespec.spec.version.version << "pre#{rev}"
-		Rake::Task[:gem].clear
-
-		Gem::PackageTask.new( hoespec.spec ) do |pkg|
-			pkg.need_zip = true
-			pkg.need_tar = true
-		end
-	end
-
-	### Make the ChangeLog update if the repo has changed since it was last built
-	file '.hg/branch'
-	file 'ChangeLog' => '.hg/branch' do |task|
-		$stderr.puts "Updating the changelog..."
-		content = make_changelog()
-		File.open( task.name, 'w', 0644 ) do |fh|
-			fh.print( content )
-		end
-	end
-
-	# Rebuild the ChangeLog immediately before release
-	task :prerelease => 'ChangeLog'
-
-rescue NameError => err
-	task :no_hg_helpers do
-		fail "Couldn't define the :pre task: %s: %s" % [ err.class.name, err.message ]
-	end
-
-	task :pre => :no_hg_helpers
-	task 'ChangeLog' => :no_hg_helpers
-
-end
+task 'hg:precheckin' => [ :check_history, :check_manifest, :spec ]
 

data/lib/configurability.rb

@@ -4,15 +4,17 @@ require 'yaml'
 
 # A configuration mixin for Ruby classes.
 # 
-# @author Michael Granger <ged@FaerieMUD.org>
+# == Author/s
+# 
+# * Michael Granger <ged@FaerieMUD.org>
 # 
 module Configurability
 
 	# Library version constant
-	VERSION = '1.0.6'
+	VERSION = '1.0.7'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 631fd470522c $
+	REVISION = %q$Revision: 605036b92217 $
 
 	require 'configurability/logformatter'
 	require 'configurability/deferredconfig'
@@ -36,22 +38,20 @@ module Configurability
 
 	class << self
 
-		# @return [Array] the Array of objects that have had Configurability 
-		# added to them
+		# the Array of objects that have had Configurability added to them
 		attr_accessor :configurable_objects
 
-		# @return [Object] the loaded configuration (after ::configure_objects
-		# has been called at least once)
+		# the loaded configuration (after ::configure_objects has been called at least once)
 		attr_accessor :loaded_config
 
-		# @return [Logger::Formatter] the log formatter that will be used when the logging 
-		#    subsystem is reset
+		# the log formatter that will be used when the logging subsystem is
+		# reset
 		attr_accessor :default_log_formatter
 
-		# @return [Logger] the logger that will be used when the logging subsystem is reset
+		# the logger that will be used when the logging subsystem is reset
 		attr_accessor :default_logger
 
-		# @return [Logger] the logger that's currently in effect
+		# the logger that's currently in effect
 		attr_accessor :logger
 		alias_method :log, :logger
 		alias_method :log=, :logger=
@@ -119,7 +119,6 @@ module Configurability
 
 
 	### Reset the global logger object to the default
-	### @return [void]
 	def self::reset_logger
 		self.logger = self.default_logger
 		self.logger.level = Logger::WARN
@@ -155,9 +154,7 @@ module Configurability
 	### used to configure the object.
 	attr_writer :config_key
 
-	### Get (and optionally set) the +config_key+.
-	### @param [Symbol] sym  the config key
-	### @return [Symbol] the config key
+	### Get (and optionally set) the +config_key+ (a Symbol).
 	def config_key( sym=nil )
 		@config_key = sym unless sym.nil?
 		@config_key ||= Configurability.make_key_from_object( self )
@@ -166,14 +163,12 @@ module Configurability
 
 
 	### Set the config key of the object.
-	### @param [Symbol] sym  the config key
 	def config_key=( sym )
 		@config_key = sym
 	end
 
 
 	### Default configuration method.
-	### @param [Object] configuration section object
 	def configure( config )
 		@config = config
 	end

data/lib/configurability/config.rb

@@ -10,26 +10,28 @@ require 'configurability'
 
 # A configuration object class for systems with Configurability
 # 
-# @author Michael Granger <ged@FaerieMUD.org>
-# @author Mahlon E. Smith <mahlon@martini.nu>
+# == Author/s
+#
+# * Michael Granger <ged@FaerieMUD.org>
+# * Mahlon E. Smith <mahlon@martini.nu>
 # 
 # This class also delegates some of its methods to the underlying struct:
 #
-# @see Configurability::Config::Struct#to_hash
+# [Configurability::Config::Struct#to_hash]
 #      #to_hash (delegated to its internal Struct)
-# @see Configurability::Config::Struct#member?
+# [Configurability::Config::Struct#member?]
 #      #member? (delegated to its internal Struct)
-# @see Configurability::Config::Struct#members
+# [Configurability::Config::Struct#members]
 #      #members (delegated to its internal Struct)
-# @see Configurability::Config::Struct#merge
+# [Configurability::Config::Struct#merge]
 #      #merge (delegated to its internal Struct)
-# @see Configurability::Config::Struct#merge!
+# [Configurability::Config::Struct#merge!]
 #      #merge! (delegated to its internal Struct)
-# @see Configurability::Config::Struct#each
+# [Configurability::Config::Struct#each]
 #      #each (delegated to its internal Struct)
-# @see Configurability::Config::Struct#[]
+# [Configurability::Config::Struct#[]]
 #      #[] (delegated to its internal Struct)
-# @see Configurability::Config::Struct#[]=
+# [Configurability::Config::Struct#[]=]
 #      #[]= (delegated to its internal Struct)
 # 
 class Configurability::Config
@@ -41,11 +43,6 @@ class Configurability::Config
 	#############################################################
 
 	### Read and return a Configurability::Config object from the file at the given +path+.
-	### @param [String] path      the path to the config file
-	### @param [Hash]   defaults  a Hash of default config values which will be
-	###                           used if the config at +path+ doesn't override
-	###                           them.
-	### @param          block     passed through as the block argument to {#initialize}.
 	def self::load( path, defaults=nil, &block )
 		path = Pathname( path ).expand_path
 		source = path.read
@@ -55,9 +52,6 @@ class Configurability::Config
 
 
 	### Recursive hash-merge function. Used as the block argument to a Hash#merge.
-	### @param [Symbol]  key     the key that's in conflict
-	### @param [Object]  oldval  the value in the original Hash
-	### @param [Object]  newval  the value in the Hash being merged
 	def self::merge_complex_hashes( key, oldval, newval )
 		return oldval.merge( newval, &method(:merge_complex_hashes) ) if
 			oldval.is_a?( Hash ) && newval.is_a?( Hash )
@@ -72,14 +66,9 @@ class Configurability::Config
 
 	### Create a new Configurability::Config object. If the optional +source+ argument
 	### is specified, parse the config from it.
-	### 
-	### @param [String] source           the YAML source of the configuration
-	### @param [String, Pathname] path   the path to the config file (if loaded from a file)
-	### @param [Hash] defaults           a Hash containing default values which the loaded values
-	###                                  will be merged into.
-	### @yield  The block will be evaluated in the context of the config object after
-	###         the config is loaded, unless it accepts an argument, in which case the config
-	###         object is passed as the argument.
+	### If one is given, the block will be evaluated in the context of the config object after
+	### the config is loaded, unless it accepts an argument, in which case the config
+	### object is passed as the argument.
 	def initialize( source=nil, path=nil, defaults=nil, &block )
 
 		# Shift the hash parameter if it shows up as the path
@@ -124,13 +113,13 @@ class Configurability::Config
 	def_delegators :@struct, :to_hash, :to_h, :member?, :members, :merge,
 		:merge!, :each, :[], :[]=
 
-	# @return [Configurability::Config::Struct] The underlying config data structure
+	# The underlying config data structure
 	attr_reader :struct
 
-	# @return [Time] The time the configuration was loaded
+	# The time the configuration was loaded
 	attr_accessor :time_created
 
-	# @return [Pathname] the path to the config file, if loaded from a file
+	# the path to the config file, if loaded from a file
 	attr_accessor :path
 
 
@@ -205,7 +194,6 @@ class Configurability::Config
 
 	### Reload the configuration from the original source if it has
 	### changed. Returns +true+ if it was reloaded and +false+ otherwise.
-	### 
 	def reload
 		raise "can't reload from an in-memory source" unless self.path
 
@@ -241,8 +229,6 @@ class Configurability::Config
 
 
 	### Read in the specified +filename+ and return a config struct.
-	### @param [String]  source  the YAML source to be converted
-	### @return [Configurability::Config::Struct]  the converted config struct
 	def make_configstruct_from_source( source, defaults=nil )
 		defaults ||= {}
 		mergefunc = Configurability::Config.method( :merge_complex_hashes )
@@ -353,7 +339,6 @@ class Configurability::Config
 
 
 		### Create a new ConfigStruct using the values from the given +hash+ if specified.
-		### @param [Hash] hash  a hash of config values
 		def initialize( hash=nil )
 			hash ||= {}
 			@hash = hash.dup
@@ -373,11 +358,8 @@ class Configurability::Config
 		alias_method :each_section, :each
 
 
-		### Return the value associated with the specified +key+.
-		### @param [Symbol, String] key  the key of the value to return
-		### @return [Object] the value associated with +key+, or another
-		###                  Configurability::Config::ConfigStruct if +key+
-		###                  is a section name.
+		# Return the value associated with the specified +key+, or another
+		# Configurability::Config::ConfigStruct if +key+ is a section name.
 		def []( key )
 			key = key.untaint.to_sym if key.respond_to?( :to_sym )
 
@@ -393,8 +375,6 @@ class Configurability::Config
 
 
 		### Set the value associated with the specified +key+ to +value+.
-		### @param [Symbol, String] key    the key of the value to set
-		### @param [Object]         value  the value to set
 		def []=( key, value )
 			key = key.untaint.to_sym
 			self.mark_dirty if @hash[ key ] != value
@@ -535,24 +515,18 @@ class Configurability::Config
 
 
 		### Create a reader method for the specified +key+ and return it.
-		### @param [Symbol] key  the config key to create the reader method body for
-		### @return [Proc] the body of the new method
 		def create_member_reader( key )
 			return lambda { self[key] }
 		end
 
 
 		### Create a predicate method for the specified +key+ and return it.
-		### @param [Symbol] key  the config key to create the predicate method body for
- 		### @return [Proc] the body of the new method
 		def create_member_predicate( key )
 			return lambda { self.member?( key ) && self[key] ? true : false }
 		end
 
 
 		### Create a writer method for the specified +key+ and return it.
-		### @param [Symbol] key  the config key to create the writer method body for
-		### @return [Proc] the body of the new method
 		def create_member_writer( key )
 			return lambda {|val| self[key] = val }
 		end

data/lib/configurability/deferredconfig.rb

@@ -3,8 +3,8 @@
 require 'configurability'
 
 
-### Mixin that can be applied to classes to cause them to configure themselves
-### as soon as they are able to.
+# Mixin that can be applied to classes to cause them to configure themselves
+# as soon as they are able to.
 module Configurability::DeferredConfig
 
 	### Extension hook: log when the mixin is used.

metadata

@@ -1,138 +1,132 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: configurability
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 1.0.7
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 6
-  version: 1.0.6
 platform: ruby
-authors: 
+authors:
 - Michael Granger
 autorequire: 
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
+cert_chain:
+- ! '-----BEGIN CERTIFICATE-----
+
   MIIDLDCCAhSgAwIBAgIBADANBgkqhkiG9w0BAQUFADA8MQwwCgYDVQQDDANnZWQx
+
   FzAVBgoJkiaJk/IsZAEZFgdfYWVyaWVfMRMwEQYKCZImiZPyLGQBGRYDb3JnMB4X
+
   DTEwMDkxNjE0NDg1MVoXDTExMDkxNjE0NDg1MVowPDEMMAoGA1UEAwwDZ2VkMRcw
+
   FQYKCZImiZPyLGQBGRYHX2FlcmllXzETMBEGCgmSJomT8ixkARkWA29yZzCCASIw
+
   DQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALy//BFxC1f/cPSnwtJBWoFiFrir
+
   h7RicI+joq/ocVXQqI4TDWPyF/8tqkvt+rD99X9qs2YeR8CU/YiIpLWrQOYST70J
+
   vDn7Uvhb2muFVqq6+vobeTkILBEO6pionWDG8jSbo3qKm1RjKJDwg9p4wNKhPuu8
+
   KGue/BFb67KflqyApPmPeb3Vdd9clspzqeFqp7cUBMEpFS6LWxy4Gk+qvFFJBJLB
+
   BUHE/LZVJMVzfpC5Uq+QmY7B+FH/QqNndn3tOHgsPadLTNimuB1sCuL1a4z3Pepd
+
   TeLBEFmEao5Dk3K/Q8o8vlbIB/jBDTUx6Djbgxw77909x6gI9doU4LD5XMcCAwEA
+
   AaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFJeoGkOr9l4B
+
   +saMkW/ZXT4UeSvVMA0GCSqGSIb3DQEBBQUAA4IBAQBG2KObvYI2eHyyBUJSJ3jN
+
   vEnU3d60znAXbrSd2qb3r1lY1EPDD3bcy0MggCfGdg3Xu54z21oqyIdk8uGtWBPL
+
   HIa9EgfFGSUEgvcIvaYqiN4jTUtidfEFw+Ltjs8AP9gWgSIYS6Gr38V0WGFFNzIH
+
   aOD2wmu9oo/RffW4hS/8GuvfMzcw7CQ355wFR4KB/nyze+EsZ1Y5DerCAagMVuDQ
+
   U0BLmWDFzPGGWlPeQCrYHCr+AcJz+NRnaHCKLZdSKj/RHuTOt+gblRex8FAh8NeA
+
   cmlhXe46pZNJgWKbxZah85jIjx95hR8vOI+NAM5iH9kOqK13DrxacTKPhqj5PjwF
+
   -----END CERTIFICATE-----
 
-date: 2011-03-03 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+'
+date: 2011-10-13 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: hoe-mercurial
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152906820 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 1
-        - 2
-        - 1
-        version: 1.2.1
+      - !ruby/object:Gem::Version
+        version: 1.3.1
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hoe-yard
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2152906820
+- !ruby/object:Gem::Dependency
+  name: hoe-highline
+  requirement: &2152905680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 0
-        - 1
-        - 2
-        version: 0.1.2
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2152905680
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152905040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 4
-        version: "2.4"
+      - !ruby/object:Gem::Version
+        version: '2.4'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: simplecov
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2152905040
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2152904600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 0
-        - 3
-        version: "0.3"
+      - !ruby/object:Gem::Version
+        version: '0.3'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: hoe
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2152904600
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &2152904160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 2
-        - 9
-        - 0
-        version: 2.9.0
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
   type: :development
-  version_requirements: *id005
-description: |-
-  Configurability is a mixin that allows you to add configurability to one or
+  prerelease: false
+  version_requirements: *2152904160
+description: ! 'Configurability is a mixin that allows you to add configurability
+  to one or
+
   more objects or classes. You can assign them each a subsection of the
+
   configuration, and then later, when the configuration is loaded, the
-  configuration is split up and sent to the objects that will use it.
-email: 
+
+  configuration is split up and sent to the objects that will use it.'
+email:
 - ged@FaerieMUD.org
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- History.md
-files: 
-- History.md
+extra_rdoc_files:
+- Manifest.txt
+- History.rdoc
+- README.rdoc
+files:
+- ChangeLog
+- History.rdoc
 - LICENSE
-- README.md
+- Manifest.txt
+- README.rdoc
 - Rakefile
 - examples/basicconfig.rb
 - examples/config.yml
@@ -146,46 +140,32 @@ files:
 - spec/configurability_spec.rb
 - spec/lib/helpers.rb
 - .gemtest
-has_rdoc: true
 homepage: http://bitbucket.org/ged/configurability
-licenses: 
+licenses:
 - BSD
-post_install_message: "\n\n\
-  New!\n\n\
-  \t"
-rdoc_options: 
-- --protected
-- --verbose
-- --title
-- Configurability Documentation
-require_paths: 
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 57
-      segments: 
-      - 1
-      - 8
-      - 7
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: configurability
-rubygems_version: 1.6.0
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Configurability is a mixin that allows you to add configurability to one or more objects or classes
+summary: Configurability is a mixin that allows you to add configurability to one
+  or more objects or classes
 test_files: []
-