configatron 1.1.0 → 1.2.0

data/README

@@ -31,6 +31,21 @@ becomes:
   
 Notice how our other configuration parameters haven't changed? Cool, eh?
 
+===Hash/YAML
+You can configure configatron from a hash as well:
+
+  configatron.configure_from_hash({:email => {:pop => {:address => 'pop.example.com', :port => 110}}, :smtp => {:address => 'smtp.example.com'}})
+  
+  configatron.email.pop.address # => 'pop.example.com'
+  configatron.email.pop.port # => 110
+  # and so on...
+  
+Notice how they're all namespaced for your as well. The same holds true for YAML files:
+
+  configuration.configure_from_yaml('/path/to/file.yml')
+  
+When the 'reload' method is called on configatron then the YAML file will be re-read in case changes have been made.
+
 ===Namespaces
 
 The question that should be on your lips is what I need to have namespaced configuration parameters. It's easy! Configatron allows you to create namespaces.
@@ -60,6 +75,19 @@ becomes:
   
 Configatron allows you to nest namespaces to your hearts content! Just keep going, it's that easy.
 
+Of course you can update a single parameter n levels deep as well:
+
+  configatron do |config|
+    config.namespace(:email) do |email|
+      email.namespace(:pop) do |pop|
+        pop.address = "pop2.example.com"
+      end
+    end
+  end
+  
+  configatron.email.pop.address # => "pop2.example.com"
+  configatron.email.smtp.address # => "smtp.example.com"
+
 Enjoy!
 
 ==Contact

data/doc/classes/Configatron/Configuration.html

@@ -55,8 +55,8 @@
         <tr class="top-aligned-row">
             <td><strong>In:</strong></td>
             <td>
-                <a href="../../files/lib/configuration_rb.html">
-                lib/configuration.rb
+                <a href="../../files/lib/configatron/configuration_rb.html">
+                lib/configatron/configuration.rb
                 </a>
         <br />
             </td>
@@ -163,7 +163,7 @@ Yields a new <a href="Store.html">Configatron::Store</a> class.
             onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000010-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/configuration.rb, line 18</span>
+    <span class="ruby-comment cmt"># File lib/configatron/configuration.rb, line 18</span>
 18:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configure</span>
 19:       <span class="ruby-identifier">storage</span> = <span class="ruby-constant">Configatron</span><span class="ruby-operator">::</span><span class="ruby-constant">Store</span>.<span class="ruby-identifier">new</span>
 20:       <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">storage</span>
@@ -194,7 +194,7 @@ Used to load configuration settings from a Hash.
             onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000011-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/configuration.rb, line 28</span>
+    <span class="ruby-comment cmt"># File lib/configatron/configuration.rb, line 28</span>
 28:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configure_from_hash</span>(<span class="ruby-identifier">parameters</span>)
 29:       <span class="ruby-identifier">storage</span> = <span class="ruby-constant">Configatron</span><span class="ruby-operator">::</span><span class="ruby-constant">Store</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">parameters</span>)
 30:       <span class="ruby-ivar">@_storage_list</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">storage</span>
@@ -222,7 +222,7 @@ Used to load configuration settings from a YAML file.
             onclick="toggleCode('M000012-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000012-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/configuration.rb, line 35</span>
+    <span class="ruby-comment cmt"># File lib/configatron/configuration.rb, line 35</span>
 35:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configure_from_yaml</span>(<span class="ruby-identifier">path</span>)
 36:       <span class="ruby-keyword kw">begin</span>
 37:         <span class="ruby-identifier">storage</span> = <span class="ruby-constant">Configatron</span><span class="ruby-operator">::</span><span class="ruby-constant">YamlStore</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">path</span>)
@@ -255,7 +255,7 @@ Replays the history of configurations.
             onclick="toggleCode('M000013-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000013-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/configuration.rb, line 47</span>
