app_conf 0.3.0 → 0.4.0

data/README.markdown

@@ -1,11 +1,13 @@
 AppConf
-=======
-Simplest YAML Backed Application Wide Configuration (AppConfig)
+----------------------------------
+YAML Backed Application Wide Configuration with a few extras ($config)
 
-* Load from YAML file(s)
-* Add additional key/value pairs in code
+* Supports nested key/values
+* Loading and Saving of YAML files
+* Add further key/value pairs in code
 * Use dot or bracket notation
-* `AppConf.to_hash` outputs a hash map of AppConf key/values
+* `$conf.to_hash` outputs a hash map of $conf key/values
+* `$conf.from_hash` creates nested key/values from a hash
 
 Installation
 ----------------------------------
@@ -30,58 +32,60 @@ other.yml
 
 Code:
 
-    AppConf.load('config.yml', 'other.yml')
-    AppConf.fullname -> 'Joe Blogs'
-    AppConf.user.name -> 'Joe'
-    AppConf.user[:address]['street'] -> '1 Some Road'
+    $conf = $conf.new
+
+    $conf.load('config.yml', 'other.yml')
+    $conf.fullname -> 'Joe Blogs'
+    $conf.user.name -> 'Joe'
+    $conf.user[:address]['street'] -> '1 Some Road'
 
 Syntax
 ----------------------------------
 
 Load multiple files at once:
 
-    AppConf.load(*filenames)
+    $conf.load(*filenames)
 
 Or individually:
 
-    AppConf.load(filename1)
-    AppConf.load(filename2)
+    $conf.load(filename1)
+    $conf.load(filename2)
 
 Use either method calls or hash syntax:
 
-    AppConf.fullname
-    AppConf[:fullname]
-    AppConf['fullname']
+    $conf.fullname
+    $conf[:fullname]
+    $conf['fullname']
 
 Infinitely nested keys:
 
-    AppConf.multiple.nested.keys
+    $conf.multiple.nested.keys
 
 Override existing values:
 
-    AppConf.loaded.from.yaml = 'can override'
-    AppConf['loaded']['from']['yaml'] = 'can override'
+    $conf.loaded.from.yaml = 'can override'
+    $conf['loaded']['from']['yaml'] = 'can override'
 
 Set new values:
 
-    AppConf.non_existing_value = 'can set'
+    $conf.non_existing_value = 'can set'
 
 Clear entire tree:
 
-    AppConf.clear
+    $conf.clear
 
 Returns nil for non-existent keys:
 
-    AppConf.non_existing -> nil
-    AppConf.non_existing.name -> NoMethodError: undefined method 'name' for nil:NilClass
+    $conf.non_existing -> nil
+    $conf.non_existing.name -> NoMethodError: undefined method 'name' for nil:NilClass
 
 Use `from_hash` to create non-existent nodes:
 
-    AppConf.from_hash({...})
+    $conf.from_hash({...})
 
 Not dependent on Rails but easy to use with it. For example:
 
-    AppConf.load('config.yml', "#{Rails.env}.yml")
+    $conf.load('config.yml', "#{Rails.env}.yml")
 
 Other stuff
 ----------------------------------
@@ -100,5 +104,5 @@ Known Issues
 ----------------------------------
 Cannot assign values to unknown nested keys because they return nil (create the tree first):
 
-    AppConf.from_hash({:non_existing => {:name => 'bla'}})
+    $conf.from_hash({:non_existing => {:name => 'bla'}})
 

data/Rakefile

@@ -1,4 +1,5 @@
 require 'rake/testtask'
+require './lib/app_conf'
 
 desc 'Test, build and install the gem'
 task :default => [:spec, :install]

data/app_conf.gemspec

@@ -2,7 +2,7 @@ require 'base64'
 
 Gem::Specification.new do |s|
   s.name        = 'app_conf'
-  s.version     = '0.3.0'
+  s.version     = '0.4.0'
   s.authors     = 'Phil Thompson'
   s.email       = Base64.decode64("cGhpbEBlbGVjdHJpY3Zpc2lvbnMuY29t\n")
   s.summary     = 'Simplest YAML Backed Application Wide Configuration (AppConfig)'

data/lib/app_conf.rb

@@ -4,16 +4,15 @@ class AppConf
   def initialize
     @hash = {}
   end
-  @@root = new
 
-  def self.load(*filenames)
+  def load(*filenames)
     filenames.each do |filename|
       content = YAML.load_file(filename)
       from_hash(content) if content
     end
   end
 
-  def self.save(key, filename)
+  def save(key, filename)
     mode = File.exist?(filename) ? 'r+' : 'w+'
     File.open(filename, mode) do |f|
       unless f.eof?
@@ -23,25 +22,17 @@ class AppConf
         end until line =~ /^---/ || f.eof?
         line =~ /^---/ ? f.seek(pos) : f.rewind
       end
-      hash = {key.to_s => @@root[key].to_hash}
+      hash = {key.to_s => self[key].to_hash}
       YAML.dump(hash, f)
       f.truncate(f.pos)
     end
   end
 
-  def self.clear key = nil
-    key ? @@root.clear(key) : @@root = new
+  def clear key = nil
+    key ? @hash[key.to_s] = nil : @hash = {}
     nil
   end
 
-  def clear key
-    @hash[key.to_s] = nil
-  end
-
-  def self.to_hash
-    @@root.to_hash
-  end
-
   def to_hash
     hash = {}
     @hash.each {|k, v| hash[k] = v.is_a?(AppConf) ? v.to_hash : v }
@@ -69,19 +60,12 @@ class AppConf
     end
   end
 
-  def self.method_missing(method, *args, &block)
-    @@root.send(method, *args)
-  end
-
-  def self.from_hash(hash, app_config = @@root)
+  def from_hash(hash)
     hash.each do |key, value|
-      if value.is_a?(Hash)
-        new_app_config = new
-        value = from_hash(value, app_config[key] || new_app_config)
-      end
-      app_config[key] = value if new_app_config.nil? || value === new_app_config
+      value = (self[key] || AppConf.new).from_hash(value) if value.is_a?(Hash)
+      @hash[key.to_s] = value
     end
-    app_config
+    self
   end
 end
 

data/spec/app_conf_spec.rb

@@ -4,10 +4,10 @@ require 'minitest/autorun'
 require 'app_conf'
 
 describe AppConf do
-  before(:each) do
+  before do
     FakeFS.activate!
 
-    config = 
+    config =
 "fullname: Joe Bloggs
 user:
   name:
@@ -20,157 +20,162 @@ user:
 "
     File.open('config.yml', 'w') {|f| f.write(config) }
     File.open('other.yml', 'w') {|f| f.write(other)}
-    AppConf.clear
-    AppConf.load("config.yml")
+    $conf = AppConf.new
+    $conf.load("config.yml")
   end
 
-  after(:each) do
+  after do
     FakeFS.deactivate!
   end
 
   it 'returns nil on empty tree' do
-    AppConf.clear
-    AppConf.user.must_be_nil
+    $conf.clear
+    $conf.user.must_be_nil
   end
 
   it 'clears a key' do
-    AppConf.user.clear :name
-    AppConf.user.name.must_be_nil
+    $conf.user.clear :name
+    $conf.user.name.must_be_nil
   end
 
   it 'clears a key in root' do
-    AppConf.clear :user
-    AppConf.user.must_be_nil
+    $conf.clear :user
+    $conf.user.must_be_nil
   end
 
   it 'cleared key can be overwritten' do
-    AppConf.clear :user
-    AppConf.user = 'something'
-    AppConf.user.must_equal 'something'
+    $conf.clear :user
+    $conf.user = 'something'
+    $conf.user.must_equal 'something'
+  end
+
+  it 'handles rake clobbering global' do
+    $conf.task = 'something'
+    $conf.task.must_equal 'something'
   end
 
   describe 'save' do
     it 'saves a key and children to yml' do
-      AppConf.save :user, 'temp.yml'
+      $conf.save :user, 'temp.yml'
       YAML.load_file('temp.yml').must_equal({'user' => {'name' => {'first' => 'Joe'}}})
     end
 
     it 'skips past comments' do
       File.open('config.yml', 'w') {|f| f.write("# comment 1\n# comment 2\n\n--- \nRest of the config")}
-      AppConf.save :user, 'config.yml'
+      $conf.save :user, 'config.yml'
       File.read('config.yml').must_equal "# comment 1\n# comment 2\n\n--- \nuser: \n  name: \n    first: Joe\n"
     end
 
     it 'overwrites when no --- and single line' do
       File.open('config.yml', 'w') {|f| f.write("some config\n") }
-      AppConf.save :user, 'config.yml'
+      $conf.save :user, 'config.yml'
       File.read('config.yml').must_equal "--- \nuser: \n  name: \n    first: Joe\n"
     end
 
     it 'overwrites when no --- and multiline' do
       File.open('config.yml', 'w') {|f| f.write("# Some\n# comments\n\nconfig:\n  name:\n") }
-      AppConf.save :user, 'config.yml'
+      $conf.save :user, 'config.yml'
       File.read('config.yml').must_equal "--- \nuser: \n  name: \n    first: Joe\n"
     end
   end
 
   describe 'to_hash' do
     it 'outputs a hash map' do
-      AppConf.load("other.yml")
-      AppConf.to_hash.must_equal({'fullname' => 'Joe Bloggs', 'user' => {'name' => {'first' => 'Joe'}, 'address' => {'street' => '1 Some Road'}}})
+      $conf.load("other.yml")
+      $conf.to_hash.must_equal({'fullname' => 'Joe Bloggs', 'user' => {'name' => {'first' => 'Joe'}, 'address' => {'street' => '1 Some Road'}}})
     end
   end
 
   describe 'keys' do
     it 'returns them' do
