configurability 1.0.10 → 1.1.0

data/History.rdoc

@@ -1,3 +1,11 @@
+== v1.1.0 [2012-04-25] Michael Granger <ged@FaerieMUD.org>
+
+Add a 'defaults' API that allows defaults to be gathered from any
+object with configurability and merged into a hash keyed by the
+object's config_key. This hash can be used to generate an initial
+unified config file for all configurable parts of a given system.
+
+
 == v1.0.10 [2012-03-13] Michael Granger <ged@FaerieMUD.org>
 
 - Fix log level message.

data/Manifest.txt

@@ -10,7 +10,7 @@ lib/configurability.rb
 lib/configurability/behavior.rb
 lib/configurability/config.rb
 lib/configurability/deferredconfig.rb
-lib/configurability/logformatter.rb
+lib/configurability/logging.rb
 spec/configurability/config_spec.rb
 spec/configurability/deferredconfig_spec.rb
 spec/configurability_spec.rb

data/README.rdoc

@@ -1,14 +1,19 @@
 = Configurability
 
-* http://bitbucket.org/ged/configurability
+home :: https://bitbucket.org/ged/configurability
+code :: https://bitbucket.org/ged/configurability
+docs :: http://deveiate.org/code/configurability
+github :: https://github.com/ged/configurability
 
 
 == 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.
+Configurability is a unified, unintrusive, assume-nothing configuration system
+for Ruby. It lets you keep the configuration for multiple objects in a single
+config file, load the file when it's convenient for you, and distribute the
+configuration when you're ready, sending it everywhere it needs to go with a
+single action.
+
 
 
 == Installation
@@ -93,6 +98,9 @@ as a Symbol:
 
 === Changing How an Object Is Configured
 
+[:FIXME:] Explain the 'at least once' configuration call, and how to handle
+being called with 'nil'.
+
 You can also change what happens when an object is configured by implementing
 a `#configure` method that takes the config section as an argument:
 
@@ -216,19 +224,27 @@ then dump it to a YAML string:
 
     config.dump
 	# => "--- \ndatabase: \n  development: \n    adapter: sqlite3\n   
-	 	database: db/dev.db\n    pool: 5\n    timeout: 5000\n  testing: \n   
-	 	adapter: mysql\n    database: t_fixedassets\n    pool: 2\n    timeout:
-	 	5000\n  production: \n    adapter: postgres\n    database:
-	 	fixedassets\n    pool: 25\n    timeout: 50\nldap: \n  uri:
-	 	ldap://ldap.acme.com/dc=acme,dc=com\n  bind_dn:
-	 	cn=web,dc=acme,dc=com\n  bind_pass: Mut@ge.Mix@ge\nbranding: \n 
-	 	header: \"#333\"\n  title: \"#dedede\"\n  anchor: \"#9fc8d4\"\n"
+		database: db/dev.db\n    pool: 5\n    timeout: 5000\n  testing: \n   
+		adapter: mysql\n    database: t_fixedassets\n    pool: 2\n    timeout:
+		5000\n  production: \n    adapter: postgres\n    database:
+		fixedassets\n    pool: 25\n    timeout: 50\nldap: \n  uri:
+		ldap://ldap.acme.com/dc=acme,dc=com\n  bind_dn:
+		cn=web,dc=acme,dc=com\n  bind_pass: Mut@ge.Mix@ge\nbranding: \n 
+		header: \"#333\"\n  title: \"#dedede\"\n  anchor: \"#9fc8d4\"\n"
 
 or write it back to the file it was loaded from:
 
 	config.write
 
 
+== Configuration Defaults
+
+Configurability also supports an API for generating a new config file with
+defaults for all objects with Configurability.
+
+[:FIXME:] Finish up the documentation
+
+
 == Development
 
 You can submit bug reports, suggestions, clone it with Mercurial, and

data/Rakefile

@@ -10,6 +10,7 @@ end
 Hoe.plugin :mercurial
 Hoe.plugin :yard
 Hoe.plugin :signing
+Hoe.plugin :deveiate
 
 Hoe.plugins.delete :rubyforge
 
@@ -25,6 +26,7 @@ hoespec = Hoe.spec 'configurability' do
 	self.dependency 'simplecov', '~> 0.3', :developer
 
 	self.spec_extras[:licenses] = ["BSD"]
+	self.spec_extras[:rdoc_options] = ['-f', 'fivefish', '-t', 'Configurability Toolkit']
 	self.require_ruby_version( '>= 1.8.7' )
 
 	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )

data/lib/configurability.rb

@@ -11,14 +11,19 @@ require 'yaml'
 module Configurability
 
 	# Library version constant
-	VERSION = '1.0.10'
+	VERSION = '1.1.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 0dcd8dcebc87 $
+	REVISION = %q$Revision: e56100a012e3 $
+
+
+	require 'configurability/logging'
+	extend Configurability::Logging
 
-	require 'configurability/logformatter'
 	require 'configurability/deferredconfig'
 
+	autoload :Config, 'configurability/config'
+
 
 	### The objects that have had Configurability added to them
 	@configurable_objects = []
@@ -31,16 +36,6 @@ module Configurability
 	### are the config section it was called with
 	@configured = Hash.new( false )
 
-	### Logging
-	@default_logger = Logger.new( $stderr )
-	@default_logger.level = $DEBUG ? Logger::DEBUG : Logger::WARN
-
-	@default_log_formatter = Configurability::LogFormatter.new( @default_logger )
-	@default_logger.formatter = @default_log_formatter
-
-	@logger = @default_logger
-
-
 	class << self
 
 		# the Array of objects that have had Configurability added to them
@@ -52,17 +47,15 @@ module Configurability
 		# the hash of configure methods => config sections which have already been installed
 		attr_reader :configured
 
-		# the log formatter that will be used when the logging subsystem is
-		# reset
-		attr_accessor :default_log_formatter
+	end
 
-		# the logger that will be used when the logging subsystem is reset
-		attr_accessor :default_logger
 
-		# the logger that's currently in effect
-		attr_accessor :logger
-		alias_method :log, :logger
-		alias_method :log=, :logger=
+	### Get the library version. If +include_buildnum+ is true, the version string will
+	### include the VCS rev ID.
+	def self::version_string( include_buildnum=false )
+		vstring = "%s %s" % [ self.name, VERSION ]
+		vstring << " (build %s)" % [ REVISION[/: ([[:xdigit:]]+)/, 1] || '0' ] if include_buildnum
+		return vstring
 	end
 
 
@@ -128,14 +121,6 @@ module Configurability
 	end
 
 
-	### Reset the global logger object to the default
-	def self::reset_logger
-		self.logger = self.default_logger
-		self.logger.level = Logger::WARN
-		self.logger.formatter = self.default_log_formatter
-	end
-
-
 	### Install the appropriate section of the +config+ into the given +object+.
 	def self::install_config( config, object )
 		section = object.config_key.to_sym
@@ -155,8 +140,7 @@ module Configurability
 				section = nil
 			end
 		else
-			self.log.info "  don't know how to get the %p section of the config from %p" %
-				[ section, config ]
+			self.log.info "  no %p section in %p; configuring with nil" % [ section, config ]
 			section = nil
 		end
 
@@ -174,10 +158,42 @@ module Configurability
 	end
 
 
+	### Gather defaults from objects with Configurability in the given +collection+
+	### object. Objects that wish to add a section to the defaults should implement
+	### a #defaults method in the same scope as #configure that returns the Hash of
+	### default, or set one of the constants in the default implementation of
+	### #defaults. The hash for each object will be merged into the +collection+
+	### via #merge!.
+	def self::gather_defaults( collection={} )
+		self.configurable_objects.each do |obj|
+			next unless obj.respond_to?( :defaults )
+			unless subhash = obj.defaults
+				Configurability.log.warn "No defaults for %p; skipping" % [ obj ]
+				next
+			end
+			section = obj.config_key.to_sym
+
+			collection.merge!( section => subhash )
+		end
+
+		return collection
+	end
+
+
+	### Gather the default configuration in a Configurability::Config object and return it.
+	def self::default_config
+		return self.gather_defaults( Configurability::Config.new )
+	end
+
+
 	#############################################################
 	### A P P E N D E D	  M E T H O D S
 	#############################################################
 
+	#
+	# :section: Configuration API
+	#
+
 	### Get (and optionally set) the +config_key+ (a Symbol).
 	def config_key( sym=nil )
 		@config_key = sym unless sym.nil?
@@ -198,5 +214,31 @@ module Configurability
 	end
 
 
