rubytree 0.3.1 → 0.4.0

data/ChangeLog

@@ -1,4 +1,27 @@
-2007-07-17  Anupam Sengupta  <anupamsg@gmail.com>
+2007-07-18  Anupam Sengupta  <anupamsg@gmail.com>
+
+	* test/testbinarytree.rb (TC_BinaryTreeTest::test_isLeftChild):
+	Minor syntax correction.
+
+	* lib/tree.rb (Tree::TreeNode::depth): Added a tree depth
+	computation method.
+	(Tree::TreeNode::breadth): Added a tree breadth method.
+
+	* test/testtree.rb (TC_TreeTest::test_depth/test_breadth): Added a
+	test for the depth and breadth method.
+
+	* lib/tree/binarytree.rb (Tree::BinaryTreeNode::is*Child):
+	Added tests for determining whether a node is a left or right
+	child.
+
+	* test/testbinarytree.rb: Added the test cases for the binary tree
+	implementation.
+	(TC_BinaryTreeTest::test_is*Child): Added tests for right or left
+	childs.
+
+	* lib/tree/binarytree.rb: Added the binary tree implementation.
+
+ 2007-07-17  Anupam Sengupta  <anupamsg@gmail.com>
 
 	* lib/tree.rb (Tree::TreeNode::parentage): Renamed 'ancestors'
 	method to 'parentage' to avoid clobbering Module.ancestors

data/README

@@ -1,9 +1,9 @@
-= Rubytree 0.3.1
+= Rubytree 0.4.0
 
   (c) 2006, 2007 Anupam Sengupta
   http://rubytree.rubyforge.org
 
-  Document Revision: $Revision: 1.7 $ by $Author: anupamsg $
+  Document Revision: $Revision: 1.9 $ by $Author: anupamsg $
 
 == License
 

data/Rakefile

@@ -1,6 +1,6 @@
 # Rakefile
 #
-# $Revision: 1.16 $ by $Author: anupamsg $
+# $Revision: 1.18 $ by $Author: anupamsg $
 # $Name:  $
 #
 # Copyright (c) 2006, 2007 Anupam Sengupta
@@ -42,7 +42,7 @@ require 'rake/rdoctask'
 desc "Default Task"
 task :default => :gem
 
-PKG_VERSION = '0.3.1'
+PKG_VERSION = '0.4.0'
 PKG_FILES = FileList[
                      '[A-Z]*',
                      'lib/**/*.rb',
@@ -107,6 +107,14 @@ begin
 end
 
 # $Log: Rakefile,v $
+# Revision 1.18  2007/07/18 20:15:06  anupamsg
+# Added two predicate methods in BinaryTreeNode to determine whether a node
+# is a left or a right node.
+#
+# Revision 1.17  2007/07/18 07:17:34  anupamsg
+# Fixed a  issue where TreeNode.ancestors was shadowing Module.ancestors. This method
+# has been renamed to TreeNode.parentage.
+#
 # Revision 1.16  2007/07/17 05:34:03  anupamsg
 # Added an optional tags Rake-task for generating the TAGS file for Emacs.
 #

data/TAGS

@@ -8,7 +8,7 @@ module Tree::Tree
48,2020
     attr_writer :content::Tree::TreeNode#content
107,3886
     def initialize::Tree::TreeNode#Tree::TreeNode.new
118,4158
     def to_s::Tree::TreeNode#to_s
132,4447
-    def ancestors::Tree::TreeNode#ancestors
144,4836
+    def parentage::Tree::TreeNode#parentage
144,4836
     def parent=::Tree::TreeNode#parent=
159,5172
     def <<::Tree::TreeNode#<<
167,5408
     def add::Tree::TreeNode#add
174,5667
@@ -55,6 +55,40 @@ class Person::Person
37,1683
     def to_s::Person#to_s
45,1853
 
 test/testtree.rb,1847
+class TC_TreeTest::TC_TreeTest
43,1728
+  def setup::TC_TreeTest#setup
45,1781
+  def loadChildren::TC_TreeTest#loadChildren
73,2687
+  def teardown::TC_TreeTest#teardown
79,2783
+  def test_root_setup::TC_TreeTest#test_root_setup
83,2828
+  def test_root::TC_TreeTest#test_root
97,3464
+  def test_firstSibling::TC_TreeTest#test_firstSibling
105,3691
+  def test_isFirstSibling::TC_TreeTest#test_isFirstSibling
115,4169
+  def test_isLastSibling::TC_TreeTest#test_isLastSibling
125,4577
+  def test_lastSibling::TC_TreeTest#test_lastSibling
135,4973
+  def test_siblings::TC_TreeTest#test_siblings
145,5442
+  def test_isOnlyChild?::TC_TreeTest#test_isOnlyChild?
164,6029
+  def test_nextSibling::TC_TreeTest#test_nextSibling
173,6341
+  def test_previousSibling::TC_TreeTest#test_previousSibling
182,6707
+  def test_add::TC_TreeTest#test_add
191,7091
+  def test_remove::TC_TreeTest#test_remove
210,7573
+  def test_removeAll::TC_TreeTest#test_removeAll
237,8283
+  def test_removeFromParent::TC_TreeTest#test_removeFromParent
246,8527
+  def test_children::TC_TreeTest#test_children
263,9157
+  def test_firstChild::TC_TreeTest#test_firstChild
289,10018
+  def test_lastChild::TC_TreeTest#test_lastChild
298,10293
+  def test_find::TC_TreeTest#test_find
307,10558
+  def test_parentage::TC_TreeTest#test_parentage
321,11093
+  def test_each::TC_TreeTest#test_each
329,11377
+  def test_each_leaf::TC_TreeTest#test_each_leaf
346,11999
+  def test_parent::TC_TreeTest#test_parent
360,12469
+  def test_indexed_access::TC_TreeTest#test_indexed_access
369,12850
+  def test_printTree::TC_TreeTest#test_printTree
377,13120
+  def test_dump::TC_TreeTest#test_dump
383,13191
+  def test_collect::TC_TreeTest#test_collect
399,13728
+  def test_freezeTree::TC_TreeTest#test_freezeTree
408,13947
+  def test_content::TC_TreeTest#test_content
417,14211
+
+test/testtree.rb.~1.11.~,1847
 class TC_TreeTest::TC_TreeTest
43,1728
   def setup::TC_TreeTest#setup
45,1781
   def loadChildren::TC_TreeTest#loadChildren
73,2687

data/lib/tree.rb

@@ -1,9 +1,9 @@
 # tree.rb
 #
-# $Revision: 1.12 $ by $Author: anupamsg $
+# $Revision: 1.16 $ by $Author: anupamsg $
 # $Name:  $
 #
-# = tree.rb - Generic Tree implementation
+# = tree.rb - Generic Multi-way Tree implementation
 #
 # Provides a generic tree data structure with ability to
 # store keyed node elements in the tree. The implementation
@@ -440,27 +440,40 @@ module Tree
       loadDumpRep(str)
     end
 
+    # Returns depth of the tree from this node. A single leaf node has a
+    # depth of 1.
+    def depth
+      return 1 if isLeaf?
+      1 + @children.collect { |child| child.depth }.max
+    end
+
+    # Returns breadth of the tree at this node level. A single node has a
+    # breadth of 1.
+    def breadth
+      return 1 if isRoot?
+      parent.children.size
+    end
+
     protected :parent=, :setAsRoot!
     private_class_method :loadDumpRep
 
   end
 end
 
-if __FILE__ == $0
-  root   = Tree::TreeNode.new("ROOT")
-  child1 = Tree::TreeNode.new("CHILD1")
-  child2 = Tree::TreeNode.new("CHILD2")
-  child3 = Tree::TreeNode.new("CHILD3")
-  grandchild1 = Tree::TreeNode.new("GRANDCHILD1")
-  root << child1 << grandchild1
-  root << child2
-  root << child3
-
-  puts child1.nextSibling
-  root.printTree
-end
-
 # $Log: tree.rb,v $
+# Revision 1.16  2007/07/18 23:38:55  anupamsg
+# Minor updates to tree.rb
+#
+# Revision 1.15  2007/07/18 22:11:50  anupamsg
+# Added depth and breadth methods for the TreeNode.
+#
+# Revision 1.14  2007/07/18 19:33:27  anupamsg
+# Added a new binary tree implementation.
+#
+# Revision 1.13  2007/07/18 07:17:34  anupamsg
+# Fixed a  issue where TreeNode.ancestors was shadowing Module.ancestors. This method
+# has been renamed to TreeNode.parentage.
+#
 # Revision 1.12  2007/07/17 03:39:28  anupamsg
 # Moved the CVS Log keyword to end of the files.
 #

data/lib/tree/binarytree.rb

@@ -0,0 +1,114 @@
+# binarytree.rb
+#
+# $Revision: 1.2 $ by $Author: anupamsg $
+# $Name:  $
+#
+# = binarytree.rb - Binary Tree implementation
+#
+# Provides a generic tree data structure with ability to
+# store keyed node elements in the tree. The implementation
+# mixes in the Enumerable module.
+#
+# Author:: Anupam Sengupta (anupamsg@gmail.com)
+#
+
+# Copyright (c) 2007 Anupam Sengupta
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# - Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# - Redistributions in binary form must reproduce the above copyright notice, this
+#   list of conditions and the following disclaimer in the documentation and/or
+#   other materials provided with the distribution.
+#
+# - Neither the name of the organization nor the names of its contributors may
+#   be used to endorse or promote products derived from this software without
+#   specific prior written permission.
+#
+#   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+require 'tree'
+
+module Tree
+
+  # Provides a Binary tree implementation. This tree node allows only two child
+  # nodes (left and right childs). It also provides direct access to the left
+  # and right children, including assignment to the same.
+  class BinaryTreeNode < TreeNode
+
+    # Adds the specified child node to the receiver node.  The child node's
+    # parent is set to be the receiver.  The child nodes are added in the order
+    # of addition, i.e., the first child added becomes the left node, and the
+    # second child will be the second node.
+    # If only one child is present, then this will be the left child.
+    def add(child)
+      raise "Already has two child nodes" if @children.size == 2
+
+      super(child)
+    end
+
+    # Returns the left child node. Note that
+    # left Child == first Child
+    def leftChild
+      children.first
+    end
+
+    # Returns the right child node. Note that
+    # right child == last child unless there is only one child.
+    def rightChild
+      children.last
+    end
+
+    # Sets the left child. If a previous child existed, it is replaced.
+    def leftChild=(leftChild)
+      @children[0] = leftChild
+      @childrenHash[leftChild.name] = leftChild
+    end
+
+    # Sets the right child. If a previous child existed, it is replaced.
+    def rightChild=(rightChild)
+      @children[1] = rightChild
+      @childrenHash[rightChild.name] = rightChild
+    end
+
+    # Returns true if this is the left child of its parent. Always returns false
+    # if this is the root node.
+    def isLeftChild?
+      return nil if isRoot?
+      self == parent.leftChild
+    end
+
+    # Returns true if this is the right child of its parent. Always returns false
+    # if this is the root node.
+    def isRightChild?
+      return nil if isRoot?
+      self == parent.rightChild
+    end
+
+  end
+
+end
+
+# $Log: binarytree.rb,v $
+# Revision 1.2  2007/07/18 20:15:06  anupamsg
+# Added two predicate methods in BinaryTreeNode to determine whether a node
+# is a left or a right node.
+#
+# Revision 1.1  2007/07/18 19:33:27  anupamsg
+# Added a new binary tree implementation.
+#

data/test/testbinarytree.rb

@@ -0,0 +1,143 @@
+#!/usr/bin/env ruby
+
+# testtree.rb
+#
+# $Revision: 1.4 $ by $Author: anupamsg $
+# $Name:  $
+#
+# Copyright (c) 2006, 2007 Anupam Sengupta
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# - Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# - Redistributions in binary form must reproduce the above copyright notice, this
+#   list of conditions and the following disclaimer in the documentation and/or
+#   other materials provided with the distribution.
+#
+# - Neither the name of the organization nor the names of its contributors may
+#   be used to endorse or promote products derived from this software without
+#   specific prior written permission.
+#
+#   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+require 'test/unit'
+require 'tree/binarytree'
+require 'person'
+
+# Test class for the Tree node.
+class TC_BinaryTreeTest < Test::Unit::TestCase
+
+  def setup
+    @root = Tree::BinaryTreeNode.new("ROOT", "Root Node")
+
+    @left_child1  = Tree::BinaryTreeNode.new("A Child at Left", "Child Node @ left")
+    @right_child1 = Tree::BinaryTreeNode.new("B Child at right", "Child Node @ right")
+
+  end
+
+  def teardown
+    @root.remove!(@left_child1)
+    @root.remove!(@right_child1)
+    @root = nil
+  end
+
+  def test_initialize
+    assert_not_nil(@root, "Binary tree's Root should have been created")
+  end
+
+  def test_add
+    @root.add  @left_child1
+    assert_same(@left_child1, @root.leftChild, "The left node should be left_child1")
+    assert_same(@left_child1, @root.firstChild, "The first node should be left_child1")
+
+    @root.add @right_child1
+    assert_same(@right_child1, @root.rightChild, "The right node should be right_child1")
+    assert_same(@right_child1, @root.lastChild, "The first node should be right_child1")
+
+    assert_raise RuntimeError do
+      @root.add Tree::BinaryTreeNode.new("The third child!")
+    end
+
+    assert_raise RuntimeError do
+      @root << Tree::BinaryTreeNode.new("The third child!")
+    end
+  end
+
+  def test_left
+    @root << @left_child1
+    @root << @right_child1
+    assert_same(@left_child1, @root.leftChild, "The left child should be 'left_child1")
+    assert_not_same(@right_child1, @root.leftChild, "The right_child1 is not the left child")
+  end
+
+  def test_right
+    @root << @left_child1
+    @root << @right_child1
+    assert_same(@right_child1, @root.rightChild, "The right child should be 'right_child1")
+    assert_not_same(@left_child1, @root.rightChild, "The left_child1 is not the left child")
+  end
+
+  def test_left_assignment
+    @root << @left_child1
+    @root << @right_child1
+    assert_same(@left_child1, @root.leftChild, "The left child should be 'left_child1")
+
+    @root.leftChild = Tree::BinaryTreeNode.new("New Left Child")
+    assert_equal("New Left Child", @root.leftChild.name, "The left child should now be the new child")
+  end
+
+  def test_right_assignment
+    @root << @left_child1
+    @root << @right_child1
+    assert_same(@right_child1, @root.rightChild, "The right child should be 'right_child1")
+
+    @root.rightChild = Tree::BinaryTreeNode.new("New Right Child")
+    assert_equal("New Right Child", @root.rightChild.name, "The right child should now be the new child")
+  end
+
+  def test_isLeftChild?
+    @root << @left_child1
+    @root << @right_child1
+
+    assert(@left_child1.isLeftChild?, "left_child1 should be the left child")
+    assert(!@right_child1.isLeftChild?, "left_child1 should be the left child")
+
+    assert(!@root.isLeftChild?, "Root is neither left child nor right")
+  end
+
+  def test_isRightChild?
+    @root << @left_child1
+    @root << @right_child1
+
+    assert(@right_child1.isRightChild?, "right_child1 should be the right child")
+    assert(!@left_child1.isRightChild?, "right_child1 should be the right child")
+    assert(!@root.isRightChild?, "Root is neither left child nor right")
+  end
+end
+
+# $Log: testbinarytree.rb,v $
+# Revision 1.4  2007/07/19 02:03:57  anupamsg
+# Minor syntax correction.
+#
+# Revision 1.3  2007/07/19 02:02:12  anupamsg
+# Removed useless files (including rdoc, which should be generated for each release.
+#
+# Revision 1.2  2007/07/18 20:15:06  anupamsg
+# Added two predicate methods in BinaryTreeNode to determine whether a node
+# is a left or a right node.
+#

data/test/testtree.rb

@@ -2,7 +2,7 @@
 
 # testtree.rb
 #
-# $Revision: 1.11 $ by $Author: anupamsg $
+# $Revision: 1.13 $ by $Author: anupamsg $
 # $Name:  $
 #
 # Copyright (c) 2006, 2007 Anupam Sengupta
@@ -419,11 +419,54 @@ class TC_TreeTest < Test::Unit::TestCase
     @root.content = pers
     assert_same(pers, @root.content, "Content should be the same")
   end
+
+  def test_depth
+    assert_equal(1, @root.depth, "A single node's depth is 1")
+
+    @root << @child1
+    assert_equal(2, @root.depth, "This should be of depth 2")
+
+    @root << @child2
+    assert_equal(2, @root.depth, "This should be of depth 2")
+
+    @child2 << @child3
+    assert_equal(3, @root.depth, "This should be of depth 3")
+    assert_equal(2, @child2.depth, "This should be of depth 2")
+
+    @child3 << @child4
+    assert_equal(4, @root.depth, "This should be of depth 4")
+
+  end
+
+  def test_breadth
+  assert_equal(1, @root.breadth, "A single node's breadth is 1")
+
+  @root << @child1
+  assert_equal(1, @root.breadth, "This should be of breadth 1")
+
+  @root << @child2
+  assert_equal(2, @child1.breadth, "This should be of breadth 2")
+  assert_equal(2, @child2.breadth, "This should be of breadth 2")
+
+  @root << @child3
+  assert_equal(3, @child1.breadth, "This should be of breadth 3")
+  assert_equal(3, @child2.breadth, "This should be of breadth 3")
+
+  @child3 << @child4
+  assert_equal(1, @child4.breadth, "This should be of breadth 1")
+end
 end
 
 __END__
 
 # $Log: testtree.rb,v $
+# Revision 1.13  2007/07/18 22:11:50  anupamsg
+# Added depth and breadth methods for the TreeNode.
+#
+# Revision 1.12  2007/07/18 07:17:34  anupamsg
+# Fixed a  issue where TreeNode.ancestors was shadowing Module.ancestors. This method
+# has been renamed to TreeNode.parentage.
+#
 # Revision 1.11  2007/07/17 03:39:29  anupamsg
 # Moved the CVS Log keyword to end of the files.
 #

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: rubytree
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
-date: 2007-07-17 00:00:00 -07:00
+  version: 0.4.0
+date: 2007-07-18 00:00:00 -07:00
 summary: Ruby implementation of the Tree data structure.
 require_paths: 
 - lib
@@ -34,10 +34,13 @@ files:
 - Rakefile
 - README
 - TAGS
+- lib/tree/binarytree.rb
 - lib/tree.rb
 - test/person.rb
+- test/testbinarytree.rb
 - test/testtree.rb
 test_files: 
+- test/testbinarytree.rb
 - test/testtree.rb
 rdoc_options: []