confstruct 0.2.0 → 0.2.1

data/README.md

@@ -5,6 +5,7 @@ hash, struct, or block, confstruct aims to provide the flexibility to do things
 way, while keeping things simple and intuitive.
 
 [![Build Status](https://secure.travis-ci.org/mbklein/confstruct.png)](http://travis-ci.org/mbklein/confstruct)
+[![Dependency Status](https://gemnasium.com/mbklein/confstruct.png)](https://gemnasium.com/mbklein/confstruct)
 
 ## Usage
 
@@ -74,7 +75,7 @@ You can even
     config.project = 'other-project'
     config.github = { :url => 'http://www.github.com/somefork/other-project', :branch => 'pre-1.0' }
 
-The configure method will even a deep merge for you if you pass it a hash or hash-like object
+The configure method will even perform a deep merge for you if you pass it a hash or hash-like object
 (anything that responds to `each_pair`)
 
     config.configure({:project => 'other-project', :github => {:url => 'http://www.github.com/somefork/other-project', :branch => 'pre-1.0'}})
@@ -98,28 +99,32 @@ hash or a struct:
     config[:github]
      => {:url=>"http://www.github.com/somefork/other-project", :branch=>"pre-1.0"}
 
-### Advanced Tips & Tricks
+### Other Features
+
+#### Deferred evaluation
 
 Any configuration value of class `Confstruct::Deferred` will be evaluated on access, allowing you to
 define read-only, dynamic configuration attributes
 
-    config[:github][:client] = Confstruct::Deferred.new { |c| RestClient::Resource.new(c.url) }
-     => #<Proc:0x00000001035eb240>
-    config.github.client 
-     => #<RestClient::Resource:0x1035e3b30 @options={}, @url="http://www.github.com/mbklein/confstruct", @block=nil> 
-    config.github.url = 'http://www.github.com/somefork/other-project'
-     => "http://www.github.com/somefork/other-project" 
-    config.github.client 
-     => #<RestClient::Resource:0x1035d5bc0 @options={}, @url="http://www.github.com/somefork/other-project", @block=nil>
+    config.app_name = "iWidgetCloud"
+    config.msgs.welcome = Confstruct::Deferred.new {|c| "Welcome to #{c.app_name}!"}    
+    config.msgs.welcome
+     => "Welcome to iWidgetCloud!"
+    config.app_name = "Enterprisey-Webscale"
+     => "Enterprisey-Webscale" 
+    config.welcome_msg
+     => "Welcome to Enterprisey-Webscale"
      
 As a convenience, `Confstruct.deferred(&block)` and `Confstruct::HashWithStructAccess#deferred!(&block)`
-act like `lambda`, making the following two assignments equivalent to the above:
+will create a Confstruct::Deferred for you, making the following two assignments equivalent to the above:
 
-    config.github.client = Confstruct.deferred { |c| RestClient::Resource.new(c.url) }
-    config.github do
-      client deferred! { |c| RestClient::Resource.new(c.url) }
+    config.welcome_msg = Confstruct.deferred { |c| "Welcome to #{c.app_name}!" }
+    config do
+      welcome_msg deferred! { |c| RestClient::Resource.new(c.url) }
     end
 
+#### Push/Pop configurations
+
 `push!` and `pop!` methods allow you to temporarily override some or all of your configuration values. This can be
 useful in spec tests where you need to change values but don't want to worry about messing up tests that depend
 on the same global configuration object.
@@ -134,9 +139,45 @@ on the same global configuration object.
      => {:project=>"confstruct", :github=>{:branch=>"master", :url=>"http://www.github.com/mbklein/confstruct"}} 
     config.github.url
      => "http://www.github.com/mbklein/confstruct"
+    
+#### lookup!
+
+`lookup!` can be used to look up down a hieararchy without raising on missing values; and/or 
+to look up with default value. 
+
+    config = Confstruct::Configuration.new do 
+      project 'confstruct'
+      github do
+        url 'http://www.github.com/mbklein/confstruct'
+        branch 'master'
+      end
+    end
+    config.lookup!("github.url")
+    => "http://www.github.com/mbklein/confstruct"
+    config.lookup!("github.no_key")
+    => nil # no raising
+    config.lookup!("not_there.really.not.there")
+    => nil
+    config.lookup!("github.not_there", "default_value")
+    => "default_value"
+    
+#### lists
+
+The pattern `add_$key!` can be used to add to or create an array. 
+
+    config = Confstruct::Configuration.new
+    config.add_color! "green"
+    => ["green"]
+    config
+    => {:color=>["green"]}
+    config.add_color! "red"
+    config.color
+    => ["green", "red"]
+    
 
 ### Notes
 
+
 * Confstruct will attempt to use ordered hashes internally when available.
   * In Ruby 1.9 and above, this is automatic.
   * In Rubies earlier than 1.9, Confstruct will try to require and use ActiveSupport::OrderedHash, 
@@ -150,6 +191,7 @@ on the same global configuration object.
 
 - <b>v0.1.0</b> - Initial release
 - <b>v0.2.0</b> - Add fallback value to HashWithStructAccess#lookup!, native support for Rails I18n.
+- <b>v0.2.1</b> - Initialize properly from a nested hash with string (non-symbol) keys
 
 ## Contributing to confstruct
 
@@ -161,7 +203,6 @@ on the same global configuration object.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-## Copyright
-
-Copyright (c) 2011 Michael B. Klein. See LICENSE.txt for further details.
+## License
 
+confstruct is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/confstruct.rb

@@ -4,5 +4,5 @@ module Confstruct
   autoload :HashWithStructAccess, 'confstruct/hash_with_struct_access'
   autoload :Configuration, 'confstruct/configuration'
   
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/lib/confstruct/configuration.rb

@@ -6,7 +6,7 @@ module Confstruct
   
     def initialize hash=@@hash_class.new, &block
       super({})
-      @default_values = hash.is_a?(HashWithStructAccess) ? hash : HashWithStructAccess.new(hash)
+      @default_values = hash.is_a?(HashWithStructAccess) ? hash : HashWithStructAccess.from_hash(hash)
       eval_or_yield @default_values, &block
       reset_defaults!
     end

data/spec/confstruct/configuration_spec.rb

@@ -8,6 +8,16 @@ describe Confstruct::Configuration do
     conf.is_a?(Confstruct::Configuration).should be_true
     conf.should == {}
   end
+  
+  it "should initialize properly from a nested hash with string keys" do
+    x = { 'a' => { 'b' => 'c' } }
+    conf = Confstruct::Configuration.new(x)
+    conf.is_a?(Hash).should be_true
+    conf.is_a?(Confstruct::Configuration).should be_true
+    conf[:a][:b].should == 'c'
+    conf['a']['b'].should == 'c'
+    conf.a.b.should == 'c'
+  end
 
   context "default values" do
     before :all do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: confstruct
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Michael Klein
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-18 00:00:00 Z
+date: 2012-01-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -157,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: A simple, hash/struct-based configuration object