RubyGems - configatron - Versions diffs - 1.2.2 → 2.0.0 - Mend

configatron 1.2.2 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (37) hide show

data/README +61 -34
data/doc/classes/Configatron.html +241 -0
data/doc/classes/Configatron/ProtectedParameter.html +146 -0
data/doc/classes/Configatron/Store.html +241 -121
data/doc/classes/Kernel.html +13 -20
data/doc/created.rid +1 -1
data/doc/files/README.html +85 -43
data/doc/files/lib/configatron/{configuration_rb.html → configatron_rb.html} +11 -4
data/doc/files/lib/configatron/{helpers_rb.html → errors_rb.html} +4 -4
data/doc/files/lib/configatron/kernel_rb.html +1 -1
data/doc/files/lib/configatron/store_rb.html +1 -1
data/doc/files/lib/configatron_rb.html +1 -2
data/doc/fr_class_index.html +2 -4
data/doc/fr_file_index.html +2 -3
data/doc/fr_method_index.html +15 -21
data/lib/configatron.rb +5 -44
data/lib/configatron/configatron.rb +44 -0
data/lib/configatron/errors.rb +7 -0
data/lib/configatron/kernel.rb +3 -9
data/lib/configatron/store.rb +148 -56
data/spec/lib/configatron_spec.rb +293 -0
data/spec/lib/futurama.yml +6 -0
data/spec/spec_helper.rb +3 -2
metadata +11 -18
data/doc/classes/Configatron/Configuration.html +0 -402
data/doc/classes/Configatron/Helpers.html +0 -174
data/doc/classes/Configatron/YamlStore.html +0 -203
data/doc/classes/Hash.html +0 -193
data/doc/files/lib/configatron/yaml_store_rb.html +0 -101
data/lib/configatron/configuration.rb +0 -112
data/lib/configatron/helpers.rb +0 -27
data/lib/configatron/yaml_store.rb +0 -33
data/spec/unit/configuration_spec.rb +0 -299
data/spec/unit/family_guy.yml +0 -2
data/spec/unit/helpers_spec.rb +0 -115
data/spec/unit/kernel_spec.rb +0 -48
data/spec/unit/store_spec.rb +0 -91

data/doc/classes/Configatron/Helpers.html DELETED

@@ -1,174 +0,0 @@
-<?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>Module: Configatron::Helpers</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>Module</strong></td>
-          <td class="class-name-in-header">Configatron::Helpers</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../files/lib/configatron/helpers_rb.html">
-                lib/configatron/helpers.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-        </table>
-    </div>
-  <!-- banner header -->
-  <div id="bodyContent">
-  <div id="contextContent">
-   </div>
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-      <div class="name-list">
-      <a href="#M000003">exists?</a>&nbsp;&nbsp;
-      <a href="#M000004">retrieve</a>&nbsp;&nbsp;
-      </div>
-    </div>
-  </div>
-    <!-- if includes -->
-    <div id="section">
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Instance methods</h3>
-      <div id="method-M000003" class="method-detail">
-        <a name="M000003"></a>
-        <div class="method-heading">
-          <a href="#M000003" class="method-signature">
-          <span class="method-name">exists?</span><span class="method-args">(name)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Checks whether or not configuration parameter exists.
-</p>
-          <p><a class="source-toggle" href="#"
-            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/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>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000004" class="method-detail">
-        <a name="M000004"></a>
-        <div class="method-heading">
-          <a href="#M000004" class="method-signature">
-          <span class="method-name">retrieve</span><span class="method-args">(name, default_value = ArgumentError)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Retrieves the specified config parameter. An optional second parameter can
-be passed that will be returned if the config parameter doesn&#8216;t
-exist.
-</p>
-          <p><a class="source-toggle" href="#"
-            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/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>
-23:       <span class="ruby-identifier">handle_missing_parameter</span>(<span class="ruby-identifier">name</span>)
-24:     <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/Configatron/YamlStore.html DELETED

@@ -1,203 +0,0 @@
-<?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/configatron/yaml_store_rb.html">
-                lib/configatron/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="#M000011">new</a>&nbsp;&nbsp;
-      <a href="#M000012">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-M000011" class="method-detail">
-        <a name="M000011"></a>
-        <div class="method-heading">
-          <a href="#M000011" 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('M000011-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000011-source">
-<pre>
-    <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>
-12:     <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <h3 class="section-bar">Public Instance methods</h3>
-      <div id="method-M000012" class="method-detail">
-        <a name="M000012"></a>
-        <div class="method-heading">
-          <a href="#M000012" 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('M000012-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000012-source">
-<pre>
-    <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>)
-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/Hash.html DELETED

@@ -1,193 +0,0 @@
-<?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: Hash</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">Hash</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../files/lib/configatron_rb.html">
-                lib/configatron.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>Parent:</strong></td>
-            <td>
-                Object
-            </td>
-        </tr>
-        </table>
-    </div>
-  <!-- banner header -->
-  <div id="bodyContent">
-  <div id="contextContent">
-   </div>
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-      <div class="name-list">
-      <a href="#M000001">recursive_merge</a>&nbsp;&nbsp;
-      <a href="#M000002">recursive_merge!</a>&nbsp;&nbsp;
-      </div>
-    </div>
-  </div>
-    <!-- if includes -->
-    <div id="section">
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Instance methods</h3>
-      <div id="method-M000001" class="method-detail">
-        <a name="M000001"></a>
-        <div class="method-heading">
-          <a href="#M000001" class="method-signature">
-          <span class="method-name">recursive_merge</span><span class="method-args">(other)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Same as Hash#merge but recursively merges sub-hashes.
-</p>
-          <p><a class="source-toggle" href="#"
-            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/configatron.rb, line 17</span>
-17:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">recursive_merge</span>(<span class="ruby-identifier">other</span>)
-18:     <span class="ruby-identifier">hash</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">dup</span>
-19:     <span class="ruby-identifier">other</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
-20:       <span class="ruby-identifier">myval</span> = <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">key</span>]
-21:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">myval</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
-22:         <span class="ruby-identifier">hash</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">myval</span>.<span class="ruby-identifier">recursive_merge</span>(<span class="ruby-identifier">value</span>)
-23:       <span class="ruby-keyword kw">else</span>
-24:         <span class="ruby-identifier">hash</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span>
-25:       <span class="ruby-keyword kw">end</span>
-26:     <span class="ruby-keyword kw">end</span>
-27:     <span class="ruby-identifier">hash</span>
-28:   <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000002" class="method-detail">
-        <a name="M000002"></a>
-        <div class="method-heading">
-          <a href="#M000002" class="method-signature">
-          <span class="method-name">recursive_merge!</span><span class="method-args">(other)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Same as Hash#merge! but recursively merges sub-hashes.
-</p>
-          <p><a class="source-toggle" href="#"
-            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/configatron.rb, line 32</span>
-32:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">recursive_merge!</span>(<span class="ruby-identifier">other</span>)
-33:     <span class="ruby-identifier">other</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
-34:       <span class="ruby-identifier">myval</span> = <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">key</span>]
-35:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">myval</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
-36:         <span class="ruby-identifier">myval</span>.<span class="ruby-identifier">recursive_merge!</span>(<span class="ruby-identifier">value</span>)
-37:       <span class="ruby-keyword kw">else</span>
-38:         <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span>
-39:       <span class="ruby-keyword kw">end</span>
-40:     <span class="ruby-keyword kw">end</span>
-41:     <span class="ruby-keyword kw">self</span>
-42:   <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>