configatron 1.2.2 → 2.0.0

data/doc/classes/Kernel.html

@@ -80,7 +80,7 @@
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000021">configatron</a>&nbsp;&nbsp;
+      <a href="#M000015">configatron</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -102,35 +102,28 @@
     <div id="methods">
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000021" class="method-detail">
-        <a name="M000021"></a>
+      <div id="method-M000015" class="method-detail">
+        <a name="M000015"></a>
 
         <div class="method-heading">
-          <a href="#M000021" class="method-signature">
-          <span class="method-name">configatron</span><span class="method-args">(&amp;block)</span>
+          <a href="#M000015" class="method-signature">
+          <span class="method-name">configatron</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-If called without a block it will return the <a
-href="Configatron/Configuration.html">Configatron::Configuration</a>
-instance. If called with a block then it will call the
-Configatron::Configatron configure method and yield up a <a
-href="Configatron/Store.html">Configatron::Store</a> object.
+Provides access to the <a href="Configatron.html">Configatron</a> storage
+system.
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000021-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000021-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/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>)
- 9:     <span class="ruby-keyword kw">else</span>
-10:       <span class="ruby-constant">Configatron</span><span class="ruby-operator">::</span><span class="ruby-constant">Configuration</span>.<span class="ruby-identifier">instance</span>
-11:     <span class="ruby-keyword kw">end</span>
-12:   <span class="ruby-keyword kw">end</span>
+   <span class="ruby-comment cmt"># File lib/configatron/kernel.rb, line 4</span>
+4:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configatron</span>
+5:     <span class="ruby-constant">Configatron</span>.<span class="ruby-identifier">instance</span>
+6:   <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>

data/doc/created.rid

@@ -1 +1 @@
-Mon, 15 Sep 2008 11:06:30 -0400
+Wed, 17 Sep 2008 15:25:17 -0400

data/doc/files/README.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Wed Sep 10 15:41:48 -0400 2008</td>
+      <td>Wed Sep 17 14:47:44 -0400 2008</td>
     </tr>
     </table>
   </div>
@@ -69,27 +69,25 @@
   <div id="contextContent">
 
     <div id="description">
-      <h1>Configatron</h1>
+      <h1><a href="../classes/Configatron.html">Configatron</a></h1>
 <p>
-Configatron makes configuring your applications and scripts incredibly
-easy. No longer is a there a need to use constants or global variables. Now
-you can use a simple and painless system to configure your life. And,
-because it&#8216;s all Ruby, you can do any crazy thing you would like to!
+<a href="../classes/Configatron.html">Configatron</a> makes configuring
+your applications and scripts incredibly easy. No longer is a there a need
+to use constants or global variables. Now you can use a simple and painless
+system to configure your life. And, because it&#8216;s all Ruby, you can do
+any crazy thing you would like to!
 </p>
 <h2>Examples</h2>
 <h3>Simple</h3>
 <pre>
-  configatron do |config|
-    config.email = &quot;mark@mackframework.com&quot;
-    config.database_url = &quot;postgres://localhost/mack_framework_rocks&quot;
-    # etc...
-  end
+  configatron.email = 'me@example.com'
+  configatron.database_url = &quot;postgres://localhost/mack_framework_rocks&quot;
 </pre>
 <p>
 Now, anywhere in your code you can do the following:
 </p>
 <pre>
-  configatron.email # =&gt; &quot;mark@mackframework.com&quot;
+  configatron.email # =&gt; &quot;me@example.com&quot;
   configatron.database_url # =&gt; &quot;postgres://localhost/mack_framework_rocks&quot;
 </pre>
 <p>
@@ -105,22 +103,20 @@ that is that is our production database url, not our development url. Fair
 enough, all you have to do is redeclare it:
 </p>
 <pre>
-  configatron do |config|
-    config.database_url = &quot;postgres://localhost/mack_framework_rocks_development&quot;
-  end
+  configatron.database_url = &quot;postgres://localhost/mack_framework_rocks_development&quot;
 </pre>
 <p>
 becomes:
 </p>
 <pre>
-  configatron.email # =&gt; &quot;mark@mackframework.com&quot;
+  configatron.email # =&gt; &quot;me@example.com&quot;
   configatron.database_url # =&gt; &quot;postgres://localhost/mack_framework_rocks_development&quot;
 </pre>
 <p>
 Notice how our other configuration parameters haven&#8216;t changed? Cool,
 eh?
 </p>