+	#
+	# :section: Configuration Defaults API
+	#
+
+	### The default implementation of the method called by ::gather_defaults when
+	### gathering configuration defaults. This method expects either a
+	### +DEFAULT_CONFIG+ or a +CONFIG_DEFAULTS+ constant to contain the configuration
+	### defaults, and will just return +nil+ if neither exists.
+	def defaults
+
+		return nil unless respond_to?( :const_defined? )
+
+		Configurability.log.debug "Looking for defaults in %p's constants." % [ self ]
+		if self.const_defined?( :DEFAULT_CONFIG )
+			Configurability.log.debug "  found DEFAULT_CONFIG"
+			return self.const_get( :DEFAULT_CONFIG ).dup
+		elsif self.const_defined?( :CONFIG_DEFAULTS )
+			Configurability.log.debug "  found CONFIG_DEFAULTS"
+			return self.const_get( :CONFIG_DEFAULTS ).dup
+		else
+			Configurability.log.debug "  no default constants."
+			return nil
+		end
+	end
+
+
 end # module Configurability
 

data/lib/configurability/config.rb

@@ -140,9 +140,17 @@ class Configurability::Config
 	### Write the configuration object using the specified name and any
 	### additional +args+.
 	def write( path=@path, *args )
+		unless path.is_a?( String ) || path.is_a?( Pathname )
+			args.unshift( path )
+			path = @path
+		end
+
 		raise ArgumentError,
 			"No name associated with this config." unless path
-		path.open( File::WRONLY|File::CREAT|File::TRUNC ) do |ofh|
+
+		self.log.info "Writing config to %s with args: %p" % [ path, args ]
+		path = Pathname( path )
+		path.open( File::WRONLY|File::CREAT|File::TRUNC, *args ) do |ofh|
 			ofh.print( self.dump )
 		end
 	end
@@ -254,6 +262,12 @@ class Configurability::Config
 	end
 
 
+	### Delegate logging to the module's Logger.
+	def log
+		Configurability.logger
+	end
+
+
 	#######
 	private
 	#######

data/lib/configurability/logging.rb

@@ -0,0 +1,300 @@
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4:
+# encoding: utf-8
+
+require 'logger'
+require 'date'
+
+require 'configurability' unless defined?( Configurability )
+
+
+# A mixin that provides a top-level logging subsystem based on Logger.
+module Configurability::Logging
+
+	### Logging
+	# Log levels
+	LOG_LEVELS = {
+		'debug' => Logger::DEBUG,
+		'info'  => Logger::INFO,
+		'warn'  => Logger::WARN,
+		'error' => Logger::ERROR,
+		'fatal' => Logger::FATAL,
+	}.freeze
+	LOG_LEVEL_NAMES = LOG_LEVELS.invert.freeze
+
+
+	### Inclusion hook
+	def self::extended( mod )
+		super
+
+		class << mod
+			# the log formatter that will be used when the logging subsystem is reset
+			attr_accessor :default_log_formatter
+
+			# the logger that will be used when the logging subsystem is reset
+			attr_accessor :default_logger
+
+			# the logger that's currently in effect
+			attr_accessor :logger
+			alias_method :log, :logger
+			alias_method :log=, :logger=
+		end
+
+		mod.default_logger = mod.logger = Logger.new( $stderr )
+		mod.default_logger.level = case
+			when $DEBUG then Logger::DEBUG
+			when $VERBOSE then Logger::INFO
+			else Logger::WARN end
+		mod.default_log_formatter = Configurability::Logging::Formatter.new( mod.default_logger )
+	end
+
+
+	### Reset the global logger object to the default
+	def reset_logger
+		self.logger = self.default_logger
+		self.logger.level = $DEBUG ? Logger::DEBUG : Logger::WARN
+		self.logger.formatter = self.default_log_formatter
+	end
+
+
+	### Returns +true+ if the global logger has not been set to something other than
+	### the default one.
+	def using_default_logger?
+		return self.logger == self.default_logger
+	end
+
+
+	# A alternate formatter for Logger instances.
+	class Formatter < Logger::Formatter
+
+		# The format to output unless debugging is turned on
+		DEFAULT_FORMAT = "[%1$s.%2$06d %3$d/%4$s] %5$5s -- %7$s\n"
+
+		# The format to output if debugging is turned on
+		DEFAULT_DEBUG_FORMAT = "[%1$s.%2$06d %3$d/%4$s] %5$5s {%6$s} -- %7$s\n"
+
+
+		### Initialize the formatter with a reference to the logger so it can check for log level.
+		def initialize( logger, format=DEFAULT_FORMAT, debug=DEFAULT_DEBUG_FORMAT ) # :notnew:
+			@logger       = logger
+			@format       = format
+			@debug_format = debug
+
+			super()
+		end
+
+		######
+		public
+		######
+
+		# The Logger object associated with the formatter
+		attr_accessor :logger
+
+		# The logging format string
+		attr_accessor :format
+
+		# The logging format string that's used when outputting in debug mode
+		attr_accessor :debug_format
+
+
+		### Log using either the DEBUG_FORMAT if the associated logger is at ::DEBUG level or
+		### using FORMAT if it's anything less verbose.
+		def call( severity, time, progname, msg )
+			args = [
+				time.strftime( '%Y-%m-%d %H:%M:%S' ),                         # %1$s
+				time.usec,                                                    # %2$d
+				Process.pid,                                                  # %3$d
+				Thread.current == Thread.main ? 'main' : Thread.object_id,    # %4$s
+				severity,                                                     # %5$s
+				progname,                                                     # %6$s
+				msg                                                           # %7$s
+			]
+
+			if @logger.level == Logger::DEBUG
+				return self.debug_format % args
+			else
+				return self.format % args
+			end
+		end
+	end # class Formatter
+
+
+	# A ANSI-colorized formatter for Logger instances.
+	class ColorFormatter < Logger::Formatter
+
+		# Set some ANSI escape code constants (Shamelessly stolen from Perl's
+		# Term::ANSIColor by Russ Allbery <rra@stanford.edu> and Zenin <zenin@best.com>
+		ANSI_ATTRIBUTES = {
+			'clear'      => 0,
+			'reset'      => 0,
+			'bold'       => 1,
+			'dark'       => 2,
+			'underline'  => 4,
+			'underscore' => 4,
+			'blink'      => 5,
+			'reverse'    => 7,
+			'concealed'  => 8,
+
+			'black'      => 30,   'on_black'   => 40,
+			'red'        => 31,   'on_red'     => 41,
+			'green'      => 32,   'on_green'   => 42,
+			'yellow'     => 33,   'on_yellow'  => 43,
+			'blue'       => 34,   'on_blue'    => 44,
+			'magenta'    => 35,   'on_magenta' => 45,
+			'cyan'       => 36,   'on_cyan'    => 46,
+			'white'      => 37,   'on_white'   => 47
+		}
+
+
+		### Create a string that contains the ANSI codes specified and return it
+		def self::ansi_code( *attributes )
+			attributes.flatten!
+			attributes.collect! {|at| at.to_s }
+			return '' unless /(?:vt10[03]|xterm(?:-color)?|linux|screen)/i =~ ENV['TERM']
+			attributes = ANSI_ATTRIBUTES.values_at( *attributes ).compact.join(';')
+
+			if attributes.empty?
+				return ''
+			else
+				return "\e[%sm" % attributes
+			end
+		end
+
+
+		### Colorize the given +string+ with the specified +attributes+ and
+		### return it, handling line-endings, color reset, etc.
+		def self::colorize( *args )
+			string = ''
+
+			if block_given?
+				string = yield
+			else
+				string = args.shift
+			end
+
+			ending = string[/(\s)$/] || ''
+			string = string.rstrip
+
+			return self.ansi_code( args.flatten ) + string + self.ansi_code( 'reset' ) + ending
+		end
+
+
+		# Color settings
+		LEVEL_FORMATS = {
+			:debug => colorize( :bold, :black ) {"[%1$s.%2$06d %3$d/%4$s] %5$5s {%6$s} -- %7$s\n"},
+			:info  => colorize( :normal ) {"[%1$s.%2$06d %3$d/%4$s] %5$5s -- %7$s\n"},
+			:warn  => colorize( :bold, :yellow ) {"[%1$s.%2$06d %3$d/%4$s] %5$5s -- %7$s\n"},
+			:error => colorize( :red ) {"[%1$s.%2$06d %3$d/%4$s] %5$5s -- %7$s\n"},
+			:fatal => colorize( :bold, :red, :on_white ) {"[%1$s.%2$06d %3$d/%4$s] %5$5s -- %7$s\n"},
+		}
+
+
+		### Initialize the formatter with a reference to the logger so it can check for log level.
+		def initialize( logger, settings={} ) # :notnew:
+			settings = LEVEL_FORMATS.merge( settings )
+
+			@logger   = logger
+			@settings = settings
+
+			super()
+		end
+
+		######
+		public
+		######
+
+		# The Logger object associated with the formatter
+		attr_accessor :logger
+
+		# The formats, by level
+		attr_accessor :settings
+
+
+		### Log using the format associated with the severity
+		def call( severity, time, progname, msg )
+			args = [
+				time.strftime( '%Y-%m-%d %H:%M:%S' ),                         # %1$s
+				time.usec,                                                    # %2$d
+				Process.pid,                                                  # %3$d
+				Thread.current == Thread.main ? 'main' : Thread.object_id,    # %4$s
+				severity,                                                     # %5$s
+				progname,                                                     # %6$s
+				msg                                                           # %7$s
+			]
+
+			return self.settings[ severity.downcase.to_sym ] % args
+		end
+
+	end # class Formatter
+
+
+	# An alternate formatter for Logger instances that outputs +div+ HTML
+	# fragments.
+	class HtmlFormatter < Logger::Formatter
+
+		# The default HTML fragment that'll be used as the template for each log message.
+		HTML_LOG_FORMAT = %q{
+		<div class="log-message %5$s">
+			<span class="log-time">%1$s.%2$06d</span>
+			[
+				<span class="log-pid">%3$d</span>
+				/
+				<span class="log-tid">%4$s</span>
+			]
+			<span class="log-level">%5$s</span>
+			:
+			<span class="log-name">%6$s</span>
+			<span class="log-message-text">%7$s</span>
+		</div>
+		}
+
+		### Override the logging formats with ones that generate HTML fragments
+		def initialize( logger, format=HTML_LOG_FORMAT ) # :notnew:
+			@logger = logger
+			@format = format
+			super()
+		end
+
+
+		######
+		public
+		######
+
+		# The HTML fragment that will be used as a format() string for the log
+		attr_accessor :format
+
+
+		### Return a log message composed out of the arguments formatted using the
+		### formatter's format string
+		def call( severity, time, progname, msg )
+			args = [
+				time.strftime( '%Y-%m-%d %H:%M:%S' ),                         # %1$s
+				time.usec,                                                    # %2$d
+				Process.pid,                                                  # %3$d
+				Thread.current == Thread.main ? 'main' : Thread.object_id,    # %4$s
+				severity.downcase,                                                     # %5$s
+				progname,                                                     # %6$s
+				escape_html( msg ).gsub(/\n/, '<br />')                       # %7$s
+			]
+
+			return self.format % args
+		end
+
+
+		#######
+		private
+		#######
+
+		### Escape any HTML special characters in +string+.
+		def escape_html( string )
+			return string.
+				gsub( '&', '&amp;' ).
+				gsub( '<', '&lt;'  ).
+				gsub( '>', '&gt;'  )
+		end
+
+	end # class HtmlFormatter
+
+
+end # module Configurability
+