+    <span class="ruby-comment cmt"># File lib/configatron/configuration.rb, line 47</span>
 47:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reload</span>
 48:       <span class="ruby-ivar">@_storage_list</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">storage</span><span class="ruby-operator">|</span>
 49:         <span class="ruby-identifier">storage</span>.<span class="ruby-identifier">reload</span>
@@ -284,7 +284,7 @@ All methods are undefined.
             onclick="toggleCode('M000015-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000015-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/configuration.rb, line 64</span>
+    <span class="ruby-comment cmt"># File lib/configatron/configuration.rb, line 64</span>
 64:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset</span>
 65:       <span class="ruby-ivar">@_storage_list</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">storage</span><span class="ruby-operator">|</span>
 66:         <span class="ruby-identifier">storage</span>.<span class="ruby-identifier">parameters</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
@@ -323,7 +323,7 @@ to false.
             onclick="toggleCode('M000014-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000014-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/configuration.rb, line 57</span>
+    <span class="ruby-comment cmt"># File lib/configatron/configuration.rb, line 57</span>
 57:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset!</span>
 58:       <span class="ruby-identifier">reset</span>
 59:       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">nil_for_missing</span> = <span class="ruby-keyword kw">false</span>
@@ -351,7 +351,7 @@ Peels back n number of configuration parameters.
             onclick="toggleCode('M000016-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000016-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/configuration.rb, line 78</span>
+    <span class="ruby-comment cmt"># File lib/configatron/configuration.rb, line 78</span>
 78:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">revert</span>(<span class="ruby-identifier">step</span> = <span class="ruby-value">1</span>)
 79:       <span class="ruby-identifier">reset</span>
 80:       <span class="ruby-identifier">step</span>.<span class="ruby-identifier">times</span> {<span class="ruby-ivar">@_storage_list</span>.<span class="ruby-identifier">pop</span>}

data/doc/classes/Configatron/Helpers.html

@@ -55,8 +55,8 @@
         <tr class="top-aligned-row">
             <td><strong>In:</strong></td>
             <td>
-                <a href="../../files/lib/helpers_rb.html">
-                lib/helpers.rb
+                <a href="../../files/lib/configatron/helpers_rb.html">
+                lib/configatron/helpers.rb
                 </a>
         <br />
             </td>
@@ -120,7 +120,7 @@ Checks whether or not configuration parameter exists.
             onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000001-source">
 <pre>
-   <span class="ruby-comment cmt"># File lib/helpers.rb, line 5</span>
+   <span class="ruby-comment cmt"># File lib/configatron/helpers.rb, line 5</span>
 5:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">name</span>)
 6:       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">name</span>)
 7:     <span class="ruby-keyword kw">end</span>
@@ -148,7 +148,7 @@ exist.
             onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000002-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/helpers.rb, line 20</span>
+    <span class="ruby-comment cmt"># File lib/configatron/helpers.rb, line 20</span>
 20:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">retrieve</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default_value</span> = <span class="ruby-constant">ArgumentError</span>)
 21:       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">name</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">name</span>)
 22:       <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">default_value</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">default_value</span> <span class="ruby-operator">==</span> <span class="ruby-constant">ArgumentError</span>

data/doc/classes/Configatron/Store.html

@@ -55,8 +55,8 @@
         <tr class="top-aligned-row">
             <td><strong>In:</strong></td>
             <td>
-                <a href="../../files/lib/store_rb.html">
-                lib/store.rb
+                <a href="../../files/lib/configatron/store_rb.html">
+                lib/configatron/store.rb
                 </a>
         <br />
             </td>
@@ -158,10 +158,14 @@ Takes an optional Hash to configure parameters.
             onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000003-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/store.rb, line 10</span>
+    <span class="ruby-comment cmt"># File lib/configatron/store.rb, line 10</span>
 10:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">parameters</span> = {})
-11:       <span class="ruby-ivar">@parameters</span> = <span class="ruby-identifier">parameters</span>
-12:     <span class="ruby-keyword kw">end</span>
+11:       <span class="ruby-ivar">@parameters</span> = <span class="ruby-identifier">parameters</span>.<span class="ruby-identifier">inject</span>({}) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">m</span>,<span class="ruby-identifier">pair</span><span class="ruby-operator">|</span>
+12:         <span class="ruby-identifier">sym</span> = <span class="ruby-identifier">pair</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Symbol</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">pair</span>.<span class="ruby-identifier">first</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">pair</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">intern</span>
+13:         <span class="ruby-identifier">m</span>[<span class="ruby-identifier">sym</span>] = <span class="ruby-identifier">pair</span>.<span class="ruby-identifier">last</span>
+14:         <span class="ruby-identifier">m</span>
+15:       <span class="ruby-keyword kw">end</span>
+16:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
@@ -186,11 +190,11 @@ Checks whether or not configuration parameter exists.
             onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000005-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/store.rb, line 30</span>
-30:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">name</span>)
-31:       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@parameters</span>[<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>].<span class="ruby-identifier">nil?</span>
-32:       <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">name</span>)
-33:     <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/configatron/store.rb, line 37</span>
+37:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">name</span>)
+38:       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@parameters</span>[<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>].<span class="ruby-identifier">nil?</span>
+39:       <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">name</span>)
+40:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
@@ -217,16 +221,19 @@ from the parameters hash is returned, if it exists.
             onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000004-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/store.rb, line 19</span>
-19:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">sym</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
-20:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">sym</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/(.+)=$/</span>)
-21:         <span class="ruby-ivar">@parameters</span>[<span class="ruby-identifier">sym</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">&quot;=&quot;</span>, <span class="ruby-value str">''</span>).<span class="ruby-identifier">to_sym</span>] = <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>
-22:       <span class="ruby-keyword kw">else</span>
-23:         <span class="ruby-identifier">val</span> = <span class="ruby-ivar">@parameters</span>[<span class="ruby-identifier">sym</span>]
-24:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">val</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">nil?</span>
-25:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">handle_missing_parameter</span>(<span class="ruby-identifier">sym</span>)
-26:       <span class="ruby-keyword kw">end</span>
-27:     <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/configatron/store.rb, line 23</span>
+23:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">sym</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+24:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">sym</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/(.+)=$/</span>)
+25:         <span class="ruby-ivar">@parameters</span>[<span class="ruby-identifier">sym</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">&quot;=&quot;</span>, <span class="ruby-value str">''</span>).<span class="ruby-identifier">to_sym</span>] = <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>
+26:       <span class="ruby-keyword kw">else</span>
+27:         <span class="ruby-identifier">val</span> = <span class="ruby-ivar">@parameters</span>[<span class="ruby-identifier">sym</span>]
+28:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Hash</span>
+29:           <span class="ruby-identifier">val</span> = (<span class="ruby-ivar">@parameters</span>[<span class="ruby-identifier">sym</span>] = <span class="ruby-constant">Configatron</span><span class="ruby-operator">::</span><span class="ruby-constant">Store</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">val</span>))
+30:         <span class="ruby-keyword kw">end</span>
+31:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">val</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">nil?</span>
+32:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">handle_missing_parameter</span>(<span class="ruby-identifier">sym</span>)
+33:       <span class="ruby-keyword kw">end</span>
+34:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
@@ -250,18 +257,18 @@ parameters.
             onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000006-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/store.rb, line 36</span>
-36:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">namespace</span>(<span class="ruby-identifier">name</span>)
-37:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">name</span>)
-38:         <span class="ruby-keyword kw">yield</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>)
-39:       <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">configatron</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">name</span>)
-40:         <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">configatron</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>)
-41:       <span class="ruby-keyword kw">else</span>
-42:         <span class="ruby-identifier">ns</span> = <span class="ruby-constant">Configatron</span><span class="ruby-operator">::</span><span class="ruby-constant">Store</span>.<span class="ruby-identifier">new</span>
-43:         <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">ns</span>
-44:         <span class="ruby-ivar">@parameters</span>[<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>] = <span class="ruby-identifier">ns</span>
-45:       <span class="ruby-keyword kw">end</span>
-46:     <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/configatron/store.rb, line 43</span>
+43:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">namespace</span>(<span class="ruby-identifier">name</span>)
+44:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">name</span>)
+45:         <span class="ruby-keyword kw">yield</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>)
+46:       <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">configatron</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">name</span>)
+47:         <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">configatron</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>)
+48:       <span class="ruby-keyword kw">else</span>
+49:         <span class="ruby-identifier">ns</span> = <span class="ruby-constant">Configatron</span><span class="ruby-operator">::</span><span class="ruby-constant">Store</span>.<span class="ruby-identifier">new</span>
+50:         <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">ns</span>
+51:         <span class="ruby-ivar">@parameters</span>[<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>] = <span class="ruby-identifier">ns</span>
+52:       <span class="ruby-keyword kw">end</span>
+53:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
@@ -286,9 +293,9 @@ etc&#8230;
             onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000007-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/store.rb, line 50</span>
-50:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reload</span>
-51:     <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/configatron/store.rb, line 57</span>
+57:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reload</span>
+58:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>

data/doc/classes/Configatron/YamlStore.html

@@ -55,8 +55,8 @@
         <tr class="top-aligned-row">
             <td><strong>In:</strong></td>
             <td>
-                <a href="../../files/lib/yaml_store_rb.html">
-                lib/yaml_store.rb
+                <a href="../../files/lib/configatron/yaml_store_rb.html">
+                lib/configatron/yaml_store.rb
                 </a>
         <br />
             </td>
@@ -148,7 +148,7 @@ Takes the full path to the YAML file.
             onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000008-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/yaml_store.rb, line 9</span>
+    <span class="ruby-comment cmt"># File lib/configatron/yaml_store.rb, line 9</span>
  9:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">file_location</span>)
 10:       <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">params_from_yaml</span>(<span class="ruby-identifier">file_location</span>))
 11:       <span class="ruby-ivar">@file_location</span> = <span class="ruby-identifier">file_location</span>
@@ -177,7 +177,7 @@ Re-reads the YAML file.
             onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000009-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/yaml_store.rb, line 15</span>
+    <span class="ruby-comment cmt"># File lib/configatron/yaml_store.rb, line 15</span>
 15:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reload</span>
 16:       <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">file_location</span>
 17:         <span class="ruby-identifier">params_from_yaml</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">file_location</span>)

data/doc/classes/Kernel.html

@@ -55,8 +55,8 @@
         <tr class="top-aligned-row">
             <td><strong>In:</strong></td>
             <td>
-                <a href="../files/lib/kernel_rb.html">
-                lib/kernel.rb
+                <a href="../files/lib/configatron/kernel_rb.html">
+                lib/configatron/kernel.rb
                 </a>
         <br />
             </td>
@@ -123,7 +123,7 @@ href="Configatron/Store.html">Configatron::Store</a> object.
             onclick="toggleCode('M000017-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000017-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/kernel.rb, line 6</span>
+    <span class="ruby-comment cmt"># File lib/configatron/kernel.rb, line 6</span>
  6:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configatron</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
  7:     <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
  8:       <span class="ruby-constant">Configatron</span><span class="ruby-operator">::</span><span class="ruby-constant">Configuration</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">configure</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)

data/doc/created.rid

@@ -1 +1 @@
-Thu, 04 Sep 2008 13:46:36 -0400
+Mon, 08 Sep 2008 15:54:51 -0400

data/doc/files/README.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Fri Aug 29 12:07:47 -0400 2008</td>
+      <td>Mon Sep 08 15:54:42 -0400 2008</td>
     </tr>
     </table>
   </div>
@@ -120,6 +120,28 @@ becomes:
 Notice how our other configuration parameters haven&#8216;t changed? Cool,
 eh?
 </p>
