rack-config-flexible 0.1.1 → 0.1.2

data/README.md

@@ -1,7 +1,8 @@
 rack-config-flexible
 ====================
 
-An alternative to Rack::Config, offering much greater flexibility.
+A flexible configuration middleware for Rack that provides a simple DSL, 
+as well as the ability to easily load configuration from yaml files.
 
 Licensing
 =========
@@ -76,8 +77,8 @@ Any calls to _set_ after _environment_ or _section_ will override
 data loaded from the yaml file if the same key is specified.
 Otherwise, they'll just add the values to the hash per usual.
 
-Loading the Entire Configuration from a Yaml
-============================================
+Loading the Entire Configuration from Yaml
+==========================================
 
 You can load the entire configuration from a single file, or a
 directory tree.
@@ -93,7 +94,27 @@ use Rack::Config::Flexible :from_file => 'settings.yaml' do
 end
 ```
 
-This one from a directory tree:
+The _settings.yaml_ file should be laid out like:
+
+```yaml
+environment:
+  section:
+    key: value
+```
+
+So, the equivalent of the initial example would be:
+
+```yaml
+production:
+  data:
+    key: value
+
+development:
+  data:
+    key: dev_value
+```
+
+This example loads from a directory tree:
 
 ```ruby
 require 'rack/config/flexible'
@@ -110,8 +131,18 @@ The directory tree is expected to be laid out like:
 
 Where each directory under _settings_ is an _environment_, 
 containg a separate yaml file for each _section_. 
-The YAML file itself will only hold key-value pairs for
+The yaml file itself will only hold key-value pairs for
 that particular _section_.
 
 See the inline documentation for more details.
 
+Caveats
+=======
+
+Do *not* use this module and _Rack::Config_ at the same time! This module
+will remove the constant for _Rack::Config_ to avoid a conflict with _Rack::Config_
+being a class, whereas here we use it as a module.
+
+This means no new instances of _Rack::Config_ can be so easily created after this module is loaded.
+However, existing instances should still work.
+

data/lib/rack/config/flexible.rb

@@ -1,6 +1,25 @@
+#
+# Rack::Config::Flexible - Configuration middleware for Rack
+#
+# Copyright (C) 2012 Tim Hentenaar. All Rights Reserved.
+#
+# Licensed under the Simplified BSD License. 
+# See the LICENSE file for details.
+#
 require 'yaml'
 
 module Rack
+
+#
+# Remove the constant for Rack::Config otherwise we get
+# a TypeError since Rack::Config is a class, not a module.
+#
+# It seems the original instances will still be preserved
+#
+if Rack::Config.is_a?(Class)
+  Rack.send(:remove_const,'Config')
+end
+
 module Config
   #
   # === Overview

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-config-flexible
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-17 00:00:00.000000000 Z
+date: 2012-11-19 00:00:00.000000000 Z
 dependencies: []
 description: ! "  Rack::Config::Flexible is an alternative to Rack::Config,\n  offering
   much greater flexibility.\n  \n  Configuration options are stored as key-value pairs
@@ -47,7 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: An alternative to Rack::Config, offering much greater flexibility