data/spec/configurability/config_spec.rb

@@ -10,7 +10,6 @@ BEGIN {
 	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
 }
 
-require 'tempfile'
 require 'logger'
 require 'fileutils'
 require 'rspec'
@@ -48,6 +47,11 @@ describe Configurability::Config do
 		setup_logging( :fatal )
 	end
 
+	after( :each ) do
+		Configurability.configurable_objects.clear
+		Configurability.reset
+	end
+
 	after( :all ) do
 		reset_logging()
 	end
@@ -135,7 +139,7 @@ describe Configurability::Config do
 
 	context "created with in-memory YAML source" do
 
-		before(:each) do
+		before( :each ) do
 			@config = Configurability::Config.new( TEST_CONFIG )
 		end
 
@@ -206,7 +210,7 @@ describe Configurability::Config do
 
 	# saving if changed since loaded
 	context " whose internal values have been changed since loaded" do
-		before(:each) do
+		before( :each ) do
 			@config = Configurability::Config.new( TEST_CONFIG )
 			@config.section.subsection.anothersection = 11451
 		end
@@ -226,42 +230,50 @@ describe Configurability::Config do
 
 	# loading from a file
 	context " loaded from a file" do
-		before(:all) do
-			@tmpfile = Tempfile.new( 'test.conf', '.' )
-			@tmpfile.print( TEST_CONFIG )
-			@tmpfile.close
+		before( :all ) do
+			filename = Dir::Tmpname.make_tmpname( './test', '.conf' )
+			@tmpfile = Pathname( filename )
+			@tmpfile.open( 'w', 0644 ) {|io| io.print(TEST_CONFIG) }
 		end
 
-		after(:all) do
-			@tmpfile.delete
+		after( :all ) do
+			@tmpfile.unlink
 		end
 
-
-		before(:each) do
-			@config = Configurability::Config.load( @tmpfile.path )
+		before( :each ) do
+			@config = Configurability::Config.load( @tmpfile.to_s )
 		end
 
 
 		### Specifications
 		it "remembers which file it was loaded from" do
-			@config.path.should == Pathname( @tmpfile.path ).expand_path
+			@config.path.should == @tmpfile.expand_path
 		end
 
 		it "writes itself back to the same file by default" do
 			@config.port = 114411
 			@config.write
-			otherconfig = Configurability::Config.load( @tmpfile.path )
+			otherconfig = Configurability::Config.load( @tmpfile.to_s )
 
 			otherconfig.port.should == 114411
 		end
 
+		it "can be written to a different file" do
+			path = Dir::Tmpname.make_tmpname( './another-', '.config' )
+
+			@config.write( path )
+			File.read( path ).should =~ /section:\n  subsection/
+
+			File.unlink( path )
+		end
+
 		it "includes the name of the file in its inspect output" do
-			@config.inspect.should include( File.basename(@tmpfile.path) )
+			@config.inspect.should include( File.basename(@tmpfile.to_s) )
 		end
 
 		it "yields itself if a block is given at load-time" do
 			yielded_self = nil
-			config = Configurability::Config.load( @tmpfile.path ) do
+			config = Configurability::Config.load( @tmpfile.to_s ) do
 				yielded_self = self
 			end
 			yielded_self.should equal( config )
@@ -270,7 +282,7 @@ describe Configurability::Config do
 		it "passes itself as the block argument if a block of arity 1 is given at load-time" do
 			arg_self = nil
 			yielded_self = nil
-			config = Configurability::Config.load( @tmpfile.path ) do |arg|
+			config = Configurability::Config.load( @tmpfile.to_s ) do |arg|
 				yielded_self = self
 				arg_self = arg
 			end
@@ -288,23 +300,23 @@ describe Configurability::Config do
 
 	# reload if file changes
 	context " whose file changes after loading" do
-		before(:all) do
-			@tmpfile = Tempfile.new( 'test.conf', '.' )
-			@tmpfile.print( TEST_CONFIG )
-			@tmpfile.close
+		before( :all ) do
+			filename = Dir::Tmpname.make_tmpname( './test', '.conf' )
+			@tmpfile = Pathname( filename )
+			@tmpfile.open( 'w', 0644 ) {|io| io.print(TEST_CONFIG) }
 		end
 
-		after(:all) do
-			@tmpfile.delete
+		after( :all ) do
+			@tmpfile.unlink
 		end
 
 
-		before(:each) do
+		before( :each ) do
 			old_date = Time.now - 3600
-			File.utime( old_date, old_date, @tmpfile.path )
-			@config = Configurability::Config.load( @tmpfile.path )
+			File.utime( old_date, old_date, @tmpfile.to_s )
+			@config = Configurability::Config.load( @tmpfile.to_s )
 			now = Time.now + 10
-			File.utime( now, now, @tmpfile.path )
+			File.utime( now, now, @tmpfile.to_s )
 		end
 
 
@@ -324,7 +336,7 @@ describe Configurability::Config do
 		end
 
 		it "reapplies its defaults when reloading" do
-			config = Configurability::Config.load( @tmpfile.path, :defaultskey => 8 )
+			config = Configurability::Config.load( @tmpfile.to_s, :defaultskey => 8 )
 			config.reload
 			config.defaultskey.should == 8
 		end
@@ -333,7 +345,7 @@ describe Configurability::Config do
 
 	# merging
 	context " created by merging two other configs" do
-		before(:each) do
+		before( :each ) do
 			@config1 = Configurability::Config.new
 			@config2 = Configurability::Config.new( TEST_CONFIG )
 			@merged = @config1.merge( @config2 )