-      AppConf.from_hash(:users => {:joe => nil, :mark => nil})
+      $conf.from_hash(:users => {:joe => nil, :mark => nil})
 
-      AppConf.users.keys.must_equal %w(joe mark)
+      $conf.users.keys.must_equal %w(joe mark)
     end
   end
 
   it 'creates from a hash' do
-    AppConf.clear
-    AppConf.from_hash(:user => {:name => {:first => 'Joe'}})
-    AppConf.user.name.first.must_equal 'Joe'
+    $conf.clear
+    $conf.from_hash(:user => {:name => {:first => 'Joe'}})
+    $conf.user.name.first.must_equal 'Joe'
   end
 
   it 'works with dot notation' do
-    AppConf.fullname.must_equal 'Joe Bloggs'
+    $conf.fullname.must_equal 'Joe Bloggs'
   end
 
   it 'works with hash notation' do
-    AppConf[:fullname].must_equal 'Joe Bloggs'
-    AppConf['fullname'].must_equal 'Joe Bloggs'
+    $conf[:fullname].must_equal 'Joe Bloggs'
+    $conf['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
+      $conf.fullname.wont_be_nil
+      $conf.clear
+      $conf.fullname.must_be_nil
     end
 
-    it 'does not return AppConf instance' do
-      AppConf.clear.must_be_nil
+    it 'does not return $conf instance' do
+      $conf.clear.must_be_nil
     end
   end
 
   it 'works with nested dot notation' do
-    AppConf.user.name.first.must_equal 'Joe'
+    $conf.user.name.first.must_equal 'Joe'
   end
 
   it 'works with nested hash notation' do
-    AppConf[:user][:name][:first].must_equal 'Joe'
-    AppConf['user']['name']['first'].must_equal 'Joe'
+    $conf[:user][:name][:first].must_equal 'Joe'
+    $conf['user']['name']['first'].must_equal 'Joe'
   end
 
   it 'works with mixed notation' do
-    AppConf[:user][:name][:first].must_equal 'Joe'
-    AppConf.user['name'].first.must_equal 'Joe'
+    $conf[:user][:name][:first].must_equal 'Joe'
+    $conf.user['name'].first.must_equal 'Joe'
   end
 
   it 'works with multiple files' do
-    AppConf.clear
-    AppConf.load("config.yml", "other.yml")
-    AppConf.user.address.street.must_equal '1 Some Road'
-    AppConf.user.name.first.must_equal 'Joe'
+    $conf.clear
+    $conf.load("config.yml", "other.yml")
+    $conf.user.address.street.must_equal '1 Some Road'
+    $conf.user.name.first.must_equal 'Joe'
   end
 
   it 'loads additional files' do
-    AppConf.load("other.yml")
-    AppConf.user.address.street.must_equal '1 Some Road'
-    AppConf.user.name.first.must_equal 'Joe'
+    $conf.load("other.yml")
+    $conf.user.address.street.must_equal '1 Some Road'
+    $conf.user.name.first.must_equal 'Joe'
   end
 
   it 'handles empty files' do
     File.open('empty.yml', 'w') {}
-    AppConf.load('empty.yml')
+    $conf.load('empty.yml')
   end
 
   it 'allows additional keys to be set' do
-    AppConf.user.name.last = 'Bloggs'
-    AppConf.user.name.last.must_equal 'Bloggs'
+    $conf.user.name.last = 'Bloggs'
+    $conf.user.name.last.must_equal 'Bloggs'
   end
 
   it 'allows additional keys to be set with hash notation' do
-    AppConf.user[:name][:last] = 'Bloggs'
-    AppConf.user.name.last.must_equal 'Bloggs'
+    $conf.user[:name][:last] = 'Bloggs'
+    $conf.user.name.last.must_equal 'Bloggs'
   end
 
   it 'allows existing keys to be overridden' do
-    AppConf.user.name.first = 'Jody'
-    AppConf.user.name.first.must_equal 'Jody'
+    $conf.user.name.first = 'Jody'
+    $conf.user.name.first.must_equal 'Jody'
   end
 
   describe 'limitations' do
     it 'returns nil when unknown key specified' do
-      AppConf.unknown.must_be_nil
+      $conf.unknown.must_be_nil
     end
 
     it 'does not allow nested items to be overwritten' do
-      lambda { AppConf.user.name = 'something' }.must_raise RuntimeError
-      lambda { AppConf[:user][:name] = 'something' }.must_raise RuntimeError
+      lambda { $conf.user.name = 'something' }.must_raise RuntimeError
+      lambda { $conf[:user][:name] = 'something' }.must_raise RuntimeError
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_conf
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-19 00:00:00.000000000Z
+date: 2012-03-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &9210480 !ruby/object:Gem::Requirement
+  requirement: &18793300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9210480
+  version_requirements: *18793300
 description: 
 email: phil@electricvisions.com
 executables: []
@@ -55,9 +55,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Simplest YAML Backed Application Wide Configuration (AppConfig)
 test_files:
 - spec/app_conf_spec.rb
+has_rdoc: