configurethis 1.0.4 → 1.0.5

data/README.md

@@ -4,6 +4,28 @@
 Clean up your configuration approach by using Configurethis. Configurethis allows you to access your config values using
 method names instead of string literals to identify which config value you want to retrieve. 
 
+## Quick example
+```ruby
+# lib/password_settings.rb
+class PasswordSettings
+  extend Configurethis
+end
+
+# some_ruby_file_in_my_app.rb
+PasswordSettings.min_length        #=> 10
+PasswordSettings.require_uppercase #=> true
+PasswordSettings.storage.keep_last #=> 3
+```
+```yml
+---
+# config/password_settings.yml
+minLength: 10
+require_uppercase: true
+storage:
+  keep_last: 3
+```
+
+## Why?
 Typical Ruby code has craziness like this all over the place:
 ```ruby
 # config/initializers/load_config.rb
@@ -42,7 +64,7 @@ storage:
   keep_last: 3
 ```
 
-## Installation
+## Get started with Configurethis!
 
 Add this line to your application's Gemfile:
 
@@ -56,7 +78,7 @@ Or install it yourself as:
 
     $ gem install configurethis
 
-## Usage
+## How to?
 
 ### Setup
 To get started, specify where you want `Configurethis` to look for your .yml files at.
@@ -108,6 +130,32 @@ class IWantToBeDifferent
 end
 ```
 
+### Inspecting keys for a hash value
+Sometimes you may want to iterate over the keys of a configured hash. You can do this by calling `#keys` on the hash to retrieve a list of the keys.
+For example, if your YAML is represented as:
+```yml
+---
+bourbon:
+  distillery:
+    woodford:
+      # more data on woodford
+    buffalo_trace:
+      # more stuff
+    makers_mark:
+      # makers stuff
+```
+And let's assume our configuration class is called `BourbonConfig`, we could retrieve a list of distilleries using `#keys`:
+```ruby
+BourbonConfig.bourbon.distillery.keys #=> ["woodford", "buffalo_trace", "makers_mark"]
+```
+
+### Validation
+If you are having problems and everything "looks clear", try running your YAML through a [YAML lint test](http://yamllint.com). 
+Ruby has been known to be forgiving to poorly formatted YAML in some versions, but not others.
+
+### Running the tests
+Just run rspec from your prompt! The tests are also contain great examples about how to use Configurethis.
+
 ### Testing
 While working with Configurethis in your specs/tests you can override the configuration
 and avoid using the real configuration files to simulate behavior. This enables you to 

data/lib/configurethis.rb

@@ -1,7 +1,7 @@
 require "configurethis/version"
 require "configurethis/value_container"
-require "configurethis/mock_configuration"
 require "configurethis/configuration"
+require "configurethis/mock_configuration"
 require "configurethis/configurethis_properties"
 
 module Configurethis

data/lib/configurethis/mock_configuration.rb

@@ -1,31 +1,14 @@
-module Configurethis
-  class MockConfiguration
-    attr_reader :path
+require "configurethis/configuration"
 
+module Configurethis
+  class MockConfiguration < Configuration
     def initialize(values)
       @path = "<mocked_configuration>"
       @mock_values = values
     end
 
-    def root=(key)
-      @values = load_configuration.fetch(key)
-    rescue ::IndexError
-      raise "'#{key}' is not configured in #{path}"
-    end
-
-    def [](key)
-      @values ||= load_configuration
-      val = @values.fetch(key)
-      return ValueContainer.new(val, path) if val.is_a?(Hash)
-      val
-    rescue ::IndexError
-      raise "'#{key}' is not configured in #{path}"
-    end
-
     def load_configuration
       @mock_values
     end
-
-
   end
 end

data/lib/configurethis/value_container.rb

@@ -5,6 +5,10 @@ module Configurethis
       @config_path = config_path
     end
 
+    def keys
+      @original_value.keys
+    end
+
     def method_missing(method, *args)
       val = @original_value.fetch(method.to_s)
       return ValueContainer.new(val, @config_path) if val.is_a?(Hash)

data/lib/configurethis/version.rb

@@ -1,3 +1,3 @@
 module Configurethis
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

data/spec/configurethis/configurethis_spec.rb

@@ -69,13 +69,28 @@ describe Configurethis do
         Then  { expect( config.alpha ).to eql( "a" ) }
       end
     end
-
-
   end
 
   describe "using configured values" do
     Given { Configurethis.root_path = File.join(File.dirname(__FILE__), 'support/config') }
 
+    describe "and inspecting configuration keys" do
+      after(:each) { KeysConfig.reload_configuration }
+      Given (:config) { KeysConfig }
+
+      context "when value is a hash" do
+        Then  { expect( config.beer.brewery.keys ).to match_array(["stone", "victory"]) }
+      end
+
+      context "when value is an array" do
+        Then  { expect{ config.beer.brewery.stone.keys }.to raise_error(NoMethodError) }
+      end
+
+      context "when value is an unassigned value" do
+        Then  { expect{ config.bourbon.distillery.woodford.keys }.to raise_error(NoMethodError) }
+      end
+    end
+
     context "when the classes config file does not exist" do
       Given (:config) { MissingConfiguration }
       Then  { expect{ config.some_value }.to raise_error(RuntimeError, "Could not locate configuration file: #{config.configuration_path}") }

data/spec/configurethis/support/classes.rb

@@ -1,5 +1,6 @@
 %w[
   conventional_path
+  keys_config
   missing_configuration
   namespaced_conventional_path
   nested_config

data/spec/configurethis/support/classes/keys_config.rb

@@ -0,0 +1,3 @@
+class KeysConfig
+  extend Configurethis
+end

data/spec/configurethis/support/config/keys_config.yml

@@ -0,0 +1,15 @@
+beer:
+  brewery:
+    stone:
+      - "IPA"
+      - "Ruination"
+      - "Imperial Stout"
+    victory:
+      - "Hop devil"
+      - "Prima Pils"
+bourbon:
+  distillery:
+    woodford:
+    buffalo_trace:
+    makers_mark:
+  

metadata

@@ -1,27 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: configurethis
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
+  prerelease: 
 platform: ruby
 authors:
 - Matt Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-08 00:00:00.000000000 Z
+date: 2013-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-given
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 description: Clean up your configuration approach by using Configurethis. Configurethis
@@ -50,6 +53,7 @@ files:
 - spec/configurethis/configurethis_spec.rb
 - spec/configurethis/support/classes.rb
 - spec/configurethis/support/classes/conventional_path.rb
+- spec/configurethis/support/classes/keys_config.rb
 - spec/configurethis/support/classes/missing_configuration.rb
 - spec/configurethis/support/classes/my_custom_conf.rb
 - spec/configurethis/support/classes/namespaced_conventional_path.rb
@@ -57,6 +61,7 @@ files:
 - spec/configurethis/support/classes/override_path.rb
 - spec/configurethis/support/classes/rails_app_config.rb
 - spec/configurethis/support/classes/riak_config.rb
+- spec/configurethis/support/config/keys_config.yml
 - spec/configurethis/support/config/nested_config.yml
 - spec/configurethis/support/config/rails_app_config.yml
 - spec/configurethis/support/config/riak_config.yml
@@ -65,26 +70,27 @@ homepage: https://github.com/mattsnyder/configurethis
 licenses:
 - MIT
 - GPL-2
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Clean up your configuration approach by using Configurethis. Configurethis
   allows you to access your config values using method names instead of string literals
   to identify which config value you want to retrieve.
@@ -92,6 +98,7 @@ test_files:
 - spec/configurethis/configurethis_spec.rb
 - spec/configurethis/support/classes.rb
 - spec/configurethis/support/classes/conventional_path.rb
+- spec/configurethis/support/classes/keys_config.rb
 - spec/configurethis/support/classes/missing_configuration.rb
 - spec/configurethis/support/classes/my_custom_conf.rb
 - spec/configurethis/support/classes/namespaced_conventional_path.rb
@@ -99,6 +106,7 @@ test_files:
 - spec/configurethis/support/classes/override_path.rb
 - spec/configurethis/support/classes/rails_app_config.rb
 - spec/configurethis/support/classes/riak_config.rb
+- spec/configurethis/support/config/keys_config.yml
 - spec/configurethis/support/config/nested_config.yml
 - spec/configurethis/support/config/rails_app_config.yml
 - spec/configurethis/support/config/riak_config.yml

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: de51c7bf8ff307aa213f4f6431be1fdd79beb4c4
-  data.tar.gz: c12f30afd2ac5c311cb13d9974f1d1a3b2c28868
-SHA512:
-  metadata.gz: ea2e4efb4bc08bccd90d4e529a3118731273df9599bea18f4a772b4412499f1dd15b0af26d794de8865f4385982c1b1d14ebc6f88217ce31a07c1ea3fdeb10cf
-  data.tar.gz: ae2b9a342b327bfd077e013ef825c36eba9d20f597123ac8155a5885c3d29ac812cf97f350efcb2d25952ddfc5e90b4b5f224b77ef1224b1c866427cbbe0a48c