+<h3>Hash/YAML</h3>
+<p>
+You can configure configatron from a hash as well:
+</p>
+<pre>
+  configatron.configure_from_hash({:email =&gt; {:pop =&gt; {:address =&gt; 'pop.example.com', :port =&gt; 110}}, :smtp =&gt; {:address =&gt; 'smtp.example.com'}})
+
+  configatron.email.pop.address # =&gt; 'pop.example.com'
+  configatron.email.pop.port # =&gt; 110
+  # and so on...
+</pre>
+<p>
+Notice how they&#8216;re all namespaced for your as well. The same holds
+true for YAML files:
+</p>
+<pre>
+  configuration.configure_from_yaml('/path/to/file.yml')
+</pre>
+<p>
+When the &#8216;reload&#8217; method is called on configatron then the YAML
+file will be re-read in case changes have been made.
+</p>
 <h3>Namespaces</h3>
 <p>
 The question that should be on your lips is what I need to have namespaced
@@ -157,6 +179,21 @@ Configatron allows you to nest namespaces to your hearts content! Just keep
 going, it&#8216;s that easy.
 </p>
 <p>
+Of course you can update a single parameter n levels deep as well:
+</p>
+<pre>
+  configatron do |config|
+    config.namespace(:email) do |email|
+      email.namespace(:pop) do |pop|
+        pop.address = &quot;pop2.example.com&quot;
+      end
+    end
+  end
+
+  configatron.email.pop.address # =&gt; &quot;pop2.example.com&quot;
+  configatron.email.smtp.address # =&gt; &quot;smtp.example.com&quot;
+</pre>
+<p>
 Enjoy!
 </p>
 <h2>Contact</h2>

data/doc/files/lib/{configuration_rb.html → configatron/configuration_rb.html}

@@ -8,7 +8,7 @@
   <title>File: configuration.rb</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
   <script type="text/javascript">
   // <![CDATA[
 
@@ -51,12 +51,12 @@
     <table class="header-table">
     <tr class="top-aligned-row">
       <td><strong>Path:</strong></td>
-      <td>lib/configuration.rb
+      <td>lib/configatron/configuration.rb
       </td>
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Sep 04 11:12:56 -0400 2008</td>
+      <td>Mon Sep 08 15:47:41 -0400 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/{helpers_rb.html → configatron/helpers_rb.html}

@@ -8,7 +8,7 @@
   <title>File: helpers.rb</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
   <script type="text/javascript">
   // <![CDATA[
 
@@ -51,12 +51,12 @@
     <table class="header-table">
     <tr class="top-aligned-row">
       <td><strong>Path:</strong></td>
-      <td>lib/helpers.rb
+      <td>lib/configatron/helpers.rb
       </td>
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Fri Aug 29 12:12:51 -0400 2008</td>
+      <td>Mon Sep 08 14:47:48 -0400 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/{kernel_rb.html → configatron/kernel_rb.html}

@@ -8,7 +8,7 @@
   <title>File: kernel.rb</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
   <script type="text/javascript">
   // <![CDATA[
 
@@ -51,12 +51,12 @@
     <table class="header-table">
     <tr class="top-aligned-row">
       <td><strong>Path:</strong></td>
-      <td>lib/kernel.rb
+      <td>lib/configatron/kernel.rb
       </td>
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Jun 12 11:49:05 -0400 2008</td>
+      <td>Mon Sep 08 14:47:48 -0400 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/{store_rb.html → configatron/store_rb.html}

@@ -8,7 +8,7 @@
   <title>File: store.rb</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
   <script type="text/javascript">
   // <![CDATA[
 
@@ -51,12 +51,12 @@
     <table class="header-table">
     <tr class="top-aligned-row">
       <td><strong>Path:</strong></td>
-      <td>lib/store.rb
+      <td>lib/configatron/store.rb
       </td>
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Sep 04 11:16:41 -0400 2008</td>
+      <td>Mon Sep 08 15:47:41 -0400 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/{yaml_store_rb.html → configatron/yaml_store_rb.html}

@@ -8,7 +8,7 @@
   <title>File: yaml_store.rb</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
   <script type="text/javascript">
   // <![CDATA[
 
@@ -51,12 +51,12 @@
     <table class="header-table">
     <tr class="top-aligned-row">
       <td><strong>Path:</strong></td>
-      <td>lib/yaml_store.rb
+      <td>lib/configatron/yaml_store.rb
       </td>
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Sep 04 11:17:28 -0400 2008</td>
+      <td>Mon Sep 08 14:47:48 -0400 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/configatron_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Sep 04 11:15:39 -0400 2008</td>
+      <td>Mon Sep 08 14:47:47 -0400 2008</td>
     </tr>
     </table>
   </div>

data/doc/fr_file_index.html

@@ -22,11 +22,11 @@
   <div id="index-entries">
     <a href="files/README.html">README</a><br />
     <a href="files/lib/configatron_rb.html">lib/configatron.rb</a><br />
-    <a href="files/lib/configuration_rb.html">lib/configuration.rb</a><br />
-    <a href="files/lib/helpers_rb.html">lib/helpers.rb</a><br />
-    <a href="files/lib/kernel_rb.html">lib/kernel.rb</a><br />
-    <a href="files/lib/store_rb.html">lib/store.rb</a><br />
-    <a href="files/lib/yaml_store_rb.html">lib/yaml_store.rb</a><br />
+    <a href="files/lib/configatron/configuration_rb.html">lib/configatron/configuration.rb</a><br />
+    <a href="files/lib/configatron/helpers_rb.html">lib/configatron/helpers.rb</a><br />
+    <a href="files/lib/configatron/kernel_rb.html">lib/configatron/kernel.rb</a><br />
+    <a href="files/lib/configatron/store_rb.html">lib/configatron/store.rb</a><br />
+    <a href="files/lib/configatron/yaml_store_rb.html">lib/configatron/yaml_store.rb</a><br />
   </div>
 </div>
 </body>

data/lib/{configuration.rb → configatron/configuration.rb}

@@ -91,6 +91,9 @@ module Configatron
         if k.is_a?(Configatron::Store)
           load_methods(k)
         else
+          if v.is_a?(Hash)
+            v = (store.parameters[k] = Configatron::Store.new(v))
+          end
           Configatron::Configuration.instance_eval do
             define_method(k) do
               v

data/lib/{store.rb → configatron/store.rb}

@@ -8,7 +8,11 @@ module Configatron
   
     # Takes an optional Hash to configure parameters.
     def initialize(parameters = {})
-      @parameters = parameters
+      @parameters = parameters.inject({}) do |m,pair|
+        sym = pair.first.is_a?(Symbol) ? pair.first : pair.first.intern
+        m[sym] = pair.last
+        m
+      end
     end
   
     # If a method is called with an = at the end, then that method name, minus
@@ -21,6 +25,9 @@ module Configatron
         @parameters[sym.to_s.gsub("=", '').to_sym] = *args
       else
         val = @parameters[sym]
+        if val.is_a? Hash
+          val = (@parameters[sym] = Configatron::Store.new(val))
+        end
         return val unless val.nil?
         return handle_missing_parameter(sym)
       end

data/lib/configatron.rb

@@ -1,10 +1,11 @@
 require 'singleton'
 require 'yaml'
-require File.join(File.dirname(__FILE__), 'helpers')
-require File.join(File.dirname(__FILE__), 'kernel')
-require File.join(File.dirname(__FILE__), 'configuration')
-require File.join(File.dirname(__FILE__), 'store')
-require File.join(File.dirname(__FILE__), 'yaml_store')
+
+require File.join(File.dirname(__FILE__), 'configatron', 'helpers')
+require File.join(File.dirname(__FILE__), 'configatron', 'kernel')
+require File.join(File.dirname(__FILE__), 'configatron', 'configuration')
+require File.join(File.dirname(__FILE__), 'configatron', 'store')
+require File.join(File.dirname(__FILE__), 'configatron', 'yaml_store')
 
 module Configatron # :nodoc:
 end

