app_conf 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+

data/LICENSE

@@ -0,0 +1,23 @@
+(The MIT License)
+
+Copyright (c) 2011 Phil Thompson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,48 @@
+AppConf
+=======
+Simplest YAML Backed Application Configuration
+
+Installation
+----------------------------------
+    gem install app_conf
+
+Usage
+----------------------------------
+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'
+    AppConf.user.address.street -> '1 Some Road'
+
+Syntax
+----------------------------------
+    AppConf.load(*filenames)
+    AppConf.multiple.nested.keys
+    AppConf.loaded.from.yaml = 'can override'
+    AppConf.non.existing.value = 'can set'
+
+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")`
+
+Why
+----------------------------------
+* Because I wanted to write the simplest app config possible
+* Because I can
+

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rake/testtask'
+
+desc 'Test, build and install the gem'
+task :default => [:spec, :install]
+
+Rake::TestTask.new(:spec) do |t|
+  t.pattern = 'spec/*_spec.rb'
+end
+
+desc 'Build and install the gem'
+task :install do
+  gemspec_path = Dir['*.gemspec'].first
+  spec = eval(File.read(gemspec_path))
+
+  result = `gem build #{gemspec_path} 2>&1`
+  if result =~ /Successfully built/
+    system "gem uninstall -x #{spec.name} 2>&1"
+    system "gem install #{spec.file_name} --no-rdoc --no-ri 2>&1"
+  else
+    raise result
+  end
+end
+
+desc 'Take the version in the gemspec, create a git tag and send the gem to rubygems'
+task :release do
+  gemspec_path = Dir['*.gemspec'].first
+  spec = eval(File.read(gemspec_path))
+
+  system "git tag -f -a v#{spec.version} -m 'Version #{spec.version}'"
+  system "git push --tags"
+  system "gem push #{spec.file_name}"
+end
+

data/app_conf.gemspec

@@ -0,0 +1,16 @@
+require 'base64'
+
+Gem::Specification.new do |s|
+  s.name        = 'app_conf'
+  s.version     = '0.1.0'
+  s.authors     = 'Phil Thompson'
+  s.email       = Base64.decode64("cGhpbEBlbGVjdHJpY3Zpc2lvbnMuY29t\n")
+  s.summary     = 'Simplest YAML Backed Application Configuration'
+  s.required_rubygems_version = '>= 1.3.6'
+
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- spec/*`.split("\n")
+
+  s.require_path = 'lib'
+end
+

data/lib/app_conf.rb

@@ -0,0 +1,42 @@
+require 'yaml'
+
+class AppConf
+  attr_reader :config
+
+  private_class_method :new
+  def initialize
+    @config = {}
+  end
+  @@config = new
+
+  def self.load(*filenames)
+    filenames.each do |filename|
+      recurse(YAML.load(File.open(filename)), @@config)
+    end
+  end
+
+  def method_missing(method, *args, &block)
+    method = method.to_s
+    if method[-1] == '='
+      method = method[0..-2]
+      raise "Not allowed to overwrite nested entities" if @config[method].is_a?(AppConf)
+      @config[method] = args.first
+    else
+      @config[method]
+    end
+  end
+
+  def self.method_missing(method, *args, &block)
+    @@config.send(method, *args)
+  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
+    end
+    app_config
+  end
+end
+

data/spec/app_conf_spec.rb

@@ -0,0 +1,48 @@
+$LOAD_PATH << 'lib'
+require 'minitest/autorun'
+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
+  end
+
+  it 'works with dot notation' do
+    AppConf.load("#{@dir}/config.yml")
+    AppConf.fullname.must_equal 'Joe Bloggs'
+  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.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 '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
+
+end
+

data/spec/config.yml

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

data/spec/other.yml

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

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: app_conf
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Phil Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-27 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: 
+email: phil@electricvisions.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- app_conf.gemspec
+- lib/app_conf.rb
+- spec/app_conf_spec.rb
+- spec/config.yml
+- spec/other.yml
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simplest YAML Backed Application Configuration
+test_files: 
+- spec/app_conf_spec.rb
+- spec/config.yml
+- spec/other.yml