app_conf 0.1.1 → 0.1.2

data/README.md

@@ -1,12 +1,12 @@
 AppConf
 =======
-Simplest YAML Backed Application Configuration
+Simplest YAML Backed Application Wide Configuration (AppConfig)
 
 Installation
 ----------------------------------
     gem install app_conf
 
-Usage
+Example
 ----------------------------------
 config.yml
     ---
@@ -28,21 +28,50 @@ Code:
 
 Syntax
 ----------------------------------
+* Load multiple files at once:
+
     AppConf.load(*filenames)
+
+* Or individually:
+
+    AppConf.load(filename1)
+    AppConf.load(filename2)
+
+* Infinitely nested keys:
+
     AppConf.multiple.nested.keys
+
+* Override existing values:
+
     AppConf.loaded.from.yaml = 'can override'
+
+* Set new values:
+
     AppConf.non.existing.value = 'can set'
 
+* Clear entire tree:
+
+    AppConf.clear
+
+* Returns nil for non-existent keys:
+
+    AppConf.non_existing -> nil
+    AppConf.non_existing.name -> NoMethodError: undefined method `name' for nil:NilClass
+
+* Not dependent on Rails but easy to use with it. For example:
+
+    AppConf.load('config.yml', "#{Rails.env}.yml")
+
 Other stuff
 ----------------------------------
 * Works with Ruby 1.9.2
 * No gem dependencies
-* Tested with MiniTest::Spec
-* Not dependent on Rails but easy to use with it. For example:
-    `AppConf.load('config.yml', "#{Rails.env}.yml")`
+* Fully tested with MiniTest::Spec
+* Packaged as a Gem on RubyGems.org
 
 Why
 ----------------------------------
-* Because I wanted to write the simplest app config possible
-* Because I can
+* Because I wanted to write the simplest useful app config possible
+* Others are either too simple or incomplete, lack documentation or aren't Gem installable
+* Because I can :-)
 

data/app_conf.gemspec

@@ -2,10 +2,10 @@ require 'base64'
 
 Gem::Specification.new do |s|
   s.name        = 'app_conf'
-  s.version     = '0.1.1'
+  s.version     = '0.1.2'
   s.authors     = 'Phil Thompson'
   s.email       = Base64.decode64("cGhpbEBlbGVjdHJpY3Zpc2lvbnMuY29t\n")
-  s.summary     = 'Simplest YAML Backed Application Configuration'
+  s.summary     = 'Simplest YAML Backed Application Wide Configuration (AppConfig)'
   s.homepage    = 'https://github.com/PhilT/app_conf'
   s.required_rubygems_version = '>= 1.3.6'
 

data/lib/app_conf.rb

@@ -1,8 +1,6 @@
 require 'yaml'
 
 class AppConf
-  attr_reader :config
-
   private_class_method :new
   def initialize
     @config = {}
@@ -15,6 +13,11 @@ class AppConf
     end
   end
 
+  def self.clear
+    @@config = new
+    nil
+  end
+
   def method_missing(method, *args, &block)
     method = method.to_s
     if method[-1] == '='
@@ -31,10 +34,13 @@ class AppConf
   end
 
 private
-  def self.recurse(yaml, app_config)
-    yaml.each do |k, v|
-      v = recurse(v, app_config.send(k) || new) if v.is_a?(Hash)
-      app_config.config[k] = v
+  def self.recurse(hash, app_config)
+    hash.each do |key, value|
+      if value.is_a?(Hash)
+        new_app_config = new
+        value = recurse(value, app_config.send(key) || new_app_config)
+      end
+      app_config.send("#{key}=", value) if new_app_config.nil? || value === new_app_config
     end
     app_config
   end

data/spec/app_conf_spec.rb

@@ -5,44 +5,65 @@ require 'app_conf'
 describe AppConf do
   before(:each) do
     @dir = File.dirname(__FILE__)
-  end
-
-  it 'cannot be instantiated directly' do
-    AppConf.new.must_be_nil
+    AppConf.clear
+    AppConf.load("#{@dir}/config.yml")
   end
 
   it 'works with dot notation' do
-    AppConf.load("#{@dir}/config.yml")
     AppConf.fullname.must_equal 'Joe Bloggs'
   end
 
+  describe 'clear' do
+    it 'clears all keys' do
+      AppConf.fullname.wont_be_nil
+      AppConf.clear
+      AppConf.fullname.must_be_nil
+    end
+
+    it 'does not return AppConf instance' do
+      AppConf.clear.must_be_nil
+    end
+  end
+
   it 'works with nested dot notation' do
-    AppConf.load("#{@dir}/config.yml")
     AppConf.user.name.first.must_equal 'Joe'
   end
 
   it 'works with multiple files' do
+    AppConf.clear
     AppConf.load("#{@dir}/config.yml", "#{@dir}/other.yml")
     AppConf.user.address.street.must_equal '1 Some Road'
     AppConf.user.name.first.must_equal 'Joe'
   end
 
+  it 'loads additional files' do
+    AppConf.load("#{@dir}/other.yml")
+    AppConf.user.address.street.must_equal '1 Some Road'
+    AppConf.user.name.first.must_equal 'Joe'
+  end
+
   it 'allows additional keys to be set' do
-    AppConf.load("#{@dir}/config.yml")
     AppConf.user.name.last = 'Bloggs'
     AppConf.user.name.last.must_equal 'Bloggs'
   end
 
   it 'allows existing keys to be overridden' do
-    AppConf.load("#{@dir}/config.yml")
     AppConf.user.name.first = 'Jody'
     AppConf.user.name.first.must_equal 'Jody'
   end
 
-  it 'does not allow nested items to be overwritten' do
-    AppConf.load("#{@dir}/config.yml")
-    lambda { AppConf.user.name = 'something' }.must_raise RuntimeError
-  end
+  describe 'limitations' do
+    it 'cannot be instantiated directly' do
+      AppConf.new.must_be_nil
+    end
 
+    it 'returns nil when unknown key specified' do
+      AppConf.unknown.must_be_nil
+    end
+
+    it 'does not allow nested items to be overwritten' do
+      lambda { AppConf.user.name = 'something' }.must_raise RuntimeError
+    end
+  end
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Phil Thompson
@@ -69,7 +69,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Simplest YAML Backed Application Configuration
+summary: Simplest YAML Backed Application Wide Configuration (AppConfig)
 test_files: 
 - spec/app_conf_spec.rb
 - spec/config.yml