rconfig 0.3.3 → 0.4.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.iws
+*.ipr
+*.iml
+*.tmproj
+*.log
+*.swp
+*.*~
+*~
+.bundle
+.directory
+.document
+.idea
+.project
+.DS_Store
+.rakeTasks
+log
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color --format progress --backtrace

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@rconfig

data/ChangeLog

@@ -0,0 +1,50 @@
+0.4.0
+=====
+* Broke RConfig core into separate modules to decrease core class size.
+* Added Rails generator to override RConfig settings in Rails projects
+* Added support for git-like config files, giving key/value properties files potentially three levels.
+* Added support for values referencing other properties in key-value config files
+* Refactored settings module to allow for clean defaults, and overriding.
+* Added RConfig logger.
+* Renamed overlay to cascade
+* Fixed a syntax error in when clause of config_hash.rb for ruby 1.9.1 - From dvyjones/rconfig (github).
+* Fixed raise on allow_reload method.
+* Fixed unit test, rconfig_test.rb.
+* Fixed minor typos, comments, and bugs.
+* Refactored Hash#weave signature; changed dont_clobber=true, to clobber=false (reads more intuitively).
+* Removed redundant validate method from PropertiesFileParser.
+* Renamed PropertiesFileParser to PropertiesFile
+
+0.3.3
+=====
+* Fixed overlay class variable not loaded warning.
+
+0.3.2
+=====
+* Fixed bug in 0.3.1 causing stackrace
+
+0.3.1 (bug - DO NOT USE)
+=====
+* Added rake scripts
+* Finished gemspec
+* Created rdocs
+* Built gem file
+
+0.3
+=====
+* Re-factored rconfig core.
+* Added new helper method to init rconfig.
+* Re-factored core_ext/hash.
+* Added custom exceptions.
+* Added global instance $config, for convenience.
+* Updated comments.
+
+0.2
+=====
+* Added support for setting config path(s) programmtically.
+* Added support for using multiple file types at once.
+* Cleaned up STDERR statements.
+
+0.1
+=====
+* First public release

data/Credits

@@ -0,0 +1,13 @@
+Thanks to everyone I included here. RConfig would not exist without their contributions.
+
+Mike Sandler, Kurt Stephens, CashNetUSA (CNU):
+  - The core of logic of RConfig is based on a stand-alone class called CnuConfig, that resided in the CNU codebase.
+  - It was originally created by Mike Sandler as a config solution for CNU's internal web apps.
+  - It only supported yaml files, but it boasted overlay support to unobstrusively load environment specific configs,
+    and a dottable notation not seen in any other ruby config libraries.
+  - It was later enhanced by Kurt Stephens to support indifferent access, reload support, and callbacks, making it
+    a enterprise worthy config solution.
+  - I have made some signifcant enhancements to RConfig since that original debut, to make it a truly complete
+    configuration solution, all of which are in this gem.
+  - The original CnuConfig, that RConfig was forked from was open-sourced by CNU as ActiveConfig. It can be found on
+    GitHub for anyone interested.

data/Gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+gem 'activesupport', '~> 3.0', :require => 'active_support'
+
+group :development do
+  gem 'rspec',   '~> 2.3.0'
+  gem 'bundler', '~> 1.0.0'
+  gem 'jeweler', '~> 1.6.4'
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    multi_json (1.1.0)
+    rake (0.9.2.2)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.0)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Rahmal Conda
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), 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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", 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.

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'lib/rconfig'
+
+ 
+Dir['tasks/**/*.rake'].sort.each { |lib| load lib }
+

data/demo/application.conf

@@ -0,0 +1,3 @@
+test=true
+
+memory_limit=512

data/demo/demo.conf

@@ -0,0 +1,13 @@
+admin_email = root@localhost
+listen_ip = 127.0.0.1
+listen_port = 87345
+file_type: conf
+only_conf: true
+
+[group1]
+user_name = johnny
+group_name = daemons
+
+[group2]
+user_name = rita
+group_name = daemons

data/demo/demo.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(File.dirname(__FILE__),"..","lib")
+
+require 'rconfig'
+
+dir = File.dirname(__FILE__)
+
+puts "Current Dir: " + dir
+puts "RConfig.add_config_path File.dirname(__FILE__) => #{RConfig.add_config_path(dir)}"
+puts "RConfig.demo[:admin_email] => #{RConfig.demo[:admin_email]}"                  #=> 'root@localhost'
+puts "RConfig.demo.listen_ip => #{RConfig.demo.listen_ip}"                          #=> '127.0.0.1'
+puts "RConfig.demo[:group1][:group_name] => #{RConfig.demo[:group1][:group_name]}"  #=> 'daemons'
+puts "RConfig.demo.group2.user_name => #{RConfig.demo.group2.user_name}"            #=> 'rita'

data/demo/demo.xml

@@ -0,0 +1,13 @@
+<demo>
+<admin_email>root@localhost</admin_email>
+<listen_ip>127.0.0.1</listen_ip>
+<listen_port>87345</listen_port>
+<group1>
+  <user_name>johnny</user_name>
+  <group_name>daemons</group_name>
+</group1>
+<group2>
+  <user_name>rita</user_name>
+  <group_name>daemons</group_name>
+</group2>
+</demo>

data/demo/demo.yml

@@ -0,0 +1,12 @@
+admin_email: root@localhost
+listen_ip: 127.0.0.1
+listen_port: 87345
+file_type: yml
+
+group1:
+  user_name: johnny
+  group_name: daemons
+
+group2:
+  user_name: rita
+  group_name: daemons

data/doc/classes/ClassVariables.html

@@ -0,0 +1,111 @@
+<?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: ClassVariables</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">ClassVariables</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/rconfig/class_variables_rb.html">
+                lib/rconfig/class_variables.rb
+                </a>
+        <br />
+            </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/classes/ConfigError.html

@@ -0,0 +1,120 @@
+<?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: ConfigError</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">ConfigError</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/rconfig/exceptions_rb.html">
+                lib/rconfig/exceptions.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                StandardError
+            </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="RConfig.html">RConfig</a> Exceptions
+</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>