conf 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jari Bakken
+
+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.rdoc

@@ -0,0 +1,51 @@
+= conf
+
+Simple configuration that supports inheritance.
+
+= Example
+
+  Conf.define(:parent) do
+    properties.like.syntax = :nice
+
+    single "pair"
+
+    nested {
+      ruby {
+        blocks true
+      }
+    }
+  end
+
+  Conf.define(:child, :parent) do
+    nested {
+      ruby {
+        blocks false
+      }
+    }
+  end
+
+  c = Conf.get(:child)
+  c.nested.ruby.blocks     #=> false
+  c.single                 #=> "pair"
+  c.properties.like.syntax #=> :nice
+
+  c.yet.another :value
+  c.yet.another            #=> :value
+
+  c.freeze
+  c.yet.another :changed   #=> can't modify frozen config
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jari Bakken. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "conf"
+    gem.summary = %Q{Simple configuraton library that supports inheritance.}
+    gem.description = %Q{Simple configuraton library that supports inheritance.}
+    gem.email = "jari.bakken@gmail.com"
+    gem.homepage = "http://github.com/jarib/conf"
+    gem.authors = ["Jari Bakken"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov_opts = %w[--exclude spec,ruby-debug,/Library/Ruby,.gem --include lib/conf]
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/conf.rb

@@ -0,0 +1,108 @@
+class Conf
+
+  class InvalidKeyError < StandardError
+  end
+
+  def self.configs
+    @configs ||= {}
+  end
+
+  def self.define(name, parent = nil, &blk)
+    case parent
+    when String, Symbol
+      parent = get(parent)
+    when Configuration, nil
+      # ok
+    else
+      raise TypeError, "expected String, Symbol, Configuration or nil, got #{parent.inspect}:#{parent.class}"
+    end
+
+    conf = configs[name] ||= Configuration.new(parent)
+
+    conf.instance_eval(&blk)
+    conf.freeze
+    conf
+  end
+
+  def self.get(name)
+    configs[name] or raise ArgumentError, "no config named #{name.inspect}"
+  end
+
+  class Configuration
+    def initialize(parent = nil)
+      if parent and not parent.kind_of? self.class
+        raise TypeError, "expected #{self.class}, got #{parent.inspect}:#{parent.class}"
+      end
+
+      @parent = parent
+      @data   = {}
+      @current_nesting = []
+    end
+
+    def freeze
+      @parent && @parent.freeze
+      super
+    end
+
+    protected
+
+    def data() @data end
+
+    def [](key)
+      k = expand_key(key)
+      val = @data[k]
+      val.nil? ? @parent && @parent[k] : val
+    end
+
+    def []=(key, value)
+      @data[expand_key(key)] = value
+      @current_nesting.clear
+    end
+
+    def expand_key(key)
+      [@current_nesting, key].flatten.compact.join "."
+    end
+
+    def method_missing(meth, *args, &blk)
+      m = meth.to_s
+
+      if m =~ /^(\w+)=/ || args.size == 1
+        check_frozen
+        key = $1 || m
+        self[key] = args.first
+      elsif blk
+        check_frozen
+        @current_nesting << m
+        instance_eval(&blk)
+        @current_nesting.pop
+      else
+        obj = self[m]
+        if obj != nil
+          @current_nesting.clear
+          obj
+        else
+          @current_nesting << m
+          validate_nesting if frozen?
+          self
+        end
+      end
+    end
+
+    def validate_nesting
+      current = expand_key(nil)
+      unless @data.any? { |key,_| key.start_with?(current)} || (@parent && @parent.data.any? { |key,_| key.start_with?(current)})
+        @current_nesting.clear
+        raise InvalidKeyError, "no such key: #{current.inspect}"
+      end
+    end
+
+    def check_frozen
+      if frozen?
+        @current_nesting.clear
+        raise "can't modify frozen config"
+      end
+    end
+  end
+end
+
+

data/spec/conf_spec.rb

@@ -0,0 +1,94 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Conf" do
+  before { Conf.configs.clear }
+
+  it "should set a single value" do
+    conf = Conf.define(:tmp) { bar "baz" }
+    conf.bar.should == "baz"
+  end
+
+  it "can be defined with a String parent" do
+    parent = Conf.define('parent') {}
+    lambda { Conf.define('child', 'parent') {}  }.should_not raise_error
+  end
+
+  it "can be defined with a Symbol parent" do
+    parent = Conf.define(:parent) {}
+    lambda { Conf.define(:child, :parent) {}  }.should_not raise_error
+  end
+
+  it "can be defined with a Configuration parent" do
+    parent = Conf.define(:parent) {}
+    lambda { Conf.define(:child, :parent) {}  }.should_not raise_error
+  end
+
+  it "can be defined with a Configuration parent" do
+    parent = Conf.define(:parent) {}
+    lambda { Conf.define(:child, parent) {}  }.should_not raise_error
+  end
+
+  it "raises a TypeError if parent is not a known type" do
+    lambda { Conf.define(:foo, {}) {} }.should raise_error(TypeError)
+  end
+
+  it "should set a nested properties-style value" do
+    conf = Conf.define(:tmp) { bar.baz :boo }
+    conf.bar.baz.should == :boo
+  end
+
+  it "should set a value with nested blocks" do
+    conf = Conf.define(:tmp) do
+      nested { block { also { works true }}}
+    end
+
+    conf.nested.block.also.works.should be_true
+  end
+
+  it "should inherit properties from parent" do
+    parent = Conf.define(:parent)       { foo.bar.baz = false }
+    child = Conf.define(:child, parent) { foo.bar.boo = true }
+
+    child.foo.bar.baz.should be_false
+    child.foo.bar.boo.should be_true
+  end
+
+  it "should override parent properties" do
+    parent = Conf.define(:parent)       { foo.bar.baz = true }
+    child = Conf.define(:child, parent) { foo.bar.baz = false }
+
+    parent.foo.bar.baz.should be_true
+    child.foo.bar.baz.should be_false
+  end
+
+  it "should inherit nested blocks from parent" do
+    parent = Conf.define(:parent)         { foo { bar { baz true }}}
+    child  = Conf.define(:child, parent)  { foo { bar { boo false }}}
+
+    child.foo.bar.baz.should be_true
+    child.foo.bar.boo.should be_false
+  end
+
+  it "should override parent nested blocks" do
+    parent = Conf.define(:parent)         { foo { bar { baz true }}}
+    child  = Conf.define(:child, parent)  { foo { bar { baz false }}}
+
+    parent.foo.bar.baz.should be_true
+    child.foo.bar.baz.should be_false
+  end
+
+  it "cannot be changed after being defined" do
+    conf = Conf.define(:tmp) { foo "bar" }
+    conf.foo.should == "bar"
+    lambda { conf.foo "baz" }.should raise_error
+  end
+
+  it "raises a TypeError if parent is not nil or Configuration instance" do
+    lambda { Conf::Configuration.new({}) }.should raise_error(TypeError)
+  end
+
+  it "raises an error if the key is not found" do
+    conf = Conf.define(:tmp) { foo.bar.baz false }
+    lambda { conf.bar }.should raise_error(Conf::InvalidKeyError)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color --backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'conf'
+require 'spec'
+require 'spec/autorun'
+require 'pp'
+
+Spec::Runner.configure do |config|
+
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: conf
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jari Bakken
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-27 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Simple configuraton library that supports inheritance.
+email: jari.bakken@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/conf.rb
+- spec/conf_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jarib/conf
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple configuraton library that supports inheritance.
+test_files: 
+- spec/conf_spec.rb
+- spec/spec_helper.rb