data/spec/configurability/deferredconfig_spec.rb

@@ -36,7 +36,7 @@ describe Configurability::DeferredConfig do
 	end
 
 	it "calls Configurability.install_config with itself when a 'configure' method is defined" do
-		config = double( "config object", :testing => :testing_config )
+		config = { :testing => :testing_config }
 		Configurability.configure_objects( config )
 
 		a_class = Class.new do

data/spec/configurability_spec.rb

@@ -287,6 +287,79 @@ describe Configurability do
 
 	end
 
+
+	describe "defaults hash" do
+
+		it "can generate a Hash of defaults for all objects with Configurability" do
+			Configurability.gather_defaults.should be_a( Hash )
+		end
+
+		it "fetches defaults from a CONFIG_DEFAULTS constant if the object defines one" do
+			klass = Class.new do
+				extend Configurability
+				config_key :testconfig
+				self::CONFIG_DEFAULTS = { :one => 1, :types => {:one => true} }
+				Configurability.log.debug "Defaults: %p" % [ self.defaults ]
+			end
+
+			Configurability.gather_defaults.should include( :testconfig )
+			Configurability.gather_defaults[:testconfig].should == klass.const_get( :CONFIG_DEFAULTS )
+			Configurability.gather_defaults[:testconfig].should_not be( klass.const_get(:CONFIG_DEFAULTS) )
+		end
+
+		it "fetches defaults from a DEFAULT_CONFIG constant if the object defines one" do
+			klass = Class.new do
+				extend Configurability
+				config_key :testconfig
+				self::DEFAULT_CONFIG = { :two => 2, :types => {:two => true} }
+			end
+
+			Configurability.gather_defaults.should include( :testconfig )
+			Configurability.gather_defaults[:testconfig].should == klass.const_get( :DEFAULT_CONFIG )
+			Configurability.gather_defaults[:testconfig].should_not be( klass.const_get(:DEFAULT_CONFIG) )
+		end
+
+		it "fetches defaults from a #defaults method if the object implements one" do
+			klass = Class.new do
+				extend Configurability
+				config_key :otherconfig
+				def self::defaults; { :other => true }; end
+			end
+
+			Configurability.gather_defaults.should include( :otherconfig )
+			Configurability.gather_defaults[:otherconfig].should == klass.defaults
+			Configurability.gather_defaults[:otherconfig].should_not be( klass.defaults )
+		end
+
+		it "can return a Configurability::Config object with defaults, too" do
+			klass1 = Class.new do
+				extend Configurability
+				config_key :testconfig
+				self::CONFIG_DEFAULTS = { :one => 1, :types => {:one => true} }
+			end
+			klass2 = Class.new do
+				extend Configurability
+				config_key :testconfig
+				self::DEFAULT_CONFIG = { :two => 2, :types => {:two => true} }
+			end
+			klass3 = Class.new do
+				extend Configurability
+				config_key :otherconfig
+				def self::defaults; { :other => true }; end
+			end
+
+			config = Configurability.default_config
+
+			config.should be_a( Configurability::Config )
+			config.testconfig.one.should == 1
+			config.testconfig.two.should == 2
+			config.testconfig.types.one.should be_true()
+			config.testconfig.types.two.should be_true()
+			config.otherconfig.other.should be_true()
+		end
+
+	end
+
 end
 
 # vim: set nosta noet ts=4 sw=4:

data/spec/lib/helpers.rb

@@ -142,6 +142,10 @@ end
 RSpec.configure do |config|
 	config.mock_with( :rspec )
 	config.include( Configurability::SpecHelpers )
+	config.treat_symbols_as_metadata_keys_with_true_values = true
+
+	config.filter_run_excluding :only_ruby_19 if RUBY_VERSION < '1.9.2'
+
 end
 
 # vim: set nosta noet ts=4 sw=4:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configurability
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -36,22 +36,27 @@ cert_chain:
   YUhDS0xaZFNLai9SSHVUT3QrZ2JsUmV4OEZBaDhOZUEKY21saFhlNDZwWk5K
   Z1dLYnhaYWg4NWpJang5NWhSOHZPSStOQU01aUg5a09xSzEzRHJ4YWNUS1Bo
   cWo1UGp3RgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
-date: 2012-03-13 00:00:00.000000000 Z
+date: 2012-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hoe-mercurial
-  requirement: &70327439150940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.4.0
   type: :development
   prerelease: false
-  version_requirements: *70327439150940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: hoe-highline
-  requirement: &70327439150420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -59,10 +64,31 @@ dependencies:
         version: 0.0.1
   type: :development
   prerelease: false
-  version_requirements: *70327439150420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70327439149940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -70,10 +96,15 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *70327439149940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70327439149500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -81,44 +112,45 @@ dependencies:
         version: '0.3'
   type: :development
   prerelease: false
-  version_requirements: *70327439149500
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: &70327439149040 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.10'
-  type: :development
-  prerelease: false
-  version_requirements: *70327439149040
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &70327439148620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *70327439148620
-description: ! 'Configurability is a mixin that allows you to add configurability
-  to one or
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ! 'Configurability is a unified, unintrusive, assume-nothing configuration
+  system
+
+  for Ruby. It lets you keep the configuration for multiple objects in a single
 
-  more objects or classes. You can assign them each a subsection of the
+  config file, load the file when it''s convenient for you, and distribute the
 
-  configuration, and then later, when the configuration is loaded, the
+  configuration when you''re ready, sending it everywhere it needs to go with a
 
-  configuration is split up and sent to the objects that will use it.'
+  single action.'
 email:
 - ged@FaerieMUD.org
 executables: []
 extensions: []
 extra_rdoc_files:
-- Manifest.txt
 - History.rdoc
+- Manifest.txt
 - README.rdoc
 files:
 - ChangeLog
@@ -133,19 +165,21 @@ files:
 - lib/configurability/behavior.rb
 - lib/configurability/config.rb
 - lib/configurability/deferredconfig.rb
-- lib/configurability/logformatter.rb
+- lib/configurability/logging.rb
 - spec/configurability/config_spec.rb
 - spec/configurability/deferredconfig_spec.rb
 - spec/configurability_spec.rb
 - spec/lib/helpers.rb
 - .gemtest
-homepage: http://bitbucket.org/ged/configurability
+homepage: https://bitbucket.org/ged/configurability
 licenses:
 - BSD
 post_install_message: 
 rdoc_options:
-- --main
-- README.rdoc
+- -f
+- fivefish
+- -t
+- Configurability Toolkit
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -162,9 +196,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: configurability
-rubygems_version: 1.8.16
+rubygems_version: 1.8.21
 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 unified, unintrusive, assume-nothing configuration system
+  for Ruby
 test_files: []

data/lib/configurability/logformatter.rb

@@ -1,60 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'logger'
-
-require 'configurability'
-
-# A custom log-formatter class for 
-class Configurability::LogFormatter < Logger::Formatter
-
-	# The format to output unless debugging is turned on
-	DEFAULT_FORMAT = "[%1$s.%2$06d %3$d/%4$s] %5$5s -- %7$s\n"
-
-	# The format to output if debugging is turned on
-	DEFAULT_DEBUG_FORMAT = "[%1$s.%2$06d %3$d/%4$s] %5$5s {%6$s} -- %7$s\n"
-
-
-	### Initialize the formatter with a reference to the logger so it can check for log level.
-	def initialize( logger, format=DEFAULT_FORMAT, debug=DEFAULT_DEBUG_FORMAT ) # :notnew:
-		@logger       = logger
-		@format       = format
-		@debug_format = debug
-
-		super()
-	end
-
-	######
-	public
-	######
-
-	# The Logger object associated with the formatter
-	attr_accessor :logger
-
-	# The logging format string
-	attr_accessor :format
-
-	# The logging format string that's used when outputting in debug mode
-	attr_accessor :debug_format
-
-
-	### Log using either the DEBUG_FORMAT if the associated logger is at ::DEBUG level or
-	### using FORMAT if it's anything less verbose.
-	def call( severity, time, progname, msg )
-		args = [
-			time.strftime( '%Y-%m-%d %H:%M:%S' ),                         # %1$s
-			time.usec,                                                    # %2$d
-			Process.pid,                                                  # %3$d
-			Thread.current == Thread.main ? 'main' : Thread.object_id,    # %4$s
-			severity,                                                     # %5$s
-			progname,                                                     # %6$s
-			msg                                                           # %7$s
-		]
-
-		if @logger.level == Logger::DEBUG
-			return self.debug_format % args
-		else
-			return self.format % args
-		end
-	end
-
-end # class Configurability::LogFormatter