rubytree 0.5.3 → 0.6.0

data/COPYING

@@ -2,7 +2,7 @@
 
 http://rubytree.rubyforge.org
 
-Copyright (c) 2006, 2007 Anupam Sengupta
+Copyright (c) 2006-2010 Anupam Sengupta
 
 All rights reserved.
 
@@ -25,3 +25,5 @@ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PRO
 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.
+
+$Id: COPYING 143 2010-01-02 09:10:16Z anupamsg $

data/ChangeLog

@@ -1,3 +1,14 @@
+2010-01-03  Anupam Sengupta  <anupamsg@gmail.com>
+
+	* lib/tree.rb (Tree::TreeNode#nodeDepth): Added the nodeDepth and
+	nodeHeight methods.  Deprecated the depth method.  This is the
+	bug-fix for bug # 22535.
+
+	* Rakefile: Added run-time dependency on the 'structured_warnings' gem.
+
+	* test/test_tree.rb: Added new test cases for the new nodeDepth
+	and nodeHeight methods.
+
 2010-01-01  Anupam Sengupta  <anupamsg@gmail.com>
 
 	* Rakefile: Have migrated 100% to usage of Hoe for the rake
@@ -179,3 +190,5 @@
 	* LICENSE: Added the BSD LICENSE file.
 
 	* Changelog: Added the Changelog file.
+
+$Id: ChangeLog 154 2010-01-03 18:01:28Z anupamsg $

data/History.txt

@@ -1,3 +1,11 @@
+=== 0.6.0 / 2010-01-03
+
+* Fixed the bug#22535[http://rubyforge.org/tracker/index.php?func=detail&aid=22535&group_id=1215&atid=4793] where the
+  depth method was actually returning height+1 (not the depth).
+
+* Marked the Tree::TreeNode#depth method as *deprecated* (and introduced the run-time dependency on
+  structured-warnings[http://github.com/schmidt/structured_warnings] gem).
+
 === 0.5.3 / 2009-12-31
 
 * Cleanup of the build system to exclusively use Hoe.
@@ -24,3 +32,5 @@
 === 0.4.2 / 2007-10-01
 
 * Minor code refactoring. Changes in the Rakefile.
+
+$Id: History.txt 156 2010-01-03 18:06:22Z anupamsg $

data/README

@@ -6,7 +6,7 @@
  \/ \_/\__,_|_.__/ \__, |\__|_|  \___|\___|
                   |___/
 
-  (c) 2006, 2007, 2008, 2009 Anupam Sengupta
+  (c) 2006, 2007, 2008, 2009, 2010 Anupam Sengupta
   http://rubytree.rubyforge.org
 
 == DESCRIPTION:
@@ -57,6 +57,8 @@ As an example, the following code-snippet implements this tree structure:
 == REQUIREMENTS:
 
 * Ruby 1.8+  (http://www.ruby-lang.org)
+* Hoe (http://seattlerb.rubyforge.org/hoe/Hoe.html) Rubygem
+* structured_warnings (http://github.com/schmidt/structured_warnings) Rubygem
 
 == INSTALL:
 
@@ -147,4 +149,4 @@ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWIS
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
-(Document Revision: $Revision: 1.18 $ by $Author: anupamsg $)
+(Document Revision: $Revision: 158 $ by $Author: anupamsg $)

data/Rakefile

@@ -1,7 +1,8 @@
+# -*- mode: ruby; -*-
+#
 # Rakefile
 #
-# $Revision: 1.29 $ by $Author: anupamsg $
-# $Name:  $
+# $Revision: 154 $ by $Author: anupamsg $ on $Date: 2010-01-03 23:31:28 +0530 (Sun, 03 Jan 2010) $
 #
 # Copyright (c) 2006, 2007 Anupam Sengupta
 #
@@ -49,7 +50,10 @@ begin
     self.extra_rdoc_files           = ['README', 'COPYING', 'ChangeLog']
     self.url                        =  "http://rubytree.rubyforge.org"
     self.readme_file                = 'README'
-    self.spec_extras[:rdoc_options] = ['--main', 'README']
+    self.extra_deps                 << ['structured_warnings', '>= 0.1.3']
+    # Set the RDoc Options.
+    self.spec_extras[:rdoc_options] = ['--main', 'README', '--line-numbers']
+    self.spec_extras[:has_rdoc]     = true
 
     # Now the publishing settings
     self.remote_rdoc_dir            = 'rdoc'
@@ -99,32 +103,3 @@ rescue LoadError
 
   END
 end
-
-#Rakefile,v $
-# Revision 1.21  2007/07/21 05:14:43  anupamsg
-# Added a VERSION constant to the Tree module,
-# and using the same in the Rakefile.
-#
-# Revision 1.20  2007/07/21 03:24:25  anupamsg
-# Minor edits to parameter names. User visible functionality does not change.
-#
-# Revision 1.19  2007/07/19 02:16:01  anupamsg
-# Release 0.4.0 (and minor fix in Rakefile).
-#
-# 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.
-#
-# Revision 1.15  2007/07/17 04:42:45  anupamsg
-# Minor fixes to the Rakefile.
-#
-# Revision 1.14  2007/07/17 03:39:28  anupamsg
-# Moved the CVS Log keyword to end of the files.
-#

data/TODO

@@ -1,9 +1,19 @@
 # -*- mode: org; coding: utf-8-unix; -*-
 
-* TODO Get the version control moved from CVS to Subversion (request submitted to RubyForge)
+* TODO Create the basic UML diagrams and upload to the Site
+  DEADLINE: <2010-01-04 Mon>
+
+* DONE Fix bug # [[http://rubyforge.org/tracker/index.php%3Ffunc%3Ddetail&aid%3D22535&group_id%3D1215&atid%3D4793][22535]]: The method Tree::TreeNode#depth is a misnomer.  The current definition actually provides the height function.
+  DEADLINE: <2010-01-09 Sat> CLOSED: [2010-01-03 Sun 22:15]
+
 * TODO Add a YAML export method to the TreeNode class.
 
+* DONE Get the version control moved from CVS to Subversion (request submitted to RubyForge)
+  CLOSED: [2010-01-02 Sat 17:58]
+
 * DONE Add logic in Rakefile to read the file list from Manifest.txt file.
   CLOSED: [2009-12-31 Thu 23:37]
 
 
+
+$Id: TODO 154 2010-01-03 18:01:28Z anupamsg $

data/lib/tree.rb

@@ -1,7 +1,6 @@
 # tree.rb
 #
-# $Revision: 1.31 $ by $Author: anupamsg $
-# $Name:  $
+# $Revision: 154 $ by $Author: anupamsg $ on $Date: 2010-01-03 23:31:28 +0530 (Sun, 03 Jan 2010) $
 #
 # = tree.rb - Generic Multi-way Tree implementation
 #
@@ -12,7 +11,7 @@
 # Author:: Anupam Sengupta (anupamsg@gmail.com)
 #
 
-# Copyright (c) 2006, 2007 Anupam Sengupta
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 Anupam Sengupta
 #
 # All rights reserved.
 #
@@ -42,22 +41,24 @@
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 
+require 'structured_warnings'   # To enable the deprecation of the depth method.
+
 # This module provides a TreeNode class which is the primary class for all
 # nodes represented in the Tree.
 # This module mixes in the Enumerable module.
 module Tree
 
   # Rubytree Package Version
-  VERSION = '0.5.3'
+  VERSION = '0.6.0'
 
   # == TreeNode Class Description
   #
   # The node class for the tree representation. the nodes are +named+ and have a
   # place-holder for the node data (i.e., the `content' of the node). The node
-  # names are expected to be unique.  In addition, the node provides navigation
+  # names are required to be unique.  In addition, the node provides navigation
   # methods to traverse the tree.
   #
-  # A node can have any number of child nodes attached to it. Note that while
+  # A node can have any number of child nodes attached to it.  Note that while
   # this implementation does not support directed graphs, the class itself makes
   # no restrictions on associating a node's CONTENT with multiple parent nodes.
   #
@@ -103,18 +104,22 @@ module Tree
   # myTreeRoot.each { |node| node.content.reverse }
   #
   # myTreeRoot.remove!(child1) # Remove the child
+  #
   class TreeNode
     include Enumerable
 
-    attr_reader :content, :name, :parent
-    attr_writer :content
+    # Name of this Node
+    attr_reader   :name
+    # Content of this Node
+    attr_accessor :content
+    # Parent of this Node
+    attr_reader   :parent
 
-    # Constructor which expects the name of the node
-    #
-    # Name of the node is expected to be unique across the
-    # tree.
+
+    # Constructor which expects the name of the node.
+    # Name of the node is expected to be unique across the tree.
     #
-    # The content can be of any type, and is defaulted to _nil_.
+    # The content can be of any type, defaults to +nil+.
     def initialize(name, content = nil)
       raise "Node name HAS to be provided" if name == nil
       @name = name
@@ -125,12 +130,13 @@ module Tree
       @children = []
     end
 
-    # Returns a copy of this node, with the parent and children links removed.
+    # Returns a copy of this node, with the parent and children links removed.  The original node remains attached to
+    # its tree.
     def detached_copy
       Tree::TreeNode.new(@name, @content ? @content.clone : nil)
     end
 
-    # Print the string representation of this node.
+    # Print the string representation of this node.  This is primary for debugging purposes.
     def to_s
       "Node Name: #{@name}" +
         " Content: " + (@content || "<Empty>") +
@@ -140,7 +146,7 @@ module Tree
     end
 
     # Returns an array of ancestors in reversed order (the first element is the
-    # immediate parent). Returns nil if this is a root node.
+    # immediate parent). Returns +nil+ if this is the root node.
     def parentage
       return nil if isRoot?
 
@@ -209,7 +215,7 @@ module Tree
       self
     end
 
-    # Indicates whether this node has any associated content.
+    # Returns +true+ if this node has any associated content.
     def hasContent?
       @content != nil
     end
@@ -219,19 +225,19 @@ module Tree
       @parent = nil
     end
 
-    # Indicates whether this node is a root node. Note that
+    # Returns +true+ if this is a root node. Note that
     # orphaned children will also be reported as root nodes.
     def isRoot?
       @parent == nil
     end
 
-    # Indicates whether this node has any immediate child nodes.
+    # Returns +true+ if this node has any immediate child nodes.
     def hasChildren?
       @children.length != 0
     end
 
-    # Indicates whether this node is a 'leaf' - i.e., one without
-    # any children
+    # Returns +true+ if this node is a 'leaf' - i.e., one without
+    # any children.
     def isLeaf?
       !hasChildren?
     end
@@ -272,7 +278,7 @@ module Tree
       each(&block)
     end
 
-    # Performs breadth first traversal of the tree rooted at this node. The
+    # Performs breadth first traversal of the tree starting at this node. The
     # traversal in a given level is from left to right.
     def breadth_each &block
       node_queue = [self]       # Create a queue with self as the initial entry
@@ -308,8 +314,11 @@ module Tree
       end
     end
 
-    # Returns the total number of nodes in this tree, rooted at the receiver
-    # node.
+    # Returns the total number of nodes in this tree, including this node.
+    #
+    # Size of the tree is defined as:
+    #
+    # Size:: The total number nodes in the subtree including this node.
     def size
       @children.inject(1) {|sum, node| sum + node.size}
     end
@@ -337,7 +346,7 @@ module Tree
       children { |child| child.printTree(level + 1)}
     end
 
-    # Returns the root for this tree. Root's root is itself.
+    # Returns the root for this tree. Root's root is itself (Hence beware of any loop that can become infinite!)
     def root
       root = self
       root = root.parent while !root.isRoot?
@@ -455,15 +464,42 @@ module Tree
       end
     end
 
-    # Returns depth of the tree from this node. A single leaf node has a
-    # depth of 1.
+    # Returns height of the (sub)tree from this node.  Height of a node is defined as:
+    #
+    # Height:: Length of the longest downward path to a leaf from the node.  Height of from the root node is height of
+    # the tree.  The height of a leaf node is zero.
+    def nodeHeight
+      return 0 if isLeaf?
+      1 + @children.collect { |child| child.nodeHeight }.max
+    end
+
+    # Returns depth this node in its (sub)tree.  Depth of a node is defined as:
+    #
+    # Depth:: Length of the node's path to its root.  Depth of a root node is zero.
+    #
+    # Note that the deprecated method Tree::TreeNode#depth was incorrectly computing this value.  Please replace all
+    # calls to the old method by this one.
+    def nodeDepth
+      return 0 if isRoot?
+      1 + parent.nodeDepth
+    end
+
+    # Returns depth of the tree from this node. A single leaf node has a depth of 1.
+    #
+    # This method is *DEPRECATED* and may be removed in the subsequent releases.  Note that per convention, the value
+    # returned by this method is actually the _height_ + 1 of the node, *not* the _depth_.
+    #
+    # For correct and conventional behavior, please use Tree::TreeNode#nodeDepth and Tree::TreeNode#nodeHeight methods
+    # instead.
     def depth
+      warn DeprecatedMethodWarning, 'This method is deprecated.  Please use nodeDepth or nodeHeight instead (bug # 22535)'
       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.
+    # Returns breadth of the tree at this node level. A single node has a breadth of 1.  Breadth is defined to be the
+    # number of nodes present as siblings to this node + 1 (this node itself), i.e., the number of children the parent
+    # of this node has.
     def breadth
       return 1 if isRoot?
       parent.children.size
@@ -473,75 +509,3 @@ module Tree
 
   end
 end
-
-# $Log: tree.rb,v $
-# Revision 1.31  2009/12/31 19:28:50  anupamsg
-# Migrated the rake build and install mechanism to use Hoe (http://seattlerb.rubyforge.org/hoe/Hoe.html) exclusively.
-# Have removed all legacy custom tasks (including the old GemSpec).  Have also made some formatting modifications to the
-# documentation.  The release itself does not contain any user visible changes from a functionality point of view.
-#
-# Revision 1.30  2009/10/05 18:27:10  anupamsg
-# Minor editing of the comment and an addition to the .cvsignore.
-#
-# Revision 1.29  2007/12/22 00:28:59  anupamsg
-# Added more test cases, and enabled ZenTest compatibility.
-#
-# Revision 1.28  2007/12/20 03:19:33  anupamsg
-# * README (Module): Modified the install instructions from source.
-# (Module): Updated the minor version number.
-#
-# Revision 1.27  2007/12/20 03:00:03  anupamsg
-# Minor code changes. Removed self_initialize from the protected methods' list.
-#
-# Revision 1.26  2007/12/20 02:50:04  anupamsg
-# (Tree::TreeNode): Removed the spurious self_initialize from the protected list.
-#
-# Revision 1.25  2007/12/19 20:28:05  anupamsg
-# Removed the unnecesary self_initialize method.
-#
-# Revision 1.24  2007/12/19 06:39:17  anupamsg
-# Removed the unnecessary field and record separator constants.  Also updated the
-# history.txt file.
-#
-# Revision 1.23  2007/12/19 06:25:00  anupamsg
-# (Tree::TreeNode): Minor fix to the comments.  Also fixed the private/protected
-# scope issue with the createDumpRep method.
-#
-# Revision 1.22  2007/12/19 06:22:03  anupamsg
-# Updated the marshalling logic to correctly handle non-string content. This
-# should fix the bug # 15614 ("When dumping with an Object as the content, you get
-# a delimiter collision")
-#
-# Revision 1.21  2007/12/19 02:24:17  anupamsg
-# Updated the marshalling logic to handle non-string contents on the nodes.
-#
-# Revision 1.20  2007/10/10 08:42:57  anupamsg
-# Release 0.4.3
-#
-# Revision 1.19  2007/08/31 01:16:27  anupamsg
-# Added breadth and pre-order traversals for the tree. Also added a method
-# to return the detached copy of a node from the tree.
-#
-# Revision 1.18  2007/07/21 05:14:44  anupamsg
-# Added a VERSION constant to the Tree module,
-# and using the same in the Rakefile.
-#
-# Revision 1.17  2007/07/21 03:24:25  anupamsg
-# Minor edits to parameter names. User visible functionality does not change.
-#
-# 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

@@ -1,7 +1,6 @@
 # binarytree.rb
 #
-# $Revision: 1.5 $ by $Author: anupamsg $
-# $Name:  $
+# $Revision: 160 $ by $Author: anupamsg $ on $Date: 2010-01-03 23:58:07 +0530 (Sun, 03 Jan 2010) $
 #
 # = binarytree.rb - Binary Tree implementation
 #
@@ -12,7 +11,7 @@
 # Author:: Anupam Sengupta (anupamsg@gmail.com)
 #
 
-# Copyright (c) 2007 Anupam Sengupta
+# Copyright (c) 2007, 2008, 2009, 2010 Anupam Sengupta
 #
 # All rights reserved.
 #
@@ -46,15 +45,14 @@ 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.
+  # 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 or right child, 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.
+    # 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
@@ -62,15 +60,13 @@ module Tree
       super(child)
     end
 
-    # Returns the left child node. Note that
-    # left Child == first Child
+    # 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.
-    # Returns nil if the right child does not exist.
+    # Returns the right child node. Note that right child == last child unless there is only one child.  Returns +nil+
+    # if the right child does not exist.
     def rightChild
       children[1]
     end
@@ -87,21 +83,19 @@ module Tree
       @childrenHash[child.name] = child if child # Assign the name mapping
     end
 
-    # Returns true if this is the left child of its parent. Always returns false
-    # if this is the root node.
+    # 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.
+    # 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
 
-    # Swaps the left and right children with each other
+    # Swaps the left and right child nodes with each other.
     def swap_children
       tempChild = leftChild
       self.leftChild= rightChild
@@ -110,22 +104,3 @@ module Tree
   end
 
 end
-
-# $Log: binarytree.rb,v $
-# Revision 1.5  2007/12/18 23:11:29  anupamsg
-# Minor documentation changes in the binarytree class.
-#
-# Revision 1.4  2007/08/30 22:08:58  anupamsg
-# Added a new swap_children method for Binary Tree. Also added minor
-# documentation and test updates.
-#
-# Revision 1.3  2007/07/21 03:24:25  anupamsg
-# Minor edits to parameter names. User visible functionality does not change.
-#
-# 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/test_binarytree.rb

@@ -2,10 +2,9 @@
 
 # test_binarytree.rb
 #
-# $Revision: 1.5 $ by $Author: anupamsg $
-# $Name:  $
+# $Revision: 146 $ by $Author: anupamsg $ on $Date: 2010-01-02 14:53:30 +0530 (Sat, 02 Jan 2010) $
 #
-# Copyright (c) 2006, 2007 Anupam Sengupta
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 Anupam Sengupta
 #
 # All rights reserved.
 #
@@ -170,35 +169,3 @@ module TestTree
     end
   end
 end
-
-# $Log: test_binarytree.rb,v $
-# Revision 1.5  2007/12/22 00:28:59  anupamsg
-# Added more test cases, and enabled ZenTest compatibility.
-#
-# Revision 1.4  2007/12/18 23:11:29  anupamsg
-# Minor documentation changes in the binarytree class.
-#
-# Revision 1.3  2007/10/02 03:07:30  anupamsg
-# * Rakefile: Added an optional task for rcov code coverage.
-#
-# * test/test_binarytree.rb: Removed the unnecessary dependency on "Person" class.
-#
-# * test/test_tree.rb: Removed dependency on the redundant "Person" class.
-#
-# Revision 1.2  2007/08/30 22:06:13  anupamsg
-# Added a new swap_children method for the Binary Tree class.
-# Also made minor documentation updates and test additions.
-#
-# Revision 1.1  2007/07/21 04:52:37  anupamsg
-# Renamed the test files.
-#
-# 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/test_tree.rb

@@ -2,10 +2,9 @@
 
 # testtree.rb
 #
-# $Revision: 1.6 $ by $Author: anupamsg $
-# $Name:  $
+# $Revision: 154 $ by $Author: anupamsg $ on $Date: 2010-01-03 23:31:28 +0530 (Sun, 03 Jan 2010) $
 #
-# Copyright (c) 2006, 2007 Anupam Sengupta
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 Anupam Sengupta
 #
 # All rights reserved.
 #
@@ -37,6 +36,7 @@
 
 require 'test/unit'
 require 'tree'
+require 'structured_warnings'
 
 module TestTree
   # Test class for the Tree node.
@@ -82,6 +82,7 @@ module TestTree
       @root = nil
     end
 
+    # This test is for the root alone - without any children being linked
     def test_root_setup
       assert_not_nil(@root, "Root cannot be nil")
       assert_nil(@root.parent, "Parent of root node should be nil")
@@ -92,17 +93,20 @@ module TestTree
       assert(!@root.hasChildren?, "Cannot have any children")
       assert(@root.hasContent?, "This root should have content")
       assert_equal(1, @root.size, "Number of nodes should be one")
-      assert_nil(@root.siblings, "Root cannot have any children")
+      assert_nil(@root.siblings, "This root does not have any children")
 
+      assert_equal(0, @root.nodeHeight, "Root's height before adding any children is 0")
       assert_raise(RuntimeError) { Tree::TreeNode.new(nil) }
     end
 
+    # This test is for the state after the children are linked to the root
     def test_root
       loadChildren
 
       assert_same(@root, @root.root, "Root's root is self")
       assert_same(@root, @child1.root, "Root should be ROOT")
       assert_same(@root, @child4.root, "Root should be ROOT")
+      assert_equal(2, @root.nodeHeight, "Root's height after adding the children should be 2")
     end
 
     def test_hasContent_eh
@@ -237,6 +241,7 @@ module TestTree
     def test_add
       assert(!@root.hasChildren?, "Should not have any children")
 
+      assert_equal(1, @root.size, "Should have 1 node (the root)")
       @root.add(@child1)
 
       @root << @child2
@@ -310,10 +315,15 @@ module TestTree
       loadChildren
 
       assert(@root.hasChildren?, "Should have children")
-      assert_equal(5, @root.size, "Should have four nodes")
+      assert_equal(5, @root.size, "Should have five nodes")
       assert(@child3.hasChildren?, "Should have children")
       assert(!@child3.isLeaf?, "Should not be a leaf")
 
+      assert_equal(1, @child3.nodeHeight, "The subtree at Child 3 should have a height of 1")
+      for child in [@child1, @child2, @child4]
+        assert_equal(0, child.nodeHeight, "The subtree at #{child.name} should have a height of 0")
+      end
+
       children = []
       for child in @root.children
         children << child
@@ -498,22 +508,62 @@ module TestTree
       assert_same(pers, @root.content, "Content should be the same")
     end
 
-    # Test the depth computation algorithm
+    # Test the depth computation algorithm.  Note that this is an incorrect computation and actually returns height+1
+    # instead of depth.  This method has been deprecated in this release and may be removed in the future.
     def test_depth
-      assert_equal(1, @root.depth, "A single node's depth is 1")
+      assert_warn(DeprecatedMethodWarning) do
+        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
+    end
+
+    # Test the height computation algorithm
+    def test_nodeHeight
+      assert_equal(0, @root.nodeHeight, "A single node's height is 0")
 
       @root << @child1
-      assert_equal(2, @root.depth, "This should be of depth 2")
+      assert_equal(1, @root.nodeHeight, "This should be of height 1")
+      assert_equal(0, @child1.nodeHeight, "This should be of height 0")
 
       @root << @child2
-      assert_equal(2, @root.depth, "This should be of depth 2")
+      assert_equal(1, @root.nodeHeight, "This should be of height 1")
+      assert_equal(0, @child2.nodeHeight, "This should be of height 0")
 
       @child2 << @child3
-      assert_equal(3, @root.depth, "This should be of depth 3")
-      assert_equal(2, @child2.depth, "This should be of depth 2")
+      assert_equal(2, @root.nodeHeight, "This should be of height 2")
+      assert_equal(1, @child2.nodeHeight, "This should be of height 1")
+      assert_equal(0, @child3.nodeHeight, "This should be of height 0")
 
       @child3 << @child4
-      assert_equal(4, @root.depth, "This should be of depth 4")
+      assert_equal(3, @root.nodeHeight, "This should be of height 3")
+      assert_equal(2, @child2.nodeHeight, "This should be of height 2")
+      assert_equal(1, @child3.nodeHeight, "This should be of height 1")
+      assert_equal(0, @child4.nodeHeight, "This should be of height 0")
+    end
+
+    # Test the depth computation algorithm.  Note that this is the correct depth computation.  The original
+    # Tree::TreeNode#depth was incorrectly computing the height of the node - instead of its depth.
+    def test_nodeDepth
+      assert_equal(0, @root.nodeDepth, "A root node's depth is 0")
+
+      loadChildren
+      for child in [@child1, @child2, @child3]
+        assert_equal(1, child.nodeDepth, "Node #{child.name} should have depth 1")
+      end
+
+      assert_equal(2, @child4.nodeDepth, "Child 4 should have depth 2")
     end
 
     # Test the breadth computation algorithm
@@ -679,40 +729,3 @@ module TestTree
 end
 
 __END__
-
-# $Log: test_tree.rb,v $
-# Revision 1.6  2007/12/22 00:28:59  anupamsg
-# Added more test cases, and enabled ZenTest compatibility.
-#
-# Revision 1.5  2007/12/19 02:24:18  anupamsg
-# Updated the marshalling logic to handle non-string contents on the nodes.
-#
-# Revision 1.4  2007/10/02 03:38:11  anupamsg
-# Removed dependency on the redundant "Person" class.
-# (TC_TreeTest::test_comparator): Added a new test for the spaceship operator.
-# (TC_TreeTest::test_hasContent): Added tests for hasContent? and length methods.
-#
-# Revision 1.3  2007/10/02 03:07:30  anupamsg
-# * Rakefile: Added an optional task for rcov code coverage.
-#
-# * test/test_binarytree.rb: Removed the unnecessary dependency on "Person" class.
-#
-# * test/test_tree.rb: Removed dependency on the redundant "Person" class.
-#
-# Revision 1.2  2007/08/31 01:16:28  anupamsg
-# Added breadth and pre-order traversals for the tree. Also added a method
-# to return the detached copy of a node from the tree.
-#
-# Revision 1.1  2007/07/21 04:52:38  anupamsg
-# Renamed the test files.
-#
-# 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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rubytree
 version: !ruby/object:Gem::Version 
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors: 
 - Anupam Sengupta
@@ -9,9 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-01 00:00:00 +05:30
+date: 2010-01-04 00:00:00 +05:30
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: structured_warnings
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.3
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -60,6 +70,7 @@ post_install_message:
 rdoc_options: 
 - --main
 - README
+- --line-numbers
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement