configurability 1.0.2 → 1.0.3

data/ChangeLog

@@ -1,9 +1,42 @@
-17[tip]   e2bf2e43bccf   2010-10-25 10:53 -0700   ged
+28[tip]   a2ae16f86c98   2010-11-29 15:43 -0800   ged
+  Added tag v1.0.3 for changeset 910ae8ac082f
+
+27[v1.0.3]   910ae8ac082f   2010-11-29 15:43 -0800   ged
+  Added signature for changeset 49e98e6334dd
+
+26[github/master,master]:25,24   49e98e6334dd   2010-11-29 15:32 -0800   ged
+  Merged with 24:7aec5228c2b0
+
+25:22   ec3f030074dc   2010-11-29 15:31 -0800   ged
+  Propagate the installed config to objects that add Configurability after the config is loaded.
+
+24   7aec5228c2b0   2010-10-29 18:00 -0700   ged
+  Added tag 1.0.2 for changeset ba2c849fde0d
+
+23[1.0.2]:21   ba2c849fde0d   2010-10-29 18:00 -0700   ged
+  Added signature for changeset 8718e7f4ea1f
+
+22   58cbefcef526   2010-11-29 15:29 -0800   ged
+  Updated build system
+
+21   8718e7f4ea1f   2010-10-29 17:32 -0700   ged
+  Fixes for specs under 1.9.2.
+
+20:17,19   17a6999c08b9   2010-10-29 17:29 -0700   ged
+  Merged with 17:e2bf2e43bccf
+
+19   e2bf2e43bccf   2010-10-25 10:53 -0700   ged
   Fixed require for RSpec 2 in the shared behavior.
 
-16   5d18e28e387b   2010-10-25 10:48 -0700   ged
+18:15   5d18e28e387b   2010-10-25 10:48 -0700   ged
   Converted tests to RSpec 2.
 
+17   4bff6d5f7b6e   2010-08-08 10:26 -0700   ged
+  Added tag 1.0.1 for changeset e3605ccbe057
+
+16[1.0.1]   e3605ccbe057   2010-08-08 10:26 -0700   ged
+  Added signature for changeset 41bc1de0bf36
+
 15   41bc1de0bf36   2010-08-04 18:51 -0700   ged
   More Configurability::Config work
 

data/Rakefile

@@ -42,6 +42,7 @@ rescue LoadError
 	end
 end
 
+require 'pathname'
 require 'rbconfig'
 require 'rake'
 require 'rake/testtask'
@@ -189,7 +190,6 @@ RDOC_OPTIONS = [
   ]
 YARD_OPTIONS = [
 	'--use-cache',
-	'--no-private',
 	'--protected',
 	'-r', README_FILE,
 	'--exclude', 'extconf\\.rb',
@@ -217,16 +217,15 @@ DEPENDENCIES = {
 
 # Developer Gem dependencies: gemname => version
 DEVELOPMENT_DEPENDENCIES = {
-	'rake'         => '>= 0.8.7',
-	'rcodetools'   => '>= 0.7.0.0',
-	'rcov'         => '>= 0.8.1.2.0',
-	'rdoc'         => '>= 2.4.3',
-	'RedCloth'     => '>= 4.0.3',
-	'rspec'        => '>= 1.2.6',
-	'ruby-termios' => '>= 0.9.6',
-	'text-format'  => '>= 1.0.0',
-	'tmail'        => '>= 1.2.3.1',
-	'diff-lcs'     => '>= 1.1.2',
+	'rake'          => '~> 0.8.7',
+	'rcodetools'    => '~> 0.7.0.0',
+	'rcov'          => '~> 0.8.1.2.0',
+	'yard'          => '~> 0.6.1',
+	'RedCloth'      => '~> 4.2.3',
+	'rspec'         => '~> 2.0.1',
+	'ruby-termios'  => '~> 0.9.6',
+	'text-format'   => '~> 1.0.0',
+	'tmail'         => '~> 1.2.3.1',
 }
 
 # Non-gem requirements: packagename => version
@@ -247,9 +246,10 @@ GEMSPEC   = Gem::Specification.new do |gem|
 		"section it requested.",
   	  ].join( "\n" )
 
-	gem.authors           = "Michael Granger"
+	gem.authors           = ["Michael Granger"]
 	gem.email             = ["ged@FaerieMUD.org"]
 	gem.homepage          = 'http://bitbucket.org/ged/configurability'
+	gem.licenses          = ["BSD"]
 
 	gem.has_rdoc          = true
 	gem.rdoc_options      = RDOC_OPTIONS
@@ -272,6 +272,8 @@ GEMSPEC   = Gem::Specification.new do |gem|
 	gem.cert_chain        = [File.expand_path('~/.gem/ged-public_gem_cert.pem')]
 
 
+	gem.required_ruby_version = '>= 1.8.7'
+
 	DEPENDENCIES.each do |name, version|
 		version = '>= 0' if version.length.zero?
 		gem.add_runtime_dependency( name, version )

data/lib/configurability.rb

@@ -9,17 +9,21 @@ require 'yaml'
 module Configurability
 
 	# Library version constant
-	VERSION = '1.0.2'
+	VERSION = '1.0.3'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 17a6999c08b9 $
+	REVISION = %q$Revision: ec3f030074dc $
 
-	require 'configurability/logformatter.rb'
+	require 'configurability/logformatter'
+	require 'configurability/deferredconfig'
 
 
 	### The objects that have had Configurability added to them
 	@configurable_objects = []
 
+	### The loaded config (if there is one)
+	@loaded_config = nil
+
 	### Logging
 	@default_logger = Logger.new( $stderr )
 	@default_logger.level = $DEBUG ? Logger::DEBUG : Logger::WARN
@@ -36,6 +40,10 @@ module Configurability
 		# added to them
 		attr_accessor :configurable_objects
 
+		# @return [Object] 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
 		attr_accessor :default_log_formatter
@@ -55,6 +63,13 @@ module Configurability
 		self.log.debug "Adding Configurability to %p" % [ object ]
 		super
 		self.configurable_objects << object
+
+		# If the config has already been propagated, add deferred configuration to the extending
+		# object in case it overrides #configure later.
+		if (( config = self.loaded_config ))
+			self.install_config( config, object )
+			object.extend( Configurability::DeferredConfig )
+		end
 	end
 
 
@@ -69,7 +84,9 @@ module Configurability
 	### object itself doesn't have a name, the name of its class will be used instead.
 	def self::make_key_from_object( object )
 		if object.respond_to?( :name )
-			return object.name.sub( /.*::/, '' ).gsub( /\W+/, '_' ).downcase.to_sym
+			name = object.name
+			name = 'anonymous' if name.nil? || name.empty?
+			return name.sub( /.*::/, '' ).gsub( /\W+/, '_' ).downcase.to_sym
 		elsif object.class.name && !object.class.name.empty?
 			return object.class.name.sub( /.*::/, '' ).gsub( /\W+/, '_' ).downcase.to_sym
 		else
@@ -87,26 +104,20 @@ module Configurability
 		self.log.debug "Splitting up config %p between %d objects with configurability." %
 			[ config, self.configurable_objects.length ]
 
+		self.loaded_config = config
+
 		self.configurable_objects.each do |obj|
-			section = obj.config_key.to_sym
-			self.log.debug "Configuring %p with the %p section of the config." %
-				[ obj, section ]
-
-			if config.respond_to?( section )
-				self.log.debug "  config has a %p method; using that" % [ section ]
-				obj.configure( config.send(section) )
-			elsif config.respond_to?( :[] )
-				self.log.debug "  config has a an index operator method; using that"
-				obj.configure( config[section] || config[section.to_s] )
-			else
-				self.log.warn "  don't know how to get the %p section of the config from %p" %
-					[ section, config ]
-				obj.configure( nil )
-			end
+			self.install_config( config, obj )
 		end
 	end
 
 
+	### If a configuration has been loaded (via {#configure_objects}), clear it.
+	def self::reset
+		self.loaded_config = nil
+	end
+
+
 	### Reset the global logger object to the default
 	### @return [void]
 	def self::reset_logger
@@ -116,6 +127,25 @@ module Configurability
 	end
 
 
+	### Install the appropriate section of the +config+ into the given +object+.
+	def self::install_config( config, object )
+		section = object.config_key.to_sym
+		self.log.debug "Configuring %p with the %p section of the config." %
+			[ object, section ]
+
+		if config.respond_to?( section )
+			self.log.debug "  config has a %p method; using that" % [ section ]
+			object.configure( config.send(section) )
+		elsif config.respond_to?( :[] )
+			self.log.debug "  config has a an index operator method; using that"
+			object.configure( config[section] || config[section.to_s] )
+		else
+			self.log.warn "  don't know how to get the %p section of the config from %p" %
+				[ section, config ]
+			object.configure( nil )
+		end
+	end
+
 
 	#############################################################
 	### A P P E N D E D	  M E T H O D S

data/lib/configurability/deferredconfig.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby -wKU
+
+require 'configurability'
+
+
+### 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.
+	def self::extended( mod )
+		Configurability.log.debug "Adding deferred configuration hook to %p" % [ mod ]
+		super
+	end
+
+
+	### Singleton method definition hook: configure the instance as soon as it
+	### overrides the #configure method supplied by the Configurability mixin itself.
+	def singleton_method_added( sym )
+		super
+
+		if sym == :configure
+			config = Configurability.loaded_config
+			Configurability.log.debug "Propagating config to %p" % [ self ]
+			Configurability.install_config( config, self )
+		end
+	end
+
+end # module Configurability::DeferredConfig

data/rake/hg.rb

@@ -151,9 +151,10 @@ unless defined?( HG_DOTDIR )
 		task :prep_release do
 			tags = get_tags()
 			rev = get_current_rev()
+			pkg_version_tag = "v#{PKG_VERSION}"
 
 			# Look for a tag for the current release version, and if it exists abort
-			if tags.include?( PKG_VERSION )
+			if tags.include?( pkg_version_tag )
 				error "Version #{PKG_VERSION} already has a tag. Did you mean " +
 					"to increment the version in #{VERSION_FILE}?"
 				fail
@@ -164,8 +165,8 @@ unless defined?( HG_DOTDIR )
 			run 'hg', 'sign'
 
 			# Tag the current rev
-			log "Tagging rev #{rev} as #{PKG_VERSION}"
-			run 'hg', 'tag', PKG_VERSION
+			log "Tagging rev #{rev} as #{pkg_version_tag}"
+			run 'hg', 'tag', pkg_version_tag
 
 			# Offer to push
 			Rake::Task['hg:push'].invoke
@@ -229,6 +230,18 @@ unless defined?( HG_DOTDIR )
 		end
 
 
+		desc "Update to tip"
+		task :update do
+			run 'hg', 'update'
+		end
+
+
+		desc "Clobber all changes (hg up -C)"
+		task :update_and_clobber do
+			run 'hg', 'update', '-C'
+		end
+
+
 		desc "Check the current code in if tests pass"
 		task :checkin => ['hg:pull', 'hg:newfiles', 'test', COMMIT_MSG_FILE] do
 			targets = get_target_args()

data/rake/packaging.rb

@@ -12,7 +12,7 @@ include Config
 ### Task: prerelease
 desc "Append the package build number to package versions"
 task :prerelease do
-	GEMSPEC.version.version << ".pre.#{PKG_BUILD}"
+	GEMSPEC.version.version << "pre#{PKG_BUILD}"
 	Rake::Task[:gem].clear
 
 	Gem::PackageTask.new( GEMSPEC ) do |pkg|

data/rake/testing.rb

@@ -47,6 +47,7 @@ begin
 	### Task: spec
 	desc "Run specs"
 	task :spec => 'spec:doc'
+	task :specs => :spec
 
 	namespace :spec do
 		desc "Run rspec every time there's a change to one of the files"

data/spec/configurability/deferredconfig_spec.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent
+
+	libdir = basedir + "lib"
+
+	$LOAD_PATH.unshift( basedir ) unless $LOAD_PATH.include?( basedir )
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+}
+
+require 'tempfile'
+require 'logger'
+require 'fileutils'
+require 'rspec'
+
+require 'spec/lib/helpers'
+
+require 'configurability'
+require 'configurability/deferredconfig'
+
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+describe Configurability::DeferredConfig do
+
+	before( :all ) do
+		setup_logging( :fatal )
+	end
+
+	after( :each ) do
+		Configurability.configurable_objects.clear
+		Configurability.reset
+	end
+
+	it "calls Configurability.install_config with itself when a 'configure' method is defined" do
+		config = double( "config object", :testing => :testing_config )
+		Configurability.configure_objects( config )
+
+		a_class = Class.new do
+			extend Configurability::DeferredConfig
+			class << self; attr_accessor :config_object; end
+			def self::config_key; "testing"; end
+			def self::configure( config )
+				self.config_object = config
+			end
+		end
+
+		a_class.config_object.should == :testing_config
+	end
+
+end
+
+# vim: set nosta noet ts=4 sw=4:

data/spec/configurability_spec.rb

@@ -15,6 +15,7 @@ require 'rspec'
 require 'spec/lib/helpers'
 
 require 'configurability'
+require 'configurability/config'
 
 
 #####################################################################
@@ -30,6 +31,7 @@ describe Configurability do
 
 	after( :each ) do
 		Configurability.configurable_objects.clear
+		Configurability.reset
 	end
 
 
@@ -49,7 +51,7 @@ describe Configurability do
 			config_key :testconfig
 		end
 
-		config = stub( "configuration object" )
+		config = mock( "configuration object" )
 		config.should_receive( :respond_to? ).with( :testconfig ).and_return( true )
 		config.should_receive( :testconfig ).and_return( :a_config_section )
 
@@ -63,7 +65,7 @@ describe Configurability do
 			config_key :testconfig
 		end
 
-		config = stub( "configuration object" )
+		config = mock( "configuration object" )
 		config.should_receive( :respond_to? ).with( :testconfig ).and_return( true )
 		config.should_receive( :testconfig ).and_return( :a_config_section )
 
@@ -78,7 +80,7 @@ describe Configurability do
 			config_key :testconfig
 		end
 
-		config = stub( "configuration object" )
+		config = mock( "configuration object" )
 		config.should_receive( :respond_to? ).with( :testconfig ).and_return( false )
 		config.should_receive( :respond_to? ).with( :[] ).and_return( true )
 		config.should_receive( :[] ).with( :testconfig ).and_return( :a_config_section )
@@ -94,7 +96,7 @@ describe Configurability do
 			config_key :testconfig
 		end
 
-		config = stub( "configuration object" )
+		config = mock( "configuration object" )
 		config.should_receive( :respond_to? ).with( :testconfig ).and_return( false )
 		config.should_receive( :respond_to? ).with( :[] ).and_return( false )
 
@@ -109,7 +111,7 @@ describe Configurability do
 			config_key :testconfig
 		end
 
-		config = stub( "configuration object" )
+		config = mock( "configuration object" )
 		config.should_receive( :respond_to? ).with( :testconfig ).and_return( false )
 		config.should_receive( :respond_to? ).with( :[] ).and_return( true )
 		config.should_receive( :[] ).with( :testconfig ).and_return( nil )
@@ -125,7 +127,7 @@ describe Configurability do
 		object.extend( Configurability )
 		object.config_key = :testobjconfig
 
-		config = stub( "configuration object" )
+		config = mock( "configuration object" )
 		config.should_receive( :respond_to? ).with( :testobjconfig ).and_return( true )
 		config.should_receive( :testobjconfig ).and_return( :a_config_section )
 
@@ -140,7 +142,7 @@ describe Configurability do
 		def object.name; "testobjconfig"; end
 		object.extend( Configurability )
 
-		config = stub( "configuration object" )
+		config = mock( "configuration object" )
 		config.should_receive( :respond_to? ).with( :testobjconfig ).and_return( true )
 		config.should_receive( :testobjconfig ).and_return( :a_config_section )
 
@@ -154,7 +156,7 @@ describe Configurability do
 		def object.name; "Test Obj-Config"; end
 		object.extend( Configurability )
 
-		config = stub( "configuration object" )
+		config = mock( "configuration object" )
 		config.should_receive( :respond_to? ).with( :test_obj_config ).and_return( true )
 		config.should_receive( :test_obj_config ).and_return( :a_config_section )
 
@@ -168,7 +170,7 @@ describe Configurability do
 		object = Object.new
 		object.extend( Configurability )
 
-		config = stub( "configuration object" )
+		config = mock( "configuration object" )
 		config.should_receive( :respond_to? ).with( :object ).and_return( true )
 		config.should_receive( :object ).and_return( :a_config_section )
 
@@ -184,7 +186,7 @@ describe Configurability do
 			end
 		end
 
-		config = stub( "configuration object" )
+		config = mock( "configuration object" )
 		config.should_receive( :respond_to? ).with( :dbobject ).and_return( true )
 		config.should_receive( :dbobject ).and_return( :a_config_section )
 
@@ -199,7 +201,7 @@ describe Configurability do
 		object = objectclass.new
 		object.extend( Configurability )
 
-		config = stub( "configuration object" )
+		config = mock( "configuration object" )
 		config.should_receive( :respond_to? ).with( :anonymous ).and_return( true )
 		config.should_receive( :anonymous ).and_return( :a_config_section )
 
@@ -208,6 +210,51 @@ describe Configurability do
 		Configurability.configure_objects( config )
 	end
 
+
+	context "after installation of a config object" do
+
+		before( :each ) do
+			@config = Configurability::Config.new
+			@config.postconfig = :yes
+			Configurability.configure_objects( @config )
+		end
+
+		after( :each ) do
+			Configurability.reset
+		end
+
+
+		it "should know what the currently-installed configuration is" do
+			Configurability.loaded_config.should equal( @config )
+		end
+
+		it "propagates the installed configuration to any objects which add Configurability" do
+			objectclass = Class.new do
+				def initialize; @config = nil; end
+				attr_reader :config
+				def name; "postconfig"; end
+				def configure( config ); @config = config; end
+			end
+
+			object = objectclass.new
+			object.extend( Configurability )
+			object.config.should == :yes
+		end
+
+		it "defers configuration until after an object has defined a #configure method if " +
+		   "it adds Configurability before declaring one" do
+			objectclass = Class.new do
+				extend Configurability
+				config_key :postconfig
+				def self::configure( config ); @config = config; end
+				class << self; attr_reader :config; end
+			end
+
+			objectclass.config.should == :yes
+		end
+
+	end
+
 end
 
 # vim: set nosta noet ts=4 sw=4:

data/spec/lib/helpers.rb

@@ -10,6 +10,8 @@ BEGIN {
 	$LOAD_PATH.unshift( libdir.to_s ) unless $LOAD_PATH.include?( libdir.to_s )
 }
 
+require 'rspec'
+
 require 'logger'
 require 'erb'
 require 'yaml'
@@ -133,5 +135,10 @@ module Configurability::SpecHelpers
 end
 
 
+RSpec.configure do |config|
+	config.mock_with( :rspec )
+	config.include( Configurability::SpecHelpers )
+end
+
 # vim: set nosta noet ts=4 sw=4:
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: configurability
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 1
   - 0
-  - 2
-  version: 1.0.2
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Michael Granger
@@ -35,7 +35,7 @@ cert_chain:
   cmlhXe46pZNJgWKbxZah85jIjx95hR8vOI+NAM5iH9kOqK13DrxacTKPhqj5PjwF
   -----END CERTIFICATE-----
 
-date: 2010-10-29 00:00:00 -07:00
+date: 2010-11-29 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -61,10 +61,12 @@ files:
 - README.md
 - LICENSE
 - spec/configurability/config_spec.rb
+- spec/configurability/deferredconfig_spec.rb
 - spec/configurability_spec.rb
 - spec/lib/helpers.rb
 - lib/configurability/behavior.rb
 - lib/configurability/config.rb
+- lib/configurability/deferredconfig.rb
 - lib/configurability/logformatter.rb
 - lib/configurability.rb
 - rake/191_compat.rb
@@ -81,8 +83,8 @@ files:
 - rake/verifytask.rb
 has_rdoc: true
 homepage: http://bitbucket.org/ged/configurability
-licenses: []
-
+licenses: 
+- BSD
 post_install_message: 
 rdoc_options: 
 - --tab-width=4
@@ -98,10 +100,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 57
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
@@ -120,5 +124,6 @@ specification_version: 3
 summary: A configurability mixin for Ruby
 test_files: 
 - spec/configurability/config_spec.rb
+- spec/configurability/deferredconfig_spec.rb
 - spec/configurability_spec.rb
 - spec/lib/helpers.rb