config_context 0.2.1 → 0.3.0

data/README.rdoc

@@ -2,50 +2,65 @@
 
 Your DSL config context...
 
+
 == Installing
     
 The latest stable version is published in gemcutter.
 
-  rake 
-  gem install ./pk/config_context-${VERSION}.gem
+  gem install config_context
+  
 
 == How to use
 
   require 'rubygems'
-  require 'context_config'
-
+  require 'config_context'
+  
   ##
-  # Pure config in a block	
-  ContextConfig.configure do |my_config|
+  # Puts all your configuration context in a block
+  #	
+  ConfigContext.configure do |config|
 
-    my_config.a = "Value of a"
-    my_comfig.b = "Value of b"
+    config.a             = "Value of a"
+    config.b             = "Value of b"
+    config.c             = { also:=>"complex", :values=>nil }
+    config[:d]           = [ "Value", "of", :d ]
+    config['String key'] = "My value"
   end
-		
+	
   ##
-  # Config like hash notation in a block
-  ContextConfig.configure do |other_config|
-		
-    other_config[:key]       = ["value1", "value2" ]
-    other_config[:other_key] = { :new=>"values" }
-  end
-		
+  # Retrieve your properties
+  #
+  puts ConfigContext.a
+  puts ConfigContext.b
+  puts ConfigContext.c
+  puts ConfigContext.d
+  puts ConfigContext[:d]
+  puts ConfigContext['String key']
+  
+  ##
+  # Check the presence of a property
+  #
+  puts ConfigContext.b if( ConfigContext.b? )
+				
   ##
-  # Loading config from YAML file
+  # Load your config from a YAML file and overrides some properties...
+  #
   begin	
-    ContextConfig.load( "settings.yml" )
-  rescue ContextConfigError => cce
-    fail( cce.message )
+    ConfigContext.load( "settings.yml", :allow_collisions=>true )
+  rescue ConfigContext::Error => e
+    fail( e.message )
   end
-
-  puts ContextConfig.a
-  puts ContextConfig[:b]
-  puts ContextConfig.all.inspect
+  
+  puts ConfigContext.a if( ConfigContext.a? )
+  puts ConfigContext.all.inspect
+  puts ConfigContext.keys
    
+
 == TODO
 
 * Document all this stuff in english... I promise
-  
+
+
 == License
 
 Copyright (c) 2010-2030 Javier Juarez Martinez

data/lib/config_context.rb

@@ -4,68 +4,43 @@ require 'yaml'
 module ConfigContext
   extend self
   
-  class ConfigContextError < StandardError; end
+  @config = { }
   
-  def init
-    
-    @config ||= {}
-  end
-
+  class Error < StandardError; end
   
   def method_missing( method, *arguments, &block )
   
-    self.init unless @config
-          
-    if( method =~ /(.+)=$/)
+    if( method =~ /(.+)=$/ )
     
-      config_key          = method.to_s.delete( '=$' ).to_sym
+      config_key          = method.to_s.delete( '=' ).to_sym
       @config[config_key] = (arguments.length == 1) ? arguments[0] : arguments
+    elsif( method =~ /(.+)\?$/ )
+      
+      @config.has_key?( method.to_s.delete( '?' ).to_sym )
     else
-      return @config[method] if @config.keys.include?( method )
+      @config[method] if @config.has_key?( method )
     end
   end
 
+  def configure; yield self; end
 
-  def configure       
-    
-    yield self
-  end
-
-
-  def []( key )
-    
-    self.init unless @config
-
-    return @config[key] if @config[key]
-    nil
-  end
-
-
-  def[]=( key, value )
-
-    self.init unless @config
-
-    @config[key]=value
-  end
-
+  def []( key ) return @config[key]; end
 
-  def all
-    
-    self.init unless @config
+  def[]=( key, value ) @config[key] = value; end
 
-    @config
-  end
+  def all; @config; end
+  
+  def keys; @config.keys; end
 
 
-  def load( config_file )
+  def load( config_file, options = { :allow_collisions => true } )
     
-    self.init unless @config
-
-    yf = YAML.load_file( config_file )
-    yf.keys.each { |key| @config[key] = yf[key] } 
+    if( options[:allow_collisions] )
+      @config.merge!( YAML.load_file( config_file ) )
+    else
+      @config.merge!( YAML.load_file( config_file ) ) { |key, original_value, new_value| original_value }
+    end
   rescue Exception => e
-    raise ConfigContextError.new( e.message )
-  else
-    @config
+    raise ConfigContext::Error.new( e.message )
   end
 end

data/lib/version.rb

@@ -2,8 +2,8 @@ module ConfigContext
   module Version
     INFO = {
       :major =>0,
-      :minor =>2,
-      :patch =>1
+      :minor =>3,
+      :patch =>0
     }
 
     NAME    = 'config_context'

data/test/unit/tc_config_context.rb

@@ -11,51 +11,108 @@ class TestConfigContext < Test::Unit::TestCase
 
   context "A ConfigContext" do
 
+    TEST_SYMBOL      = 'symbol'
+    TEST_LIST        = [1, 2, 3]
+    TEST_HASH        = { :a=>1, :b=>2, :c=>3 }
+    TEST_STRING      = 'string'
+    TEST_OTHERSYMBOL = "othersymbol"
+    
+    
     setup do
 
       ConfigContext.configure do |config|
 
-        config.element = "element"
-        config.mylist    = [1,2,3]
-        config.myhash    = { :a=>1, :b=>2, :c=>3 }
+        config.mysymbol = TEST_SYMBOL
+        config.mylist   = TEST_LIST
+        config.myhash   = TEST_HASH
       end
 
-      ConfigContext['string']  = "String"
-      ConfigContext[:mysymbol] = "I am a pretty symbol"
+      ConfigContext[TEST_STRING]  = TEST_STRING
+      ConfigContext[:othersymbol] = TEST_OTHERSYMBOL
     end
     
-    should "Test configure members" do
+    should "configure properties" do
     
-      assert_equal( ConfigContext.element, "element" )
-      assert_equal( ConfigContext.mylist, [1,2,3] )
-      assert_equal( ConfigContext.myhash, { :a=>1, :b=>2, :c=>3 } )
-      assert_equal( ConfigContext['string'], "String" )
-      assert_equal( ConfigContext.mysymbol, "I am a pretty symbol" )
-      assert_equal( ConfigContext[:mysymbol], "I am a pretty symbol" )
+      assert_equal( ConfigContext.mysymbol, TEST_SYMBOL )
+      assert_equal( ConfigContext.mylist, TEST_LIST )
+      assert_equal( ConfigContext.myhash, TEST_HASH )
+      assert_equal( ConfigContext[TEST_STRING], TEST_STRING )
+      assert_equal( ConfigContext.othersymbol, TEST_OTHERSYMBOL )
+      assert_equal( ConfigContext[:othersymbol], TEST_OTHERSYMBOL )
     end
-  
-    should "Test all properties" do
+
+    should "check the presence of some properties" do
+    
+      assert( ConfigContext.mysymbol? )
+      assert( ConfigContext.mylist? )
+      assert( ConfigContext.myhash? )
+      assert( ConfigContext.othersymbol? )
+
+      assert( !ConfigContext.string? ) # Pay attention to this behaviour!!!
+
+      assert( !ConfigContext.thisdonotexist? )
+    end
+    
+    should "retrive all properties" do
      
-      assert_equal( ConfigContext.all, { :element=>"element", :mylist=>[1,2,3], :myhash=>{ :a=>1, :b=>2, :c=>3 }, :mysymbol=> 'I am a pretty symbol', 'string'=>'String' } )
+      assert_equal( ConfigContext.all, { 
+        :mysymbol    =>TEST_SYMBOL, 
+        :mylist      =>TEST_LIST, 
+        :myhash      =>TEST_HASH, 
+        'string'     =>TEST_STRING,
+        :othersymbol =>TEST_OTHERSYMBOL
+      } )
     end
-
-    should "Test yaml load" do
     
+    should "retrieve all property keys" do
+
+      assert_equal( ConfigContext.keys, [ :mysymbol, :mylist, :myhash, 'string', :othersymbol ] )
+    end
+
+    should "load a Yaml file without keys collisions" do
+          
       ConfigContext.load( File.join( File.dirname( __FILE__ ), %w[ .. fixtures test.yml] ) )    
-      assert_equal( ConfigContext.all, { :element=>'element', :mylist=>[1,2,3], :myhash=>{ :a=>1, :b=>2, :c=>3 }, :mysymbol=>'I am a pretty symbol', 'string'=>'String' } )
+      assert_equal( ConfigContext.all, { 
+        :mysymbol    =>TEST_SYMBOL, 
+        :mylist      =>TEST_LIST, 
+        :myhash      =>TEST_HASH, 
+        'string'     =>TEST_STRING,
+        :othersymbol =>TEST_OTHERSYMBOL
+      } )
+    end
+        
+    should "load a Yaml file with key collisions" do
+    
+      original_value = "The Original value is here"
+      
+      ConfigContext.configure { |config| config.mysymbol = original_value }
+
+      ConfigContext.load( File.join( File.dirname( __FILE__ ), %w[ .. fixtures test.yml] ), :allow_collisions=>false )    
+      assert_equal( ConfigContext.all, { 
+        :mysymbol    =>original_value, 
+        :mylist      =>TEST_LIST, 
+        :myhash      =>TEST_HASH, 
+        'string'     =>TEST_STRING,
+        :othersymbol =>TEST_OTHERSYMBOL
+      } )
+    end
+    
+    should "load a Yaml file with error" do
+        
+      assert_raises( ConfigContext::Error ) { ConfigContext.load( "very bad file.yml" ) }
     end
     
-    should "Test update property" do
+    should "update properties" do
       
-      assert_equal( ConfigContext.element, "element" )
-      ConfigContext.element = "A"
-      assert_equal( ConfigContext.element, "A" )
+      assert_equal( ConfigContext.mysymbol, TEST_SYMBOL )
+      ConfigContext.mysymbol = "A"
+      assert_equal( ConfigContext.mysymbol, "A" )
 
-      assert_equal( ConfigContext.mylist, [1,2,3] )
+      assert_equal( ConfigContext.mylist, TEST_LIST )
       ConfigContext.mylist = [4,5,6]
       assert_equal( ConfigContext.mylist, [4,5,6] )
 
-      assert_equal( ConfigContext.myhash, { :a=>1, :b=>2, :c=>3 } )
+      assert_equal( ConfigContext.myhash, TEST_HASH )
       ConfigContext.myhash= { :d=>4, :e=>5, :f=>6 }
       assert_equal( ConfigContext.myhash, { :d=>4, :e=>5, :f=>6 } )
     end

metadata

@@ -2,7 +2,7 @@
 name: config_context
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Javier Juarez
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-14 00:00:00 +01:00
+date: 2011-03-15 00:00:00 +01:00
 default_executable: 
 dependencies: []