configatron 1.2.2 → 2.0.0

data/lib/configatron/configatron.rb

@@ -0,0 +1,44 @@
+require 'singleton'
+
+class Configatron
+  include Singleton
+  
+  def initialize # :nodoc:
+    @_namespace = :default
+    reset!
+  end
+  
+  # Forwards the method call onto the 'namespaced' Configatron::Store
+  def method_missing(sym, *args)
+    @_store[@_namespace].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)
+    @_namespace = rand
+    @_store[@_namespace] = @_store[:default].deep_clone 
+    begin
+      if options
+        self.method_missing(:configure_from_hash, options)
+      end
+      yield
+    rescue Exception => e
+      raise e
+    ensure
+      @_store.delete(@_namespace)
+      @_namespace = :default
+    end
+  end
+  
+  undef :inspect # :nodoc:
+  undef :nil? # :nodoc:
+  
+end

data/lib/configatron/errors.rb

@@ -0,0 +1,7 @@
+class Configatron
+  class ProtectedParameter < StandardError
+    def intialize(name)
+      super("Can not modify protected parameter: '#{name}'")
+    end
+  end
+end

data/lib/configatron/kernel.rb

@@ -1,14 +1,8 @@
 module Kernel
   
-  # If called without a block it will return the Configatron::Configuration instance.
-  # If called with a block then it will call the Configatron::Configatron configure method
-  # and yield up a Configatron::Store object.
-  def configatron(&block)
-    if block_given?
-      Configatron::Configuration.instance.configure(&block)
-    else
-      Configatron::Configuration.instance
-    end
+  # Provides access to the Configatron storage system.
+  def configatron
+    Configatron.instance
   end
   
 end

data/lib/configatron/store.rb

@@ -1,74 +1,166 @@
-module Configatron
-  # Used to store each of the 'sets' of configuration parameters.
+class Configatron
   class Store
-    include Configatron::Helpers
     
-    # The actual key/pair parameter values.
-    attr_reader :parameters
-  
-    # Takes an optional Hash to configure parameters.
-    def initialize(parameters = {})
-      @parameters = parameters.inject({}) do |m,pair|
-        sym = pair.first.is_a?(Symbol) ? pair.first : pair.first.intern
-        m[sym] = pair.last
-        m
-      end
+    # Takes an optional Hash of parameters
+    def initialize(options = {})
+      @_store = {}
+      configure_from_hash(options)
+      @_protected = []
     end
-  
-    # If a method is called with an = at the end, then that method name, minus
-    # the equal sign is added to the parameter list as a key, and it's *args
-    # become the value for that key. Eventually the keys become method names.
-    # If a method is called without an = sign at the end then the value from
-    # the parameters hash is returned, if it exists.
-    def method_missing(sym, *args)
-      if sym.to_s.match(/(.+)=$/)
-        @parameters[sym.to_s.gsub("=", '').to_sym] = *args
-      else
-        val = @parameters[sym]
-        if val.is_a? Hash
-          val = (@parameters[sym] = Configatron::Store.new(val))
-        end
-        return val unless val.nil?
-        return handle_missing_parameter(sym)
+    
+    # Returns a Hash representing the configurations
+    def to_hash
+      @_store
+    end
+
+    def inspect # :nodoc:
+      to_hash.inspect
+    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.
+    def configure_from_yaml(path)
+      begin
+        configure_from_hash(YAML.load(File.read(path)))
+      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
     
-    # Checks whether or not configuration parameter exists.
-    def exists?(name)
-      return true unless @parameters[name.to_sym].nil?
-      super(name)
+    # 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
     
-    # Used to create 'namespaces' around a set of configuration parameters.
-    def namespace(name)
-      if exists?(name)
-        yield self.send(name.to_sym)
-      elsif configatron.exists?(name)
-        yield configatron.send(name.to_sym)
+    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)
+        @_store[name] = parse_options(*args)
+      elsif @_store.has_key?(sym)
+        return @_store[sym]
       else
-        ns = Configatron::Store.new
-        yield ns
-        @parameters[name.to_sym] = ns
+        store = Configatron::Store.new
+        @_store[sym] = store
+        return store
       end
     end
     
-    # Called when a reload is called on configatron. Useful for subclasses that 
-    # may need to read a file in, etc...
-    def reload
+    def ==(other) # :nodoc:
+      self.to_hash == other
     end
     
-    def to_hash
-      @parameters.inject({}) do |acc, (k,v)|
-        case v
-        when Configatron::Store
-          acc[k] = v.to_hash
+    def protect(name)
+      @_protected << name.to_sym
+    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
-          acc[k] = v
+          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 )
+            v_cl = deep_clone( v, cloned )
+            cl.instance_eval( "#{var} = v_cl" )
+          end
+          return cl
         end
-        
-        acc
       end
     end
-  
-  end # Store
-end # Configatron
+    
+    private
+    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/configatron_spec.rb

@@ -0,0 +1,293 @@
+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 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
+    
+  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
+    
+  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
+    
+  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.inspect.should == {:one => 1, :letters => {:a => 'A', :b => 'B'}}.inspect
+    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