configru 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "riot", ">= 0"
+  gem "bundler", "~> 1.0.0"
+end
+
+# Specify your gem's dependencies in configru.gemspec
+gemspec

data/README.md

@@ -0,0 +1,54 @@
+# Configru
+
+Versatile configuration file loader for Ruby
+
+## Desired Example Usage
+
+```yaml
+server: irc.ninthbit.net
+port: 6667
+nick: awesomeface
+powerlevel: 9
+awesome: omgyes
+```
+
+```ruby
+require 'configru'
+
+Configru.load do
+  cascade '~/foo.yml', '/etc/foo.yml' # Set files to look in
+  defaults do
+    server 'irc.freenode.net'
+    port 6667
+    nick 'bot'
+    powerlevel 1
+    awesome 'not at all'
+  end
+  verify do
+    server /\S+/ # Must match regex
+    nick /\S+/
+    port Fixnum # Must be an instance of
+    powerlevel 1..10 # Must be in range
+    awesome ['not at all', 'omgyes', 'meh'] # Must be one of
+  end
+end
+
+puts "Connecting to #{Configru.server}:#{Configru.port}"
+```
+
+## License
+
+Copyright (c) 2011, Curtis McEnroe <programble@gmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+
+require 'rake'
+require 'rake/testtask'
+
+desc "Run all tests"
+task :test do
+  Rake::TestTask.new do |t|
+    t.libs << "test"
+    t.pattern = "test/**/*_test.rb"
+    t.verbose = false
+  end
+end
+
+task :default => :test

data/configru.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "configru/version"
+
+Gem::Specification.new do |s|
+  s.name        = "configru"
+  s.version     = Configru::VERSION
+  s.authors     = ["Curtis McEnroe"]
+  s.email       = ["programble@gmail.com"]
+  s.homepage    = "https://github.com/programble/configru"
+  s.summary     = %q{Versatile configuration file loader}
+  s.description = s.summary
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/configru/confighash.rb

@@ -0,0 +1,31 @@
+module Configru
+  class ConfigHash < Hash
+    def initialize(hash={})
+      super
+      merge!(hash)
+    end
+    
+    def merge!(hash)
+      hash.each do |key, value|
+        if value.is_a?(Hash) && self[key].is_a?(ConfigHash)
+          self[key].merge!(value)
+        elsif value.is_a?(Hash)
+          self[key] = ConfigHash.new(value)
+        else
+          self[key] = value
+        end
+      end
+    end
+    
+    def [](key)
+      key = key.to_s if key.is_a?(Symbol)
+      # For some reason, super(key) returns {} instead of nil when the key
+      # doesn't exist :\
+      super(key) if self.include?(key)
+    end
+    
+    def method_missing(key, *args)
+      self[key]
+    end
+  end
+end

data/lib/configru/dsl.rb

@@ -0,0 +1,59 @@
+module Configru
+  module DSL
+    class LoadDSL
+      attr_reader :defaults_hash, :verify_hash, :files_array, :load_method
+      
+      def initialize(block)
+        @defaults_hash = {}
+        @verify_hash = {}
+        @files_array = []
+        @load_method = :first
+        instance_eval(&block)
+      end
+      
+      def first_of(*args)
+        @load_method = :first
+        @files_array = args
+      end
+      
+      def cascade(*args)
+        @load_method = :cascade
+        @files_array = args
+      end
+      
+      def defaults(hash=nil, &block)
+        if hash
+          @defaults_hash = hash
+        elsif block
+          @defaults_hash = HashDSL.new(block).hash
+        end
+      end
+      
+      def verify(hash=nil, &block)
+        if hash
+          @verify_hash = hash
+        elsif block
+          @verify_hash = HashDSL.new(block).hash
+        end
+      end
+    end
+    
+    class HashDSL
+      attr_reader :hash
+      
+      def initialize(block)
+        @hash = {}
+        instance_eval(&block)
+      end
+      
+      def method_missing(method, *args, &block)
+        key = method.to_s
+        if block
+          @hash[key] = HashDSL.new(block).hash
+        else
+          @hash[key] = args[0]
+        end
+      end
+    end
+  end
+end

data/lib/configru/version.rb

@@ -0,0 +1,3 @@
+module Configru
+  VERSION = "0.0.1"
+end

data/lib/configru.rb

@@ -0,0 +1,77 @@
+$: << File.dirname(__FILE__) unless $:.include?(File.dirname(__FILE__))
+
+require 'configru/confighash'
+require 'configru/dsl'
+
+require 'yaml'
+
+module Configru
+  class ConfigurationError < RuntimeError; end
+
+  def self.load(load_method=:first, files=[], defaults={}, verify={}, &block)
+    if block
+      dsl = DSL::LoadDSL.new(block)
+      @load_method = dsl.load_method
+      @files = dsl.files_array.map {|x| File.expand_path(x)}
+      @defaults = dsl.defaults_hash
+      @verify = dsl.verify_hash
+    else
+      @load_method = load_method
+      @files = files
+      @defaults = defaults
+      @verify = verify
+    end
+    self.reload
+  end
+  
+  def self.reload
+    @config = ConfigHash.new(@defaults)
+    
+    case @load_method
+    when :first
+      if file = @files.find {|file| File.file?(file)} # Intended
+        @config.merge!(YAML.load_file(file) || {})
+      end
+    when :cascade
+      @files.reverse_each do |file|
+        @config.merge!(YAML.load_file(file) || {}) if File.file?(file)
+      end
+    end
+    
+    self.verify(@config, @verify)
+  end
+  
+  @verify_stack = []
+  def self.verify(hash, criteria)
+    hash.each do |key, value|
+      next unless criteria[key]
+      @verify_stack.unshift(key)
+      
+      result = case criteria[key]
+      when Hash
+        self.verify(value, criteria[key])
+        true
+      when Class
+        value.is_a?(criteria[key])
+      when Array
+        criteria[key].include?(value)
+      else
+        criteria[key] === value
+      end
+      
+      raise ConfigurationError, "configuration option '#{@verify_stack.reverse.join('.')}' is invalid" unless result
+      
+      @verify_stack.shift
+    end
+  end
+  
+  def self.[](key)
+    @config[key]
+  end
+  
+  def self.method_missing(key, *args)
+    # Simulate NoMethodError if it looks like they really wanted a method
+    raise NoMethodError, "undefined method `#{key.to_s}' for #{self.inspect}:#{self.class}" unless args.empty?
+    self[key]
+  end
+end

data/test/confighash_test.rb

@@ -0,0 +1,53 @@
+require 'teststrap'
+
+context 'ConfigHash - ' do
+  setup { Configru::ConfigHash.new }
+  
+  context 'empty' do
+    asserts('[:quux]') { topic[:quux] }.nil
+    asserts(:quux).nil
+  end
+  
+  context 'non-empty' do
+    hookup do
+      topic.merge!({'foo' => 1, 'bar' => 2, 'baz' => 3})
+    end
+    
+    # Testing access methods
+    asserts("['foo']") { topic['foo'] }.equals(1)
+    asserts('[:foo]') { topic[:foo] }.equals(1)
+    asserts(:foo).equals(1)
+  end
+  
+  context 'overwriting a value by merge' do
+    hookup do
+      topic.merge!({'foo' => 1, 'bar' => 2, 'baz' => 3})
+      topic.merge!({'bar' => 4})
+    end
+    asserts(:bar).equals(4)
+  end
+  
+  context 'merging a nested Hash' do
+    hookup do
+      topic.merge!({'foo' => 1, 'bar' => 2, 'baz' => 3})
+      topic.merge!({'bar' => 4})
+      topic.merge!({'baz' => {'quux' => 5}})
+    end
+    
+    asserts(:baz).kind_of(Configru::ConfigHash)
+    asserts('baz.quux') { topic.baz.quux }.equals(5)
+  end
+  
+  context 'recursively merging a nested Hash' do
+    hookup do
+      topic.merge!({'foo' => 1, 'bar' => 2, 'baz' => 3})
+      topic.merge!({'bar' => 4})
+      topic.merge!({'baz' => {'quux'  => 5}})
+      topic.merge!({'baz' => {'apple' => 6}})
+    end
+    
+    asserts(:baz).kind_of(Configru::ConfigHash)
+    asserts('baz.apple') { topic.baz.apple }.equals(6)
+    asserts('baz.quux') { topic.baz.quux }.equals(5)
+  end
+end

data/test/teststrap.rb

@@ -0,0 +1,11 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'riot'
+require 'configru'
+

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: configru
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Curtis McEnroe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-14 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Versatile configuration file loader
+email: 
+- programble@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- configru.gemspec
+- lib/configru.rb
+- lib/configru/confighash.rb
+- lib/configru/dsl.rb
+- lib/configru/version.rb
+- test/confighash_test.rb
+- test/teststrap.rb
+has_rdoc: true
+homepage: https://github.com/programble/configru
+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: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Versatile configuration file loader
+test_files: 
+- test/confighash_test.rb
+- test/teststrap.rb