configurability 2.3.0.pre20161121123955 → 3.0.0.pre20161123172826

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 470dde9269109d507424b3459e90e86f5dca7bce
-  data.tar.gz: 8c3ac3e698ab18ff6783c2c0c7afe2b333de8234
+  metadata.gz: 312a9f359af2205c1d19680cdbf9d78dccffabbd
+  data.tar.gz: 04da93e50487652b33a29533d8bce47bdd6d45eb
 SHA512:
-  metadata.gz: 5ba7e4bb087da76a09937c1eb655e02a41aed364c8ead62e95e6d87210143b94d23979c7636ea82c4b31e7391d0da6803093e4b8572a49ae9d6f302414f27312
-  data.tar.gz: b770a6f29e6703a0c16ccc0c56896e49e34fff4fe5ebc2eacca5533dbbab04e99879c18b65af101b7045a1b891ca77acf98412499e2e3ebd7a92305ee4aeb6b0
+  metadata.gz: fa298908a7f0a5c1204397e94e31b9c3292f045133b36e0c61c8f9d94065e371c3b7e7f53ca15f85d4902765f6b43d40f3b35fa71344a6e4edae10082f2a58de
+  data.tar.gz: 30c3d90e89cc257107f60d5eb7097508ad820b03caa3c23453f2ed384b5c8efd828d169f440c7f7850a8a9820108d89a5e1ac66fecb85509c946ed9f2f6b280a

data/{History.rdoc → History.md}

@@ -1,3 +1,14 @@
+== v3.0.0 [2016-11-23] Michael Granger <ged@FaerieMUD.org>
+
+Enhancement:
+
+- Add hierarchical config keys.
+
+
+== v2.2.2 [2016-09-28] Michael Granger <ged@FaerieMUD.org>
+
+- Added signature for changeset 806d1f512f55
+
 == v2.2.2 [2016-09-28] Michael Granger <ged@FaerieMUD.org>
 
 - Fix the merge used by Configurability.gather_defaults

data/Manifest.txt

@@ -1,8 +1,8 @@
 ChangeLog
-History.rdoc
+History.md
 LICENSE
 Manifest.txt
-README.rdoc
+README.md
 Rakefile
 bin/configurability
 examples/basicconfig.rb

data/{README.rdoc → README.md}

@@ -1,12 +1,20 @@
-= Configurability
+# 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
+home
+: https://bitbucket.org/ged/configurability
 
+code
+: https://bitbucket.org/ged/configurability
 
-== Description
+docs
+: http://deveiate.org/code/configurability
+
+github
+: https://github.com/ged/configurability
+
+
+
+## Description
 
 Configurability is a unified, unintrusive, assume-nothing configuration system
 for Ruby. It lets you keep the configuration for multiple objects in a single
@@ -16,12 +24,12 @@ single action.
 
 
 
-== Installation
+## Installation
 
     gem install configurability
 
 
-== Usage
+## Usage
 
 To add configurability to a class, just require the library and extend
 the class:
@@ -68,14 +76,20 @@ When the configuration is loaded, an instance variable called `@config` is set
 to the appropriate section of the config object for each object that has
 been extended with Configurability.
 
+As you add more objects to your configuration, it may be useful to group
+related sections together. You can specify that your object's configuration
+is part of a group by prepending the name of the group to your config key
+separated by a double underscore (`__`)
+
 
-== 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
@@ -96,10 +110,8 @@ as a Symbol:
         end
     end
 
-=== Changing How an Object Is Configured
 
-[:FIXME:] Explain the 'at least once' configuration call, and how to handle
-being called with 'nil'.
+### 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:
@@ -119,7 +131,7 @@ 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,
@@ -237,15 +249,31 @@ or write it back to the file it was loaded from:
 	config.write
 
 
-== Configuration Defaults
+## Configuration Defaults
+
+It's a good idea to provide a set of reasonable defaults for any configured
+object. Configurability provides a `defaults` method that will look for a constant
+called either `DEFAULT_CONFIG` or `CONFIG_DEFAULTS` on each object extended with
+Configurability, and will return a dup of the value of this constant if it does.
+
+You can also override `defaults` yourself if you wish to provide them via something
+other than a constant.
+
+There are also a couple of useful functions built on top of this method:
 
-Configurability also supports an API for generating a new config file with
-defaults for all objects with Configurability.
+gather_defaults
+: You can fetch a Hash of the default config values of all objects that have been extended 
+  with Configurability by calling `Configurabilty.gather_defaults`. You can also pass an
+  object that responds to `#merge!` to the method to merge the defaults into an existing
+  config.
 
-[:FIXME:] Finish up the documentation
+default_config
+: This will return a Configurability::Config object made from the results of
+  `gather_defaults`. This makes it easy to write a config file that contains the default
+  configuration: `Configurability.default_config.write( "defaults.yml" )`
 
 
-== Development
+## Development
 
 You can submit bug reports, suggestions, clone it with Mercurial, and
 read more about future plans at 
@@ -261,9 +289,9 @@ This task will install any missing dependencies, run the tests/specs,
 and generate the API documentation.
 
 
-== License
+## License
 
-Copyright (c) 2010-2016 Michael Granger
+Copyright (c) 2010-2016 Michael Granger and Mahlon E. Smith
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/Rakefile

@@ -17,21 +17,27 @@ Hoe.plugins.delete :rubyforge
 Encoding.default_internal = Encoding::UTF_8
 
 hoespec = Hoe.spec 'configurability' do |spec|
-	spec.readme_file = 'README.rdoc'
-	spec.history_file = 'History.rdoc'
-	spec.extra_rdoc_files = Rake::FileList[ '*.rdoc' ]
+	spec.readme_file = 'README.md'
+	spec.history_file = 'History.md'
+	spec.extra_rdoc_files = FileList[ '*.rdoc', '*.md' ]
 	spec.license 'BSD-3-Clause'
+	spec.urls = {
+		home:   'http://deveiate.org/projects/configurability',
+		code:   'http://bitbucket.org/ged/configurability',
+		docs:   'http://deveiate.org/code/configurability',
+		github: 'http://github.com/ged/configurability',
+	}
 
 	spec.developer 'Michael Granger', 'ged@FaerieMUD.org'
+	spec.developer 'Mahlon E. Smith', 'mahlon@martini.nu'
 
 	spec.dependency 'loggability', '~> 0.11'
 
-	spec.dependency 'hoe-deveiate', '~> 0.5', :developer
-	spec.dependency 'simplecov', '~> 0.8', :developer
-	spec.dependency 'hoe-bundler', '~> 1.2', :developer
-	spec.dependency 'rspec', '~> 3.0', :developer
+	spec.dependency 'hoe-deveiate', '~> 0.8', :developer
+	spec.dependency 'simplecov', '~> 0.12', :developer
+	spec.dependency 'rspec', '~> 3.5', :developer
 
-	spec.require_ruby_version( '>= 1.9.2' )
+	spec.require_ruby_version( '>= 2.2.0' )
 
 	spec.hg_sign_tags = true if spec.respond_to?( :hg_sign_tags= )
 	spec.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"

data/lib/configurability.rb

@@ -18,10 +18,10 @@ module Configurability
 
 
 	# Library version constant
-	VERSION = '2.2.2'
+	VERSION = '3.0.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 93764baee5f8 $
+	REVISION = %q$Revision: 1932602f7894 $
 
 	require 'configurability/deferredconfig'
 
@@ -169,6 +169,15 @@ module Configurability
 	end
 
 
+	### Nest the specified +hash+ inside subhashes for each subsection of the given +key+ and
+	### return the result.
+	def self::expand_config_hash( key, hash )
+		return key.to_s.split( '__' ).reverse.inject( hash ) do |inner_hash, subkey|
+			{ subkey.to_sym => inner_hash }
+		end
+	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
@@ -180,10 +189,12 @@ module Configurability
 
 		self.configurable_objects.each do |obj|
 			next unless obj.respond_to?( :defaults )
-			if subhash = obj.defaults
-				section = obj.config_key.to_sym
-				Configurability.log.debug "Defaults for %p (%p): %p" % [ obj, section, subhash ]
-				collection.merge!( section => subhash, &mergefunc )
+			if defaults_hash = obj.defaults
+				nested_hash = self.expand_config_hash( obj.config_key, defaults_hash )
+				Configurability.log.debug "Defaults for %p (%p): %p" %
+					[ obj, obj.config_key, nested_hash ]
+
+				collection.merge!( nested_hash, &mergefunc )
 			else
 				Configurability.log.warn "No defaults for %p; skipping" % [ obj ]
 			end
@@ -263,7 +274,7 @@ module Configurability
 	### Return a Configurability::Config object that contains the configuration
 	### defaults for the receiver.
 	def default_config
-		default_values = self.defaults or return Configurability::Config.new( {} )
+		default_values = self.defaults or return Configurability::Config::Struct.new( {} )
 		return Configurability::Config::Struct.new( default_values )
 	end
 

data/spec/configurability_spec.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+require 'ostruct'
 require 'helpers'
 
 require 'rspec'
@@ -55,82 +56,80 @@ describe Configurability do
 	end
 
 
-	it "fetches config sections via a method with the config key name if the config " +
-	   "responds_to? it" do
+	it "can use a struct-like object as the config" do
 		klass = Class.new do
 			extend Configurability
 			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
 
 
-	it "fetches config subsections via a method chain that corresponds to the config key" do
+	it "can use a struct-like object as a config with subsections " do
 		klass = Class.new do
 			extend Configurability
 			config_key "testconfig.subsection"
 		end
-
-		config = double( "configuration object" )
-		expect( config ).to receive( :respond_to? ).with( :testconfig ).and_return( true )
-
-		section = double( "configuration section" )
-		expect( config ).to receive( :testconfig ).and_return( section )
-		expect( section ).to receive( :respond_to? ).with( :subsection ).and_return( true )
-		expect( section ).to receive( :subsection ).and_return( :the_config_subsection )
+		config = OpenStruct.new( testconfig: {subsection: :the_config_subsection} )
 
 		expect( klass ).to receive( :configure ).with( :the_config_subsection )
+
 		Configurability.configure_objects( config )
 	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 and #key?" do
+	it "can use a hash as the config" do
 		klass = Class.new do
 			extend Configurability
 			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( true )
-		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 )
 	end
 
 
-	it "fetches config subsections via the index operator if the config doesn't respond " +
-	   "directly to the section name, but does to the index operator and #key?" do
+	it "can use a hash as a config with subsections" do
 		klass = Class.new do
 			extend Configurability
 			config_key :testconfig__subsection
 		end
+		config = { testconfig: {subsection: :the_config_subsection} }
 
-		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( true )
+		expect( klass ).to receive( :configure ).with( :the_config_subsection )
+
+		Configurability.configure_objects( config )
+	end
 
-		section = double( "configuration section" )
-		expect( config ).to receive( :[] ).with( :testconfig ).and_return( section )
-		expect( section ).to receive( :respond_to? ).with( :subsection ).and_return( false )
-		expect( section ).to receive( :respond_to? ).with( :key? ).and_return( true )
-		expect( section ).to receive( :respond_to? ).with( :[] ).and_return( true )
-		expect( section ).to receive( :key? ).with( :subsection ).and_return( true )
-		expect( section ).to receive( :[] ).with( :subsection ).and_return( :the_config_subsection )
+
+	it "can use a mix of struct-like and hash-like objects as a config with subsections" do
+		klass = Class.new do
+			extend Configurability
+			config_key :testconfig__subsection
+		end
+		config = OpenStruct.new( testconfig: {subsection: :the_config_subsection} )
+
+		expect( klass ).to receive( :configure ).with( :the_config_subsection )
+
+		Configurability.configure_objects( config )
+	end
+
+
+	it "supports more than one level of subsections" do
+		klass = Class.new do
+			extend Configurability
+			config_key "testconfig.sect1.sect2"
+		end
+		config = OpenStruct.new( testconfig: {sect1: {sect2: :the_config_subsection}} )
 
 		expect( klass ).to receive( :configure ).with( :the_config_subsection )
+
 		Configurability.configure_objects( config )
 	end
 
@@ -431,6 +430,19 @@ describe Configurability do
 		end
 
 
+		it "returns nested hashes for subsection defaults" do
+			klass = Class.new do
+				extend Configurability
+				config_key "testconfig.sect1.sect2"
+				self::CONFIG_DEFAULTS = { one: 1, two: 2 }
+			end
+
+			defaults = Configurability.gather_defaults
+
+			expect( defaults ).to eq({ testconfig: { sect1: {sect2: { one: 1, two: 2 }} } })
+		end
+
+
 		it "can return a Configurability::Config object with defaults, too" do
 			klass1 = Class.new do
 				extend Configurability

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: configurability
 version: !ruby/object:Gem::Version
-  version: 2.3.0.pre20161121123955
+  version: 3.0.0.pre20161123172826
 platform: ruby
 authors:
 - Michael Granger
+- Mahlon E. Smith
 autorequire: 
 bindir: bin
 cert_chain:
@@ -35,7 +36,7 @@ cert_chain:
   w8aNA5re5+Rt/Vvjxj5AcEnZnZiz5x959NaddQocX32Z1unHw44pzRNUur1GInfW
   p4vpx2kUSFSAGjtCbDGTNV2AH8w9OU4xEmNz8c5lyoA=
   -----END CERTIFICATE-----
-date: 2016-11-21 00:00:00.000000000 Z
+date: 2016-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -99,42 +100,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: hoe-bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -171,18 +158,19 @@ description: |-
   single action.
 email:
 - ged@FaerieMUD.org
+- mahlon@martini.nu
 executables:
 - configurability
 extensions: []
 extra_rdoc_files:
-- History.rdoc
+- History.md
 - Manifest.txt
-- README.rdoc
+- README.md
 files:
 - ChangeLog
-- History.rdoc
+- History.md
 - Manifest.txt
-- README.rdoc
+- README.md
 - Rakefile
 - bin/configurability
 - examples/basicconfig.rb
@@ -195,21 +183,21 @@ files:
 - spec/configurability/deferredconfig_spec.rb
 - spec/configurability_spec.rb
 - spec/helpers.rb
-homepage: https://bitbucket.org/ged/configurability
+homepage: http://deveiate.org/projects/configurability
 licenses:
 - BSD-3-Clause
 metadata: {}
 post_install_message: 
 rdoc_options:
 - "--main"
-- README.rdoc
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"