WhiteCloth 0.0.4 → 0.0.5

data/HISTORY

@@ -1,5 +1,26 @@
 RELEASE HISTORY
 
+v0.0.4 / 2011-05-17
+
+Regenerate gemspec for version 0.0.4 (David Love david@homeunix.org.uk)
+
+Changes:
+
+* 6 Patch Enhancements
+
+    * Update the HISTORY file
+    * Added foundations for the Standard Tree, including tests.
+    * Add a next function to UUIDTools::UUID to allow the generation of sequential UUID's
+    * Added basic sanity tests for the Gibberish library
+    * Update HISTORY file after tagging a version
+    * Remove FluxTuna from the testing namespace
+
+* 2 General Enhancements
+
+    * Version bump to 0.0.4
+    * Regenerate gemspec for version 0.0.2
+
+
 v0.0.2 / 2011-05-16
 
 Regenerate gemspec for version 0.0.2 (David Love david@homeunix.org.uk)
@@ -34,21 +55,17 @@ Changes:
     * Initial commit to WhiteCloth.
 
 
-HEAD / 2011-05-18
+HEAD / 2011-05-19
 
 Current Development (David Love)
 
 Changes:
 
-* 5 Patch Enhancements
+* 1 Bugfix Enhancements
 
-    * Added foundations for the Standard Tree, including tests.
-    * Add a next function to UUIDTools::UUID to allow the generation of sequential UUID's
-    * Added basic sanity tests for the Gibberish library
-    * Update HISTORY file after tagging a version
-    * Remove FluxTuna from the testing namespace
+    * Changed the node adding logic to make the 'Node not found' case clearer, and updated the function documentation to point out a potential problem using argument hashes.
 
 * 1 General Enhancements
 
-    * Regenerate gemspec for version 0.0.2
+    * Regenerate gemspec for version 0.0.4
 

data/Rakefile

@@ -95,6 +95,7 @@ YARD::Rake::YardocTask.new
 task :before_release do
   # Update the HISTORY file
   `vclog history -f gnu  > HISTORY`
+  `git commit -a -m "Update HISTORY file"`
 end
 
 ## Update the HISTORY file before a version bump

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/WhiteCloth.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{WhiteCloth}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Love"]
-  s.date = %q{2011-05-17}
+  s.date = %q{2011-05-18}
   s.default_executable = %q{whitecloth}
   s.description = %q{See: http://research.homeunix.org.uk}
   s.email = %q{david@homeunix.org.uk}

data/lib/data_structures/standard_node.rb

@@ -39,18 +39,23 @@ module WhiteCloth::DataStructures
       self.add(child_node)
     end
     
-    # Look for the designated block within tree starting at the current node.
+    # Look for the designated block within tree starting at the current node. If the +block_name+
+    # is +nil+ or +ROOT+, than we return the root of the current tree (i.e. ourselves).
     def [] (block_name)
       
       # We need to work out which node has the right content. Since
       # the nodes are effectively unordered, we have to look (potentially)
       # at every node
-      self.each{|child|
-        if child.content === block_name then
-          return child
-        end
-      }
-      
+      unless block_name.nil? or block_name == "ROOT"
+        self.each{|child|
+          if child.content === block_name then
+            return child
+          end
+        }
+        return nil
+      else
+        return self
+      end      
     end
     
     ###

data/lib/data_structures/standard_tree.rb

@@ -51,14 +51,19 @@ module WhiteCloth::DataStructures
     
     # Adds the specified nodes to the tree. The +node_list+ is a block, which is taken
     # to be a hash of node names/node identities and the contents to add to the identified
-    # nodes.
+    # nodes. If the +block_name+ is +nil+ or +ROOT+, than we add to the root of the tree.
+    #
+    # @note: Since the argument list is a {Hash}, each node in the list *must* be unique.
+    # Otherwise later arguments will override earlier ones, and you *will not* get the
+    # behaviour you think.
     def << (node_list)
       Hash[*node_list.flatten].each{|parent, contents|
         add_child(parent, contents)
       }
     end
     
-    # Look for the designated block within tree starting at the current node.
+    # Look for the designated block within tree starting at the current node. If the 
+    # +block_name+ is +nil+ or +ROOT+, than we add to the root of the tree.
     def [] (block_name)
       return @nodes[block_name]
     end

data/test/data_structures/standard_tree_test.rb

@@ -78,9 +78,9 @@ module Test::DataStructures
     setup { 
       @root = StandardTree.new("b081eabd-8799-4885-8c4d-eb3cf76b30b4")
 
-      @root << {nil => "Child 1"}
-      @root << {nil => "Child 2", nil => "Child 3"}
-      @root << {nil => "Child 3", "Child Node 3" => "Grand Child 1"}
+      @root << {"ROOT" => "Child 1", nil => "Child 5"}
+      @root << {nil => "Child 2"}
+      @root << {nil => "Child 3", "Child 3" => "Grand Child 1"}
       @root << {nil => "Child 4"}
       @root << {"Child 4" => "Grand Child 2", "Grand Child 1" => "Great Grand Child 1"}
       
@@ -89,10 +89,12 @@ module Test::DataStructures
     
     asserts("root's root is self") { topic[nil].root == topic[nil] }
     asserts("child 1's root should be ROOT") { topic["Child 1"].root == topic[nil] }
-    asserts("child 4's root should be ROOT") { topic["Child 4"].root == topic[nil] }
+    asserts("child 4's root should be ROOT") { topic["Child 4"].root == topic[nil] }    
+    asserts("child 2 is a kind of WhiteCloth::DataStructures::StandardNode") { topic["Child 2"].kind_of?(WhiteCloth::DataStructures::StandardNode) }
+    asserts("child 2's id (name)") { topic["Child 2"].id }.equals("b081eabd-8799-4885-8c4d-eb3cf76b30b7")
     asserts("great grand child 1's parent should be \"Grand Child 1\"") { topic["Great Grand Child 1"].parent == topic["Grand Child 1"] }
     denies("great grand child 1's parent should be \"Child 3\"") { topic["Great Grand Child 1"].parent == topic["Child 3"] }
-    asserts("root's height after adding the children") { topic[nil].node_height }.equals(2)
+    asserts("root's height after adding the children") { topic[nil].node_height }.equals(3)
   end
 
   context "Test the new nodes have no content" do

metadata

@@ -2,7 +2,7 @@
 name: WhiteCloth
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - David Love
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-17 00:00:00 +01:00
+date: 2011-05-18 00:00:00 +01:00
 default_executable: whitecloth
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -282,7 +282,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1095565922106216962
+      hash: -1575231288095777273
       segments: 
       - 0
       version: "0"