app_conf 0.2.4 → 0.2.5

data/README.markdown

@@ -13,19 +13,23 @@ Installation
 
 Example
 ----------------------------------
+
 config.yml
+
     ---
     fullname: Joe Bloggs
     user:
       name: Joe
 
 other.yml
+
     ---
     user:
       address:
         street: 1 Some Road
 
 Code:
+
     AppConf.load('config.yml', 'other.yml')
     AppConf.fullname -> 'Joe Blogs'
     AppConf.user.name -> 'Joe'
@@ -33,39 +37,50 @@ Code:
 
 Syntax
 ----------------------------------
+
 Load multiple files at once:
+
     AppConf.load(*filenames)
 
 Or individually:
+
     AppConf.load(filename1)
     AppConf.load(filename2)
 
 Use either method calls or hash syntax:
+
     AppConf.fullname
     AppConf[:fullname]
     AppConf['fullname']
 
 Infinitely nested keys:
+
     AppConf.multiple.nested.keys
 
 Override existing values:
+
     AppConf.loaded.from.yaml = 'can override'
     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
 
 Use `from_hash` to create non-existent nodes:
+
     AppConf.from_hash({...})
 
 Not dependent on Rails but easy to use with it. For example:
+
     AppConf.load('config.yml', "#{Rails.env}.yml")
 
 Other stuff
@@ -84,5 +99,6 @@ Why
 Known Issues
 ----------------------------------
 Cannot assign values to unknown nested keys because they return nil (create the tree first):
+
     AppConf.from_hash({:non_existing => {:name => 'bla'}})
 

data/Rakefile

@@ -14,7 +14,7 @@ task :install do
 
   result = `gem build #{gemspec_path} 2>&1`
   if result =~ /Successfully built/
-    system "gem uninstall -x #{spec.name} 2>&1"
+    system "gem uninstall -I #{spec.name} 2>&1"
     system "gem install #{spec.file_name} --no-rdoc --no-ri 2>&1"
   else
     raise result

data/app_conf.gemspec

@@ -2,7 +2,7 @@ require 'base64'
 
 Gem::Specification.new do |s|
   s.name        = 'app_conf'
-  s.version     = '0.2.4'
+  s.version     = '0.2.5'
   s.authors     = 'Phil Thompson'
   s.email       = Base64.decode64("cGhpbEBlbGVjdHJpY3Zpc2lvbnMuY29t\n")
   s.summary     = 'Simplest YAML Backed Application Wide Configuration (AppConfig)'
@@ -13,5 +13,7 @@ Gem::Specification.new do |s|
   s.test_files         = `git ls-files -- spec/*`.split("\n")
 
   s.require_path = 'lib'
+
+  s.add_development_dependency 'fakefs'
 end
 

data/lib/app_conf.rb

@@ -12,6 +12,16 @@ class AppConf
     end
   end
 
+  def self.save(key, filename)
+    mode = File.exist?(filename) ? 'r+' : 'w+'
+    File.open(filename, mode) do |f|
+      while f.readline =~ /^#/; end unless f.eof?
+      hash = {key.to_s => @@root[key].to_hash}
+      YAML.dump(hash, f)
+      f.truncate(f.pos)
+    end
+  end
+
   def self.clear
     @@root = new
     nil

data/spec/app_conf_spec.rb

@@ -1,112 +1,143 @@
 $LOAD_PATH << 'lib'
+require 'fakefs/safe'
 require 'minitest/autorun'
 require 'app_conf'
 
 describe AppConf do
+  before(:each) do
+    FakeFS.activate!
+
+    config = 
+"fullname: Joe Bloggs
+user:
+  name:
+    first: Joe
+"
+    other =
+"user:
+  address:
+      street: 1 Some Road
+"
+    File.open('config.yml', 'w') {|f| f.write(config) }
+    File.open('other.yml', 'w') {|f| f.write(other)}
+    AppConf.clear
+    AppConf.load("config.yml")
+  end
+
+  after(:each) do
+    FakeFS.deactivate!
+  end
+
   it 'returns nil on empty tree' do
+    AppConf.clear
     AppConf.user.must_be_nil
   end
 
-  describe 'General' do
-    before(:each) do
-      @dir = File.dirname(__FILE__)
-      AppConf.clear
-      AppConf.load("#{@dir}/config.yml")
+  describe 'save' do
+    it 'saves a key and children to yml' do
+      AppConf.save :user, 'temp.yml'
+      YAML.load_file('temp.yml').must_equal({'user' => {'name' => {'first' => 'Joe'}}})
     end
 
-    describe 'inspect' do
-      it 'outputs a tree hash' do
-        AppConf.load("#{@dir}/other.yml")
-        AppConf.to_hash.must_equal({'fullname' => 'Joe Bloggs', 'user' => {'name' => {'first' => 'Joe'}, 'address' => {'street' => '1 Some Road'}}})
-      end
+    it 'skips past comments' do
+      File.open('config.yml', 'w') {|f| f.write("# comment 1\n# comment 2\n\nRest of the config")}
+      AppConf.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
+  end
 
-    describe 'keys' do
-      it 'returns them' do
-        AppConf.from_hash(:users => {:joe => nil, :mark => nil})
-
-        AppConf.users.keys.must_equal %w(joe mark)
-      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'}}})
     end
+  end
 
-    it 'creates from a hash' do
-      AppConf.clear
-      AppConf.from_hash(:user => {:name => {:first => 'Joe'}})
-      AppConf.user.name.first.must_equal 'Joe'
-    end
+  describe 'keys' do
+    it 'returns them' do
+      AppConf.from_hash(:users => {:joe => nil, :mark => nil})
 
-    it 'works with dot notation' do
-      AppConf.fullname.must_equal 'Joe Bloggs'
+      AppConf.users.keys.must_equal %w(joe mark)
     end
+  end
 
-    it 'works with hash notation' do
-      AppConf[:fullname].must_equal 'Joe Bloggs'
-      AppConf['fullname'].must_equal 'Joe Bloggs'
-    end
+  it 'creates from a hash' do
+    AppConf.clear
+    AppConf.from_hash(:user => {:name => {:first => 'Joe'}})
+    AppConf.user.name.first.must_equal 'Joe'
+  end
 
-    describe 'clear' do
-      it 'clears all keys' do
-        AppConf.fullname.wont_be_nil
-        AppConf.clear
-        AppConf.fullname.must_be_nil
-      end
+  it 'works with dot notation' do
+    AppConf.fullname.must_equal 'Joe Bloggs'
+  end
 
-      it 'does not return AppConf instance' do
-        AppConf.clear.must_be_nil
-      end
-    end
+  it 'works with hash notation' do
+    AppConf[:fullname].must_equal 'Joe Bloggs'
+    AppConf['fullname'].must_equal 'Joe Bloggs'
+  end
 
-    it 'works with nested dot notation' do
-      AppConf.user.name.first.must_equal 'Joe'
+  describe 'clear' do
+    it 'clears all keys' do
+      AppConf.fullname.wont_be_nil
+      AppConf.clear
+      AppConf.fullname.must_be_nil
     end
 
-    it 'works with nested hash notation' do
-      AppConf[:user][:name][:first].must_equal 'Joe'
-      AppConf['user']['name']['first'].must_equal 'Joe'
+    it 'does not return AppConf instance' do
+      AppConf.clear.must_be_nil
     end
+  end
 
-    it 'works with mixed notation' do
-      AppConf[:user][:name][:first].must_equal 'Joe'
-      AppConf.user['name'].first.must_equal 'Joe'
-    end
+  it 'works with nested dot notation' do
+    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 'works with nested hash notation' do
+    AppConf[:user][:name][:first].must_equal 'Joe'
+    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 'works with mixed notation' do
+    AppConf[:user][:name][:first].must_equal 'Joe'
+    AppConf.user['name'].first.must_equal 'Joe'
+  end
 
-    it 'allows additional keys to be set' do
-      AppConf.user.name.last = 'Bloggs'
-      AppConf.user.name.last.must_equal 'Bloggs'
-    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'
+  end
 
-    it 'allows additional keys to be set with hash notation' do
-      AppConf.user[:name][:last] = 'Bloggs'
-      AppConf.user.name.last.must_equal 'Bloggs'
-    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'
+  end
 
-    it 'allows existing keys to be overridden' do
-      AppConf.user.name.first = 'Jody'
-      AppConf.user.name.first.must_equal 'Jody'
-    end
+  it 'allows additional keys to be set' do
+    AppConf.user.name.last = 'Bloggs'
+    AppConf.user.name.last.must_equal 'Bloggs'
+  end
 
-    describe 'limitations' do
-      it 'returns nil when unknown key specified' do
-        AppConf.unknown.must_be_nil
-      end
+  it 'allows additional keys to be set with hash notation' do
+    AppConf.user[:name][:last] = 'Bloggs'
+    AppConf.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'
+  end
+
+  describe 'limitations' do
+    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
-        lambda { AppConf[:user][:name] = 'something' }.must_raise RuntimeError
-      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
     end
   end
 end

metadata

@@ -1,28 +1,33 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: app_conf
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.5
   prerelease: 
-  version: 0.2.4
 platform: ruby
-authors: 
+authors:
 - Phil Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-07 00:00:00 +01:00
-default_executable: 
-dependencies: []
-
+date: 2011-12-14 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: &20417420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20417420
 description: 
 email: phil@electricvisions.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - LICENSE
 - README.markdown
@@ -30,37 +35,29 @@ files:
 - app_conf.gemspec
 - lib/app_conf.rb
 - spec/app_conf_spec.rb
-- spec/config.yml
-- spec/other.yml
-has_rdoc: true
 homepage: https://github.com/PhilT/app_conf
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Simplest YAML Backed Application Wide Configuration (AppConfig)
-test_files: 
+test_files:
 - spec/app_conf_spec.rb
-- spec/config.yml
-- spec/other.yml

data/spec/config.yml

@@ -1,5 +0,0 @@
-fullname: Joe Bloggs
-user:
-  name:
-    first: Joe
-

data/spec/other.yml

@@ -1,4 +0,0 @@
-user:
-  address:
-    street: 1 Some Road
-