RubyGems - rconfig - Versions diffs - 0.3.3 → 0.4.0 - Mend

rconfig 0.3.3 → 0.4.0

Files changed (74) hide show

data/.gitignore +17 -0
data/.rspec +1 -0
data/.rvmrc +1 -0
data/ChangeLog +50 -0
data/Credits +13 -0
data/Gemfile +9 -0
data/Gemfile.lock +30 -0
data/LICENSE.txt +20 -0
data/README.rdoc +0 -0
data/Rakefile +11 -0
data/demo/application.conf +3 -0
data/demo/demo.conf +13 -0
data/demo/demo.rb +14 -0
data/demo/demo.xml +13 -0
data/demo/demo.yml +12 -0
data/doc/classes/ClassVariables.html +111 -0
data/doc/classes/ConfigError.html +120 -0
data/doc/classes/ConfigHash.html +354 -0
data/doc/classes/Constants.html +226 -0
data/doc/classes/Hash.html +269 -0
data/doc/classes/InvalidConfigPathError.html +119 -0
data/doc/classes/Object.html +220 -0
data/doc/classes/PropertiesFileParser.html +282 -0
data/doc/classes/RConfig.html +1745 -0
data/doc/created.rid +1 -0
data/doc/files/README_rdoc.html +271 -0
data/doc/files/lib/rconfig/class_variables_rb.html +107 -0
data/doc/files/lib/rconfig/config_hash_rb.html +114 -0
data/doc/files/lib/rconfig/constants_rb.html +101 -0
data/doc/files/lib/rconfig/core_ext/hash_rb.html +114 -0
data/doc/files/lib/rconfig/core_ext/object_rb.html +101 -0
data/doc/files/lib/rconfig/core_ext_rb.html +114 -0
data/doc/files/lib/rconfig/exceptions_rb.html +110 -0
data/doc/files/lib/rconfig/properties_file_parser_rb.html +146 -0
data/doc/files/lib/rconfig/rconfig_rb.html +186 -0
data/doc/files/lib/rconfig_rb.html +117 -0
data/doc/fr_class_index.html +35 -0
data/doc/fr_file_index.html +37 -0
data/doc/fr_method_index.html +75 -0
data/doc/index.html +24 -0
data/doc/rdoc-style.css +208 -0
data/lib/generators/rconfig/install_generator.rb +13 -0
data/lib/generators/rconfig/templates/rconfig.rb +82 -0
data/lib/rconfig.rb +98 -32
data/lib/rconfig/callbacks.rb +46 -0
data/lib/rconfig/cascade.rb +56 -0
data/lib/rconfig/config.rb +78 -0
data/lib/rconfig/constants.rb +58 -0
data/lib/rconfig/core_ext/array.rb +3 -0
data/lib/rconfig/core_ext/hash.rb +56 -57
data/lib/rconfig/core_ext/nil.rb +5 -0
data/lib/rconfig/core_ext/string.rb +3 -0
data/lib/rconfig/core_methods.rb +276 -0
data/lib/rconfig/exceptions.rb +21 -8
data/lib/rconfig/load_paths.rb +55 -0
data/lib/rconfig/logger.rb +86 -0
data/lib/rconfig/properties_file.rb +138 -0
data/lib/rconfig/reload.rb +75 -0
data/lib/rconfig/settings.rb +93 -0
data/lib/rconfig/utils.rb +175 -0
data/lib/tasks/gem.rake +14 -0
data/lib/tasks/rdoc.rake +11 -0
data/lib/tasks/spec.rake +25 -0
data/rconfig.gemspec +33 -0
data/spec/core_ext/object_spec.rb +44 -0
data/spec/rconfig_spec.rb +7 -0
data/spec/spec.opts +4 -0
data/spec/spec_helper.rb +16 -0
metadata +128 -32
data/lib/rconfig/config_hash.rb +0 -105
data/lib/rconfig/core_ext.rb +0 -6
data/lib/rconfig/properties_file_parser.rb +0 -80
data/lib/rconfig/rconfig.rb +0 -871
data/test/rconfig_test.rb +0 -381

data/doc/created.rid ADDED Viewed

	@@ -0,0 +1 @@
1	+ Fri, 12 Feb 2010 17:04:46 -0600

data/doc/files/README_rdoc.html ADDED Viewed

