zen_config 0.0.3 → 0.0.4

data/README.md

@@ -50,7 +50,7 @@ Restrict config scope in your classes :
 
 ## Usage
 
-Instantiate ZenConfig with a configuration hash :
+###Instantiate ZenConfig with a configuration hash :
 
     config_hash = { :foo => "foo value", :bar => { :baz => "baz value" } }
     MyConfig = ZenConfig.new config_hash
@@ -59,31 +59,20 @@ Instantiate ZenConfig with a configuration hash :
     MyConfig.bar.baz
      => "baz value"
 
-By default, ZenConfig is read only :
+###By default, ZenConfig is read only :
 
     MyConfig.foo = "bar value"
     NoMethodError: undefined method `foo=' for #<ZenConfig:0x00000002ee52f8>
 
-But changes can be allowed on build time :
+###But changes can be allowed on build time :
 
     MyConfig = ZenConfig.new config_hash, true
     MyConfig.foo = "new foo value"
      => "new foo value"
     MyConfig.foo
      => "new foo value"
-
-ZenConfigs can be converted to hashs :
-
-    MyConfig.to_hash
-     => {:foo=>"new foo value", :bar=>{:baz=>"baz value"}}
-
-Config keys can be deleted (if ZenConfig is unlocked) :
-
-    MyConfig.delete :bar
-    MyConfig.to_hash
-     => {:foo=>"new foo value"}
-
-Then the object can be locked to read only again :
+     
+###Then the object can be locked to read only again :
 
     MyConfig.read_only
     MyConfig.read_only?
@@ -91,48 +80,106 @@ Then the object can be locked to read only again :
     MyConfig.foo = "foo value"
     NoMethodError: undefined method `foo=' for #<ZenConfig:0x00000002ee52f8>
 
-And there's no way to unlock write.
+__And there's no way to unlock write.__
+
 This guarantees that ZenConfig data hasn't been altered since read-only lock has been set.
 You should not use unlocked ZenConfig in your application code, since you don't know when and where it has been modified.
 Dynamic persistent writes functions will come in future versions.
 
-Sub configurations can be nested (if ZenConfig object is not locked) :
+###Sub configurations can be nested (if ZenConfig is unlocked) :
 
     MyConfig.new :bar
     MyConfig.bar.baz = "baz value"
 
-Nested configurations are ZenConfigs. This allow accessing configuration on a specific context :
+###Nested configurations are ZenConfigs :
 
     MyBarConfig = MyConfig.bar
     MyBarConfig.class
      => ZenConfig
     MyBarConfig.baz
      => "baz value"
+     
+This allow accessing configuration on a specific context.
 
-Nested ZenConfigs can access their parent :
+###Nested ZenConfigs can access their parent :
 
     MyBarConfig.parent.foo
      => "bar value"
 
-Of course, root ZenConfig has no parent :
+###Of course, root ZenConfig has no parent :
 
     MyConfig.parent
      => nil
 
-You can check if a config key exists :
+###ZenConfigs can be converted to hashs :
 
-    MyConfig.foo_exists?
-     => true
+    MyConfig.to_hash
+     => {:foo=>"new foo value", :bar=>{:baz=>"baz value"}}
+
+###ZenConfigs subkeys can be parsed :
 
-Count keys :
+	MyConfig.each do |key, value|
+	  puts key.to_s + ":" + value.class.to_s
+	end
+	foo:String
+	bar:ZenConfig
+	 => {:foo=>"foo value", :bar=>{:baz=>"baz value"}}
+
+###Counted :
 
     MyConfig.count
      => 2
     MyConfig.bar.count
      => 1
 
-Note : ZenConfig methods are reserved words that can not be used as config keys.
-They'll probably be renamed with a leading underscore in future versions.
+###Checked :
+
+    MyConfig.exists? :bar
+     => true
+     
+or
+
+    MyConfig.bar_exists?
+     => true
+
+###Deleted (if ZenConfig is unlocked) :
+
+    MyConfig.delete :bar
+    MyConfig.to_hash
+     => {:foo=>"new foo value"}
+     
+or
+
+    MyConfig.delete_bar
+    MyConfig.to_hash
+     => {:foo=>"new foo value"}
+
+## Important note on reserved words :
+
+Some words are reserved by Ruby or ZenConfig (public methods or attributes).
+
+The best practice is to avoid using one of these reserved words as keys in your config files, but you can call them by adding an underscore in front of the key.
+
+Using these reserved words can result in strange behaviors :
+
+	MyConfig = ZenConfig.new({ :reject => { :default => 10 } })
+	[...]
+	MyConfig.to_hash
+	 => {:reject=>{:value=>"10"}}
+
+Config is successfully loaded but :
+ 
+	MyConfig.reject.value
+	NoMethodError: undefined method `value' for #<Enumerator:0x000000026fd5b8>
+
+Solution :
+	
+	MyConfig._reject.value
+	 => 10
+
+Reserved words could be reduced by making ZenConfig a BasicObject subclass, but it's not possible as ZenConfig uses Enumerable.
+
+__Anyone knowing how to get the best of both worlds is welcome !__
 
 ## Goals
 

data/lib/zen_config.rb

@@ -28,6 +28,7 @@ class ZenConfig
 
   def delete key
     if @allow_modifications
+      key = key.to_sym
       backup = @data[key]
       @data.delete key
       update_count
@@ -36,14 +37,15 @@ class ZenConfig
   end
 
   def exists? key
-    @data.has_key? key
+    @data.has_key? key.to_sym
   end
 
-  def get name, default = nil
+  def get key, default = nil
+    key = key.to_sym
     result = default
 
-    if @data.has_key? name
-      result = @data[name]
+    if @data.has_key? key
+      result = @data[key]
     end
 
     return result
@@ -63,6 +65,8 @@ class ZenConfig
   end
 
   def set key, value
+    key = key.to_sym
+    
     if @allow_modifications
       if value.is_a? Hash
         @data[key] = self.new value, true
@@ -125,11 +129,11 @@ class ZenConfig
     value = args.first
 
     # Checks if a key exists
-    if /\A(.*)_exists\?\Z/.match method
+    if /\A([a-zA-Z1-9]+)_exists\?\Z/.match method
       exists? $1
 
     # Delete a key
-    elsif /\Adelete_(.*)\Z/.match method
+    elsif /\Adelete_([a-zA-Z1-9]+)\Z/.match method
       delete $1 if exists? $1
 
     # Writes a key value
@@ -139,6 +143,7 @@ class ZenConfig
 
     # Reads a key value
     elsif (args.count == 0)
+      method = method[1..-1] if method[0] == '_'
       get method
 
     # Unknown method

data/lib/zen_config/version.rb

@@ -1,3 +1,3 @@
 class ZenConfig
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zen_config
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors: