configatron 1.0.1 → 1.1.0

data/doc/classes/Configatron/Configuration.html

@@ -92,12 +92,13 @@ The central class for managing the configurations.
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000007">configure</a>&nbsp;&nbsp;
-      <a href="#M000008">configure_from_hash</a>&nbsp;&nbsp;
-      <a href="#M000009">reload</a>&nbsp;&nbsp;
-      <a href="#M000011">reset</a>&nbsp;&nbsp;
-      <a href="#M000010">reset!</a>&nbsp;&nbsp;
-      <a href="#M000012">revert</a>&nbsp;&nbsp;
+      <a href="#M000010">configure</a>&nbsp;&nbsp;
+      <a href="#M000011">configure_from_hash</a>&nbsp;&nbsp;
+      <a href="#M000012">configure_from_yaml</a>&nbsp;&nbsp;
+      <a href="#M000013">reload</a>&nbsp;&nbsp;
+      <a href="#M000015">reset</a>&nbsp;&nbsp;
+      <a href="#M000014">reset!</a>&nbsp;&nbsp;
+      <a href="#M000016">revert</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -145,11 +146,11 @@ NoMethodError exception will be raised.
     <div id="methods">
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000007" class="method-detail">
-        <a name="M000007"></a>
+      <div id="method-M000010" class="method-detail">
+        <a name="M000010"></a>
 
         <div class="method-heading">
-          <a href="#M000007" class="method-signature">
+          <a href="#M000010" class="method-signature">
           <span class="method-name">configure</span><span class="method-args">() {|storage| ...}</span>
           </a>
         </div>
@@ -159,8 +160,8 @@ NoMethodError exception will be raised.
 Yields a new <a href="Store.html">Configatron::Store</a> class.
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000007-source">
+            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>
 18:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configure</span>
@@ -176,11 +177,11 @@ Yields a new <a href="Store.html">Configatron::Store</a> class.
         </div>
       </div>
 
-      <div id="method-M000008" class="method-detail">
-        <a name="M000008"></a>
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
 
         <div class="method-heading">
-          <a href="#M000008" class="method-signature">
+          <a href="#M000011" class="method-signature">
           <span class="method-name">configure_from_hash</span><span class="method-args">(parameters)</span>
           </a>
         </div>
@@ -190,8 +191,8 @@ Yields a new <a href="Store.html">Configatron::Store</a> class.
 Used to load configuration settings from a Hash.
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000008-source">
+            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>
 28:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configure_from_hash</span>(<span class="ruby-identifier">parameters</span>)
@@ -204,11 +205,44 @@ Used to load configuration settings from a Hash.
         </div>
       </div>
 
-      <div id="method-M000009" class="method-detail">
-        <a name="M000009"></a>
+      <div id="method-M000012" class="method-detail">
+        <a name="M000012"></a>
 
         <div class="method-heading">
-          <a href="#M000009" class="method-signature">
+          <a href="#M000012" class="method-signature">
+          <span class="method-name">configure_from_yaml</span><span class="method-args">(path)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Used to load configuration settings from a YAML file.
+</p>
+          <p><a class="source-toggle" href="#"
+            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>
+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>)
+38:         <span class="ruby-ivar">@_storage_list</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">storage</span>
+39:         <span class="ruby-identifier">load_methods</span>(<span class="ruby-identifier">storage</span>)
+40:       <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENOENT</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
+41:         <span class="ruby-identifier">puts</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span>
+42:         <span class="ruby-comment cmt"># file doesn't exist.</span>
+43:       <span class="ruby-keyword kw">end</span>
+44:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000013" class="method-detail">
+        <a name="M000013"></a>
+
+        <div class="method-heading">
+          <a href="#M000013" class="method-signature">
           <span class="method-name">reload</span><span class="method-args">()</span>
           </a>
         </div>
@@ -218,25 +252,26 @@ Used to load configuration settings from a Hash.
 Replays the history of configurations.
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000009-source">
+            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 35</span>
-35:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reload</span>
-36:       <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>
-37:         <span class="ruby-identifier">load_methods</span>(<span class="ruby-identifier">storage</span>)
-38:       <span class="ruby-keyword kw">end</span>
-39:     <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/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>
+50:         <span class="ruby-identifier">load_methods</span>(<span class="ruby-identifier">storage</span>)
+51:       <span class="ruby-keyword kw">end</span>
+52:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
       </div>
 
-      <div id="method-M000011" class="method-detail">
-        <a name="M000011"></a>
+      <div id="method-M000015" class="method-detail">
+        <a name="M000015"></a>
 
         <div class="method-heading">
-          <a href="#M000011" class="method-signature">
+          <a href="#M000015" class="method-signature">
           <span class="method-name">reset</span><span class="method-args">()</span>
           </a>
         </div>
@@ -246,64 +281,64 @@ Replays the history of configurations.
 All methods are undefined.
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000011-source">
+            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 51</span>
-51:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset</span>
-52:       <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>
-53:         <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>
-54:           <span class="ruby-constant">Configatron</span><span class="ruby-operator">::</span><span class="ruby-constant">Configuration</span>.<span class="ruby-identifier">instance_eval</span> <span class="ruby-keyword kw">do</span>
-55:             <span class="ruby-keyword kw">begin</span>
-56:               <span class="ruby-identifier">undef_method</span>(<span class="ruby-identifier">k</span>)
-57:             <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">NameError</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
-58:             <span class="ruby-keyword kw">end</span>
-59:           <span class="ruby-keyword kw">end</span>
-60:         <span class="ruby-keyword kw">end</span>
-61:       <span class="ruby-keyword kw">end</span>
-62:     <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/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>
+67:           <span class="ruby-constant">Configatron</span><span class="ruby-operator">::</span><span class="ruby-constant">Configuration</span>.<span class="ruby-identifier">instance_eval</span> <span class="ruby-keyword kw">do</span>
+68:             <span class="ruby-keyword kw">begin</span>
+69:               <span class="ruby-identifier">undef_method</span>(<span class="ruby-identifier">k</span>)
+70:             <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">NameError</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
+71:             <span class="ruby-keyword kw">end</span>
+72:           <span class="ruby-keyword kw">end</span>
+73:         <span class="ruby-keyword kw">end</span>
+74:       <span class="ruby-keyword kw">end</span>
+75:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
       </div>
 
-      <div id="method-M000010" class="method-detail">
-        <a name="M000010"></a>
+      <div id="method-M000014" class="method-detail">
+        <a name="M000014"></a>
 
         <div class="method-heading">
-          <a href="#M000010" class="method-signature">
+          <a href="#M000014" class="method-signature">
           <span class="method-name">reset!</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-Does a hard <a href="Configuration.html#M000011">reset</a> of the <a
+Does a hard <a href="Configuration.html#M000015">reset</a> of the <a
 href="Configuration.html">Configatron::Configuration</a> class. All methods
 are undefined, the list of configuration parameters is emptied, and the
-nil_for_missing method gets <a href="Configuration.html#M000011">reset</a>
+nil_for_missing method gets <a href="Configuration.html#M000015">reset</a>
 to false.
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000010-source">
+            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 44</span>
-44:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset!</span>
-45:       <span class="ruby-identifier">reset</span>
-46:       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">nil_for_missing</span> = <span class="ruby-keyword kw">false</span>
-47:       <span class="ruby-ivar">@_storage_list</span> = []
-48:     <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/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>
+60:       <span class="ruby-ivar">@_storage_list</span> = []
+61:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
       </div>
 
-      <div id="method-M000012" class="method-detail">
-        <a name="M000012"></a>
+      <div id="method-M000016" class="method-detail">
+        <a name="M000016"></a>
 
         <div class="method-heading">
-          <a href="#M000012" class="method-signature">
+          <a href="#M000016" class="method-signature">
           <span class="method-name">revert</span><span class="method-args">(step = 1)</span>
           </a>
         </div>
@@ -313,15 +348,15 @@ to false.
 Peels back n number of configuration parameters.
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000012-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000012-source">
+            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 65</span>
-65:     <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>)
-66:       <span class="ruby-identifier">reset</span>
-67:       <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>}
-68:       <span class="ruby-identifier">reload</span>
-69:     <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/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>}
+81:       <span class="ruby-identifier">reload</span>
+82:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>

data/doc/classes/Configatron/Store.html

@@ -96,6 +96,7 @@ Used to store each of the ‘sets’ of configuration parameters.
       <a href="#M000004">method_missing</a>&nbsp;&nbsp;
       <a href="#M000006">namespace</a>&nbsp;&nbsp;
       <a href="#M000003">new</a>&nbsp;&nbsp;
+      <a href="#M000007">reload</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -266,6 +267,33 @@ parameters.
         </div>
       </div>
 
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
+
+        <div class="method-heading">
+          <a href="#M000007" class="method-signature">
+          <span class="method-name">reload</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Called when a <a href="Store.html#M000007">reload</a> is called on
+configatron. Useful for subclasses that may need to read a file in,
+etc&#8230;
+</p>
+          <p><a class="source-toggle" href="#"
+            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>
+</pre>
+          </div>
+        </div>
+      </div>
+
 
     </div>
 

data/doc/classes/Configatron/YamlStore.html

@@ -0,0 +1,203 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Configatron::YamlStore</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" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Configatron::YamlStore</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/yaml_store_rb.html">
+                lib/yaml_store.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="Store.html">
+                Configatron::Store
+               </a>
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+Used to store each of the &#8216;sets&#8217; of configuration parameters
+that came from a YAML file.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000008">new</a>&nbsp;&nbsp;
+      <a href="#M000009">reload</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">file_location</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+
+        <div class="method-heading">
+          <a href="#M000008" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(file_location)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Takes the full path to the YAML file.
+</p>
+          <p><a class="source-toggle" href="#"
+            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>
+ 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>
+12:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
+
+        <div class="method-heading">
+          <a href="#M000009" class="method-signature">
+          <span class="method-name">reload</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Re-reads the YAML file.
+</p>
+          <p><a class="source-toggle" href="#"
+            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>
+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>)
+18:       <span class="ruby-keyword kw">end</span>
+19:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/classes/Kernel.html

@@ -80,7 +80,7 @@
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000013">configatron</a>&nbsp;&nbsp;
+      <a href="#M000017">configatron</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -102,11 +102,11 @@
     <div id="methods">
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000013" class="method-detail">
-        <a name="M000013"></a>
+      <div id="method-M000017" class="method-detail">
+        <a name="M000017"></a>
 
         <div class="method-heading">
-          <a href="#M000013" class="method-signature">
+          <a href="#M000017" class="method-signature">
           <span class="method-name">configatron</span><span class="method-args">(&amp;block)</span>
           </a>
         </div>
@@ -120,8 +120,8 @@ Configatron::Configatron configure method and yield up a <a
 href="Configatron/Store.html">Configatron::Store</a> object.
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000013-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000013-source">
+            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>
  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>)

data/doc/created.rid

@@ -1 +1 @@
-Fri, 29 Aug 2008 12:14:31 -0400
+Thu, 04 Sep 2008 13:46:36 -0400

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 Jun 12 13:05:51 -0400 2008</td>
+      <td>Thu Sep 04 11:15:39 -0400 2008</td>
     </tr>
     </table>
   </div>
@@ -74,6 +74,7 @@
 
       <div class="name-list">
       singleton&nbsp;&nbsp;
+      yaml&nbsp;&nbsp;
       </div>
     </div>
 

data/doc/files/lib/configuration_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Fri Aug 29 12:10:22 -0400 2008</td>
+      <td>Thu Sep 04 11:12:56 -0400 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/store_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Fri Aug 29 12:12:56 -0400 2008</td>
+      <td>Thu Sep 04 11:16:41 -0400 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/yaml_store_rb.html

@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <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" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+  <div id="fileHeader">
+    <h1>yaml_store.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>lib/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>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/fr_class_index.html

@@ -23,6 +23,7 @@
     <a href="classes/Configatron/Configuration.html">Configatron::Configuration</a><br />
     <a href="classes/Configatron/Helpers.html">Configatron::Helpers</a><br />
     <a href="classes/Configatron/Store.html">Configatron::Store</a><br />
+    <a href="classes/Configatron/YamlStore.html">Configatron::YamlStore</a><br />
     <a href="classes/Kernel.html">Kernel</a><br />
   </div>
 </div>

data/doc/fr_file_index.html

@@ -26,6 +26,7 @@
     <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 />
   </div>
 </div>
 </body>

data/doc/fr_method_index.html

@@ -20,19 +20,23 @@
 <div id="index">
   <h1 class="section-bar">Methods</h1>
   <div id="index-entries">
-    <a href="classes/Kernel.html#M000013">configatron (Kernel)</a><br />
-    <a href="classes/Configatron/Configuration.html#M000007">configure (Configatron::Configuration)</a><br />
-    <a href="classes/Configatron/Configuration.html#M000008">configure_from_hash (Configatron::Configuration)</a><br />
+    <a href="classes/Kernel.html#M000017">configatron (Kernel)</a><br />
+    <a href="classes/Configatron/Configuration.html#M000010">configure (Configatron::Configuration)</a><br />
+    <a href="classes/Configatron/Configuration.html#M000011">configure_from_hash (Configatron::Configuration)</a><br />
+    <a href="classes/Configatron/Configuration.html#M000012">configure_from_yaml (Configatron::Configuration)</a><br />
     <a href="classes/Configatron/Store.html#M000005">exists? (Configatron::Store)</a><br />
     <a href="classes/Configatron/Helpers.html#M000001">exists? (Configatron::Helpers)</a><br />
     <a href="classes/Configatron/Store.html#M000004">method_missing (Configatron::Store)</a><br />
     <a href="classes/Configatron/Store.html#M000006">namespace (Configatron::Store)</a><br />
+    <a href="classes/Configatron/YamlStore.html#M000008">new (Configatron::YamlStore)</a><br />
     <a href="classes/Configatron/Store.html#M000003">new (Configatron::Store)</a><br />
-    <a href="classes/Configatron/Configuration.html#M000009">reload (Configatron::Configuration)</a><br />
-    <a href="classes/Configatron/Configuration.html#M000011">reset (Configatron::Configuration)</a><br />
-    <a href="classes/Configatron/Configuration.html#M000010">reset! (Configatron::Configuration)</a><br />
+    <a href="classes/Configatron/Store.html#M000007">reload (Configatron::Store)</a><br />
+    <a href="classes/Configatron/Configuration.html#M000013">reload (Configatron::Configuration)</a><br />
+    <a href="classes/Configatron/YamlStore.html#M000009">reload (Configatron::YamlStore)</a><br />
+    <a href="classes/Configatron/Configuration.html#M000015">reset (Configatron::Configuration)</a><br />
+    <a href="classes/Configatron/Configuration.html#M000014">reset! (Configatron::Configuration)</a><br />
     <a href="classes/Configatron/Helpers.html#M000002">retrieve (Configatron::Helpers)</a><br />
-    <a href="classes/Configatron/Configuration.html#M000012">revert (Configatron::Configuration)</a><br />
+    <a href="classes/Configatron/Configuration.html#M000016">revert (Configatron::Configuration)</a><br />
   </div>
 </div>
 </body>

data/lib/configatron.rb

@@ -1,8 +1,10 @@
 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')
 
 module Configatron # :nodoc:
 end

data/lib/configuration.rb

@@ -31,9 +31,22 @@ module Configatron
       load_methods(storage)
     end
     
+    # Used to load configuration settings from a YAML file.
+    def configure_from_yaml(path)
+      begin
+        storage = Configatron::YamlStore.new(path)
+        @_storage_list << storage
+        load_methods(storage)
+      rescue Errno::ENOENT => e
+        puts e.message
+        # file doesn't exist.
+      end
+    end
+    
     # Replays the history of configurations.
     def reload
       @_storage_list.each do |storage|
+        storage.reload
         load_methods(storage)
       end
     end

data/lib/store.rb

@@ -44,6 +44,11 @@ module Configatron
         @parameters[name.to_sym] = ns
       end
     end
+    
+    # Called when a reload is called on configatron. Useful for subclasses that 
+    # may need to read a file in, etc...
+    def reload
+    end
   
   end # Store
 end # Configatron

data/lib/yaml_store.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__), 'store')
+module Configatron
+  # Used to store each of the 'sets' of configuration parameters that came from a YAML file.
+  class YamlStore < Configatron::Store
+    
+    attr_accessor :file_location
+    
+    # Takes the full path to the YAML file.
+    def initialize(file_location)
+      super(params_from_yaml(file_location))
+      @file_location = file_location
+    end
+    
+    # Re-reads the YAML file.
+    def reload
+      if self.file_location
+        params_from_yaml(self.file_location)
+      end
+    end
+    
+    private
+    def params_from_yaml(file_location)
+      begin
+        @parameters = YAML.load(File.read(file_location))
+        return @parameters
+      rescue Errno::ENOENT => e
+        puts e
+      end
+      return {}
+    end
+    
+  end
+end

data/spec/unit/configuration_spec.rb

@@ -1,3 +1,4 @@
+require 'fileutils'
 require 'pathname'
 require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
 
@@ -29,6 +30,66 @@ describe Configatron::Configuration do
     
   end
   
+  describe "configure_from_yaml" 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 take a path to YAML file and use it configure configatron" do
+      configatron.should_not respond_to(:family_guy)
+      configatron.should_not respond_to(:lois)
+      
+      configatron.configure_from_yaml(File.join(File.dirname(__FILE__), 'family_guy.yml'))
+      
+      configatron.should respond_to(:family_guy)
+      configatron.should respond_to(:lois)
+      
+      configatron.family_guy.should == "Peter Griffin"
+      configatron.lois.should == "Lois Griffin"
+    end
+    
+    it "should silently file 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
+    
+    it "should re-read the file during a reload" do
+      File.open(@futurama, 'w') do |f|
+        f.puts 'bender: robot'
+        f.puts 'fry: human'
+      end
+      
+      configatron.should_not respond_to(:bender)
+      configatron.should_not respond_to(:fry)
+      
+      configatron.configure_from_yaml(@futurama)
+      
+      configatron.should respond_to(:bender)
+      configatron.should respond_to(:fry)
+      
+      configatron.bender.should == 'robot'
+      configatron.fry.should == 'human'
+      
+      File.open(@futurama, 'w') do |f|
+        f.puts 'bender: Bending Robot'
+        f.puts 'fry: Human Male'
+      end
+      
+      configatron.reload
+      
+      configatron.bender.should == 'Bending Robot'
+      configatron.fry.should == 'Human Male'
+      
+    end
+    
+  end
+  
   describe "revert" do
     
     it "should roll back 1 level by default" do

data/spec/unit/family_guy.yml

@@ -0,0 +1,2 @@
+family_guy: Peter Griffin
+lois: Lois Griffin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: configatron
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
 - markbates
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-29 00:00:00 -04:00
+date: 2008-09-04 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -27,10 +27,12 @@ files:
 - lib/helpers.rb
 - lib/kernel.rb
 - lib/store.rb
+- lib/yaml_store.rb
 - README
 - doc/classes/Configatron/Configuration.html
 - doc/classes/Configatron/Helpers.html
 - doc/classes/Configatron/Store.html
+- doc/classes/Configatron/YamlStore.html
 - doc/classes/Kernel.html
 - doc/created.rid
 - doc/files/lib/configatron_rb.html
@@ -38,6 +40,7 @@ files:
 - 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
@@ -76,6 +79,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit
 - spec/unit/configuration_spec.rb
+- spec/unit/family_guy.yml
 - spec/unit/helpers_spec.rb
 - spec/unit/kernel_spec.rb
 - spec/unit/store_spec.rb