@@ -0,0 +1,271 @@
+<?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: README.rdoc</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>README.rdoc</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>README.rdoc
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Fri Feb 12 15:17:46 -0600 2010</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <h1><a href="../classes/RConfig.html">RConfig</a></h1>
+<p>
+The complete solution for Ruby Configuration Management. <a
+href="../classes/RConfig.html">RConfig</a> is a Ruby library that manages
+configuration within Ruby applications. It bridges the gap between yaml,
+xml, and key/value based properties files, by providing a centralized
+solution to handle application configuration from one location. It provides
+the simplicity of hash-based access, that Rubyists have come to know and
+love, supporting your configuration style of choice, while providing many
+new features, and an elegant API.
+</p>
+<h2>Features</h2>
+<ul>
+<li>Simple, easy to install and use.
+</li>
+<li>Supports yaml, xml, and properties files.
+</li>
+<li>Yaml and xml files support infinite level of configuration grouping.
+</li>
+<li>Properties files support git config-like configuration grouping.
+</li>
+<li>Intuitive dot-notation &#8216;key chaining&#8217; argument access.
+</li>
+<li>Simple well-known hash/array based argument access.
+</li>
+<li>Implements multilevel caching to reduce disk access.
+</li>
+<li>Short-hand access to &#8216;global&#8217; application configuration, and
+shell environment.
+</li>
+<li>Overlays multiple configuration files to support environment and
+host-specific configuration.
+</li>
+<li>Onload callbacks for single, multiple, or any config file.
+</li>
+</ul>
+<h2>Example</h2>
+<pre>
+  shell/console =&gt;
+    export LANG=en
+  demo.yml =&gt;
+   server:
+     address: host.domain.com
+     port: 81
+   ...
+  application.properties =&gt;
+    debug_level=verbose
+  ...
+ demo.rb =&gt;
+  require 'rconfig'
+  RConfig.config_paths = ['$HOME/config', '#{APP_ROOT}/config', '/demo/conf']
+  RConfig.demo[:server][:port] =&gt; 81
+  RConfig.demo.server.address  =&gt; 'host.domain.com'
+  RConfig[:debug_level] =&gt; 'verbose'
+  RConfig[:lang] =&gt; 'en'
+  ...
+</pre>
+<h2>Requirements</h2>
+<ul>
+<li>Ruby (Developed on 1.8.7)
+</li>
+<li>RubyGems (Developed on 1.3.5)
+</li>
+<li>activesupport (2.2.2+)
+</li>
+</ul>
+<h2>Install</h2>
+<pre>
+  sudo gem install rconfig
+</pre>
+<h2>ToDo</h2>
+<ol>
+<li>Finish JSpecs for existing code (Yeah, I know. You’re supposed to right
+the JSpecs first.)
+</li>
+<li>Create re-factor goals based on Caliper metrics.
+</li>
+<li>Prep for cleaner, stabler release.
+</li>
+</ol>
+<h2>Feature Ideas</h2>
+<ul>
+<li>Support for git-like config/properties files (You know, with the namespaced
+header blocks.).
+</li>
+<li>Support for Database-driven configuration.
+</li>
+<li>Removing dependency on ActiveSupport (Pull in needed code.).
+</li>
+<li>These are features I’m considering. E-mail me &lt;rahmal@gmail.com&gt; If
+you like to see a feature added or expedited.
+</li>
+</ul>
+<h2>Known Issues</h2>
+<ul>
+<li>None
+</li>
+</ul>
+<h2>License</h2>
+<p>
+(The MIT License)
+</p>
+<p>
+Copyright (c) 2009 Rahmal Conda &lt;rahmal@gmail.com&gt;
+</p>
+<p>
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+&#8216;Software&#8217;), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+</p>
+<p>
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+</p>
+<p>
+THE SOFTWARE IS PROVIDED &#8216;AS IS&#8217;, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.
+</p>
+<h2>Credits</h2>
+<p>
+Thanks to everyone I included here. <a
+href="../classes/RConfig.html">RConfig</a> would not exist without their
+contributions.
+</p>
+<p>
+Mike Sandler, Kurt Stephens, CashNetUSA (CNU):
+</p>
+<ul>
+<li>Wrote the proprietary class <a href="../classes/RConfig.html">RConfig</a>
+was originally based on.
+</li>
+</ul>
+    </div>
+   </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/files/lib/rconfig/class_variables_rb.html ADDED Viewed

@@ -0,0 +1,107 @@
+<?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: class_variables.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>class_variables.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>lib/rconfig/class_variables.rb
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Fri Feb 12 16:34:29 -0600 2010</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+These are all the variables used to store RConfigs state.
+</p>
+    </div>
+   </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/files/lib/rconfig/config_hash_rb.html ADDED Viewed

@@ -0,0 +1,114 @@
+<?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: config_hash.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>config_hash.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>lib/rconfig/config_hash.rb
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Wed Jan 06 00:15:55 -0600 2010</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+Copyright (c) 2009 Rahmal Conda &lt;rahmal@gmail.com&gt;
+</p>
+<p>
+<a href="../../../classes/ConfigHash.html">ConfigHash</a> is a special
+class, derived from HashWithIndifferentAccess. It was specifically created
+for handling config data or creating mock objects from yaml files. It
+provides a dotted notation for accessing embedded hash values, similar to
+the way one might traverse a object tree.
+</p>
+    </div>
+   </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>