konf 0.0.0 → 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Oleg Khabarov
+
+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,50 @@
+# Konf
+
+**Konf** is a simple configuration reader. 
+
+## Setup
+
+Simply install the gem and/or plug this into the Gemfile:
+
+    gem 'konf'
+    
+## Usage
+
+Assuming you have a configuration file like this:
+
+    development:
+      admin:
+        name: Dev
+        email: dev@test.test
+    production:
+      admin:
+        name: Pro
+        email: pro@test.test
+
+You can load a YAML file, or provide a simple Hash and read configuration values like this:
+    
+    >> conf = Konf.new('configuration.yml')
+    >> conf.development.name
+    => 'Dev'
+    
+If you try to read a configuration that wasn't defined:
+
+    >> conf.development.invalid
+    => Konf::NotFound: No configuration found for 'invalid'
+    
+You can check if configuration exists:
+
+    >> conf.development.admin?
+    => true
+    >> conf.development.invalid?
+    => false
+    
+You can namespace your configuration:
+
+    >> conf = Konf.new('configuration.yml', 'production')
+    >> conf.admin.name
+    => 'Pro'
+
+## Author
+
+(c) 2011 Oleg Khabarov, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/konf.gemspec

@@ -0,0 +1,51 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "konf"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Oleg Khabarov"]
+  s.date = "2011-12-21"
+  s.description = "minimalistic configuration reader"
+  s.email = "oleg@khabarov.ca"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "konf.gemspec",
+    "lib/konf.rb",
+    "test/config.yml",
+    "test/konf_test.rb"
+  ]
+  s.homepage = "http://github.com/GBH/konf"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "minimalistic configuration reader"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+  end
+end
+

data/lib/konf.rb

@@ -1,3 +1,31 @@
-class Konf
+require 'yaml'
+require 'erb'
+
+class Konf < Hash
+  class NotFound < StandardError; end
+  
+  def initialize(source, root = nil)
+    hash = case source
+    when Hash
+      source
+    else
+      YAML.load(ERB.new(File.read(source)).result).to_hash
+    end
+    if root
+      hash = hash[root] or raise NotFound, "No configuration found for '#{root}'"
+    end
+    self.replace hash
+  end
+  
+  def method_missing(name, *args, &block)
+    key = name.to_s
+    if key.gsub!(/\?$/, '')
+      has_key? key
+    else
+      raise NotFound, "No configuration found for '#{name}'" unless has_key?(key)
+      value = fetch key
+      value.is_a?(Hash) ? Konf.new(value) : value
+    end
+  end
   
 end

data/test/config.yml

@@ -0,0 +1,6 @@
+conf_a:
+  conf_1: value
+  conf_2: value <%= 1 + 1 %>
+      
+conf_b:
+  conf_1: value

data/test/konf_test.rb

@@ -3,8 +3,76 @@ require 'konf'
 
 class KonfTest < Test::Unit::TestCase
   
-  def test_me
-    flunk
+  def test_initialization_as_hash
+    conf = Konf.new('a' => {'b' => 'c'})
+    assert_equal ({'a' => {'b' => 'c'}}), conf
+  end
+  
+  def test_initialization_as_yaml
+    conf = Konf.new(File.expand_path('config.yml', File.dirname(__FILE__)))
+    assert_equal ({
+      'conf_a' => {
+        'conf_1' => 'value',
+        'conf_2' => 'value 2',
+      },
+      'conf_b' => {
+        'conf_1' => 'value'
+      }
+    }), conf
+  end
+  
+  def test_initialization_with_root
+    conf = Konf.new({'a' => {'b' => 'c'}}, 'a')
+    assert_equal ({'b' => 'c'}), conf
+  end
+  
+  def test_initialization_with_blank_source
+    begin
+      conf = Konf.new
+    rescue => e
+      assert_equal ArgumentError, e.class
+    end
+  end
+  
+  def test_initialization_with_invalid_file
+    begin
+      conf = Konf.new('invalid')
+    rescue => e
+      assert_equal Errno::ENOENT, e.class
+    end
+  end
+  
+  def test_initialization_with_invalid_root
+    begin
+      conf = Konf.new({'a' => {'b' => 'c'}}, 'd')
+    rescue => e
+      assert_equal Konf::NotFound, e.class
+    end
+  end
+  
+  def test_accessors
+    conf = Konf.new('a' => {'b' => 'c'})
+    
+    assert_equal ({'b' => 'c'}), conf.a
+    assert_equal Konf, conf.a.class
+    assert_equal 'c', conf.a.b
+  end
+  
+  def test_accessors_undefined
+    conf = Konf.new('a' => {'b' => 'c'})
+    begin
+      conf.z
+    rescue => e
+      assert_equal Konf::NotFound, e.class
+    end
+  end
+  
+  def test_accessors_inspector
+    conf = Konf.new('a' => {'b' => 'c'})
+    assert conf.a?
+    assert !conf.z?
+    assert conf.a.b?
+    assert !conf.a.z?
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: konf
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-20 00:00:00.000000000Z
+date: 2011-12-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70357497352640 !ruby/object:Gem::Requirement
+  requirement: &70176349459780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70357497352640
+  version_requirements: *70176349459780
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70357497352160 !ruby/object:Gem::Requirement
+  requirement: &70176349459300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,19 +32,23 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70357497352160
+  version_requirements: *70176349459300
 description: minimalistic configuration reader
 email: oleg@khabarov.ca
 executables: []
 extensions: []
 extra_rdoc_files:
+- LICENSE
 - README.md
 files:
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - VERSION
+- konf.gemspec
 - lib/konf.rb
+- test/config.yml
 - test/konf_test.rb
 homepage: http://github.com/GBH/konf
 licenses:
@@ -61,7 +65,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -940001040518687663
+      hash: 2717882700731022676
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: