simpleconf 0.0.1

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in simpleconf.gemspec
+gemspec

data/README.md

@@ -0,0 +1,84 @@
+SimpleConf
+=============
+
+Needed a simple configuration library for my gems. Made public so everyone can take advantage!
+
+##Install
+    [sudo] gem install simpleconf
+
+##Usage
+
+  **Simple Configuration**
+
+    CONFIG = SimpleConf {
+        host "localhost"
+        port 80
+        blacklist [1,2,3]
+    }
+
+    CONFIG.host # localhost
+    CONFIG.port # 80
+    CONFIG.blacklist # [1,2,3]
+
+  **Nested Configuration**
+
+    CONFIG = SimpleConf {
+      server {
+        ip "0.0.0.0"
+        port 8080
+      }
+
+      workers 50
+
+      security {
+        admin {
+          only_from "127.0.0.1"
+        }
+
+        max_logins 5
+      }
+    }
+
+    CONFIG.server.ip # "0.0.0.0"
+    CONFIG.workers # 50
+    CONFIG.security.admin.only_from # "127.0.0.1"
+    CONFIG.security.max_logins # 5
+
+  **Merging**
+
+    default = SimpleConf {
+      host "localhost"
+      port 80
+    }
+
+    new_config = default.merge( #also merge!
+      SimpleConf {
+        port 9999
+      }
+    )
+
+    new_config.host # "localhost"
+    new_config.port # 9999
+
+  **Overriding**
+
+    config = SimpleConf {
+      host "localhost", :override => false
+      port 80
+    }
+
+    config.host "google.com"
+    config.host # Still "localhost"
+    config.port 9999
+    config.port # 9999
+
+  **Lock configuration**
+
+    default = SimpleConf(:init_only => true){
+      host "localhost"
+    }
+
+    default.port 80 #throws error!!!
+
+
+  To see all examples/cases, see the spec file.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+include Rake::DSL
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/lib/core/hash.rb

@@ -0,0 +1,16 @@
+class Hash
+  def rmerge!(other_hash)
+    merge!(other_hash) do |key, oldval, newval|
+      if oldval.is_a?(SimpleConf::Conf) && newval.is_a?(SimpleConf::Conf)
+        oldval.check_and_change_overrides(newval)
+        oldval.__vars__.rmerge!(newval.__vars__)
+        oldval.instance_eval(&newval.__instance_block__)
+        oldval
+      elsif oldval.is_a?(Hash)
+        oldval.rmerge!(newval)
+      else
+        newval
+      end
+    end
+  end
+end

data/lib/core/kernel.rb

@@ -0,0 +1,5 @@
+module Kernel
+  def SimpleConf(*args, &blk)
+    SimpleConf.build(*args, &blk)
+  end
+end

data/lib/simpleconf/conf.rb

@@ -0,0 +1,87 @@
+module SimpleConf
+  class Conf < ::BlankSlate
+    attr_accessor :__vars__,  :__init_only__
+    attr_reader :__instance_block__, :__overrides__
+    def initialize(instance_block, opts={})
+      @__opts__ = opts
+      @__vars__ = {}
+      @__init_only__ = false
+      @__instance_block__ = instance_block
+      @__default_config__ = {
+        :override => true
+      }
+
+      @__overrides__ = {}
+    end
+
+    def merge(other)
+      fail "Other needs to be a SimpleConf::Conf" unless other.is_a? Conf
+      copy = SimpleConf.build(@__opts__, &@__instance_block__)
+      copy.merge!(other)
+      copy
+    end
+
+    def check_and_change_overrides(other)
+      self.__overrides__.each do |meth, override|
+        if !override
+          other.__overrides__[meth] = false
+          other.__vars__[meth] = __vars__[meth]
+        end
+      end
+
+    end
+
+    def merge!(other)
+      fail "Other needs to be a SimpleConf::Conf" unless other.is_a? Conf
+      check_and_change_overrides(other)
+      self.__init_only__ = other.__init_only__
+      self.instance_eval(&other.__instance_block__)
+      __vars__.rmerge!(other.__vars__)
+      nil
+    end
+
+    def method_missing(meth, *args, &blk)
+      fail "#{meth} was not defined in configuration setup" if @__init_only__
+
+      meta = (class << self; self; end)
+
+      if block_given?
+        nested_opts = @__opts__.merge(args.shift || {})
+        sub_config = SimpleConf.build(nested_opts, &blk)
+
+        meta.class_eval do
+          define_method(meth) do |*args, &blk|
+          @__vars__[meth]
+          end
+        end
+        @__vars__[meth] = sub_config
+        return
+      end
+
+      value = args.shift
+      opts = @__default_config__.merge(args.shift || {})
+      @__overrides__[meth] = opts[:override]
+      meta.class_eval do
+        define_method(meth) do |*args, &blk|
+          local_override = ((args[1].is_a?(Hash) && !args[1][:override].nil?)   && @__overrides__[meth]) ? args[1][:override] : @__overrides__[meth]
+
+          @__overrides__[meth] = local_override
+
+          if args.first && @__overrides__[meth]
+            @__vars__[meth] = args.first
+          else
+            @__vars__[meth]
+          end
+        end
+
+        define_method("#{meth}=") do |*args|
+          if args.first && @__overrides__[meth]
+            @__vars__[meth] = args.first
+          end
+          @__vars__[meth]
+        end
+      end
+      @__vars__[meth] = value
+  end
+end
+end

data/lib/simpleconf/version.rb

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

data/lib/simpleconf.rb

@@ -0,0 +1,19 @@
+module SimpleConf
+  require 'blankslate'
+  BlankSlate.reveal(:is_a?)
+  require 'simpleconf/conf'
+  require 'core/hash'
+  require 'core/kernel'
+
+  def build(opts={}, &blk)
+    fail "Build needs a block" unless block_given?
+    c = Conf.new(blk, opts)
+    c.instance_eval(&blk)
+    c.__init_only__ = true if opts[:init_only]
+    c
+  end
+
+  module_function :build
+
+end
+

data/simpleconf.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "simpleconf/version"
+
+Gem::Specification.new do |s|
+  s.name        = "simpleconf"
+  s.version     = SimpleConf::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Mike Lewis"]
+  s.email       = ["ft.mikelewis@gmail.com"]
+  s.homepage    = "http://github.com/mikelewis/simpleconf"
+  s.summary     = %q{Simple Configuration DSL that supports merging, locking and more.}
+  s.description = %q{Simple Configuration DSL that supports merging, locking and more.}
+
+  s.rubyforge_project = "simpleconf"
+
+  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"]
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'blankslate'
+end

data/spec/simpleconf_spec.rb

@@ -0,0 +1,411 @@
+require 'spec_helper'
+
+describe SimpleConf do
+  context "#build" do
+    it "should respond to build" do
+      SimpleConf.should respond_to(:build)
+    end
+
+    it "should throw an error if no block given" do
+      lambda {
+        SimpleConf.build
+      }.should raise_error
+    end
+
+    it "should accept a block" do
+      lambda {
+        SimpleConf.build {}
+      }.should_not raise_error
+    end
+
+    it "should return a SimpleConf::Conf" do
+      SimpleConf.build{}.should be_an_instance_of(SimpleConf::Conf)
+    end
+
+    it "should return two seperate configs for two calls" do
+      c = SimpleConf.build {}
+      SimpleConf.build{}.should_not eq(c)
+    end
+  end
+
+  it "should create a Kernel method SimpleConf" do
+    Kernel.should respond_to(:SimpleConf)
+  end
+
+  it "should of created a recursive merge for hash" do
+    meth_name = RUBY_VERSION < "1.9" ? "rmerge!" : :rmerge!
+    Hash.instance_methods.should include(meth_name)
+  end
+
+  it "should create a Kernel method that works" do
+    c = SimpleConf {
+      boat "blue"
+      sky "red"
+    }
+    c.boat.should == "blue"
+    c.sky.should == "red"
+  end
+
+  it "should be able to create simple config" do
+    c = SimpleConf.build do
+      host "localhost"
+      port 80
+      this_is_blank
+    end
+
+    c.host.should  == "localhost"
+    c.port.should == 80
+    c.this_is_blank.should == nil
+  end
+
+  it "should be able to create a simple config that we can edit" do
+    c = SimpleConf.build do
+      host "localhost"
+    end
+    c.host "google.com"
+
+    c.host.should == "google.com"
+  end
+
+  it "should be able to respond to value= after setup" do
+    c = SimpleConf.build do
+      host "localhost"
+    end
+    c.host = "google.com"
+    c.host.should == "google.com"
+  end
+
+  context "Blank Slate" do
+    it "should remove all methods and allow user to do whatever he wants " do
+      
+    c = SimpleConf {
+      id 5
+      hash 20
+      freeze "boo"
+    }
+
+    c.id.should == 5
+    c.hash.should == 20
+    c.freeze.should == "boo"
+    end
+
+  end
+
+  context "init_only" do
+    it "should throw an error if we use strict option and we have never encountered that config item" do
+      c = SimpleConf.build :init_only => true do
+        host "localhost"
+      end
+      lambda {
+        c.port
+      }.should raise_error
+    end
+
+    it "should throw an error if we use the strict options and we try to make another config" do
+      c = SimpleConf(:init_only=>true) {
+        host "localhost"
+      }
+
+      lambda {
+      c.port "boooo"
+      }.should raise_error
+    end
+
+    it "should not throw an error if we don't use strict option and we have never enounterd that config item" do
+      c = SimpleConf.build do
+        host "localhost"
+      end
+      lambda {
+        c.port
+      }.should_not raise_error
+    end
+  end
+
+  context "override" do
+    it "should default to true" do
+      c = SimpleConf.build do
+        host "localhost"
+      end
+
+      c.host "yea"
+      c.host.should == "yea"
+    end
+
+    it "should not allow override if specified" do
+      c = SimpleConf.build do
+        host "localhost", :override => false
+      end
+
+      c.host "bo"
+      c.host = "HAHAHA"
+      c.host.should == "localhost"
+    end
+  end
+
+  context "nested" do
+    it "should create nested configs" do
+      c = SimpleConf {
+        server {
+        host "localhost"
+        port 80
+      }
+      }
+
+      c.server.should respond_to(:host)
+      c.server.should respond_to(:port)
+      c.server.host.should == "localhost"
+      c.server.port.should == 80
+    end
+
+    it "should create nested configs forever" do
+      c = SimpleConf {
+        a {
+        age 15
+        b {
+          name "Mike"
+          c {
+            d 5
+          }
+        }
+      }
+      }
+
+      c.a.age.should == 15
+      c.a.b.name.should == "Mike"
+      c.a.b.c.d.should == 5
+    end
+
+    it "should allow for editable config elems within nests" do
+      c = SimpleConf {
+        a {
+        b {
+        name "mike"
+      }
+      }
+      }
+      c.a.b.name = "Tim"
+
+      c.a.b.name.should == "Tim"
+    end
+
+    it "should inherit properties" do
+      c = SimpleConf(:init_only => true) {
+        a {
+        age 15
+      }
+      }
+      c.a.age 20
+
+      lambda {
+        c.a.b
+      }.should raise_error
+    end
+
+    it "should allow for options for nests" do
+      c = SimpleConf {
+        age 15
+        a(:init_only=>true) {
+          name "Mike"
+
+          b {
+            sex "male"
+            race "human", :override => false
+          }
+        }
+      }
+
+      lambda { c.a.tom }.should raise_error
+
+        c.age 20
+      c.age.should == 20
+
+      lambda { c.a.b.haha }.should raise_error
+
+        c.a.b.race "donkey"
+      c.a.b.race.should == "human"
+
+      c.a.b.sex "female"
+      c.a.b.sex.should == "female"
+    end
+
+    it "should allow for options within nests" do
+      c = SimpleConf {
+        a {
+        b "Mike", :override => false
+      }
+      }
+
+      c.a.b "Tom"
+      c.a.b.should == "Mike"
+    end
+  end
+
+  context "Merge" do
+    before do
+      @default = SimpleConf {
+        server "localhost"
+        port 80
+        socket "/tmp/sock.sock"
+
+        tree {
+          leafs 30
+          height 50
+          bugs false
+          ants{
+            big false
+            fast true
+          }
+        }
+      }
+
+      @new = SimpleConf {
+        port 90
+        socket "haha"
+        tree {
+          leafs 60, :override => false
+          bugs true
+          ants {
+            fast false
+            home {
+              big true
+              sq_feet 5000
+            }
+          }
+        }
+      }
+    end
+
+    it "Conf should respond to merge and merge!" do
+      c = SimpleConf {
+        a "b"
+      }
+      [:merge, :merge!].each do |meth|
+        c.should respond_to(meth)
+      end
+    end
+
+    it "should not accept anything other than another SimpleConf::Conf object" do
+      c = SimpleConf {
+        server "localhost"
+      }
+      lambda {
+        c.merge!(5)
+      }.should raise_error
+    end
+
+    it "should merge! a SimpleConf::Conf" do
+
+      ret_val = @default.merge!(@new)
+
+      ret_val.should be_nil
+      @default.should be_an_instance_of(SimpleConf::Conf)
+
+      @default.server.should == "localhost"
+      @default.port.should == 90
+      @default.socket.should == "haha"
+      @default.tree.bugs.should == true
+      @default.tree.leafs.should == 60
+      @default.tree.height.should == 50
+      @default.tree.ants.big.should == false
+      @default.tree.ants.home.sq_feet.should == 5000
+    end
+
+    it "should merge a SimpleConf::Conf" do
+
+      new_conf = @default.merge(@new)
+
+      new_conf.should be_an_instance_of(SimpleConf::Conf)
+      new_conf.should_not eq(@default)
+
+      new_conf.server.should == "localhost"
+      new_conf.port.should == 90
+      new_conf.socket.should == "haha"
+      new_conf.tree.bugs.should == true
+      new_conf.tree.leafs.should == 60
+      new_conf.tree.height.should == 50
+      new_conf.tree.ants.big.should == false
+      new_conf.tree.ants.home.sq_feet.should == 5000
+    end
+
+    it "should merge a SimpleConf::Conf and leave the old one intact" do
+      new_conf = @default.merge(@new)
+
+      @default.server.should == "localhost"
+      @default.port == 80
+      @default.tree.leafs == 30
+      @default.tree.height == 50
+      @default.tree.ants.big == false
+      @default.tree.ants.fast == true
+      @default.tree.ants.home.should be_nil
+      lambda { @default.tree.ants.home.sq_feet }.should raise_error
+    end
+
+    context "Properties" do
+      before do
+        @default = SimpleConf {
+          server "localhost"
+          port 80, :override => false
+          socket "/tmp/sock.sock"
+
+          tree {
+            leafs 30
+            height 50
+            bugs false, :override => false
+            ants{
+              big false, :override => false
+              fast true
+            }
+          }
+        }
+
+      end
+      it "should merge and inherit options" do
+        @default.merge!(@new)
+        @default.port 8080
+        @default.port.should == 80
+      end
+
+      it "should merge and inherit nested properties" do
+        @default.merge!(@new)
+        @default.tree.bugs.should == false
+        @default.tree.ants.big.should == false
+        @default.tree.leafs 200
+        @default.tree.leafs.should == 60
+      end
+    end
+
+    context "merging with init_only" do
+      before do
+        @new = SimpleConf(:init_only => true) {
+          port 90
+          socket "haha"
+          tree {
+            leafs 60, :override => false
+            bugs true
+            ants {
+              fast false
+              home {
+                big true
+                sq_feet 5000
+              }
+            }
+          }
+        }
+
+      end
+
+      it "the newly merged item should be init_only" do
+        @default.merge!(@new)
+        @default.__init_only__.should == true
+      end
+
+      it "the newly merged item should act as init_only" do
+        @default.merge!(@new)
+        lambda{
+          @default.name "name"
+        }.should raise_error
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'simpleconf'

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: simpleconf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mike Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2153376680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153376680
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2153376260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153376260
+- !ruby/object:Gem::Dependency
+  name: blankslate
+  requirement: &2153375840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153375840
+description: Simple Configuration DSL that supports merging, locking and more.
+email:
+- ft.mikelewis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- lib/core/hash.rb
+- lib/core/kernel.rb
+- lib/simpleconf.rb
+- lib/simpleconf/conf.rb
+- lib/simpleconf/version.rb
+- simpleconf.gemspec
+- spec/simpleconf_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/mikelewis/simpleconf
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: simpleconf
+rubygems_version: 1.7.1
+signing_key: 
+specification_version: 3
+summary: Simple Configuration DSL that supports merging, locking and more.
+test_files:
+- spec/simpleconf_spec.rb
+- spec/spec_helper.rb