configurability 3.0.0.pre20161123172826 → 3.0.0.pre20161130162622

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 312a9f359af2205c1d19680cdbf9d78dccffabbd
-  data.tar.gz: 04da93e50487652b33a29533d8bce47bdd6d45eb
+  metadata.gz: ec7bd9ddc5f5378d2ae449b87206d9c3c2c957ef
+  data.tar.gz: 1f9f7e27cb176bef33f426d0cb62fe1e99ad216f
 SHA512:
-  metadata.gz: fa298908a7f0a5c1204397e94e31b9c3292f045133b36e0c61c8f9d94065e371c3b7e7f53ca15f85d4902765f6b43d40f3b35fa71344a6e4edae10082f2a58de
-  data.tar.gz: 30c3d90e89cc257107f60d5eb7097508ad820b03caa3c23453f2ed384b5c8efd828d169f440c7f7850a8a9820108d89a5e1ac66fecb85509c946ed9f2f6b280a
+  metadata.gz: f0370cd0b0a9bf748f5d4fd5c358008723e130e6f4183c7a03fbafdf7be0e1f33610da76fc874c439f88eb32d21fbfbae347cdf72dfca98c2885c661c7af4884
+  data.tar.gz: 2d5a72fe466eedbd356742ff970c076b93569b0a2c221bd92b6616f58feead5f4c81df2c4f2541493a6684ef55f6fb383120b4cbb6ea590b0c7578e9b807b020

data/lib/configurability.rb

@@ -18,14 +18,15 @@ module Configurability
 
 
 	# Library version constant
-	VERSION = '3.0.0'
+	VERSION = '2.99.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 1932602f7894 $
+	REVISION = %q$Revision: 5c1ffea885e8 $
 
 	require 'configurability/deferredconfig'
 
 	autoload :Config, 'configurability/config'
+	autoload :DSL, 'configurability/dsl'
 
 
 	### The objects that have had Configurability added to them
@@ -233,9 +234,48 @@ module Configurability
 	end
 
 
-	### Default configuration method.
-	def configure( config )
+	### Default configuration method. This will merge the provided +config+ with the defaults
+	### if there are any and the +config+ responds to <tt>#to_h</tt>. If the +config+ responds to
+	### <tt>#each_pair</tt>, any writable attributes of the calling object with the same name
+	### as a key of the +config+ will be called with the corresponding value. E.g.,
+	###
+	###   class MyClass
+	###       extend Configurability
+	###       CONFIG_DEFAULTS = { environment: 'develop', apikey: 'testing-key' }
+	###       config_key :my_class
+	###       class << self
+	###           attr_accessor :environment, :apikey
+	###       end
+	###   end
+	###
+	###   config = { my_class: {apikey: 'demo-key'} }
+	###   Configurability.configure_objects( config )
+	###
+	###   MyClass.apikey
+	###   # => 'demo-key'
+	###   MyClass.environment
+	###   # => 'develop'
+	###
+	def configure( config=nil )
+		config = self.defaults( {} ).merge( config.to_h || {} ) if
+			config.nil? || config.respond_to?( :to_h )
+
 		@config = config
+
+		if @config.respond_to?( :each_pair )
+			@config.each_pair do |key, value|
+				Configurability.log.debug "Looking for %p config attribute" % [ key ]
+				next unless self.respond_to?( "#{key}=" )
+				Configurability.log.debug "  setting %p to %p via attr_writer" %
+					[ key, value ]
+				self.public_send( "#{key}=", value )
+			end
+		else
+			Configurability.log.
+				debug "config object (%p) isn't iterable; skipping config attributes" % [ @config ]
+		end
+
+		return @config
 	end
 
 
@@ -245,6 +285,36 @@ module Configurability
 	end
 
 
+	#
+	# :section: Configuration settings block
+	#
+
+	### Declare configuration settings and defaults. In the provided +block+, you can create
+	### a configuration setting using the following syntax:
+	###
+	###   configurability( :my_config_key ) do
+	###       # Declare a setting with a `nil` default
+	###       setting :a_config_key
+	###       # Declare one with a default value
+	###       setting :another_config_key, default: 18
+	###   end
+	###
+	def configurability( config_key=nil, &block )
+		self.config_key = config_key if config_key
+
+		if block
+			Configurability.log.debug "Applying config declaration block using DSL::Generator"
+			generator = Configurability::DSL::Generator.new( self )
+			generator.instance_eval( &block )
+		end
+
+		if (( config = Configurability.loaded_config ))
+			Configurability.install_config( config, self )
+		end
+
+	end
+
+
 	#
 	# :section: Configuration Defaults API
 	#
@@ -252,10 +322,10 @@ module Configurability
 	### 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
+	### defaults, and will just return the +fallback+ value if neither exists. 
+	def defaults( fallback=nil )
 
-		return nil unless respond_to?( :const_defined? )
+		return fallback unless respond_to?( :const_defined? )
 
 		Configurability.log.debug "Looking for defaults in %p's constants." % [ self ]
 		if self.const_defined?( :DEFAULT_CONFIG, false )
@@ -266,7 +336,7 @@ module Configurability
 			return self.const_get( :CONFIG_DEFAULTS, false ).dup
 		else
 			Configurability.log.debug "  no default constants."
-			return nil
+			return fallback
 		end
 	end
 

data/spec/configurability_spec.rb

@@ -141,10 +141,7 @@ describe Configurability do
 			config_key :testconfig
 		end
 
-		config = double( "configuration object" )
-		expect( config ).to receive( :respond_to? ).with( :testconfig ).and_return( false )
-		expect( config ).to receive( :respond_to? ).with( :[] ).and_return( false )
-
+		config = Object.new
 		expect( klass ).to receive( :configure ).with( nil )
 
 		Configurability.configure_objects( config )
@@ -157,15 +154,7 @@ describe Configurability do
 			config_key :testconfig
 		end
 
-		config = double( "configuration object" )
-		expect( config ).to receive( :respond_to? ).with( :testconfig ).and_return( false )
-		expect( config ).to receive( :respond_to? ).with( :key? ).and_return( true )
-		expect( config ).to receive( :respond_to? ).with( :[] ).and_return( true )
-		expect( config ).to receive( :key? ).with( :testconfig ).and_return( false )
-		expect( config ).to receive( :key? ).with( 'testconfig' ).and_return( true )
-		expect( config ).to receive( :[] ).with( :testconfig ).and_return( nil )
-		expect( config ).to receive( :[] ).with( 'testconfig' ).and_return( :a_config_section )
-
+		config = { 'testconfig' => :a_config_section }
 		expect( klass ).to receive( :configure ).with( :a_config_section )
 
 		Configurability.configure_objects( config )
@@ -178,11 +167,9 @@ describe Configurability do
 			config_key :testconfig
 		end
 
-		config = double( "configuration object" )
-		expect( config ).to receive( :respond_to? ).with( :testconfig ).and_return( true )
-		expect( config ).to receive( :testconfig ).and_return( :a_config_section )
-
+		config = OpenStruct.new( testconfig: :a_config_section )
 		expect( klass ).to receive( :configure ).with( :a_config_section )
+
 		Configurability.configure_objects( config )
 	end
 
@@ -192,10 +179,7 @@ describe Configurability do
 		object.extend( Configurability )
 		object.config_key = :testobjconfig
 
-		config = double( "configuration object" )
-		expect( config ).to receive( :respond_to? ).with( :testobjconfig ).and_return( true )
-		expect( config ).to receive( :testobjconfig ).and_return( :a_config_section )
-
+		config = OpenStruct.new( testobjconfig: :a_config_section )
 		expect( object ).to receive( :configure ).with( :a_config_section )
 
 		Configurability.configure_objects( config )
@@ -211,12 +195,7 @@ describe Configurability do
 			config_key :subconfig
 		end
 
-		config = double( "configuration object" )
-		expect( config ).to receive( :respond_to? ).with( :testconfig ).and_return( true )
-		expect( config ).to receive( :testconfig ).and_return( :a_config_section )
-		expect( config ).to receive( :respond_to? ).with( :subconfig ).and_return( true )
-		expect( config ).to receive( :subconfig ).and_return( :a_sub_config_section )
-
+		config = OpenStruct.new( testconfig: :a_config_section, subconfig: :a_sub_config_section )
 		expect( subclass ).to receive( :configure ).with( :a_sub_config_section )
 
 		Configurability.configure_objects( config )
@@ -229,10 +208,7 @@ describe Configurability do
 		def object.name; "testobjconfig"; end
 		object.extend( Configurability )
 
-		config = double( "configuration object" )
-		expect( config ).to receive( :respond_to? ).with( :testobjconfig ).and_return( true )
-		expect( config ).to receive( :testobjconfig ).and_return( :a_config_section )
-
+		config = OpenStruct.new( testobjconfig: :a_config_section )
 		expect( object ).to receive( :configure ).with( :a_config_section )
 
 		Configurability.configure_objects( config )
@@ -244,10 +220,7 @@ describe Configurability do
 		def object.name; "Test Obj-Config"; end
 		object.extend( Configurability )
 
-		config = double( "configuration object" )
-		expect( config ).to receive( :respond_to? ).with( :test_obj_config ).and_return( true )
-		expect( config ).to receive( :test_obj_config ).and_return( :a_config_section )
-
+		config = OpenStruct.new( test_obj_config: :a_config_section )
 		expect( object ).to receive( :configure ).with( :a_config_section )
 
 		Configurability.configure_objects( config )
@@ -259,10 +232,7 @@ describe Configurability do
 		object = Object.new
 		object.extend( Configurability )
 
-		config = double( "configuration object" )
-		expect( config ).to receive( :respond_to? ).with( :object ).and_return( true )
-		expect( config ).to receive( :object ).and_return( :a_config_section )
-
+		config = OpenStruct.new( object: :a_config_section )
 		expect( object ).to receive( :configure ).with( :a_config_section )
 
 		Configurability.configure_objects( config )
@@ -276,10 +246,7 @@ describe Configurability do
 			end
 		end
 
-		config = double( "configuration object" )
-		expect( config ).to receive( :respond_to? ).with( :dbobject ).and_return( true )
-		expect( config ).to receive( :dbobject ).and_return( :a_config_section )
-
+		config = OpenStruct.new( dbobject: :a_config_section )
 		expect( My::DbObject ).to receive( :configure ).with( :a_config_section )
 
 		Configurability.configure_objects( config )
@@ -292,10 +259,7 @@ describe Configurability do
 		object = objectclass.new
 		object.extend( Configurability )
 
-		config = double( "configuration object" )
-		expect( config ).to receive( :respond_to? ).with( :anonymous ).and_return( true )
-		expect( config ).to receive( :anonymous ).and_return( :a_config_section )
-
+		config = OpenStruct.new( anonymous: :a_config_section )
 		expect( object ).to receive( :configure ).with( :a_config_section )
 
 		Configurability.configure_objects( config )
@@ -489,6 +453,183 @@ describe Configurability do
 			expect( config.spanishconfig.uno ).to eq( 1 )
 		end
 
