config_module 0.0.1 → 0.0.2

data/README.markdown

@@ -3,10 +3,105 @@ ConfigModule
 
 Load important configuration files into their own modules!
 
+Installation
+------------
+
+Install the [gem](http://rubygems.org/gems/config_module), preferably using [Bundler](http://gembundler.com/):
+
+  ```ruby
+  gem 'config_module'     # in your Gemfile
+  ```
+
+  ```bash
+  bundle install          # on the command line
+  ```
+
+You may need to tell Ruby that you want to use it (depending how you're using Bundler):
+
+  ```ruby
+  require 'config_module' # in your file
+  ```
+
+Setup
+-----
+
+You only need to add two lines inside any module definition to make it a ConfigModule.
+
+1. Add the ConfigModule functionality to your module:
+
+  ```ruby
+  extend ConfigModule
+  ```
+
+2. Specify the name of your configuration file:
+
+  ```ruby
+  config_file './some_config.yml'
+  ```
+
+Done! 
+
+You're set up, and you can add any other functionality, aliases, or derived values to your module
+like any other Ruby module.
+
 Usage
 -----
 
-Set up your module:
+Now give it a try, any [valid](https://github.com/acook/config_module/edit/master/README.markdown#caveats) 
+key in your configuration file will now be a method:
+
+```ruby
+SomeConfig.my_key
+```
+
+You can even chain them! Try it:
+
+```ruby
+SomeConfig.my_key.my_subkey
+```
+
+How cool is that?
+
+Extras
+------
+
+In addition to the basics, ConfigModule also supplies a couple of helpers you might find useful.
+
+1. You can also set the "namespace" you want to use, this is great for apps with multiple environments:
+
+  ```ruby
+  namespace ENV['my_environment']
+  ```
+
+  This will set the root of the tree to whichever branch you specify, so you don't have to.
+  
+2. There's also a new method available in your module that points directly to the raw configuration data:
+   
+  ```ruby
+  config
+  ```
+  
+  Don't overwrite this method!
+
+3. You can still access raw data from outside the module too, if you want:
+  
+  ```ruby
+  MyConfig[:some_key].is_a? Hash #=> true
+  ```
+
+Example
+-------
+
+Given a YAML file `./config/example.yml':
+
+```yaml
+---
+:production:
+  :foo: bar
+  :noodle: boom!
+```
+
+And you set up your module:
 
 ```ruby
 require 'config_module'
@@ -25,11 +120,25 @@ module ExampleConfig
 end
 ```
 
-Then use it:
+Then you can use it like this:
 
 ```ruby
 ExampleConfig.foo       #=> 'bar'
 ExampleConfig.kanoodle  #=> 'kaboom!'
 ```
 
-Done!
+Pretty nifty, huh?
+
+Caveats
+-------
+
+- **Q:** You mention "valid key". What's a valid key? 
+- **A:** It's any object that you can call `.to_sym` on!
+
+Who made this anyway?
+---------------------
+
+I'm glad you asked!
+
+    Anthony M. Cook 2013
+    

data/lib/config_module/version.rb

@@ -1,3 +1,3 @@
 module ConfigModule
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/config_module.rb

@@ -1,4 +1,4 @@
-require 'config_module/version'
+require_relative 'config_module/version'
 require 'ostruct'
 require 'yaml'
 
@@ -35,7 +35,9 @@ protected
   end
 
   def method_missing name, *args, &block
-    wrap(config.send name, *args, &block) || super
+    wrap config.send name, *args, &block
+  rescue
+    raise NoMethodError, "undefined method `#{name}' for #{self}", caller(1)
   end
 
   class ConfigOption < OpenStruct

data/test/config/false_nil.yml

@@ -0,0 +1,3 @@
+---
+f: false
+n:

data/test/test.rb

@@ -1,7 +1,7 @@
 require_relative 'mutest'
 extend Mutest
 
-require_relative '../config_module'
+require_relative '../lib/config_module'
 module Rails; def self.env; 'production'; end; end
 require_relative 'example_config'
 
@@ -18,3 +18,24 @@ end
 spec 'nested hash values are properly wrapped' do
   ExampleConfig.dictionary.class == ConfigModule::ConfigOption
 end
+
+spec 'config modules have [] methods' do
+  ExampleConfig[:dictionary].keys.include? :configuration
+end
+
+spec 'subkeys are accessible with methods' do
+  ExampleConfig.dictionary.configuration == 'An arrangement of elements in a particular form, figure, or combination.'
+end
+
+module FalseNil
+  extend ConfigModule
+  config_file './config/false_nil.yml'
+end
+
+spec 'false values are returned' do
+  FalseNil.f == false
+end
+
+spec 'nil values are preserved' do
+  FalseNil.n == nil
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: config_module
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-14 00:00:00.000000000 Z
+date: 2013-02-15 00:00:00.000000000 Z
 dependencies: []
 description: Wrap a configuration file in a module for easy use throughout your application.
   Inspired by Rails.
@@ -27,6 +27,7 @@ files:
 - lib/config_module.rb
 - lib/config_module/version.rb
 - test/config/example.yml
+- test/config/false_nil.yml
 - test/example_config.rb
 - test/mutest.rb
 - test/test.rb
@@ -56,6 +57,7 @@ specification_version: 3
 summary: Load important configuration files into their own modules!
 test_files:
 - test/config/example.yml
+- test/config/false_nil.yml
 - test/example_config.rb
 - test/mutest.rb
 - test/test.rb