-<h3><a href="../classes/Hash.html">Hash</a>/YAML</h3>
+<h3>Hash/YAML</h3>
 <p>
 You can configure configatron from a hash as well:
 </p>
@@ -145,26 +141,16 @@ file will be re-read in case changes have been made.
 <h3>Namespaces</h3>
 <p>
 The question that should be on your lips is what I need to have namespaced
-configuration parameters. It&#8216;s easy! Configatron allows you to create
+configuration parameters. It&#8216;s easy! <a
+href="../classes/Configatron.html">Configatron</a> allows you to create
 namespaces.
 </p>
 <pre>
-  configatron do |config|
-    config.website_url = &quot;http://www.mackframework.com&quot;
-    config.namespace(:email) do |email|
-      email.namespace(:pop) do |pop|
-        pop.address = &quot;pop.example.com&quot;
-        pop.port = &quot;110&quot;
-        # etc ...
-      end
-      email.namespace(:smtp) do |smtp|
-        smtp.address = &quot;smtp.example.com&quot;
-        smtp.port = &quot;25&quot;
-        # etc ...
-      end
-    end
-    # etc...
-  end
+  configatron.website_url = &quot;http://www.mackframework.com&quot;
+  configatron.email.pop.address = &quot;pop.example.com&quot;
+  configatron.email.pop.port = 110
+  configatron.email.smtp.address = &quot;smtp.example.com&quot;
+  configatron.email.smtp.port = 25
 </pre>
 <p>
 becomes:
@@ -175,24 +161,80 @@ becomes:
   configatron.website_url # =&gt; &quot;http://www.mackframework.com&quot;
 </pre>
 <p>
-Configatron allows you to nest namespaces to your hearts content! Just keep
-going, it&#8216;s that easy.
+<a href="../classes/Configatron.html">Configatron</a> 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 = &quot;pop2.example.com&quot;
 
   configatron.email.pop.address # =&gt; &quot;pop2.example.com&quot;
   configatron.email.smtp.address # =&gt; &quot;smtp.example.com&quot;
 </pre>
+<h3>Misc.</h3>
+<p>
+Even if parameters haven&#8216;t been set, you can still call them, and
+you&#8216;ll get nil back:
+</p>
+<pre>
+  configatron.i.dont.exist.nil? # =&gt; true
+  configatron.i.dont.exist # =&gt; nil
+</pre>
+<p>
+You can set &#8216;default&#8217; values for parameters. If there is
+already a setting, it won&#8216;t be replaced. This is useful if
+you&#8216;ve already done your &#8216;configuration&#8217; and you call a
+library, that needs to have parameters set. The library can set it&#8216;s
+defaults, without worrying that it might have overridden your custom
+settings.
+</p>
+<pre>
+  configatron.set_default(:name, 'Mark Bates')
+  configatron.name # =&gt; 'Mark Bates'
+  configatron.set_default(:name, 'Me')
+  configatron.name # =&gt; 'Mark Bates'
+</pre>
+<p>
+Sometimes in testing, or other situations, you want to temporarily change
+some settings. You can do this with the <tt>temp</tt> method:
+</p>
+<pre>
+  configatron.one = 1
+  configatron.letters.a = 'A'
+  configatron.letters.b = 'B'
+  configatron.temp do
+    configatron.letters.b = 'bb'
+    configatron.letters.c = 'c'
+    configatron.one # =&gt; 1
+    configatron.letters.a # =&gt; 'A'
+    configatron.letters.b # =&gt; 'bb'
+    configatron.letters.c # =&gt; 'c'
+  end
+  configatron.one # =&gt; 1
+  configatron.letters.a # =&gt; 'A'
+  configatron.letters.b # =&gt; 'B'
+  configatron.letters.c # =&gt; nil
+</pre>
+<p>
+You can also pass in an optional Hash to the <tt>temp</tt>:
+</p>
+<pre>
+  configatron.one = 1
+  configatron.letters.a = 'A'
+  configatron.letters.b = 'B'
+  configatron.temp(:letters =&gt; {:b =&gt; 'bb', :c =&gt; 'c'}) do
+    configatron.one == 1
+    configatron.letters.a # =&gt; 'A'
+    configatron.letters.b # =&gt; 'bb'
+    configatron.letters.c # =&gt; 'c'
+  end
+  configatron.one == 1
+  configatron.letters.a # =&gt; 'A'
+  configatron.letters.b # =&gt; 'B'
+  configatron.letters.c # =&gt; nil
+</pre>
 <p>
 Enjoy!
 </p>

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

@@ -5,7 +5,7 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-  <title>File: configuration.rb</title>
+  <title>File: configatron.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" />
@@ -47,16 +47,16 @@
 
 
   <div id="fileHeader">
-    <h1>configuration.rb</h1>
+    <h1>configatron.rb</h1>
     <table class="header-table">
     <tr class="top-aligned-row">
       <td><strong>Path:</strong></td>
-      <td>lib/configatron/configuration.rb
+      <td>lib/configatron/configatron.rb
       </td>
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Mon Sep 15 11:06:00 -0400 2008</td>
+      <td>Wed Sep 17 15:15:24 -0400 2008</td>
     </tr>
     </table>
   </div>
@@ -69,6 +69,13 @@
   <div id="contextContent">
 
 
+    <div id="requires-list">
+      <h3 class="section-bar">Required files</h3>
+
+      <div class="name-list">
+      singleton&nbsp;&nbsp;
+      </div>
+    </div>
 
    </div>
 

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

@@ -5,7 +5,7 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-  <title>File: helpers.rb</title>
+  <title>File: errors.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" />
@@ -47,16 +47,16 @@
 
 
   <div id="fileHeader">
-    <h1>helpers.rb</h1>
+    <h1>errors.rb</h1>
     <table class="header-table">
     <tr class="top-aligned-row">
       <td><strong>Path:</strong></td>
-      <td>lib/configatron/helpers.rb
+      <td>lib/configatron/errors.rb
       </td>
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Fri Sep 05 16:22:37 -0400 2008</td>
+      <td>Wed Sep 17 15:16:26 -0400 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/configatron/kernel_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Fri Sep 05 16:22:37 -0400 2008</td>
+      <td>Wed Sep 17 14:47:44 -0400 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/configatron/store_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Mon Sep 15 10:59:23 -0400 2008</td>
+      <td>Wed Sep 17 15:16:26 -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>Mon Sep 15 11:05:40 -0400 2008</td>
+      <td>Wed Sep 17 15:02:18 -0400 2008</td>
     </tr>
     </table>
   </div>
@@ -73,7 +73,6 @@
       <h3 class="section-bar">Required files</h3>
 
       <div class="name-list">
-      singleton&nbsp;&nbsp;
       yaml&nbsp;&nbsp;
       </div>
     </div>

data/doc/fr_class_index.html

@@ -20,11 +20,9 @@
 <div id="index">
   <h1 class="section-bar">Classes</h1>
   <div id="index-entries">
-    <a href="classes/Configatron/Configuration.html">Configatron::Configuration</a><br />
-    <a href="classes/Configatron/Helpers.html">Configatron::Helpers</a><br />
+    <a href="classes/Configatron.html">Configatron</a><br />
+    <a href="classes/Configatron/ProtectedParameter.html">Configatron::ProtectedParameter</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/Hash.html">Hash</a><br />
     <a href="classes/Kernel.html">Kernel</a><br />
   </div>
 </div>

data/doc/fr_file_index.html

@@ -22,11 +22,10 @@
   <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/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/configatron_rb.html">lib/configatron/configatron.rb</a><br />
+    <a href="files/lib/configatron/errors_rb.html">lib/configatron/errors.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/doc/fr_method_index.html

@@ -20,27 +20,21 @@
 <div id="index">
   <h1 class="section-bar">Methods</h1>
   <div id="index-entries">
-    <a href="classes/Kernel.html#M000021">configatron (Kernel)</a><br />
-    <a href="classes/Configatron/Configuration.html#M000013">configure (Configatron::Configuration)</a><br />
-    <a href="classes/Configatron/Configuration.html#M000014">configure_from_hash (Configatron::Configuration)</a><br />
-    <a href="classes/Configatron/Configuration.html#M000015">configure_from_yaml (Configatron::Configuration)</a><br />
-    <a href="classes/Configatron/Helpers.html#M000003">exists? (Configatron::Helpers)</a><br />
-    <a href="classes/Configatron/Store.html#M000007">exists? (Configatron::Store)</a><br />
-    <a href="classes/Configatron/Store.html#M000006">method_missing (Configatron::Store)</a><br />
-    <a href="classes/Configatron/Store.html#M000008">namespace (Configatron::Store)</a><br />
-    <a href="classes/Configatron/Store.html#M000005">new (Configatron::Store)</a><br />
-    <a href="classes/Configatron/YamlStore.html#M000011">new (Configatron::YamlStore)</a><br />
-    <a href="classes/Hash.html#M000001">recursive_merge (Hash)</a><br />
-    <a href="classes/Hash.html#M000002">recursive_merge! (Hash)</a><br />
-    <a href="classes/Configatron/YamlStore.html#M000012">reload (Configatron::YamlStore)</a><br />
-    <a href="classes/Configatron/Store.html#M000009">reload (Configatron::Store)</a><br />
-    <a href="classes/Configatron/Configuration.html#M000016">reload (Configatron::Configuration)</a><br />
-    <a href="classes/Configatron/Configuration.html#M000018">reset (Configatron::Configuration)</a><br />
-    <a href="classes/Configatron/Configuration.html#M000017">reset! (Configatron::Configuration)</a><br />
-    <a href="classes/Configatron/Helpers.html#M000004">retrieve (Configatron::Helpers)</a><br />
-    <a href="classes/Configatron/Configuration.html#M000019">revert (Configatron::Configuration)</a><br />
-    <a href="classes/Configatron/Configuration.html#M000020">to_hash (Configatron::Configuration)</a><br />
-    <a href="classes/Configatron/Store.html#M000010">to_hash (Configatron::Store)</a><br />
+    <a href="classes/Kernel.html#M000015">configatron (Kernel)</a><br />
+    <a href="classes/Configatron/Store.html#M000006">configure_from_hash (Configatron::Store)</a><br />
+    <a href="classes/Configatron/Store.html#M000007">configure_from_yaml (Configatron::Store)</a><br />
+    <a href="classes/Configatron/Store.html#M000013">deep_clone (Configatron::Store)</a><br />
+    <a href="classes/Configatron/ProtectedParameter.html#M000014">intialize (Configatron::ProtectedParameter)</a><br />
+    <a href="classes/Configatron.html#M000001">method_missing (Configatron)</a><br />
+    <a href="classes/Configatron/Store.html#M000004">new (Configatron::Store)</a><br />
+    <a href="classes/Configatron/Store.html#M000008">nil? (Configatron::Store)</a><br />
+    <a href="classes/Configatron/Store.html#M000012">protect (Configatron::Store)</a><br />
+    <a href="classes/Configatron/Store.html#M000010">remove (Configatron::Store)</a><br />
+    <a href="classes/Configatron.html#M000002">reset! (Configatron)</a><br />
+    <a href="classes/Configatron/Store.html#M000009">retrieve (Configatron::Store)</a><br />
+    <a href="classes/Configatron/Store.html#M000011">set_default (Configatron::Store)</a><br />
+    <a href="classes/Configatron.html#M000003">temp (Configatron)</a><br />
+    <a href="classes/Configatron/Store.html#M000005">to_hash (Configatron::Store)</a><br />
   </div>
 </div>
 </body>

data/lib/configatron.rb

@@ -1,45 +1,6 @@
-require 'singleton'
+base = File.join(File.dirname(__FILE__), 'configatron')
 require 'yaml'
-
-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
-
-class Hash
-
-  # Same as Hash#merge but recursively merges sub-hashes.
-
-  def recursive_merge(other)
-    hash = self.dup
-    other.each do |key, value|
-      myval = self[key]
-      if value.is_a?(Hash) && myval.is_a?(Hash)
-        hash[key] = myval.recursive_merge(value)
-      else
-        hash[key] = value
-      end
-    end
-    hash
-  end
-
-  # Same as Hash#merge! but recursively merges sub-hashes.
-
-  def recursive_merge!(other)
-    other.each do |key, value|
-      myval = self[key]
-      if value.is_a?(Hash) && myval.is_a?(Hash)
-        myval.recursive_merge!(value)
-      else
-        self[key] = value
-      end
-    end
-    self
-  end
-
-end
-
+require File.join(base, 'kernel')
+require File.join(base, 'configatron')
+require File.join(base, 'store')
+require File.join(base, 'errors')