configurability 1.0.8 → 1.0.9

data/ChangeLog

@@ -1,8 +1,61 @@
+2012-01-27  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/configurability.rb:
+	Fixing the version
+	[9319c44c05ce] [tip]
+
+	* .hgsigs, .hgtags, History.rdoc, lib/configurability.rb,
+	spec/configurability/config_spec.rb:
+	Merged with ssh://hg@bitbucket.org/ged/configurability@86718657a466
+	[d3f6f8d77060]
+
+	* .hgtags:
+	Added tag v1.0.8 for changeset 6a7852aa7398
+	[5e85b9cb1122]
+
+	* .hgsigs:
+	Added signature for changeset 2501a302fe07
+	[6a7852aa7398]
+
+	* History.rdoc, lib/configurability.rb:
+	Bumped the version, updated history.
+	[2501a302fe07]
+
+	* .rvm.gems, .rvmrc, experiments/staticcling-weirdness.rb, experiments
+	/staticcling-weirdness2.rb, experiments/staticcling-weirdness3.rb,
+	lib/configurability.rb, lib/configurability/deferredconfig.rb,
+	spec/configurability/config_spec.rb, spec/configurability_spec.rb,
+	spec/lib/helpers.rb:
+	Fixing bugs found while working on StaticCling
+	[0c3c20665455]
+
+	* .tm_properties:
+	Adding TextMate properties
+	[45b92add3e1e]
+
+2011-11-01  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v1.0.8 for changeset 5b3d66af5a59
+	[86718657a466]
+
+	* .hgsigs:
+	Added signature for changeset 97a03db6f41c
+	[5b3d66af5a59] [v1.0.8]
+
+	* History.rdoc, lib/configurability.rb:
+	Bumped patch version and updated the History file.
+	[97a03db6f41c]
+
+	* spec/configurability/config_spec.rb:
+	Fix for Ruby 1.9.3.
+	[a26cd541ea8f]
+
 2011-10-13  Michael Granger  <ged@FaerieMUD.org>
 
 	* .hgtags:
 	Added tag v1.0.7 for changeset 4e605f137155
-	[0f391f680b61] [tip]
+	[0f391f680b61]
 
 	* .hgsigs:
 	Added signature for changeset 605036b92217
@@ -26,7 +79,7 @@
 
 	* Rakefile:
 	Merged with c9b7b76e4792
-	[cae88e472706] [github/master]
+	[cae88e472706]
 
 	* Rakefile:
 	Cleaning up the Rakefile a bit

data/History.rdoc

@@ -1,3 +1,21 @@
+== v1.0.9 [2012-01-27] Michael Granger <ged@FaerieMUD.org>
+
+Fix problems associated with inheritance.
+
+- Added a Hash of configure methods that have already been called
+  as pairs of Methods and Config sections. (Configurability.configured)
+- Use the `configured` hash to avoid re-calling configure with the same
+  config section more than once when a class with Configurability is
+  inherited.
+- Configurability.install_config -- Only use the index operator method
+  of the config object if it actually has the config_key as a key. Else
+  configure with +nil+.
+- Support different whitespace conventions in different YAML libraries
+
+Thanks to Mahlon E. Smith for reporting this bug, and for pairing with
+me to fix it.
+
+
 == v1.0.8 [2011-11-01] Michael Granger <ged@FaerieMUD.org>
 
 - Fix for Ruby 1.9.3-p0.

data/lib/configurability.rb

@@ -11,10 +11,10 @@ require 'yaml'
 module Configurability
 
 	# Library version constant
-	VERSION = '1.0.8'
+	VERSION = '1.0.9'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 97a03db6f41c $
+	REVISION = %q$Revision: 9319c44c05ce $
 
 	require 'configurability/logformatter'
 	require 'configurability/deferredconfig'
@@ -26,6 +26,11 @@ module Configurability
 	### The loaded config (if there is one)
 	@loaded_config = nil
 
+	### The hash of configuration calls that have already taken place -- the keys are
+	### Method objects for the configure methods of the configured objects, and the values
+	### 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
@@ -44,6 +49,9 @@ module Configurability
 		# the loaded configuration (after ::configure_objects has been called at least once)
 		attr_accessor :loaded_config
 
+		# 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
@@ -104,6 +112,7 @@ module Configurability
 		self.log.debug "Splitting up config %p between %d objects with configurability." %
 			[ config, self.configurable_objects.length ]
 
+		self.reset
 		self.loaded_config = config
 
 		self.configurable_objects.each do |obj|
@@ -115,6 +124,7 @@ module Configurability
 	### If a configuration has been loaded (via {#configure_objects}), clear it.
 	def self::reset
 		self.loaded_config = nil
+		self.configured.clear
 	end
 
 
@@ -134,15 +144,33 @@ module Configurability
 
 		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] )
+			section = config.send( section )
+		elsif config.respond_to?( :[] ) && config.respond_to?( :key? )
+			self.log.debug "  config has a hash-ish interface..."
+			if config.key?( section ) || config.key?( section.to_s )
+				self.log.debug "    and has a %p member; using that" % [ section ]
+				section = config[section] || config[section.to_s]
+			else
+				self.log.debug "    but no %p member."
+				section = nil
+			end
 		else
 			self.log.warn "  don't know how to get the %p section of the config from %p" %
 				[ section, config ]
-			object.configure( nil )
+			section = nil
 		end
+
+		# Figure out if the configure method has already been called with this config
+		# section before, and don't re-call it if so
+		configure_method = object.method( :configure )
+
+		if self.configured[ configure_method ] == section
+			self.log.debug "  avoiding re-calling %p" % [ configure_method ]
+			return
+		end
+
+		self.log.debug "  calling %p" % [ configure_method ]
+		configure_method.call( section )
 	end
 
 
@@ -150,10 +178,6 @@ module Configurability
 	### A P P E N D E D	  M E T H O D S
 	#############################################################
 
-	### The symbol which corresponds to the section of the configuration
-	### used to configure the object.
-	attr_writer :config_key
-
 	### Get (and optionally set) the +config_key+ (a Symbol).
 	def config_key( sym=nil )
 		@config_key = sym unless sym.nil?

data/lib/configurability/deferredconfig.rb

@@ -20,6 +20,7 @@ module Configurability::DeferredConfig
 		super
 
 		if sym == :configure
+			Configurability.log.debug "Re-configuring %p via deferred config hook." % [ self ]
 			config = Configurability.loaded_config
 			Configurability.log.debug "Propagating config to %p" % [ self ]
 			Configurability.install_config( config, self )

data/spec/configurability/config_spec.rb

@@ -53,7 +53,7 @@ describe Configurability::Config do
 	end
 
 	it "can dump itself as YAML" do
-		Configurability::Config.new.dump.should =~ /^--- \{\}\n\n?/
+		Configurability::Config.new.dump.strip.should == "--- {}"
 	end
 
 	it "returns nil as its change description" do

data/spec/configurability_spec.rb

@@ -74,7 +74,7 @@ describe Configurability do
 	end
 
 	it "fetches config sections via the index operator if the config doesn't respond " +
-	   "directly to the section name, but does to the index operator" do
+	   "directly to the section name, but does to the index operator and #key?" do
 		klass = Class.new do
 			extend Configurability
 			config_key :testconfig
@@ -82,7 +82,9 @@ describe Configurability do
 
 		config = mock( "configuration object" )
 		config.should_receive( :respond_to? ).with( :testconfig ).and_return( false )
+		config.should_receive( :respond_to? ).with( :key? ).and_return( true )
 		config.should_receive( :respond_to? ).with( :[] ).and_return( true )
+		config.should_receive( :key? ).with( :testconfig ).and_return( true )
 		config.should_receive( :[] ).with( :testconfig ).and_return( :a_config_section )
 
 		klass.should_receive( :configure ).with( :a_config_section )
@@ -113,7 +115,10 @@ describe Configurability do
 
 		config = mock( "configuration object" )
 		config.should_receive( :respond_to? ).with( :testconfig ).and_return( false )
+		config.should_receive( :respond_to? ).with( :key? ).and_return( true )
 		config.should_receive( :respond_to? ).with( :[] ).and_return( true )
+		config.should_receive( :key? ).with( :testconfig ).and_return( false )
+		config.should_receive( :key? ).with( 'testconfig' ).and_return( true )
 		config.should_receive( :[] ).with( :testconfig ).and_return( nil )
 		config.should_receive( :[] ).with( 'testconfig' ).and_return( :a_config_section )
 
@@ -253,6 +258,33 @@ describe Configurability do
 			objectclass.config.should == :yes
 		end
 
+		it "doesn't reconfigure objects that have already been configured unless the config changes" do
+			first_objectclass = Class.new do
+				extend Configurability
+				@configs = []
+				config_key :postconfig
+				def self::configure( config ); @configs << config; end
+				def self::inherited( subclass ); subclass.instance_variable_set(:@configs, []); super; end
+				class << self; attr_reader :configs; end
+			end
+
+			second_objectclass = Class.new( first_objectclass ) do
+				extend Configurability
+				config_key :postconfig
+				def self::configure( config ); @configs << config; end
+			end
+
+			third_objectclass = Class.new( second_objectclass ) do
+				extend Configurability
+				config_key :postconfig
+				def self::configure( config ); @configs << config; end
+			end
+
+			first_objectclass.configs.should == [ @config[:postconfig] ]
+			second_objectclass.configs.should == [ nil, @config[:postconfig] ]
+			third_objectclass.configs.should == [ nil, @config[:postconfig] ]
+		end
+
 	end
 
 end

data/spec/lib/helpers.rb

@@ -19,6 +19,7 @@ require 'yaml'
 
 SimpleCov.start do
 	add_filter '/spec/'
+	add_filter '/textmate-command/'
 end
 require 'configurability'
 
@@ -127,7 +128,6 @@ module Configurability::SpecHelpers
 			Thread.current['logger-output'] = []
 			logdevice = ArrayLogger.new( Thread.current['logger-output'] )
 			Configurability.logger = Logger.new( logdevice )
-			Configurability.logger.level = level
 			Configurability.logger.formatter = HtmlLogFormatter.new( Configurability.logger )
 		else
 			logger = Logger.new( $stderr )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configurability
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -48,11 +48,11 @@ cert_chain:
   -----END CERTIFICATE-----
 
 '
-date: 2011-11-01 00:00:00.000000000 Z
+date: 2012-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hoe-mercurial
-  requirement: &70130268838340 !ruby/object:Gem::Requirement
+  requirement: &70293058889240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -60,10 +60,10 @@ dependencies:
         version: 1.3.1
   type: :development
   prerelease: false
-  version_requirements: *70130268838340
+  version_requirements: *70293058889240
 - !ruby/object:Gem::Dependency
   name: hoe-highline
-  requirement: &70130268837300 !ruby/object:Gem::Requirement
+  requirement: &70293058887220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -71,10 +71,10 @@ dependencies:
         version: 0.0.1
   type: :development
   prerelease: false
-  version_requirements: *70130268837300
+  version_requirements: *70293058887220
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70130268836020 !ruby/object:Gem::Requirement
+  requirement: &70293058885400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -82,10 +82,10 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *70130268836020
+  version_requirements: *70293058885400
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70130268834960 !ruby/object:Gem::Requirement
+  requirement: &70293058884740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -93,18 +93,29 @@ dependencies:
         version: '0.3'
   type: :development
   prerelease: false
-  version_requirements: *70130268834960
+  version_requirements: *70293058884740
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70293058884160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: *70293058884160
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &70130268833240 !ruby/object:Gem::Requirement
+  requirement: &70293058883580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.13'
   type: :development
   prerelease: false
-  version_requirements: *70130268833240
+  version_requirements: *70293058883580
 description: ! 'Configurability is a mixin that allows you to add configurability
   to one or
 
@@ -163,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: configurability
-rubygems_version: 1.8.10
+rubygems_version: 1.8.14
 signing_key: 
 specification_version: 3
 summary: Configurability is a mixin that allows you to add configurability to one