+
+		it "responds with the provided result if the object with Configurabilty has no defaults" do
+			klass = Class.new do
+				extend Configurability
+				config_key :testconfig
+			end
+
+			expect( klass.defaults({}) ).to eq( {} )
+		end
+
+	end
+
+
+	describe "default configure method" do
+
+		let!( :configurable_class ) do
+			Class.new do
+				include Configurability
+				config_key :testconfig
+				class << self
+					attr_accessor :apikey, :environment
+				end
+			end
+		end
+
+
+		it "sets attributes of the configured object that correspond with the keys of the config" do
+			config = OpenStruct.new( apikey: 'the-api-key', environment: 'production' )
+
+			configurable_class.configure( config )
+
+			expect( configurable_class.apikey ).to eq( 'the-api-key' )
+			expect( configurable_class.environment ).to eq( 'production' )
+		end
+
+
+		it "merges in defaults if they exist" do
+			configurable_class::DEFAULT_CONFIG = { environment: 'development' }
+			config = OpenStruct.new( apikey: 'the-api-key' )
+
+			configurable_class.configure( config )
+
+			expect( configurable_class.apikey ).to eq( 'the-api-key' )
+			expect( configurable_class.environment ).to eq( 'development' )
+		end
+
+
+		it "merges in defaults even if configured with `nil`" do
+			configurable_class::DEFAULT_CONFIG = { environment: 'development' }
+
+			configurable_class.configure
+
+			expect( configurable_class.apikey ).to eq( nil )
+			expect( configurable_class.environment ).to eq( 'development' )
+		end
+
+
+		it "returns the merged config for overrides" do
+			configurable_class::DEFAULT_CONFIG = { environment: 'development' }
+
+			rval = configurable_class.configure( apikey: 'the-api-key' )
+
+			expect( rval[:apikey] ).to eq( 'the-api-key' )
+			expect( rval[:environment] ).to eq( 'development' )
+		end
+
+	end
+
+
+	describe "configuration DSL" do
+
+		let( :mod ) do
+			mod = Module.new
+			mod.extend( Configurability )
+			mod
+		end
+
+		let( :instance ) do
+			instance = Object.new
+			instance.extend( Configurability )
+			instance
+		end
+
+
+		it "just sets the config key if called with a name" do
+			mod.configurability( :testconfig )
+			expect( mod.config_key ).to eq( :testconfig )
+		end
+
+
+		it "allows the declaration of one or more config options" do
+			mod.configurability( :testconfig ) do
+				setting :environment
+				setting :apikey
+			end
+
+			expect {
+				mod.environment = 'development'
+			}.to change { mod.environment }.to( 'development' )
+			expect {
+				mod.apikey = 'jofRtkw&QzCoukGwAWDMjyTkQzWnCXhhgEs'
+			}.to change { mod.apikey }.to( 'jofRtkw&QzCoukGwAWDMjyTkQzWnCXhhgEs' )
+		end
+
+
+		it "works for object instances with Configurability as well" do
+			instance.configurability( :testconfig ) do
+				setting :environment
+				setting :apikey
+			end
+
+			expect {
+				instance.environment = 'development'
+			}.to change { instance.environment }.to( 'development' )
+			expect {
+				instance.apikey = 'jofRtkw&QzCoukGwAWDMjyTkQzWnCXhhgEs'
+			}.to change { instance.apikey }.to( 'jofRtkw&QzCoukGwAWDMjyTkQzWnCXhhgEs' )
+		end
+
+
+		it "allow the declaration of one or more config options with an inferred config key" do
+			mod.configurability do
+				setting :environment
+				setting :apikey
+			end
+
+			expect {
+				mod.environment = 'development'
+			}.to change { mod.environment }.to( 'development' )
+			expect {
+				mod.apikey = 'jofRtkw&QzCoukGwAWDMjyTkQzWnCXhhgEs'
+			}.to change { mod.apikey }.to( 'jofRtkw&QzCoukGwAWDMjyTkQzWnCXhhgEs' )
+		end
+
+
+		it "allow the declaration of one or more config options with defaults" do
+			mod.configurability( :testconfig ) do
+				setting :environment, default: 'development'
+				setting :apikey, default: '<none set>'
+			end
+
+			expect {
+				mod.environment = 'production'
+			}.to change { mod.environment }.
+				from( 'development' ).
+				to( 'production' )
+
+			expect {
+				mod.apikey = 'jofRtkw&QzCoukGwAWDMjyTkQzWnCXhhgEs'
+			}.to change { mod.apikey }.
+				from( '<none set>' ).
+				to( 'jofRtkw&QzCoukGwAWDMjyTkQzWnCXhhgEs' )
+
+			expect( mod.defaults ).to include(
+				environment: 'development',
+				apikey: '<none set>'
+			)
+		end
+
+
+		it "installs the current config after its done if it's already been loaded" do
+			config = OpenStruct.new( testconfig: {
+				environment: 'production',
+				apikey: 'jofRtkw&QzCoukGwAWDMjyTkQzWnCXhhgEs'
+			})
+
+			Configurability.configure_objects( config )
+
+			mod.configurability( :testconfig ) do
+				setting :environment, default: 'development'
+				setting :apikey, default: '<none set>'
+			end
+
+			expect( mod.environment ).to eq( 'production' )
+			expect( mod.apikey ).to eq( 'jofRtkw&QzCoukGwAWDMjyTkQzWnCXhhgEs' )
+		end
+
 	end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configurability
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre20161123172826
+  version: 3.0.0.pre20161130162622
 platform: ruby
 authors:
 - Michael Granger
@@ -36,7 +36,7 @@ cert_chain:
   w8aNA5re5+Rt/Vvjxj5AcEnZnZiz5x959NaddQocX32Z1unHw44pzRNUur1GInfW
   p4vpx2kUSFSAGjtCbDGTNV2AH8w9OU4xEmNz8c5lyoA=
   -----END CERTIFICATE-----
-date: 2016-11-24 00:00:00.000000000 Z
+date: 2016-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability