rconfigurator 0.0.2 → 0.0.3

data/README

@@ -1,8 +1,6 @@
 === Welcome to RConfigurator!
 
---- Configuration shouldn't be hard...
-
-...and loading configuration for your Ruby application has never been easier. 
+--- Abstract
 
 RConfigurator automatically "hydrates" your application's module constants by walking
 through a .yml file. If you've got module constants strewn throughout your project, 
@@ -10,13 +8,14 @@ you can use RConfigurator to aggregate these into one place.
 
 --- Usage
 
-To get this going, you just have to require 'rconfigurator' and provide use with the
-name of the project and the location of the configuration file:
+Just require 'rconfigurator', provide the location of the configuration file and the
+name of a project, and then call RConfigurator.configure!:
 
     require 'rconfigurator'
     RConfigurator.configure! "ExampleModule", "/path/to/my/config"
 
-Configurator will analyze the file and 'inflate' your module constants using the data it finds there. Let's say you've got the following module constants:
+Configurator will analyze the file and 'inflate' your module constants using the data 
+it finds there. Let's say you've got the following module constants:
 
   ExampleModule::KEY = 'value'
   ExampleModule::NUMERIC_DATA = 3.221
@@ -38,12 +37,13 @@ when the value is itself a module. RConfigurator will construct the module conte
 in place just before it needs a reference. 
 
 For a better feel of how this ends up being useful, or perhaps some inspiration,
-here's an example of part of a real configuration file I am using for another small project:
+here's an example of part of a real configuration file I am using for another 
+small project:
 
 		version: 0.3.9
 		release: alpha
 		authors: joseph weissman
-		license: artistic license <http://www.perlfoundation.org/artistic_license_2_0>
+		license: artistic <http://www.perlfoundation.org/artistic_license_2_0>
 
 		# support module config
 		support:
@@ -63,25 +63,39 @@ here's an example of part of a real configuration file I am using for another sm
 		# ... 
 
 
---- RConfig
+--- Tools
 
-RConfigurator comes with a debugger that will output the statements it will 'eval'. You can
-invoke this utility as 'rconfig [file1] [file2] ...' assuming you have installed the gem.
 
-Running rconfig over the first example yaml file gives us the module structure we are expecting:
+RConfigurator comes with a command line utility called 'rconfig' for debugging 
+your configuration files. Invoking the utility against a configuration file 
+attempts to perform the configuration, logging the statements RConfigurator.config! 
+would normally just silently 'eval'. Invoke this utility as 'rconfig [file1] [file2] ...' 
+(assuming you have installed the gem.)
 
-	module HypotheticalParentModule; module SampleModule; SOME_KEY = "another value"; end; ; end
-	module I;  module Am;  module A;  module Module; end; end; end; end; 
-	module HypotheticalParentModule; KEY_SHOULD_BE_MODULE = I::Am::A::Module; ; end
-	module HypotheticalParentModule; KEY = "value"; ; end
-	module HypotheticalParentModule; NUMERIC_DATA = 3.221; ; end
+Running rconfig over the first example yaml file gives us the module structure 
+we are expecting. It uses "HypotheticalParentModule" as the root project module
+Note the output from rconfig is the unindented 'compact' form we actually evaluate, 
+with one key-value pair per line.
 
+	module HypotheticalParentModule; module SampleModule; SOME_KEY = "another value"; end; ; end	
+	module I;  module Am;  module A;  module Module; end; end; end; end; 	
+	module HypotheticalParentModule; KEY_SHOULD_BE_MODULE = I::Am::A::Module; ; end	
+	module HypotheticalParentModule; KEY = "value"; ; end	
+	module HypotheticalParentModule; NUMERIC_DATA = 3.221; ; end
 
+Please note that I have added this tool as a convenience, and I should point out 
+that developing the configuration file is generally quite straightforward. Using 
+rconfig to 'validate' is probably not necessary. This tool is included for sanity-
+inducing purposes (and perhaps more involved use-cases where it could be helpful 
+in the scenario where a complex config file has become subtly incorrect.)
 
 --- Problems? 
 
-Please log bug reports and enhancement proposals here, or feel free to email the author/maintainer of RConfigurator, Joseph Weissman, jweissman1986 (at) gmail.com
+Please log bug reports and enhancement proposals here, or feel free to email the 
+author/maintainer of RConfigurator, Joseph Weissman, jweissman1986 (at) gmail.com
 
---- Conclusion
+--- Afterword
 
-So far in practice, I have found that it is definitely convenient to be able to architecturally separate 'tuning' from code. I like that I can instantiate complex module structures just by adding a few lines of YAML.
+So far in practice, I have found that it is definitely convenient to be able to 
+architecturally separate 'tuning' from code. I like that I can instantiate complex 
+module structures just by adding a few lines of YAML.

data/doc/Gemfile.html

@@ -0,0 +1,98 @@
+<?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>File: Gemfile [RDoc Documentation]</title>
+
+  <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
+
+  <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 class="file">
+  <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="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 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">
+    
+<p>source “<a href="http://rubygems.org">rubygems.org</a>”</p>
+
+<p># Specify your gem’s dependencies in configurator.gemspec gem “rspec”</p>
+
+  </div>
+
+  <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/LICENSE_txt.html

@@ -0,0 +1,94 @@
+<?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>File: LICENSE.txt [RDoc Documentation]</title>
+
+  <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
+
+  <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 class="file">
+  <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="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 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">
+    
+  </div>
+
+  <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.html

@@ -0,0 +1,223 @@
+<?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</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>
+          
+            <li><a href="./lib/rconfigurator/version_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/rconfigurator/version.rb">lib/rconfigurator/version.rb</a></li>
+          
+            <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">
+      
+
+      
+
+      
+      <!-- Namespace Contents -->
+      <div id="namespace-list-section" class="section">
+        <h3 class="section-header">Namespace</h3>
+        <ul class="link-list">
+          
+          <li><span class="type">MODULE</span> <a href="RConfigurator/StringUtilities.html">RConfigurator::StringUtilities</a></li>
+          
+          <li><span class="type">CLASS</span> <a href="RConfigurator/Configurator.html">RConfigurator::Configurator</a></li>
+          
+        </ul>
+      </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-configure-21">::configure!</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</h1>
+
+    <div id="description" class="description">
+      
+    </div><!-- description -->
+
+    
+    
+    
+    <div id="5Buntitled-5D" class="documentation-section">
+      
+
+      
+
+      
+      <!-- Constants -->
+      <div id="constants-list" class="section">
+        <h3 class="section-header">Constants</h3>
+        <dl>
+        
+          <dt><a name="VERSION">VERSION</a></dt>
+          
+          <dd class="description"></dd>
+          
+        
+        </dl>
+      </div>
+      
+
+      
+
+      <!-- Methods -->
+      
+      <div id="public-class-method-details" class="method-section section">
+        <h3 class="section-header">Public Class Methods</h3>
+
+      
+        <div id="configure-21-method" class="method-detail ">
+          <a name="method-c-configure-21"></a>
+
+          
+          <div class="method-heading">
+            <span class="method-name">configure!</span><span
+              class="method-args">(name, file, debug=false)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          
+
+          <div class="method-description">
+            
+            <p>Use this configure! method to both create a new configurator AND launch the
+configuration process in one go.</p>
+            
+
+            
+            <div class="method-source-code" id="configure-21-source">
+<pre>
+<span class="ruby-comment"># File lib/rconfigurator.rb, line 15</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">configure!</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">file</span>, <span class="ruby-identifier">debug</span>=<span class="ruby-keyword">false</span>)
+  <span class="ruby-identifier">configurator</span> = <span class="ruby-constant">Configurator</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">file</span>)
+  <span class="ruby-identifier">configurator</span>.<span class="ruby-identifier">configure</span>(<span class="ruby-identifier">debug</span>)
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- configure-21-source -->
+            
+          </div>
+
+          
+
+          
+        </div><!-- configure-21-method -->
+
+      
+      </div><!-- public-class-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>
+