config_module 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a93ee42bdd50f65f7ae6b14b8b76cb7ea3dfe3a7
-  data.tar.gz: 0052b145d6b42b8d7e6662a9d196e22907e94568
+  metadata.gz: d6792656b2d9b4c12032dbdc18f8cd23616d7e30
+  data.tar.gz: 0783bade48f7706ed7c98250955c0fb2e2f6f521
 SHA512:
-  metadata.gz: 0f347735ec0e70695643960023c16128f58ea943992ef3c5f71af2daf96df5854b221f1448d635f8544cde4b4555c061e8b70844d864f90066b7ad1e49b25a92
-  data.tar.gz: 5535e018b88f7112b83e3015bfe7f2b58d02e76cfad063d4f0309ce963756919eb72baf8f5b45bb7c5150765175475378b1297e893b4b2a1e4ccf96baada5cdc
+  metadata.gz: d0898b4cf1494a0691235b4620bd76c2a829a1c8e268ac1804f02bbdb8b438cc4cb7278eb29ca0b6c0260c7306f10463957af74b22e4aa518f7e645866653da1
+  data.tar.gz: d44917bb9a1a70b59d03453ced028c8e7d05b64d7ce1173336c14dfacc040e18f0d5f4c432fdffcade9933dc0bf5530fddc4cb172340de872084599c83fa83c6

data/.travis.yml

@@ -1,9 +1,10 @@
 language: ruby
 rvm:
+  - 2.0.0
   - 1.9.3
   - 1.9.2
-  - rbx-19mode
   - ruby-head
+  - rbx-19mode
 script: bundle exec ruby spec/run_all_specs.rb
 before_install:
   - gem update bundler

data/README.markdown

@@ -3,6 +3,9 @@ ConfigModule
 
 Load important configuration files into their own modules!
 
+Reference documentation for the [Latest Released](http://rubydoc.info/gems/config_module/file/README.markdown) and [Edge Version](https://github.com/acook/config_module#readme) is available.
+
+[![Build Status](https://travis-ci.org/acook/config_module.png?branch=master)](https://travis-ci.org/acook/config_module)
 [![Code Climate](https://codeclimate.com/github/acook/config_module.png)](https://codeclimate.com/github/acook/config_module)
 [![Dependency Status](https://gemnasium.com/acook/config_module.png)](https://gemnasium.com/acook/config_module)
 
@@ -42,7 +45,7 @@ You only need to add two lines inside any module definition to make it a ConfigM
   config_file './some_config.yml'
   ```
 
-Done! 
+Done!
 
 You're set up, and you can add any other functionality, aliases, or derived values to your module
 like any other Ruby module.
@@ -50,7 +53,7 @@ like any other Ruby module.
 Usage
 -----
 
-Now give it a try, any [valid](https://github.com/acook/config_module/edit/master/README.markdown#caveats) 
+Now give it a try, any [valid](#caveats)
 key in your configuration file will now be a method:
 
 ```ruby
@@ -70,26 +73,80 @@ 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:
+### Namespaces
+
+You can also set the "namespace" you want to use, this is great for apps with different configurations per environment:
+
+```ruby
+namespace ENV['my_environment']
+```
+
+This will set the root of the configuration tree to whichever branch you specify, so you don't have to.
+
+Depending on your configuration file's structure, it might be useful to pull out a deeper subtree, in that case you can include multiple keys separated by commas, or even give it an array.
+
+Check out the [example section](#example) below to see how it's used.
+
+### The `config` Method
+
+There's also a new method available in your module that points to the root of your configuration data:
+
+```ruby
+def foo
+  config.foo
+end
+```
+
+### Check for Presence of Configuration Keys with `has_key?`
+
+There are times you want to provde defaults for values, and in typical Ruby fashion you would probably do this:
+
+```ruby
+MyConfig.some_option || 'my default value'
+```
+
+Occassionally though, that won't be good enough because the value could intentionally be `false` or even `nil`. In those situations, you might want to check to see if the key exists (especially useful along with namespaces). Much like a Hash, you can use the `has_key?` method and do something like:
+
+```ruby
+if MyConfig.has_key? :some_option then
+  MyConfig.some_option
+else
+  'my default value'
+end
+```
+
+### Hash-like Access
+
+You can access config options like a hash too, if you want:
 
   ```ruby
-  namespace ENV['my_environment']
+  MyConfig[:some_key].is_a? Hash #=> true
   ```
 
-  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:
-   
+  This is useful mainly when you'd rather get a `nil` instead of raising an error for nonexistant keys:
+
   ```ruby
-  config
+  MyConfig[:nonexistant_key] #=> nil
+  MyConfig.nonexistant_key   #=> raises ConfigModule::ConfigOption::NotFoundError
   ```
-  
-  Don't overwrite this method!
 
-3. You can still access raw data from outside the module too, if you want:
-  
+  It'll also avoid any naming conflicts that might arise between methods defined on ConfigModule or ConfigOption and your key names. You can use it in concert with the above `config` method instead of `self` to enhance readability:
+
   ```ruby
-  MyConfig[:some_key].is_a? Hash #=> true
+  def bar
+    config[:namespace]
+  end
+  ```
+
+
+### Enumerable
+
+  `ConfigOption` is the way ConfigModule packages up subtrees, and unlike `OpenStruct`, it is `Enumerable`:
+
+  ```ruby
+  MyConfig.some_key_with_subkeys.each do |subkey|
+    puts subkey
+  end
   ```
 
 Example
@@ -99,9 +156,10 @@ Given a YAML file `./config/example.yml':
 
 ```yaml
 ---
-:production:
-  :foo: bar
-  :noodle: boom!
+:example:
+  :production:
+    :foo: bar
+    :noodle: boom!
 ```
 
 And you set up your module:
@@ -113,12 +171,18 @@ module ExampleConfig
   extend ConfigModule
 
   config_file './config/example.yml'
-  namespace Rails.env
+  namespace :example, Rails.env
 
   module_function
 
   def kanoodle
-    'ka' + config.noodle
+    'ka' + noodle
+  end
+
+  def all_keys
+    config.map do |key, _|
+      key
+    end
   end
 end
 ```
@@ -127,7 +191,10 @@ Then you can use it like this:
 
 ```ruby
 ExampleConfig.foo       #=> 'bar'
+ExampleConfig[:foo]     #=> 'bar'
+ExampleConfig[:notakey] #=> nil
 ExampleConfig.kanoodle  #=> 'kaboom!'
+ExampleConfig.all_keys  #=> [:foo, :noodle]
 ```
 
 Pretty nifty, huh?
@@ -135,8 +202,8 @@ 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!
+- **Q:** You mention "valid key". What's a valid key?
+- **A:** It's any object that you can call `.to_sym` on (same as `OpenStruct`)!
 
 Who made this anyway?
 ---------------------
@@ -144,4 +211,4 @@ Who made this anyway?
 I'm glad you asked!
 
     Anthony M. Cook 2013
-    
+

data/lib/config_module/config_helper.rb

@@ -19,7 +19,10 @@ module ConfigModule
         raise
       end
     end
-    alias_method :field_lookup_handler, :method_missing_handler
+
+    def field_lookup_handler name, source, *args, &block
+      config[name]
+    end
 
     def load_config
       @raw_config = YAML.load_file config_file

data/lib/config_module/config_option.rb

@@ -19,10 +19,14 @@ module ConfigModule
       @table[name.to_sym]
     end
 
+    def has_key? key
+      @table.has_key? key
+    end
+
     def method_missing name, *args, &block
       result = super
 
-      if result || @table.include?(name) then
+      if result || @table.has_key?(name) then
         self.class.wrap result
       else
         raise(

data/lib/config_module/version.rb

@@ -1,3 +1,3 @@
 module ConfigModule
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/config_module.rb

@@ -1,6 +1,5 @@
 require 'ostruct'
 require 'yaml'
-require 'pry'
 
 require_relative 'config_module/version'
 require_relative 'config_module/exceptions'
@@ -16,6 +15,10 @@ module ConfigModule
     __config_module_helper.config
   end
 
+  def has_key? key
+    __config_module_helper.config.has_key? key
+  end
+
 protected
 
   def config_file new_config_file

data/spec/config_module_spec.rb

@@ -17,6 +17,10 @@ spec 'config modules return correct data using []' do
   ExampleConfig[:foo] == 'bar'
 end
 
+spec 'when using [], return nil for nonexistant keys' do
+  ExampleConfig[:nonexistant] == nil
+end
+
 spec 'nested hash values are properly wrapped' do
   ExampleConfig.dictionary.class == ConfigModule::ConfigOption
 end

data/spec/config_option_spec.rb

@@ -15,6 +15,18 @@ spec 'ConfigOptions are Enumerable' do
   opt.map{|k,v| v[:b]} == [5]
 end
 
+spec 'identifies the presence of keys' do
+  opt.has_key? :a
+end
+
+spec 'identifies the lack of keys' do
+  opt.has_key?('nonexistant') == false
+end
+
+spec 'identifies the presence of nested keys' do
+  opt.a.has_key? :b
+end
+
 spec 'to_ary' do
   begin
     opt.to_ary

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_module
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Anthony Cook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-14 00:00:00.000000000 Z
+date: 2013-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uspec