RubyGems - rconfigurator - Versions diffs - 0.0.2 → 0.0.3 - Mend

rconfigurator 0.0.2 → 0.0.3

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 (46) hide show

data/README +34 -20
data/doc/Gemfile.html +98 -0
data/doc/LICENSE_txt.html +94 -0
data/doc/RConfigurator.html +223 -0
data/doc/RConfigurator/Configurator.html +332 -0
data/doc/RConfigurator/StringUtilities.html +194 -0
data/doc/README.html +203 -0
data/doc/Rakefile.html +100 -0
data/doc/bin/rconfig.html +58 -0
data/doc/created.rid +11 -0
data/doc/images/brick.png +0 -0
data/doc/images/brick_link.png +0 -0
data/doc/images/bug.png +0 -0
data/doc/images/bullet_black.png +0 -0
data/doc/images/bullet_toggle_minus.png +0 -0
data/doc/images/bullet_toggle_plus.png +0 -0
data/doc/images/date.png +0 -0
data/doc/images/find.png +0 -0
data/doc/images/loadingAnimation.gif +0 -0
data/doc/images/macFFBgHack.png +0 -0
data/doc/images/package.png +0 -0
data/doc/images/page_green.png +0 -0
data/doc/images/page_white_text.png +0 -0
data/doc/images/page_white_width.png +0 -0
data/doc/images/plugin.png +0 -0
data/doc/images/ruby.png +0 -0
data/doc/images/tag_green.png +0 -0
data/doc/images/wrench.png +0 -0
data/doc/images/wrench_orange.png +0 -0
data/doc/images/zoom.png +0 -0
data/doc/index.html +76 -0
data/doc/js/darkfish.js +116 -0
data/doc/js/jquery.js +32 -0
data/doc/js/quicksearch.js +114 -0
data/doc/js/thickbox-compressed.js +10 -0
data/doc/lib/rconfigurator/configurator_rb.html +55 -0
data/doc/lib/rconfigurator/utilities_rb.html +52 -0
data/doc/lib/rconfigurator/version_rb.html +52 -0
data/doc/lib/rconfigurator_rb.html +56 -0
data/doc/rdoc.css +763 -0
data/doc/spec/rconfigurator/rconfigurator_spec_rb.html +54 -0
data/lib/rconfigurator.rb +5 -0
data/lib/rconfigurator/version.rb +1 -1
data/spec/rconfigurator/rconfigurator_spec.rb +11 -3
data/spec/resources/sample.yml +4 -0
metadata +44 -4

data/doc/RConfigurator/Configurator.html ADDED

@@ -0,0 +1,332 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+  <title>Class: RConfigurator::Configurator</title>
+  <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
+  <script src="../js/jquery.js" type="text/javascript" charset="utf-8"></script>
+  <script src="../js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
+  <script src="../js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
+  <script src="../js/darkfish.js" type="text/javascript" charset="utf-8"></script>
+</head>
+<body id="top" class="class">
+  <div id="metadata">
+    <div id="home-metadata">
+      <div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="../index.html">Home</a>
+          <a href="../index.html#classes">Classes</a>
+          <a href="../index.html#methods">Methods</a>
+        </h3>
+      </div>
+    </div>
+    <div id="file-metadata">
+      <div id="file-list-section" class="section">
+        <h3 class="section-header">In Files</h3>
+        <div class="section-body">
+          <ul>
+            <li><a href="../lib/rconfigurator_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/rconfigurator.rb">lib/rconfigurator.rb</a></li>
+          </ul>
+        </div>
+      </div>
+    </div>
+    <div id="class-metadata">
+      <!-- Parent Class -->
+      <div id="parent-class-section" class="section">
+        <h3 class="section-header">Parent</h3>
+        <p class="link">Object</p>
+      </div>
+      <!-- Method Quickref -->
+      <div id="method-list-section" class="section">
+        <h3 class="section-header">Methods</h3>
+        <ul class="link-list">
+          <li><a href="#method-c-new">::new</a></li>
+          <li><a href="#method-i-configure">#configure</a></li>
+          <li><a href="#method-i-parse_and_recursively_create_constants-21">#parse_and_recursively_create_constants!</a></li>
+        </ul>
+      </div>
+      <!-- Included Modules -->
+      <div id="includes-section" class="section">
+        <h3 class="section-header">Included Modules</h3>
+        <ul class="link-list">
+          <li><a class="include" href="StringUtilities.html">RConfigurator::StringUtilities</a></li>
+        </ul>
+      </div>
+    </div>
+    <div id="project-metadata">
+      <div id="fileindex-section" class="section project-section">
+        <h3 class="section-header">Files</h3>
+        <ul>
+          <li class="file"><a href="../Gemfile.html">Gemfile</a></li>
+          <li class="file"><a href="../LICENSE_txt.html">LICENSE.txt</a></li>
+          <li class="file"><a href="../README.html">README</a></li>
+          <li class="file"><a href="../Rakefile.html">Rakefile</a></li>
+        </ul>
+      </div>
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class/Module Index
+          <span class="search-toggle"><img src="../images/find.png"
+            height="16" width="16" alt="[+]"
+            title="show/hide quicksearch" /></span></h3>
+        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+        <fieldset>
+          <legend>Quicksearch</legend>
+          <input type="text" name="quicksearch" value=""
+            class="quicksearch-field" />
+        </fieldset>
+        </form>
+        <ul class="link-list">
+          <li><a href="../RConfigurator.html">RConfigurator</a></li>
+          <li><a href="../RConfigurator/Configurator.html">RConfigurator::Configurator</a></li>
+          <li><a href="../RConfigurator/StringUtilities.html">RConfigurator::StringUtilities</a></li>
+        </ul>
+        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+      </div>
+    </div>
+  </div>
+  <div id="documentation">
+    <h1 class="class">RConfigurator::Configurator</h1>
+    <div id="description" class="description">
+<p>“Hydrate” a Ruby application’s module constants from a configuration
+.yml</p>
+    </div><!-- description -->
+    <div id="5Buntitled-5D" class="documentation-section">
+      <!-- Methods -->
+      <div id="public-class-method-details" class="method-section section">
+        <h3 class="section-header">Public Class Methods</h3>
+        <div id="new-method" class="method-detail ">
+          <a name="method-c-new"></a>
+          <div class="method-heading">
+            <span class="method-name">new</span><span
+              class="method-args">(project_name, config_file, opts={})</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          <div class="method-description">
+            <p><a href="Configurator.html#method-c-new">Configurator.new</a> takes the
+name of the project and a configuration file It does not perform any
+configuration yet; you must also call configure  if <a
+href="../RConfigurator.html">RConfigurator</a> is invoked this way.</p>
+            <div class="method-source-code" id="new-source">
+<pre>
+<span class="ruby-comment"># File lib/rconfigurator.rb, line 32</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">project_name</span>, <span class="ruby-identifier">config_file</span>, <span class="ruby-identifier">opts</span>={})
+  <span class="ruby-ivar">@project_name</span> = <span class="ruby-identifier">project_name</span>
+  <span class="ruby-ivar">@config_file</span>  = <span class="ruby-identifier">config_file</span>
+  <span class="ruby-ivar">@data</span> = <span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-identifier">load</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@config_file</span>)).<span class="ruby-identifier">to_hash</span>
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- new-source -->
+          </div>
+        </div><!-- new-method -->
+      </div><!-- public-class-method-details -->
+      <div id="public-instance-method-details" class="method-section section">
+        <h3 class="section-header">Public Instance Methods</h3>
+        <div id="configure-method" class="method-detail ">
+          <a name="method-i-configure"></a>
+          <div class="method-heading">
+            <span class="method-name">configure</span><span
+              class="method-args">(debug=false)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          <div class="method-description">
+            <p>Kicks off our recursive enumeration of the configuration data and module
+constant generation business logic.</p>
+            <div class="method-source-code" id="configure-source">
+<pre>
+<span class="ruby-comment"># File lib/rconfigurator.rb, line 42</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">configure</span>(<span class="ruby-identifier">debug</span>=<span class="ruby-keyword">false</span>)
+  <span class="ruby-identifier">parse_and_recursively_create_constants!</span>(<span class="ruby-ivar">@data</span>, [], <span class="ruby-identifier">debug</span>)
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- configure-source -->
+          </div>
+        </div><!-- configure-method -->
+        <div id="parse_and_recursively_create_constants-21-method" class="method-detail ">
+          <a name="method-i-parse_and_recursively_create_constants-21"></a>
+          <div class="method-heading">
+            <span class="method-name">parse_and_recursively_create_constants!</span><span
+              class="method-args">(hash, module_context = [], debug=false)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          <div class="method-description">
+            <p>configure application based on an easily-managed .yml file – use
+‘eval’  to generate constants based on the structure of the hash we get
+from the yaml. most of the business logic for recursively parsing a hash
+and creating module  constants basically just involves tracking module
+names properly.</p>
+            <div class="method-source-code" id="parse_and_recursively_create_constants-21-source">
+<pre>
+<span class="ruby-comment"># File lib/rconfigurator.rb, line 52</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">parse_and_recursively_create_constants!</span>(<span class="ruby-identifier">hash</span>, <span class="ruby-identifier">module_context</span> = [], <span class="ruby-identifier">debug</span>=<span class="ruby-keyword">false</span>)
+  <span class="ruby-identifier">hash</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
+    <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Hash</span>
+      <span class="ruby-identifier">module_name</span> = <span class="ruby-identifier">convert_string_to_camel_case</span>(<span class="ruby-identifier">key</span>)
+      <span class="ruby-identifier">context</span> = <span class="ruby-identifier">module_context</span>.<span class="ruby-identifier">dup</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">module_name</span>
+      <span class="ruby-identifier">parse_and_recursively_create_constants!</span>(<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">key</span>], <span class="ruby-identifier">context</span>, <span class="ruby-identifier">debug</span>)
+    <span class="ruby-keyword">else</span>
+      <span class="ruby-identifier">value_is_a_module</span> = <span class="ruby-keyword">false</span>
+      <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">String</span>
+        <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">include?</span> <span class="ruby-string">&quot;::&quot;</span>
+          <span class="ruby-identifier">value_is_a_module</span> = <span class="ruby-keyword">true</span>
+        <span class="ruby-keyword">else</span>
+          <span class="ruby-identifier">value</span> = <span class="ruby-node">&quot;\&quot;#{value}\&quot;&quot;</span>
+        <span class="ruby-keyword">end</span>
+      <span class="ruby-keyword">end</span>
+      <span class="ruby-keyword">if</span> <span class="ruby-identifier">value_is_a_module</span>
+        <span class="ruby-comment"># explicitly build out this module (since it doesn't exist) so that we can talk about it</span>
+        <span class="ruby-identifier">expression</span> = <span class="ruby-identifier">value</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">'::'</span>).<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">module_name</span><span class="ruby-operator">|</span> <span class="ruby-node">&quot;module #{module_name}; &quot;</span>}.<span class="ruby-identifier">join</span>(<span class="ruby-string">' '</span>)
+        <span class="ruby-identifier">value</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">'::'</span>).<span class="ruby-identifier">count</span>.<span class="ruby-identifier">times</span> { <span class="ruby-identifier">expression</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">&quot;end; &quot;</span>}
+        <span class="ruby-identifier">eval</span>(<span class="ruby-identifier">expression</span>, <span class="ruby-identifier">$_</span><span class="ruby-identifier">_global_scope</span>)
+        <span class="ruby-identifier">puts</span>(<span class="ruby-identifier">expression</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">debug</span>
+      <span class="ruby-keyword">end</span>
+      <span class="ruby-comment"># define the given constant</span>
+      <span class="ruby-identifier">depth</span> = <span class="ruby-identifier">module_context</span>.<span class="ruby-identifier">count</span>
+      <span class="ruby-identifier">expr</span> = <span class="ruby-identifier">module_context</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">module_name</span><span class="ruby-operator">|</span> <span class="ruby-node">&quot;module #{module_name}; &quot;</span> }.<span class="ruby-identifier">join</span>(<span class="ruby-string">&quot; &quot;</span>)
+      <span class="ruby-identifier">expr</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;#{key.upcase} = #{value}; &quot;</span>
+      <span class="ruby-identifier">depth</span>.<span class="ruby-identifier">times</span> { <span class="ruby-identifier">expr</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">&quot;end; &quot;</span>}
+      <span class="ruby-identifier">expr</span> = <span class="ruby-node">&quot;module #{@project_name}; #{expr}; end&quot;</span>
+      <span class="ruby-identifier">eval</span>(<span class="ruby-identifier">expr</span>, <span class="ruby-identifier">$_</span><span class="ruby-identifier">_global_scope</span>)
+      <span class="ruby-identifier">puts</span>(<span class="ruby-identifier">expr</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">debug</span>
+    <span class="ruby-keyword">end</span>
+  <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- parse_and_recursively_create_constants-21-source -->
+          </div>
+        </div><!-- parse_and_recursively_create_constants-21-method -->
+      </div><!-- public-instance-method-details -->
+    </div><!-- 5Buntitled-5D -->
+  </div><!-- documentation -->
+  <div id="validator-badges">
+    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+      Rdoc Generator</a> 2</small>.</p>
+  </div>
+</body>
+</html>

data/doc/RConfigurator/StringUtilities.html ADDED

@@ -0,0 +1,194 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+  <title>Module: RConfigurator::StringUtilities</title>
+  <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
+  <script src="../js/jquery.js" type="text/javascript" charset="utf-8"></script>
+  <script src="../js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
+  <script src="../js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
+  <script src="../js/darkfish.js" type="text/javascript" charset="utf-8"></script>
+</head>
+<body id="top" class="module">
+  <div id="metadata">
+    <div id="home-metadata">
+      <div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="../index.html">Home</a>
+          <a href="../index.html#classes">Classes</a>
+          <a href="../index.html#methods">Methods</a>
+        </h3>
+      </div>
+    </div>
+    <div id="file-metadata">
+      <div id="file-list-section" class="section">
+        <h3 class="section-header">In Files</h3>
+        <div class="section-body">
+          <ul>
+            <li><a href="../lib/rconfigurator/utilities_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/rconfigurator/utilities.rb">lib/rconfigurator/utilities.rb</a></li>
+          </ul>
+        </div>
+      </div>
+    </div>
+    <div id="class-metadata">
+      <!-- Method Quickref -->
+      <div id="method-list-section" class="section">
+        <h3 class="section-header">Methods</h3>
+        <ul class="link-list">
+          <li><a href="#method-i-convert_string_to_camel_case">#convert_string_to_camel_case</a></li>
+        </ul>
+      </div>
+    </div>
+    <div id="project-metadata">
+      <div id="fileindex-section" class="section project-section">
+        <h3 class="section-header">Files</h3>
+        <ul>
+          <li class="file"><a href="../Gemfile.html">Gemfile</a></li>
+          <li class="file"><a href="../LICENSE_txt.html">LICENSE.txt</a></li>
+          <li class="file"><a href="../README.html">README</a></li>
+          <li class="file"><a href="../Rakefile.html">Rakefile</a></li>
+        </ul>
+      </div>
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class/Module Index
+          <span class="search-toggle"><img src="../images/find.png"
+            height="16" width="16" alt="[+]"
+            title="show/hide quicksearch" /></span></h3>
+        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+        <fieldset>
+          <legend>Quicksearch</legend>
+          <input type="text" name="quicksearch" value=""
+            class="quicksearch-field" />
+        </fieldset>
+        </form>
+        <ul class="link-list">
+          <li><a href="../RConfigurator.html">RConfigurator</a></li>
+          <li><a href="../RConfigurator/Configurator.html">RConfigurator::Configurator</a></li>
+          <li><a href="../RConfigurator/StringUtilities.html">RConfigurator::StringUtilities</a></li>
+        </ul>
+        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+      </div>
+    </div>
+  </div>
+  <div id="documentation">
+    <h1 class="module">RConfigurator::StringUtilities</h1>
+    <div id="description" class="description">
+<p>takes a string_with_underbars and ConvertsToCamelCase</p>
+    </div><!-- description -->
+    <div id="5Buntitled-5D" class="documentation-section">
+      <!-- Methods -->
+      <div id="public-instance-method-details" class="method-section section">
+        <h3 class="section-header">Public Instance Methods</h3>
+        <div id="convert_string_to_camel_case-method" class="method-detail ">
+          <a name="method-i-convert_string_to_camel_case"></a>
+          <div class="method-heading">
+            <span class="method-name">convert_string_to_camel_case</span><span
+              class="method-args">(string)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          <div class="method-description">
+            <div class="method-source-code" id="convert_string_to_camel_case-source">
+<pre>
+<span class="ruby-comment"># File lib/rconfigurator/utilities.rb, line 7</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">convert_string_to_camel_case</span>(<span class="ruby-identifier">string</span>)
+  <span class="ruby-identifier">new_string</span> = <span class="ruby-identifier">string</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/^[a-z]|_+[a-z]/</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">upcase</span> }
+  <span class="ruby-identifier">new_string</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-string">'_'</span>, <span class="ruby-string">''</span>)
+  <span class="ruby-identifier">new_string</span>
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- convert_string_to_camel_case-source -->
+          </div>
+        </div><!-- convert_string_to_camel_case-method -->
+      </div><!-- public-instance-method-details -->
+    </div><!-- 5Buntitled-5D -->
+  </div><!-- documentation -->
+  <div id="validator-badges">
+    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+      Rdoc Generator</a> 2</small>.</p>
+  </div>
+</body>
+</html>