data/spec/unit/configuration_spec.rb

@@ -30,6 +30,62 @@ describe Configatron::Configuration do
     
   end
   
+  describe "hashes to namespace" do
+    
+    before :each do
+      configatron.reset!
+      @futurama = File.join(File.dirname(__FILE__), 'futurama.yml')
+      FileUtils.rm_f(@futurama)
+    end
+
+    after :each do
+      FileUtils.rm_f(@futurama)
+    end
+    
+    it "should namespace hashes from yaml" do
+      
+      configatron.should_not respond_to(:cartoon)
+      
+      File.open(@futurama, 'w') do |f|
+        f.puts %{
+cartoon:
+  characters:
+    fry: human
+    leela: mutant
+    bender: robot
+  transportation: space ship
+  fans:
+    one: Mark Bates
+    two: Dylan Bates
+        }
+      end
+      
+      configatron.configure_from_yaml(@futurama)
+      
+      configatron.should respond_to(:cartoon)
+      configatron.cartoon.should be_an_instance_of(Configatron::Store)
+      
+      configatron.cartoon.characters.fry.should == 'human'
+      configatron.cartoon.transportation.should == 'space ship'
+      
+    end
+    
+    it "should namespace hashes" do
+      
+      configatron.should_not respond_to(:cartoon)
+      
+      configatron.configure_from_hash({:cartoon => {:characters => {:fry => 'human', :leela => 'mutant', :bender => 'robot'}, :transportation => 'space ship'}, :fans => {:one => 'Mark Bates', :two => 'Dylan Bates'}})
+      
+      configatron.should respond_to(:cartoon)
+      configatron.cartoon.should be_an_instance_of(Configatron::Store)
+      
+      configatron.cartoon.characters.fry.should == 'human'
+      configatron.cartoon.transportation.should == 'space ship'
+      
+    end
+    
+  end
+  
   describe "configure_from_yaml" do
     
     before :each do
@@ -55,7 +111,7 @@ describe Configatron::Configuration do
       configatron.lois.should == "Lois Griffin"
     end
     
-    it "should silently file if the file doesn't exist" do
+    it "should silently fail if the file doesn't exist" do
       lambda {configatron.configure_from_yaml(File.join(File.dirname(__FILE__), 'i_dont_exist.yml'))}.should_not raise_error(Errno::ENOENT)
     end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: configatron
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - markbates
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-04 00:00:00 -04:00
+date: 2008-09-08 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -22,12 +22,12 @@ extensions: []
 extra_rdoc_files: 
 - README
 files: 
+- lib/configatron/configuration.rb
+- lib/configatron/helpers.rb
+- lib/configatron/kernel.rb
+- lib/configatron/store.rb
+- lib/configatron/yaml_store.rb
 - lib/configatron.rb
-- lib/configuration.rb
-- lib/helpers.rb
-- lib/kernel.rb
-- lib/store.rb
-- lib/yaml_store.rb
 - README
 - doc/classes/Configatron/Configuration.html
 - doc/classes/Configatron/Helpers.html
@@ -35,12 +35,12 @@ files:
 - doc/classes/Configatron/YamlStore.html
 - doc/classes/Kernel.html
 - doc/created.rid
+- doc/files/lib/configatron/configuration_rb.html
+- doc/files/lib/configatron/helpers_rb.html
+- doc/files/lib/configatron/kernel_rb.html
+- doc/files/lib/configatron/store_rb.html
+- doc/files/lib/configatron/yaml_store_rb.html
 - doc/files/lib/configatron_rb.html
-- doc/files/lib/configuration_rb.html
-- doc/files/lib/helpers_rb.html
-- doc/files/lib/kernel_rb.html
-- doc/files/lib/store_rb.html
-- doc/files/lib/yaml_store_rb.html
 - doc/files/README.html
 - doc/fr_class_index.html
 - doc/fr_file_index.html