sonofhash 0.1 → 0.11

data/README.md

@@ -0,0 +1,18 @@
+Quacks like a Hash, but contains one additional method - commit()
+
+Typical usage:
+
+	require 'rubygems'
+	require 'sonofhash'
+	
+	parent = SonOfHash.new
+	child = parent.new_child
+	
+	parent['name'] = 'Moondublin'
+	puts child['name']            # Moondublin
+	
+	child['name'] = 'Lugrat'
+	puts parent['name']           # Moondublin
+	
+	child.commit
+	puts parent['name']           # Lugrat

data/lib/sonofhash.rb

@@ -1,5 +1,24 @@
 require 'set'
 
+# Quacks like a Hash, but contains one additional method - commit()
+#
+# Typical usage:
+#
+#   require 'rubygems'
+#   require 'sonofhash'
+#
+#   parent = SonOfHash.new
+#   child = parent.new_child
+#
+#   parent['name'] = 'Moondublin'
+#   puts child['name']            # Moondublin
+#   
+#   child['name'] = 'Lugrat'
+#   puts parent['name']           # Moondublin
+#
+#   child.commit
+#   puts parent['name']           # Lugrat
+#
 class SonOfHash
 
   def initialize(parent={})
@@ -8,6 +27,8 @@ class SonOfHash
     @parent = parent
   end
 
+  # Create a new child of this object. This is the primary way to
+  # record changes.
   def new_child
     return SonOfHash.new(self)
   end
@@ -36,6 +57,7 @@ class SonOfHash
     return @store.delete(key)
   end
   
+  # Merges the changes of this object into its parent
   def commit
     @store.each {|key, value| @parent[key] = value}
     @deletions.each {|key| @parent.delete(key)}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sonofhash
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: "0.11"
 platform: ruby
 authors: 
 - Tushar Pokle
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-11 00:00:00 +11:00
+date: 2010-03-12 00:00:00 +11:00
 default_executable: 
 dependencies: []
 
@@ -23,6 +23,7 @@ extra_rdoc_files: []
 
 files: 
 - lib/sonofhash.rb
+- README.md
 has_rdoc: true
 homepage: http://gemcutter.org/gems/partition
 licenses: []