iqeo-conf 0.0.11 → 0.0.12

data/doc/method_list.html

@@ -55,6 +55,14 @@
   
 
   <li class="r2 ">
+    <span class='object_link'><a href="Iqeo/Configuration.html#_items-instance_method" title="Iqeo::Configuration#_items (method)">#_items</a></span>
+    
+      <small>Iqeo::Configuration</small>
+    
+  </li>
+  
+
+  <li class="r1 ">
     <span class='object_link'><a href="Iqeo/Configuration.html#_load-instance_method" title="Iqeo::Configuration#_load (method)">#_load</a></span>
     
       <small>Iqeo::Configuration</small>
@@ -62,8 +70,16 @@
   </li>
   
 
+  <li class="r2 ">
+    <span class='object_link'><a href="Iqeo/Configuration.html#_merge-instance_method" title="Iqeo::Configuration#_merge (method)">#_merge</a></span>
+    
+      <small>Iqeo::Configuration</small>
+    
+  </li>
+  
+
   <li class="r1 ">
-    <span class='object_link'><a href="Iqeo/Configuration.html#_parent-instance_method" title="Iqeo::Configuration#_parent (method)">#_parent</a></span>
+    <span class='object_link'><a href="Iqeo/Configuration.html#_merge%21-instance_method" title="Iqeo::Configuration#_merge! (method)">#_merge!</a></span>
     
       <small>Iqeo::Configuration</small>
     
@@ -71,7 +87,7 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Iqeo/Configuration.html#_read-instance_method" title="Iqeo::Configuration#_read (method)">#_read</a></span>
+    <span class='object_link'><a href="Iqeo/Configuration.html#_parent-instance_method" title="Iqeo::Configuration#_parent (method)">#_parent</a></span>
     
       <small>Iqeo::Configuration</small>
     
@@ -79,7 +95,7 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Iqeo/Configuration.html#_set-instance_method" title="Iqeo::Configuration#_set (method)">#_set</a></span>
+    <span class='object_link'><a href="Iqeo/Configuration.html#_read-instance_method" title="Iqeo::Configuration#_read (method)">#_read</a></span>
     
       <small>Iqeo::Configuration</small>
     
@@ -87,7 +103,7 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Iqeo/Configuration.html#initialize-instance_method" title="Iqeo::Configuration#initialize (method)">#initialize</a></span>
+    <span class='object_link'><a href="Iqeo/Configuration.html#_set-instance_method" title="Iqeo::Configuration#_set (method)">#_set</a></span>
     
       <small>Iqeo::Configuration</small>
     
@@ -95,7 +111,7 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Iqeo/Configuration.html#load-class_method" title="Iqeo::Configuration.load (method)">load</a></span>
+    <span class='object_link'><a href="Iqeo/Configuration.html#initialize-instance_method" title="Iqeo::Configuration#initialize (method)">#initialize</a></span>
     
       <small>Iqeo::Configuration</small>
     
@@ -103,7 +119,7 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Iqeo/Configuration.html#method_missing-instance_method" title="Iqeo::Configuration#method_missing (method)">#method_missing</a></span>
+    <span class='object_link'><a href="Iqeo/Configuration.html#load-class_method" title="Iqeo::Configuration.load (method)">load</a></span>
     
       <small>Iqeo::Configuration</small>
     
@@ -111,7 +127,7 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Iqeo/Configuration.html#new_defer_block_for_parent-class_method" title="Iqeo::Configuration.new_defer_block_for_parent (method)">new_defer_block_for_parent</a></span>
+    <span class='object_link'><a href="Iqeo/Configuration.html#method_missing-instance_method" title="Iqeo::Configuration#method_missing (method)">#method_missing</a></span>
     
       <small>Iqeo::Configuration</small>
     
@@ -119,7 +135,7 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Iqeo/Configuration.html#read-class_method" title="Iqeo::Configuration.read (method)">read</a></span>
+    <span class='object_link'><a href="Iqeo/Configuration.html#new_defer_block_for_parent-class_method" title="Iqeo::Configuration.new_defer_block_for_parent (method)">new_defer_block_for_parent</a></span>
     
       <small>Iqeo::Configuration</small>
     
@@ -127,6 +143,14 @@
   
 
   <li class="r1 ">
+    <span class='object_link'><a href="Iqeo/Configuration.html#read-class_method" title="Iqeo::Configuration.read (method)">read</a></span>
+    
+      <small>Iqeo::Configuration</small>
+    
+  </li>
+  
+
+  <li class="r2 ">
     <span class='object_link'><a href="Iqeo/Configuration.html#version-class_method" title="Iqeo::Configuration.version (method)">version</a></span>
     
       <small>Iqeo::Configuration</small>

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri May 11 14:53:17 2012 by
+  Generated on Mon May 14 20:37:48 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.1 (ruby-1.9.3).
 </div>

data/iqeo-conf.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.version       = Iqeo::Configuration::VERSION
 
   gem.add_development_dependency "rake",      "~> 0.9.2"
-  gem.add_development_dependency "rspec",     "~> 2.9.0"
+  gem.add_development_dependency "rspec",     "~> 2.10.0"
   gem.add_development_dependency "yard",      "~> 0.8.1"
   gem.add_development_dependency "rdoc",      "~> 3.12.0"
   gem.add_development_dependency "redcarpet", "~> 2.1.1"

data/lib/iqeo/configuration/version.rb

@@ -1,6 +1,6 @@
 module Iqeo
   class Configuration
     # Current semantic version number
-    VERSION = "0.0.11"
+    VERSION = "0.0.12"
   end
 end

data/lib/iqeo/configuration.rb

@@ -2,12 +2,9 @@
 require_relative "configuration/version"
 require_relative "configuration/hash_with_indifferent_access"
 
-# todo: merge configurations
-# todo: defaults
 # todo: blank slate for DSL
-# todo: rdoc documentation - yuck! try YARD & Markdown!
 
-# Iqeo namespace module.
+# Iqeo namespace
 
 module Iqeo
 
@@ -52,8 +49,12 @@ module Iqeo
       conf
     end
 
-    def initialize &block
-      @items = HashWithIndifferentAccess.new
+    def initialize default = nil, &block
+      @_items = case
+                  when default.kind_of?( HashWithIndifferentAccess ) then default
+                  when default.kind_of?( Configuration ) then default._items
+                  else HashWithIndifferentAccess.new
+                end
       @_parent = nil
       if block_given?
         if block.arity == 1                                           # cannot set parent for yield blocks here as self is wrong !?
@@ -68,7 +69,7 @@ module Iqeo
     end
 
     def method_missing name, *values, &block
-      return @items.send( name, *values, &block ) if @items.respond_to? name     # @items methods are highest priority
+      return @_items.send( name, *values, &block ) if @_items.respond_to? name     # @_items methods are highest priority
 
       name = name.to_s.chomp('=')
 
@@ -85,7 +86,7 @@ module Iqeo
       return _set name, values.first                                  # set item to single value
     end
 
-    attr_accessor :_parent
+    attr_accessor :_parent, :_items
 
     def _set key, value
       # fix: extend parenting for enumerable with configurations at arbitrary depth
@@ -93,7 +94,7 @@ module Iqeo
       when value.kind_of?( Configuration ) then value._parent = self
       when value.kind_of?( Enumerable )    then value.each { |v| v._parent = self if v.kind_of? Configuration }
       end
-      @items[key] = value
+      @_items[key] = value
     end
     alias []= _set
 
@@ -104,8 +105,8 @@ module Iqeo
     # Returns nil if key does not exist.
 
     def _get key
-      return @items[key] unless @items[key].nil?
-      return @items[key] if  _parent.nil?
+      return @_items[key] unless @_items[key].nil?
+      return @_items[key] if _parent.nil?
       _parent._get key
     end
     alias [] _get
@@ -118,6 +119,16 @@ module Iqeo
       _read file.respond_to?(:read) ? file.read : File.read(file)
     end
 
+    def _merge! other
+      @_items.merge! other._items
+      self
+    end
+
+    def _merge other
+      self.dup._merge! other
+    end
+
+
   end
 
 end

data/spec/configuration_spec.rb

@@ -6,6 +6,39 @@ include Iqeo
 
 describe Configuration do
 
+  def simple_eval_string
+    "alpha 1
+    bravo 'two'
+    charlie 3.0
+    delta :four"
+  end
+
+  def simple_explicit_configuration
+    conf = Configuration.new
+    conf.alpha 1
+    conf.bravo 'two'
+    conf.charlie 3.0
+    conf.delta :four
+    conf
+  end
+
+  def simple_configuration_example conf
+    conf.should_not be_nil
+    conf.alpha.should   == 1     and conf.alpha.should be_a Fixnum
+    conf.bravo.should   == "two" and conf.bravo.should be_a String
+    conf.charlie.should == 3.0   and conf.charlie.should be_a Float
+    conf.delta.should   == :four and conf.delta.should be_a Symbol
+  end
+
+  def nested_configuration_example conf
+    conf.alpha.should be_true
+    conf.foxtrot.should be_true
+    simple_configuration_example conf.bravo
+    conf.bravo.foxtrot.should be_true
+    simple_configuration_example conf.echo
+    conf.echo.foxtrot.should be_true
+  end
+
   it 'reports the correct version' do
     Configuration.version.should == Configuration::VERSION
   end
@@ -36,75 +69,42 @@ describe Configuration do
       conf_new.should be conf_yielded
     end
 
+    it 'accepts defaults from another configuration' do
+      conf = Configuration.new simple_explicit_configuration
+      simple_configuration_example conf
+    end
+
+    it 'overrides defaults from another configuration' do
+      conf_default = Configuration.new( simple_explicit_configuration ) { echo true }
+      conf_default.echo.should be_true
+      conf = Configuration.new( conf_default ) { echo false }
+      simple_configuration_example conf
+      conf.echo.should be_false
+    end
+
     context 'can load' do
 
-      it 'simple instance_eval DSL from string' do
-        string = "alpha 1
-                  bravo 'two'
-                  charlie 3.0
-                  delta :four"
-        conf = nil
-        expect do
-          conf = Configuration.read string
-        end.to_not raise_error
-        conf.should_not be_nil
-        conf.alpha.should   == 1     and conf.alpha.should be_a Fixnum
-        conf.bravo.should   == "two" and conf.bravo.should be_a String
-        conf.charlie.should == 3.0   and conf.charlie.should be_a Float
-        conf.delta.should   == :four and conf.delta.should be_a Symbol
+      it 'simple eval DSL from string' do
+        simple_configuration_example Configuration.read simple_eval_string
       end
 
-      it 'simple instance_eval DSL from file (StringIO)' do
-        io = StringIO.new  "alpha 1
-                            bravo 'two'
-                            charlie 3.0
-                            delta :four"
-        conf = nil
-        expect do
-          conf = Configuration.load io
-        end.to_not raise_error
-        conf.should_not be_nil
-        conf.alpha.should   == 1     and conf.alpha.should be_a Fixnum
-        conf.bravo.should   == "two" and conf.bravo.should be_a String
-        conf.charlie.should == 3.0   and conf.charlie.should be_a Float
-        conf.delta.should   == :four and conf.delta.should be_a Symbol
+      it 'simple eval DSL from file (StringIO)' do
+        simple_configuration_example Configuration.load StringIO.new simple_eval_string
       end
 
-      it 'simple instance_eval DSL from file (mock & expected methods)' do
+      it 'simple eval DSL from file (mock & expected methods)' do
         file = mock
         file.should_receive( :respond_to? ).with( :read ).and_return true
-        file.should_receive( :read ).and_return  "alpha 1
-                                                  bravo 'two'
-                                                  charlie 3.0
-                                                  delta :four"
-        conf = nil
-        expect do
-          conf = Configuration.load file
-        end.to_not raise_error
-        conf.should_not be_nil
-        conf.alpha.should   == 1     and conf.alpha.should be_a Fixnum
-        conf.bravo.should   == "two" and conf.bravo.should be_a String
-        conf.charlie.should == 3.0   and conf.charlie.should be_a Float
-        conf.delta.should   == :four and conf.delta.should be_a Symbol
+        file.should_receive( :read ).and_return simple_eval_string
+        simple_configuration_example Configuration.load file
       end
 
-      it 'simple instance_eval DSL from filename (expected methods)' do
-        File.should_receive( :read ).with( "filename" ).and_return "alpha 1
-                                                                    bravo 'two'
-                                                                    charlie 3.0
-                                                                    delta :four"
-        conf = nil
-        expect do
-          conf = Configuration.load "filename"
-        end.to_not raise_error
-        conf.should_not be_nil
-        conf.alpha.should   == 1     and conf.alpha.should be_a Fixnum
-        conf.bravo.should   == "two" and conf.bravo.should be_a String
-        conf.charlie.should == 3.0   and conf.charlie.should be_a Float
-        conf.delta.should   == :four and conf.delta.should be_a Symbol
+      it 'simple eval DSL from filename (expected methods)' do
+        File.should_receive( :read ).with( "filename" ).and_return simple_eval_string
+        simple_configuration_example Configuration.load "filename"
       end
 
-      it 'complex instance_eval DSL from string' do
+      it 'complex eval DSL from string' do
         string = "alpha true
                   bravo do
                     charlie true
@@ -112,10 +112,7 @@ describe Configuration do
                       echo true
                     end
                   end"
-        conf = nil
-        expect do
-          conf = Configuration.read string
-        end.to_not raise_error
+        conf = Configuration.read string
         conf.should_not be_nil
         conf.alpha.should be_true
         conf.bravo.should be_a Configuration
@@ -134,19 +131,15 @@ describe Configuration do
   context 'settings retrieval' do
 
     it 'returns nil for non-existent settings' do
-      conf = Configuration.new
-      conf.not_a_setting.should be_nil
+      simple_explicit_configuration.not_a_setting.should be_nil
     end
 
     it 'delegates hash methods to internal hash' do
-      conf = nil
-      expect do
         conf = Configuration.new
         conf.alpha 1
         conf.bravo 2
         conf.charlie 3
         conf.delta 4
-      end.to_not raise_error
       conf.should_not be_nil
       sum = 0
       expect do
@@ -161,19 +154,7 @@ describe Configuration do
   context 'single value setting' do
 
     it 'accepts simple values' do
-      conf = nil
-      expect do
-        conf = Configuration.new
-        conf.alpha 1
-        conf.bravo 'two'
-        conf.charlie 3.0
-        conf.delta :four
-      end.to_not raise_error
-      conf.should_not be_nil
-      conf.alpha.should   == 1     and conf.alpha.should be_a Fixnum
-      conf.bravo.should   == 'two' and conf.bravo.should be_a String
-      conf.charlie.should == 3.0   and conf.charlie.should be_a Float
-      conf.delta.should == :four   and conf.delta.should be_a Symbol
+      simple_configuration_example simple_explicit_configuration
     end
 
     it 'accepts complex values' do
@@ -521,83 +502,47 @@ describe Configuration do
       context 'can load' do
 
         it 'settings into the current configuration from a string' do
-          conf = nil
-          expect do
-            conf = Configuration.new do |c|
-              c.alpha true
-              c._read "bravo true\ncharlie true"
-            end
-          end.to_not raise_error
-          conf.should_not be_nil
-          conf.alpha.should be_true
-          conf.bravo.should be_true
-          conf.charlie.should be_true
+          conf = Configuration.new do |c|
+            c.alpha false
+            c._read simple_eval_string
+            c.echo true
+          end
+          simple_configuration_example conf
+          conf.echo.should be_true
         end
 
         it 'settings into the current configuration from a file (StringIO)' do
-          io = StringIO.new "bravo true
-                             charlie true"
-          conf = nil
-          expect do
-            conf = Configuration.new do |c|
-              c.alpha true
-              c._load io
-            end
-          end.to_not raise_error
-          conf.should_not be_nil
-          conf.alpha.should be_true
-          conf.bravo.should be_true
-          conf.charlie.should be_true
+          conf = Configuration.new do |c|
+            c.alpha false
+            c._load StringIO.new simple_eval_string
+            c.echo true
+          end
+          simple_configuration_example conf
+          conf.echo.should be_true
         end
 
         it 'settings into a nested configuration from a string' do
-          conf = nil
-          expect do
-            conf = Configuration.new do |c|
-              c.alpha true
-              c.bravo do |x|
-                x._read "charlie true\ndelta true"
-              end
-              c.echo { |x| x._read "foxtrot true\nhotel true" }
+          conf = Configuration.new do |c|
+            c.alpha true
+            c.bravo do |x|
+              x._read simple_eval_string
             end
-          end.to_not raise_error
-          conf.should_not be_nil
-          conf.alpha.should be_true
-          conf.bravo.should be_a Configuration
-          conf.bravo.charlie.should be_true
-          conf.bravo.delta.should be_true
-          conf.bravo.alpha.should be_true
-          conf.echo.should be_a Configuration
-          conf.echo.foxtrot.should be_true
-          conf.echo.hotel.should be_true
-          conf.echo.alpha.should be_true
+            c.echo { |x| x._read simple_eval_string }
+            c.foxtrot true
+          end
+          nested_configuration_example conf
         end
 
         it 'settings into a nested configuration from a file (StringIO)' do
-          io1 = StringIO.new "charlie true
-                              delta true"
-          io2 = StringIO.new "foxtrot true
-                              hotel true"
-          conf = nil
-          expect do
-            conf = Configuration.new do |c|
-              c.alpha true
-              c.bravo do |x|
-                x._load io1
-              end
-              c.echo { |x| x._load io2 }
+          conf = Configuration.new do |c|
+            c.alpha true
+            c.bravo do |x|
+              x._load StringIO.new simple_eval_string
             end
-          end.to_not raise_error
-          conf.should_not be_nil
-          conf.alpha.should be_true
-          conf.bravo.should be_a Configuration
-          conf.bravo.charlie.should be_true
-          conf.bravo.delta.should be_true
-          conf.bravo.alpha.should be_true
-          conf.echo.should be_a Configuration
-          conf.echo.foxtrot.should be_true
-          conf.echo.hotel.should be_true
-          conf.echo.alpha.should be_true
+            c.echo { |x| x._load StringIO.new simple_eval_string }
+            c.foxtrot true
+          end
+          nested_configuration_example conf
         end
 
       end # can load
@@ -794,83 +739,46 @@ describe Configuration do
       context 'can load' do
 
         it 'settings into the current configuration from a string' do
-          conf = nil
-          expect do
-            conf = Configuration.new do
-              alpha true
-              _read "bravo true\ncharlie true"
-            end
-          end.to_not raise_error
-          conf.should_not be_nil
-          conf.alpha.should be_true
-          conf.bravo.should be_true
-          conf.charlie.should be_true
+          $simple_eval_string = simple_eval_string
+          conf = Configuration.new do
+            alpha true
+            _read $simple_eval_string
+          end
+          simple_configuration_example conf
         end
 
         it 'settings into the current configuration from a file (StringIO)' do
-          io = StringIO.new "bravo true
-                             charlie true"
-          conf = nil
-          expect do
-            conf = Configuration.new do
-              alpha true
-              _load io
-            end
-          end.to_not raise_error
-          conf.should_not be_nil
-          conf.alpha.should be_true
-          conf.bravo.should be_true
-          conf.charlie.should be_true
+          $simple_eval_string = simple_eval_string
+          conf = Configuration.new do
+            alpha true
+            _load StringIO.new $simple_eval_string
+          end
+          simple_configuration_example conf
         end
 
         it 'settings into a nested configuration from a string' do
-          conf = nil
-          expect do
-            conf = Configuration.new do
-              alpha true
-              bravo do
-                _read "charlie true\ndelta true"
-              end
-              echo { _read "foxtrot true\nhotel true" }
+          $simple_eval_string = simple_eval_string
+          conf = Configuration.new do
+            alpha true
+            bravo do
+              _read $simple_eval_string
             end
-          end.to_not raise_error
-          conf.should_not be_nil
-          conf.alpha.should be_true
-          conf.bravo.should be_a Configuration
-          conf.bravo.charlie.should be_true
-          conf.bravo.delta.should be_true
-          conf.bravo.alpha.should be_true
-          conf.echo.should be_a Configuration
-          conf.echo.foxtrot.should be_true
-          conf.echo.hotel.should be_true
-          conf.echo.alpha.should be_true
+            echo { _read $simple_eval_string }
+            foxtrot true
+          end
+          nested_configuration_example conf
         end
 
         it 'settings into a nested configuration from a file (StringIO)' do
-          io1 = StringIO.new "charlie true
-                              delta true"
-          io2 = StringIO.new "foxtrot true
-                              hotel true"
-          conf = nil
-          expect do
-            conf = Configuration.new do
-              alpha true
-              bravo do
-                _load io1
-              end
-              echo { _load io2 }
+          conf = Configuration.new do
+            alpha true
+            bravo do
+              _load StringIO.new $simple_eval_string
             end
-          end.to_not raise_error
-          conf.should_not be_nil
-          conf.alpha.should be_true
-          conf.bravo.should be_a Configuration
-          conf.bravo.charlie.should be_true
-          conf.bravo.delta.should be_true
-          conf.bravo.alpha.should be_true
-          conf.echo.should be_a Configuration
-          conf.echo.foxtrot.should be_true
-          conf.echo.hotel.should be_true
-          conf.echo.alpha.should be_true
+            echo { _load StringIO.new $simple_eval_string }
+            foxtrot true
+          end
+          nested_configuration_example conf
         end
 
       end # can load
@@ -879,4 +787,37 @@ describe Configuration do
 
   end # mode of usage
 
-end
+  it 'can merge! configurations' do
+    orig = simple_explicit_configuration
+    orig.echo :original1
+    orig.foxtrot :original2
+    other = Configuration.new do
+              foxtrot :overridden
+              hotel :new
+            end
+    conf = orig._merge! other
+    simple_configuration_example conf
+    conf.echo.should be :original1
+    conf.hotel.should be :new
+    conf.foxtrot.should be :overridden
+    conf.should be orig
+  end
+
+  it 'can merge configurations' do
+    orig = simple_explicit_configuration
+    orig.echo :original1
+    orig.foxtrot :original2
+    other = Configuration.new do
+              foxtrot :overridden
+              hotel :new
+            end
+    conf = orig._merge other
+    simple_configuration_example conf
+    conf.echo.should be :original1
+    conf.hotel.should be :new
+    conf.foxtrot.should be :overridden
+    conf.should_not be orig
+  end
+
+end
+