basic_config 0.0.2 → 0.1.0

data/README.md

@@ -1,6 +1,4 @@
-# BasicConfig
-
-[![Build Status](https://secure.travis-ci.org/stephan778/basic_config.png)](http://travis-ci.org/stephan778/basic_config)
+# BasicConfig [![Build Status](https://secure.travis-ci.org/stephan778/basic_config.png)](http://travis-ci.org/stephan778/basic_config)
 
 Friendly configuration wrapper. If you find yourself using things like:
 
@@ -75,10 +73,23 @@ or corrupting some data until you finally notice and track it down back to this
 
 If you are using a `BasicConfig`:
 ```ruby
+AppConfig = BasicConfig.load_env('config/application.yml', 'development')
 secret_token = AppConfig.something
 ```
-you'll get `NoMethodError` in that particular line with the name of the key that
-is missing.
+you'll get `BasicConfig::NotFound` exception with a message similar to this:
+    
+    Configuration key 'development.something' is missing in config/application.yml
+
+if you're constructing BasicConfig with `new`, then it'll show source code
+location where BasicConfig is initialized.
+
+```ruby
+AppConfig = BasicConfig.new({ secret_token: 'something' })
+secret_token = AppConfig.secret_toklen # Note a typo here
+
+# Will result in exception:
+# BasicConfig::NotFound: Configuration key 'secret_toklen' is missing in BasicConfig constructed at your_file.rb:5 in `new'
+```
 
 *Note:* There is also an `include?` method which you can use to check if
 particular key exist in your config - `AppConfig.include?(:something)`.

data/basic_config.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(spec)/})
   gem.name          = 'basic_config'
   gem.require_path  = 'lib'
-  gem.version       = '0.0.2'
+  gem.version       = '0.1.0'
 
   gem.add_development_dependency('rspec', '~> 2.10')
 end

data/lib/basic_config.rb

@@ -1,9 +1,24 @@
 require 'yaml'
 
 class BasicConfig
-  def initialize(hash)
+  class NotFound < RuntimeError
+    attr_reader :name, :scope, :key
+
+    def initialize(name, scope, key)
+      @name = name
+      @scope = scope
+      @key = key
+
+      super("Configuration key '#{scope}#{key}' is missing in #{name}")
+    end
+  end
+
+  def initialize(hash, configuration_name = nil, configuration_scope = '')
     raise ArgumentError, 'Hash can not be nil' if hash.nil?
 
+    @name = configuration_name || "BasicConfig constructed at #{caller[0]}"
+    @scope = configuration_scope
+
     # Symbolize keys: don't want to add ActiveSupport dependency just for this.
     @hash = hash.inject({}) do |h, (key, value)|
       h[key.to_sym] = value
@@ -11,7 +26,7 @@ class BasicConfig
     end
 
     @hash.each do |key, value|
-      @hash[key] = BasicConfig.new(value) if value.is_a?(Hash)
+      @hash[key] = BasicConfig.new(value, @name, [@scope, key, '.'].join) if value.is_a?(Hash)
     end
   end
 
@@ -28,7 +43,7 @@ class BasicConfig
       raise ArgumentError, 'Getter can not receive any arguments' if !args.empty? || block_given?
       @hash[meth]
     else
-      super
+      raise NotFound.new(@name, @scope, meth)
     end
   end
 
@@ -45,10 +60,10 @@ class BasicConfig
   end
 
   def self.load_file(name)
-    BasicConfig.new(YAML.load_file(name))
+    BasicConfig.new(YAML.load_file(name), name)
   end
 
   def self.load_env(name, env)
-    BasicConfig.new(YAML.load_file(name)[env])
+    BasicConfig.new(YAML.load_file(name)[env], name, env + '.')
   end
 end

data/spec/basic_config_spec.rb

@@ -41,28 +41,28 @@ describe BasicConfig do
   end
 
   it 'correctly handles respond_to? queries' do
-    subject.should respond_to :one
-    subject.should respond_to :three
-    subject.should_not respond_to :unknown
+    should respond_to :one
+    should respond_to :three
+    should_not respond_to :unknown
   end
-
-  it 'raises NoMethodError for unknown keys' do
-    expect { subject.four }.to raise_error(NoMethodError)
+  
+  it 'raises BasicConfig::KeyNotFound for unknown keys' do
+    expect { subject.four }.to raise_error(BasicConfig::NotFound)
   end
 
   it 'can be converted back to hash' do
     subject.to_hash.should == symbolized_hash
   end
 
-  describe '::load_file' do
+  describe '.load_file' do
     it 'uses YAML to load files' do
-      YAML.should_receive(:load_file).with('file').and_return(:content)
-      BasicConfig.should_receive(:new).with(:content)
-      BasicConfig.load_file('file')
+      content = { key: 'value' }
+      YAML.stub(:load_file).with('file').and_return(content)
+      BasicConfig.load_file('file').to_hash.should == content
     end
   end
 
-  describe '::load_env' do
+  describe '.load_env' do
     let(:content) do
       {
         'development' => {
@@ -73,10 +73,86 @@ describe BasicConfig do
         }
       }
     end
+    let(:environment) { 'development' }
+    let(:expected_result) { { value: 'x' } }
+
     it 'selects env section from YAML loaded file' do
-      YAML.should_receive(:load_file).with('file').and_return(content)
-      BasicConfig.should_receive(:new).with(content['development'])
-      BasicConfig.load_env('file', 'development')
+      YAML.stub(:load_file).with('file').and_return(content)
+      BasicConfig.load_env('file', environment).to_hash.should == expected_result
+    end
+  end
+  
+  describe BasicConfig::NotFound do
+    let(:exception) do
+      begin
+        config.missing_key
+      rescue BasicConfig::NotFound => expected_failure
+        expected_failure
+      end
+    end
+    subject { exception.message }
+    let(:original_config) { BasicConfig.new(hash) }
+    let(:original_scoping) { '' }
+
+    shared_examples_for 'specific failure' do
+      it 'contains the right location' do
+        should include location
+      end
+
+      it 'contains the right key' do
+        should include "'#{missing_key_name}'"
+      end
+    end
+
+    shared_examples_for 'construction contexts' do
+      context 'when constructed manually' do
+        let(:original_config) { BasicConfig.new(hash) }
+        let(:location) { 'spec/basic_config_spec.rb:109' }
+        
+        it_behaves_like 'specific failure'
+      end
+
+      context 'when loaded from YAML' do
+        let(:content) { hash }
+        let(:filename) { 'example.yml' }
+        let(:location) { filename }
+        
+        before do
+          YAML.stub(:load_file).with(filename).and_return(content)
+        end
+
+        let(:original_config) { BasicConfig.load_file(filename) }
+
+        it_behaves_like 'specific failure'
+
+        context 'with env' do
+          let(:content) do
+            {
+              'development' => hash,
+              'test' => hash
+            }
+          end
+          let(:environment) { 'development' }
+          let(:original_config) { BasicConfig.load_env(filename, environment) }
+          let(:original_scoping) { 'development.' }
+
+          it_behaves_like 'specific failure'
+        end
+      end
+    end
+
+    context 'top-level' do
+      let(:config) { original_config }
+      let(:missing_key_name) { "#{original_scoping}missing_key" }
+
+      it_behaves_like 'construction contexts'
+    end
+
+    context 'one-level in' do
+      let(:config) { original_config.three }
+      let(:missing_key_name) { "#{original_scoping}three.missing_key" }
+
+      it_behaves_like 'construction contexts'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: basic_config
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-02 00:00:00.000000000 Z
+date: 2012-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec