sevenwire-configatron 2.2.2

data/README

@@ -0,0 +1,132 @@
+=Configatron
+
+Configatron makes configuring your applications and scripts incredibly easy. No longer is a there a need to use constants or global variables. Now you can use a simple and painless system to configure your life. And, because it's all Ruby, you can do any crazy thing you would like to!
+
+==Examples
+
+===Simple
+  configatron.email = 'me@example.com'
+  configatron.database_url = "postgres://localhost/mack_framework_rocks"
+  
+Now, anywhere in your code you can do the following:
+
+  configatron.email # => "me@example.com"
+  configatron.database_url # => "postgres://localhost/mack_framework_rocks"
+
+Viola! Simple as can be.
+
+Now you're saying, what if I want to have a 'default' set of options, but then override them later, based on other information? Simple again. Let's use our above example. We've configured our 'database_url' option to be "postgres://localhost/mack_framework_rocks". The problem with that is that is our production database url, not our development url. Fair enough, all you have to do is redeclare it:
+
+  configatron.database_url = "postgres://localhost/mack_framework_rocks_development"
+
+  
+becomes:
+
+  configatron.email # => "me@example.com"
+  configatron.database_url # => "postgres://localhost/mack_framework_rocks_development"
+  
+Notice how our other configuration parameters haven't changed? Cool, eh?
+
+===Hash/YAML
+You can configure configatron from a hash as well:
+
+  configatron.configure_from_hash({:email => {:pop => {:address => 'pop.example.com', :port => 110}}, :smtp => {:address => 'smtp.example.com'}})
+  
+  configatron.email.pop.address # => 'pop.example.com'
+  configatron.email.pop.port # => 110
+  # and so on...
+  
+Notice how they're all namespaced for your as well. The same holds true for YAML files:
+
+  configuration.configure_from_yaml('/path/to/file.yml')
+  
+When the 'reload' method is called on configatron then the YAML file will be re-read in case changes have been made.
+
+===Namespaces
+
+The question that should be on your lips is what I need to have namespaced configuration parameters. It's easy! Configatron allows you to create namespaces.
+  
+  configatron.website_url = "http://www.mackframework.com"
+  configatron.email.pop.address = "pop.example.com"
+  configatron.email.pop.port = 110
+  configatron.email.smtp.address = "smtp.example.com"
+  configatron.email.smtp.port = 25
+
+becomes:
+
+  configatron.email.pop.address # => "pop.example.com"
+  configatron.email.smtp.address # => "smtp.example.com"
+  configatron.website_url # => "http://www.mackframework.com"
+  
+Configatron allows you to nest namespaces to your hearts content! Just keep going, it's that easy.
+
+Of course you can update a single parameter n levels deep as well:
+
+  configatron.email.pop.address = "pop2.example.com"
+  
+  configatron.email.pop.address # => "pop2.example.com"
+  configatron.email.smtp.address # => "smtp.example.com"
+  
+===Misc.
+
+Even if parameters haven't been set, you can still call them, and you'll get nil back:
+
+  configatron.i.dont.exist.nil? # => true
+  configatron.i.dont.exist # => nil
+  
+You can set 'default' values for parameters. If there is already a setting, it won't be replaced. This is useful if you've already done your 'configuration' and you call a library, that needs to have parameters set. The library can set it's defaults, without worrying that it might have overridden your custom settings.
+
+  configatron.set_default(:name, 'Mark Bates')
+  configatron.name # => 'Mark Bates'
+  configatron.set_default(:name, 'Me')
+  configatron.name # => 'Mark Bates'
+  
+Sometimes in testing, or other situations, you want to temporarily change some settings. You can do this with the <tt>temp</tt> method:
+
+  configatron.one = 1
+  configatron.letters.a = 'A'
+  configatron.letters.b = 'B'
+  configatron.temp do
+    configatron.letters.b = 'bb'
+    configatron.letters.c = 'c'
+    configatron.one # => 1
+    configatron.letters.a # => 'A'
+    configatron.letters.b # => 'bb'
+    configatron.letters.c # => 'c'
+  end
+  configatron.one # => 1
+  configatron.letters.a # => 'A'
+  configatron.letters.b # => 'B'
+  configatron.letters.c # => nil
+  
+You can also pass in an optional Hash to the <tt>temp</tt>:
+
+  configatron.one = 1
+  configatron.letters.a = 'A'
+  configatron.letters.b = 'B'
+  configatron.temp(:letters => {:b => 'bb', :c => 'c'}) do
+    configatron.one == 1
+    configatron.letters.a # => 'A'
+    configatron.letters.b # => 'bb'
+    configatron.letters.c # => 'c'
+  end
+  configatron.one == 1
+  configatron.letters.a # => 'A'
+  configatron.letters.b # => 'B'
+  configatron.letters.c # => nil
+
+Enjoy!
+
+==Contact
+Please mail bugs, suggestions and patches to <bugs@mackframework.com>.
+
+On the web at: http://www.mackframework.com
+
+==License and Copyright
+Copyright (C) 2008 Mark Bates, http://www.mackframework.com
+
+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 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/lib/configatron.rb

@@ -0,0 +1,9 @@
+base = File.join(File.dirname(__FILE__), 'configatron')
+require 'yaml'
+require File.join(base, 'configatron')
+require File.join(base, 'store')
+require File.join(base, 'errors')
+require File.join(base, 'core_ext', 'kernel')
+require File.join(base, 'core_ext', 'object')
+require File.join(base, 'core_ext', 'string')
+require File.join(base, 'core_ext', 'class')

data/lib/configatron/configatron.rb

@@ -0,0 +1,54 @@
+require 'singleton'
+
+class Configatron
+  include Singleton
+  
+  alias_method :send!, :send
+  
+  def initialize # :nodoc:
+    @_namespace = [:default]
+    reset!
+  end
+  
+  # Forwards the method call onto the 'namespaced' Configatron::Store
+  def method_missing(sym, *args)
+    @_store[@_namespace.last].send(sym, *args)
+  end
+  
+  # Removes ALL configuration parameters
+  def reset!
+    @_store = {:default => Configatron::Store.new}
+  end
+  
+  # Allows for the temporary overriding of parameters in a block.
+  # Takes an optional Hash of parameters that will be applied before
+  # the block gets called. At the end of the block, the temporary
+  # settings are deleted and the original settings are reinstated.
+  def temp(options = nil)
+    begin
+      temp_start(options)
+      yield
+    rescue Exception => e
+      raise e
+    ensure
+      temp_end
+    end
+  end
+  
+  def temp_start(options = nil)
+    n_space = rand
+    @_store[n_space] = @_store[@_namespace.last].deep_clone
+    @_namespace << n_space
+    if options
+      self.method_missing(:configure_from_hash, options)
+    end
+  end
+  
+  def temp_end
+    @_store.delete(@_namespace.pop)
+  end
+  
+  undef :inspect # :nodoc:
+  undef :nil? # :nodoc:
+  
+end

data/lib/configatron/core_ext/class.rb

@@ -0,0 +1,26 @@
+class Class
+  
+  # Returns access to configuration parameters named after the class.
+  # 
+  # Examples:
+  #   configatron.foo.bar = :bar
+  #   configatron.a.b.c.d = 'D'
+  #   
+  #   class Foo
+  #   end
+  #   
+  #   module A
+  #     module B
+  #       class C
+  #       end
+  #     end
+  #   end
+  # 
+  #   Foo.to_configatron.bar # => :bar
+  #   A::B::C.to_configatron.d # => 'D'
+  def to_configatron
+    name_spaces = self.name.split("::").collect{|s| s.methodize}
+    configatron.send_with_chain(name_spaces)
+  end
+  
+end

data/lib/configatron/core_ext/kernel.rb

@@ -0,0 +1,8 @@
+module Kernel
+  
+  # Provides access to the Configatron storage system.
+  def configatron
+    Configatron.instance
+  end
+  
+end

data/lib/configatron/core_ext/object.rb

@@ -0,0 +1,9 @@
+class Object # :nodoc:
+  
+  def send_with_chain(methods, *args) # :nodoc:
+    obj = self
+    [methods].flatten.each {|m| obj = obj.send(m, *args)}
+    obj
+  end
+  
+end

data/lib/configatron/core_ext/string.rb

@@ -0,0 +1,84 @@
+class String # :nodoc:
+  
+  def underscore # :nodoc:
+    self.to_s.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+  end
+  
+  def methodize # :nodoc:
+    x = self
+    
+    # if we get down to a nil or an empty string raise an exception! 
+    raise NameError.new("#{self} cannot be converted to a valid method name!") if x.nil? || x == ''
+    
+    # get rid of the big stuff in the front/back
+    x.strip!
+    
+    # if we get down to a nil or an empty string raise an exception! 
+    raise NameError.new("#{self} cannot be converted to a valid method name!") if x.nil? || x == ''
+    
+    x = x.underscore
+    
+    # get rid of spaces and make the _
+    x.gsub!(' ', '_')
+    # get rid of everything that isn't 'safe' a-z, 0-9, ?, !, =, _
+    x.gsub!(/([^ a-zA-Z0-9\_\?\!\=]+)/n, '_')
+    
+    # if we get down to a nil or an empty string raise an exception! 
+    raise NameError.new("#{self} cannot be converted to a valid method name!") if x.nil? || x == ''
+    
+    # condense multiple 'safe' non a-z chars to just one.
+    # ie. ___ becomes _ !!!! becomes ! etc...
+    [' ', '_', '?', '!', "="].each do |c|
+      x.squeeze!(c)
+    end
+    
+    # if we get down to a nil or an empty string raise an exception! 
+    raise NameError.new("#{self} cannot be converted to a valid method name!") if x.nil? || x == ''
+    
+    #down case the whole thing
+    x.downcase!
+    
+    # get rid of any characters at the beginning that aren't a-z
+    while !x.match(/^[a-z]/)
+      x.slice!(0)
+      
+      # if we get down to a nil or an empty string raise an exception! 
+      raise NameError.new("#{self} cannot be converted to a valid method name!") if x.nil? || x == ''
+    end
+    
+    # let's trim this bad boy down a bit now that we've cleaned it up, somewhat.
+    # we should do this before cleaning up the end character, because it's possible to end up with a 
+    # bad char at the end if you trim too late.
+    x = x[0..100] if x.length > 100
+    
+    # get rid of any characters at the end that aren't safe
+    while !x.match(/[a-z0-9\?\!\=]$/)
+      x.slice!(x.length - 1)
+      # if we get down to a nil or an empty string raise an exception! 
+      raise NameError.new("#{self} cannot be converted to a valid method name!") if x.nil? || x == ''
+    end
+    
+    # if we get down to a nil or an empty string raise an exception! 
+    raise NameError.new("#{self} cannot be converted to a valid method name!") if x.nil? || x == ''
+    
+    # let's get rid of characters that don't belong in the 'middle' of the method.
+    orig_middle = x[1..(x.length - 2)]
+    n_middle = orig_middle.dup
+    
+    ['?', '!', "="].each do |c|
+      n_middle.gsub!(c, "_")
+    end
+    
+    # the previous gsub can leave us with multiple underscores that need cleaning up.
+    n_middle.squeeze!("_")
+    
+    x.gsub!(orig_middle, n_middle)
+    x.gsub!("_=", "=")
+    x
+  end
+  
+end

data/lib/configatron/errors.rb

@@ -0,0 +1,13 @@
+class Configatron
+  class ProtectedParameter < StandardError
+    def intialize(name)
+      super("Can not modify protected parameter: '#{name}'")
+    end
+  end
+
+  class LockedNamespace < StandardError
+    def initialize(name)
+      super("Cannot add new parameters to locked namespace: #{name.inspect}")
+    end
+  end
+end

data/lib/configatron/store.rb

@@ -0,0 +1,258 @@
+class Configatron
+  class Store
+    alias_method :send!, :send
+    
+    # Takes an optional Hash of parameters
+    def initialize(options = {}, name = nil, parent = nil)
+      @_name = name
+      @_parent = parent
+      @_store = {}
+      configure_from_hash(options)
+      @_protected = []
+    end
+    
+    # Returns a Hash representing the configurations
+    def to_hash
+      @_store
+    end
+    
+    def inspect
+      path = [@_name]
+      parent = @_parent
+      until parent.nil?
+        path << parent.instance_variable_get('@_name')
+        parent = parent.instance_variable_get('@_parent')
+      end
+      path << 'configatron'
+      path.compact!
+      path.reverse!
+      f_out = []
+      @_store.each do |k, v|
+        if v.is_a?(Configatron::Store)
+          v.inspect.each_line do |line|
+            if line.match(/\n/)
+              line.each_line do |l|
+                l.strip!
+                f_out << l
+              end
+            else
+              line.strip!
+              f_out << line
+            end
+          end
+        else
+          f_out << "#{path.join('.')}.#{k} = #{v.inspect}"
+        end
+      end
+      f_out.compact.sort.join("\n")
+    end
+
+    # Allows for the configuration of the system via a Hash
+    def configure_from_hash(options)
+      parse_options(options)
+    end
+
+    # Allows for the configuration of the system from a YAML file.
+    # Takes the path to the YAML file.  Also takes an optional parameter,
+    # <tt>:hash</tt>, that indicates a specific hash that should be
+    # loaded from the file. 
+    def configure_from_yaml(path, opts = {})
+      begin
+        yml = YAML.load(File.read(path))
+        yml = yml[opts[:hash]] unless opts[:hash].nil?
+        configure_from_hash(yml)
+      rescue Errno::ENOENT => e
+        puts e.message
+      end
+    end
+
+    # Returns true if there are no configuration parameters
+    def nil?
+      return @_store.empty?
+    end
+
+    # Retrieves a certain parameter and if that parameter
+    # doesn't exist it will return the default_value specified.
+    def retrieve(name, default_value = nil)
+      @_store[name.to_sym] || default_value
+    end
+    
+    # Removes a parameter. In the case of a nested parameter
+    # it will remove all below it.
+    def remove(name)
+      @_store.delete(name.to_sym)
+    end
+
+    # Sets a 'default' value. If there is already a value specified
+    # it won't set the value.
+    def set_default(name, default_value)
+      unless @_store[name.to_sym]
+        @_store[name.to_sym] = parse_options(default_value)
+      end
+    end
+    
+    def method_missing(sym, *args) # :nodoc:
+      if sym.to_s.match(/(.+)=$/)
+        name = sym.to_s.gsub("=", '').to_sym
+        raise Configatron::ProtectedParameter.new(name) if @_protected.include?(name) || methods_include?(name)
+        raise Configatron::LockedNamespace.new(@_name) if @_locked && !@_store.has_key?(name)
+        @_store[name] = parse_options(*args)
+      elsif sym.to_s.match(/(.+)\!$/)
+        name = sym.to_s.gsub("!", '').to_sym
+        @_store.has_key?(name) && !@_store[name].nil? ? @_store[name] : nil
+      elsif @_store.has_key?(sym)
+        return @_store[sym]
+      else
+        store = Configatron::Store.new({}, sym, self)
+        @_store[sym] = store
+        return store
+      end
+    end
+    
+    def ==(other) # :nodoc:
+      self.to_hash == other
+    end
+    
+    # Prevents a parameter from being reassigned. If called on a 'namespace' then
+    # all parameters below it will be protected as well.
+    def protect(name)
+      @_protected << name.to_sym
+    end
+
+    # Prevents all parameters from being reassigned.
+    def protect_all!
+      @_protected.clear
+      @_store.keys.each do |k|
+        val = self.send(k)
+        val.protect_all! if val.class == Configatron::Store
+        @_protected << k
+      end
+    end
+    
+    # Removes the protection of a parameter.
+    def unprotect(name)
+      @_protected.reject! { |e| e == name.to_sym }
+    end
+    
+    def unprotect_all!
+      @_protected.clear
+      @_store.keys.each do |k|
+        val = self.send(k)
+        val.unprotect_all! if val.class == Configatron::Store
+      end
+    end
+
+    # Prevents a namespace from having new parameters set. The lock is applied
+    # recursively to any namespaces below it.
+    def lock(name)
+      namespace = @_store[name.to_sym]
+      raise ArgumentError, "Namespace #{name.inspect} does not exist" if namespace.nil?
+      namespace.lock!
+    end
+
+    def unlock(name)
+      namespace = @_store[name.to_sym]
+      raise ArgumentError, "Namespace #{name.inspect} does not exist" if namespace.nil?
+      namespace.unlock!
+    end
+    
+    # = DeepClone
+    #
+    # == Version
+    #  1.2006.05.23 (change of the first number means Big Change)
+    #
+    # == Description
+    #  Adds deep_clone method to an object which produces deep copy of it. It means
+    #  if you clone a Hash, every nested items and their nested items will be cloned.
+    #  Moreover deep_clone checks if the object is already cloned to prevent endless recursion.
+    #
+    # == Usage
+    #
+    #  (see examples directory under the ruby gems root directory)
+    #
+    #   require 'rubygems'
+    #   require 'deep_clone'
+    #
+    #   include DeepClone
+    #
+    #   obj = []
+    #   a = [ true, false, obj ]
+    #   b = a.deep_clone
+    #   obj.push( 'foo' )
+    #   p obj   # >> [ 'foo' ]
+    #   p b[2]  # >> []
+    #
+    # == Source
+    # http://simplypowerful.1984.cz/goodlibs/1.2006.05.23
+    #
+    # == Author
+    #  jan molic (/mig/at_sign/1984/dot/cz/)
+    #
+    # == Licence
+    #  You can redistribute it and/or modify it under the same terms of Ruby's license;
+    #  either the dual license version in 2003, or any later version.
+    #
+    def deep_clone( obj=self, cloned={} )
+      if cloned.has_key?( obj.object_id )
+        return cloned[obj.object_id]
+      else
+        begin
+          cl = obj.clone
+        rescue Exception
+          # unclonnable (TrueClass, Fixnum, ...)
+          cloned[obj.object_id] = obj
+          return obj
+        else
+          cloned[obj.object_id] = cl
+          cloned[cl.object_id] = cl
+          if cl.is_a?( Hash )
+            cl.clone.each { |k,v|
+              cl[k] = deep_clone( v, cloned )
+            }
+          elsif cl.is_a?( Array )
+            cl.collect! { |v|
+              deep_clone( v, cloned )
+            }
+          end
+          cl.instance_variables.each do |var|
+            v = cl.instance_eval( var.to_s )
+            v_cl = deep_clone( v, cloned )
+            cl.instance_eval( "#{var} = v_cl" )
+          end
+          return cl
+        end
+      end
+    end
+    
+    protected
+    def lock!
+      @_locked = true
+      @_store.values.each { |store| store.lock! if store.is_a?(Configatron::Store) }
+    end
+
+    def unlock!
+      @_locked = false
+      @_store.values.each { |store| store.unlock! if store.is_a?(Configatron::Store) }
+    end
+    
+    private
+    def methods_include?(name)
+      self.methods.include?(RUBY_VERSION > '1.9.0' ? name.to_sym : name.to_s)
+    end
+    
+    def parse_options(options)
+      if options.is_a?(Hash)
+        options.each do |k,v|
+          if v.is_a?(Hash)
+            self.method_missing(k.to_sym).configure_from_hash(v)
+          else
+            self.method_missing("#{k.to_sym}=", v)
+          end
+        end
+      else
+        return options
+      end
+    end
+    
+  end
+end

data/spec/lib/class_spec.rb

@@ -0,0 +1,28 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+configatron.foo.bar = :bar
+configatron.a.b.c.d = 'D'
+
+class Foo
+end
+
+module A
+  module B
+    class C
+    end
+  end
+end
+
+describe Class do
+  
+  describe 'to_configatron' do
+    
+    it 'should return a Configatron::Store object based on the name of the class' do
+      Foo.to_configatron.should be_kind_of(Configatron::Store)
+      Foo.to_configatron.bar.should == :bar
+      A::B::C.to_configatron.d.should == 'D'
+    end
+    
+  end
+  
+end

data/spec/lib/configatron_spec.rb

@@ -0,0 +1,434 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe "configatron" do
+
+  before(:each) do
+    configatron.reset!
+  end
+  
+  describe 'protect' do
+    
+    it 'should protect a parameter and prevent it from being set' do
+      configatron.one = 1
+      configatron.protect(:one)
+      lambda{configatron.one = 'one'}.should raise_error(Configatron::ProtectedParameter)
+      configatron.one.should == 1
+    end
+    
+    it 'should protect basic methods' do
+      lambda{configatron.object_id = 123456}.should raise_error(Configatron::ProtectedParameter)
+      lambda{configatron.foo.object_id = 123456}.should raise_error(Configatron::ProtectedParameter)
+    end
+    
+    it 'should work with nested parameters' do
+      configatron.one = 1
+      configatron.letters.a = 'A'
+      configatron.letters.b = 'B'
+      configatron.letters.protect(:a)
+      lambda{configatron.letters.a = 'a'}.should raise_error(Configatron::ProtectedParameter)
+      configatron.letters.a.should == 'A'
+      configatron.protect(:letters)
+      lambda{configatron.letters.a = 'a'}.should raise_error(Configatron::ProtectedParameter)
+      lambda{configatron.letters = 'letter'}.should raise_error(Configatron::ProtectedParameter)
+    end
+    
+    it 'should work with configure_from_hash' do
+      configatron.one = 1
+      configatron.letters.a = 'A'
+      configatron.letters.b = 'B'
+      configatron.letters.protect(:a)
+      lambda{configatron.configure_from_hash(:letters => {:a => 'a'})}.should raise_error(Configatron::ProtectedParameter)
+      configatron.letters.a.should == 'A'
+      configatron.protect(:letters)
+      lambda{configatron.letters.configure_from_hash(:a => 'a')}.should raise_error(Configatron::ProtectedParameter)
+      lambda{configatron.configure_from_hash(:letters => 'letters')}.should raise_error(Configatron::ProtectedParameter)
+    end
+    
+    it "should be able to protect all parameters at once" do
+      configatron.one = 1
+      configatron.letters.a = 'A'
+      configatron.letters.b = 'B'
+      configatron.protect_all!
+      [:a,:b].each do |l|
+        lambda{configatron.configure_from_hash(:letters => {l => l.to_s})}.should raise_error(Configatron::ProtectedParameter)
+        configatron.letters.send(l).should == l.to_s.upcase
+      end
+      lambda{configatron.letters.configure_from_hash(:a => 'a')}.should raise_error(Configatron::ProtectedParameter)
+      lambda{configatron.configure_from_hash(:letters => 'letters')}.should raise_error(Configatron::ProtectedParameter)
+    end
+    
+    it "should be able to unprotect a parameter" do
+      configatron.one = 1
+      configatron.protect(:one)
+      configatron.unprotect(:one)
+      lambda{configatron.one = 2}.should_not raise_error
+    end
+    
+    it "should be able to unprotect all parameters at once" do
+      configatron.one = 1
+      configatron.letters.a = 'A'
+      configatron.letters.b = 'B'
+      configatron.protect_all!
+      configatron.unprotect_all!
+      lambda{configatron.one = 2}.should_not raise_error
+      lambda{configatron.letters.configure_from_hash(:a => 'a')}.should_not raise_error
+    end
+    
+  end
+
+  describe 'lock' do
+    before :each do
+      configatron.letters.a = 'A'
+      configatron.letters.b = 'B'
+      configatron.letters.greek.alpha = 'alpha'
+      configatron.lock(:letters)
+    end
+
+    it 'should allow setting of existing parameters in locked parameter' do
+      lambda { configatron.letters.a = 'a' }.should_not raise_error
+    end
+
+    it 'should not allow setting of a parameter that is not already set' do
+      lambda { configatron.letters.c = 'C' }.should raise_error(Configatron::LockedNamespace)
+    end
+
+    it 'should allow setting of existing parameters in child of locked parameter' do
+      lambda { configatron.letters.greek.alpha = 'a' }.should_not raise_error
+    end
+
+    it 'should not allow setting of new parameters in child of locked parameter' do
+      lambda { configatron.letters.greek.beta = 'beta' }.should raise_error(Configatron::LockedNamespace)
+    end
+
+    it 'should not affect parameters below the locked namespace' do
+      lambda { configatron.one = 1 }.should_not raise_error
+    end
+
+    it 'should raise an ArgumentError if unknown namespace is locked' do
+      lambda { configatron.lock(:numbers).should raise_error(ArgumentError) }
+    end
+
+    describe 'then unlock' do
+      before :each do
+        configatron.unlock(:letters)
+      end
+
+      it 'should allow setting of new parameter in unlocked namespace' do
+        lambda { configatron.letters.d = 'd' }.should_not raise_error
+      end
+
+      it 'should allow setting of new parameter in unlocked namespace\'s child' do
+        lambda { configatron.letters.greek.zeta = 'z' }.should_not raise_error
+      end
+
+      it 'should raise an ArgumentError if unknown namespace is unlocked' do
+        lambda { configatron.unlock(:numbers).should raise_error(ArgumentError) }
+      end
+    end
+  end
+  
+  describe 'temp' do
+    
+    it 'should revert back to the original parameters when the block ends' do
+      configatron.one = 1
+      configatron.letters.a = 'A'
+      configatron.letters.b = 'B'
+      configatron.temp do
+        configatron.letters.b = 'bb'
+        configatron.letters.c = 'c'
+        configatron.one.should == 1
+        configatron.letters.a.should == 'A'
+        configatron.letters.b.should == 'bb'
+        configatron.letters.c.should == 'c'
+      end
+      configatron.one.should == 1
+      configatron.letters.a.should == 'A'
+      configatron.letters.b.should == 'B'
+      configatron.letters.c.should be_nil
+    end
+    
+    it 'should take an optional hash of parameters' do
+      configatron.one = 1
+      configatron.letters.a = 'A'
+      configatron.letters.b = 'B'
+      configatron.temp(:letters => {:b => 'bb', :c => 'c'}) do
+        configatron.one.should == 1
+        configatron.letters.a.should == 'A'
+        configatron.letters.b.should == 'bb'
+        configatron.letters.c.should == 'c'
+      end
+      configatron.one.should == 1
+      configatron.letters.a.should == 'A'
+      configatron.letters.b.should == 'B'
+      configatron.letters.c.should be_nil
+    end
+    
+    it 'should work the same as temp_start/temp_end' do
+      configatron.one = 1
+      configatron.temp_start
+      configatron.one = 'ONE'
+      configatron.one.should == 'ONE'
+      configatron.temp_end
+      configatron.one.should == 1
+    end
+    
+    it 'should be able to nest' do
+      configatron.one = 1
+      configatron.letters.a = 'A'
+      configatron.letters.b = 'B'
+      configatron.temp do
+        configatron.letters.b = 'bb'
+        configatron.letters.c = 'c'
+        configatron.one.should == 1
+        configatron.letters.a.should == 'A'
+        configatron.letters.b.should == 'bb'
+        configatron.letters.c.should == 'c'
+        configatron.temp do
+          configatron.letters.b = 'bbb'
+          configatron.one.should == 1
+          configatron.letters.a.should == 'A'
+          configatron.letters.b.should == 'bbb'
+          configatron.letters.c.should == 'c'
+        end
+      end
+      configatron.one.should == 1
+      configatron.letters.a.should == 'A'
+      configatron.letters.b.should == 'B'
+      configatron.letters.c.should be_nil
+    end
+    
+  end
+
+  describe 'configure_from_hash' do
+    
+    it 'should configure itself from a hash' do
+      configatron.foo.should be_nil
+      configatron.configure_from_hash(:foo => :bar)
+      configatron.foo.should == :bar
+    end
+    
+    it 'should handled deeply nested params' do
+      configatron.friends.rachel.should be_nil
+      configatron.configure_from_hash(:friends => {:rachel => 'Rachel Green'})
+      configatron.friends.rachel.should == 'Rachel Green'
+    end
+    
+    it 'should not remove previously defined params' do
+      configatron.friends.rachel = 'Rachel Green'
+      configatron.friends.ross = 'Ross Gellar'
+      configatron.friends.monica = 'Monica Gellar'
+      configatron.configure_from_hash(:friends => {:rachel => 'R. Green', :monica => 'Monica Bing'})
+      configatron.friends.ross.should == 'Ross Gellar'
+      configatron.friends.rachel.should == 'R. Green'
+      configatron.friends.monica.should == 'Monica Bing'
+    end 
+    
+  end
+  
+  describe 'configure_from_yaml' do
+    
+    it 'should configure itself from a yaml file' do
+      configatron.futurama.should be_nil
+      configatron.configure_from_yaml(File.join(File.dirname(__FILE__), 'futurama.yml'))
+      configatron.futurama.robots.bender.should == 'Bender The Robot'
+    end
+    
+    it 'should not remove previously defined params' do
+      configatron.futurama.mutants.leela = 'Leela'
+      configatron.configure_from_yaml(File.join(File.dirname(__FILE__), 'futurama.yml'))
+      configatron.futurama.robots.bender.should == 'Bender The Robot'
+      configatron.futurama.mutants.leela = 'Leela'
+    end
+    
+    it "should fail silently if the file doesn't exist" do
+      lambda{configatron.configure_from_yaml('i_dont_exist.yml')}.should_not raise_error
+    end
+    
+    it "should be able to load a specific hash from the file" do
+      configatron.others.should be_nil
+      configatron.survivors.should be_nil
+      configatron.configure_from_yaml(File.join(File.dirname(__FILE__), 'lost.yml'), :hash => "survivors")
+      configatron.others.should be_nil
+      configatron.survivors.should be_nil
+      configatron.on_island.jack.should == 'Jack Shepherd'
+    end
+    
+  end
+  
+  it 'should return a parameter' do
+    configatron.foo = :bar
+    configatron.foo.should == :bar
+  end
+  
+  it 'should return a nested parameter' do
+    configatron.children.dylan = 'Dylan Bates'
+    configatron.children.dylan.should == 'Dylan Bates'
+  end
+  
+  it 'should set a nested parameter and not remove previously defined params' do
+    configatron.friends.rachel = 'Rachel Green'
+    configatron.friends.rachel.should == 'Rachel Green'
+    configatron.friends.ross = 'Ross Gellar'
+    configatron.friends.ross.should == 'Ross Gellar'
+    configatron.friends.monica = 'Monica Gellar'
+    configatron.friends.monica.should == 'Monica Gellar'
+    configatron.friends.rachel = 'R. Green'
+    configatron.friends.monica = 'Monica Bing'
+    configatron.friends.rachel.should == 'R. Green'
+    configatron.friends.ross.should == 'Ross Gellar'
+    configatron.friends.monica.should == 'Monica Bing'
+  end
+  
+  it 'should return the Configatron instance' do
+    configatron.should be_is_a(Configatron)
+  end
+  
+  describe 'to_hash' do
+    
+    it 'should return a hash of all the params' do
+      configatron.one = 1
+      configatron.letters.a = 'A'
+      configatron.letters.b = 'B'
+      configatron.to_hash.should == {:one => 1, :letters => {:a => 'A', :b => 'B'}}
+    end
+    
+  end
+  
+  describe 'inspect' do
+    
+    it 'should call return the inspect method of the to_hash method' do
+      configatron.one = 1
+      configatron.letters.a = 'A'
+      configatron.letters.b = 'B'
+      configatron.numbers.small.one = 1
+      configatron.numbers.small.others = [2,3]
+      configatron.numbers.big.one.hundred = '100'
+      
+      configatron.inspect.should == %{
+configatron.letters.a = "A"
+configatron.letters.b = "B"
+configatron.numbers.big.one.hundred = "100"
+configatron.numbers.small.one = 1
+configatron.numbers.small.others = [2, 3]
+configatron.one = 1
+}.strip
+      
+    end
+    
+  end
+  
+  describe 'nil?' do
+    
+    it 'should return true if there are no parameters' do
+      configatron.should be_nil
+      configatron.friends.should be_nil
+    end
+    
+    it 'should return true if there are no parameters on a nested parameter' do
+      configatron.friends.monica.should be_nil
+    end
+    
+  end
+  
+  describe 'retrieve' do
+    
+    it 'should retrieve a parameter' do
+      configatron.office = 'Michael'
+      configatron.retrieve(:office).should == 'Michael'
+    end
+    
+    it 'should return the optional second parameter if the config setting is nil' do
+      configatron.retrieve(:office, 'Stanley').should == 'Stanley'
+    end
+    
+    it 'should work with a symbol or a string' do
+      configatron.office = 'Michael'
+      configatron.retrieve(:office).should == 'Michael'
+      configatron.retrieve('office').should == 'Michael'
+    end
+    
+    it 'should work on nested parameters' do
+      configatron.the.office = 'Michael'
+      configatron.the.retrieve(:office).should == 'Michael'
+      configatron.the.retrieve('office').should == 'Michael'
+    end
+    
+  end
+  
+  describe 'remove' do
+    
+    it 'should remove a parameter' do
+      configatron.movies = 'Pulp Fiction'
+      configatron.movies.should == 'Pulp Fiction'
+      configatron.remove(:movies)
+      configatron.movies.should be_nil
+    end
+    
+    it 'should remove a nested parameter' do
+      configatron.the.movies = 'Pulp Fiction'
+      configatron.the.movies.should == 'Pulp Fiction'
+      configatron.the.remove(:movies)
+      configatron.the.movies.should be_nil
+    end
+    
+    it 'should work with a symbol or a string' do
+      configatron.the.movies = 'Pulp Fiction'
+      configatron.the.office = 'Michael'
+      configatron.the.remove(:movies)
+      configatron.the.movies.should be_nil
+      configatron.the.remove('office')
+      configatron.the.office.should be_nil
+    end
+    
+    it 'should remove all sub-parameters' do
+      configatron.the.movies = 'Pulp Fiction'
+      configatron.the.office = 'Michael'
+      configatron.remove(:the)
+      configatron.the.should be_nil
+      configatron.the.movies.should be_nil
+    end
+    
+  end
+  
+  describe 'set_default' do
+    
+    it 'should set a default parameter value' do
+      configatron.set_default(:movies, 'Pulp Fiction')
+      configatron.movies.should == 'Pulp Fiction'
+    end
+    
+    it 'should set a default parameter value for a nested parameter' do
+      configatron.the.set_default(:movies, 'Pulp Fiction')
+      configatron.the.movies.should == 'Pulp Fiction'
+    end
+    
+    it 'should not set the parameter if it is already set' do
+      configatron.movies = 'Transformers'
+      configatron.set_default(:movies, 'Pulp Fiction')
+      configatron.movies.should == 'Transformers'
+    end
+    
+    it 'should not set the nested parameter if it is already set' do
+      configatron.the.movies = 'Transformers'
+      configatron.the.set_default(:movies, 'Pulp Fiction')
+      configatron.the.movies.should == 'Transformers'
+    end
+    
+  end
+  
+  describe 'reset!' do
+    
+    it 'should clear out all parameter' do
+      configatron.one = 1
+      configatron.letters.a = 'A'
+      configatron.letters.b = 'B'
+      configatron.one.should == 1
+      configatron.letters.a.should == 'A'
+      configatron.reset!
+      configatron.one.should be_nil
+      configatron.letters.a.should be_nil
+    end
+    
+  end
+
+end

data/spec/lib/futurama.yml

@@ -0,0 +1,6 @@
+futurama:
+  robots:
+    bender: Bender The Robot
+  humans:
+    fry: Philip J. Fry
+    amy: Amy Wong

data/spec/lib/lost.yml

@@ -0,0 +1,14 @@
+others:
+    on_island:
+        ben: Benjamin Linus
+        richard: Richard Alpert
+    deceased:
+        goodwin: Goodwin Stanhope
+        mikhail: Mikhail Bakunin
+survivors:
+    on_island:
+        jack: Jack Shepherd
+        locke: John Locke
+    deceased:
+        charlie: Charlie Pace
+        michael: Michael Dawson

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'spec'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'configatron')

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: sevenwire-configatron
+version: !ruby/object:Gem::Version 
+  version: 2.2.2
+platform: ruby
+authors: 
+- markbates
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-29 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: "Configatron was developed by: markbates"
+email: mark@mackframework.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/configatron/configatron.rb
+- lib/configatron/core_ext/class.rb
+- lib/configatron/core_ext/kernel.rb
+- lib/configatron/core_ext/object.rb
+- lib/configatron/core_ext/string.rb
+- lib/configatron/errors.rb
+- lib/configatron/store.rb
+- lib/configatron.rb
+- README
+- spec/lib
+- spec/lib/class_spec.rb
+- spec/lib/configatron_spec.rb
+- spec/lib/futurama.yml
+- spec/lib/lost.yml
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://www.mackframework.com
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: magrathea
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A powerful Ruby configuration system.
+test_files: 
+- spec/lib
+- spec/lib/class_spec.rb
+- spec/lib/configatron_spec.rb
+- spec/lib/futurama.yml
+- spec/lib/lost.yml
+- spec/spec.opts
+- spec/spec_helper.rb