rubytree 0.4.2 → 0.5.0

data/ChangeLog

@@ -1,3 +1,38 @@
+2007-12-19  Anupam Sengupta  <anupamsg@gmail.com>
+
+	* Rakefile: Fixed a problem with reading the Tree::VERSION for the
+	gem packaging, if any prior version of the gem is already installed.
+
+2007-12-18  Anupam Sengupta  <anupamsg@gmail.com>
+
+	* lib/tree.rb: Updated the marshalling logic to correctly handle
+	non-string content.
+	(Tree::TreeNode::createDumpRep): Minor code change to use symbols
+	instead of string key names.
+	(Tree): Version number change to 0.5.0
+	(Tree::TreeNode::hasContent): Minor fix to the comments.
+
+	* test/test_tree.rb (TC_TreeTest::test_breadth_each): Updated test
+	cases for the marshalling logic.
+
+2007-11-12  Anupam Sengupta  <anupamsg@gmail.com>
+
+	* test/test_binarytree.rb: Minor documentation correction.
+
+	* lib/tree/binarytree.rb (Tree::BinaryTreeNode::isRightChild):
+	Minor documentation change.
+
+2007-10-10  Anupam Sengupta  <anupamsg@gmail.com>
+
+	* README: Restructured the format.
+
+	* Rakefile: Added Hoe related logic. If not present, the Rakefile
+	will default to old behavior.
+
+2007-10-09  Anupam Sengupta  <anupamsg@gmail.com>
+
+	* Rakefile: Added setup.rb related tasks. Also added the setup.rb in the PKG_FILES list.
+
 2007-10-01  Anupam Sengupta  <anupamsg@gmail.com>
 
 	* Rakefile: Added an optional task for rcov code coverage.

data/History.txt

@@ -0,0 +1,11 @@
+= 0.5.0 / 2007-12-18
+
+* Fixed the marshalling code to correctly handle non-string content.
+
+= 0.4.3 / 2007-10-09
+
+* Changes to the build mechanism (now uses Hoe).
+
+= 0.4.2 / 2007-10-01
+
+* Minor code refactoring. Changes in the Rakefile.

data/Manifest.txt

@@ -0,0 +1,12 @@
+COPYING
+ChangeLog
+History.txt
+Manifest.txt
+README
+TODO
+Rakefile
+lib/tree.rb
+lib/tree/binarytree.rb
+setup.rb
+test/test_binarytree.rb
+test/test_tree.rb

data/README

@@ -1,27 +1,18 @@
-= Rubytree 0.4.2
+= Rubytree
 
-(c) 2006, 2007 Anupam Sengupta
+  (c) 2006, 2007 Anupam Sengupta
   http://rubytree.rubyforge.org
 
-  Document Revision: $Revision: 1.11 $ by $Author: anupamsg $
-
-== License
-
-Rubytree has been released under the BSD License. See the file COPYING for
-details.
-
-== Introduction
+== DESCRIPTION:
 
 Rubytree is a simple implementation of the generic Tree data structure.  This
 implementation is node-centric, where the individual nodes on the tree are the
 primary objects and drive the structure.
 
-== Getting Rubytree
+== INSTALL:
 
 Rubytree is an open source project and is hosted at
-http://rubyforge.org/projects/rubytree
-
-The project home page is http://rubytree.rubyforge.org
+http://rubytree.rubyforge.org
 
 Rubytree can be downloaded as a Rubygem or as a tar/zip file from:
 
@@ -35,8 +26,6 @@ The file name is one of:
 
 Download the appropriate file-type.
 
-== Installing Rubytree
-
 It is recommended to install Rubytree as a Ruby Gem, as this is an easy way to
 keep the version updated, and keep multiple versions of the library available on
 your system.
@@ -54,7 +43,7 @@ super-user (root) to successfully install the gem.
 Extract the archive file (tgz or zip) and run the 'rake' command from the
 top-level source directory.
 
-== Documentation
+== DOCUMENTATION:
 
 The primary class for this implementation is Tree::TreeNode. See the
 class documentation for an usage example.
@@ -68,7 +57,7 @@ Documentation on the web is available at:
 
 http://rubytree.rubyforge.org/rdoc
 
-== Example
+== EXAMPLE:
 
 The following code-snippet implements this tree structure:
 
@@ -110,7 +99,7 @@ The following code-snippet implements this tree structure:
 
  myTreeRoot.remove!(child1) # Remove the child
 
-== LICENSE
+== LICENSE:
 
 Rubytree is licensed under BSD license.
 
@@ -142,3 +131,6 @@ 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.
+
+
+(Document Revision: $Revision: 1.12 $ by $Author: anupamsg $)

data/Rakefile

@@ -1,6 +1,6 @@
 # Rakefile
 #
-# $Revision: 1.23 $ by $Author: anupamsg $
+# $Revision: 1.27 $ by $Author: anupamsg $
 # $Name:  $
 #
 # Copyright (c) 2006, 2007 Anupam Sengupta
@@ -34,64 +34,123 @@
 #
 
 require 'rubygems'
-require 'rake/clean'
 require 'rake/gempackagetask'
+
+require 'rake/clean'
+require 'rake/packagetask'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
-require './lib/tree.rb'         # To read the version information.
+require 'fileutils'
 
-desc "Default Task"
-task :default => :gem
+# General Stuff ####################################################
 
-PKG_VERSION = Tree::VERSION
+$:.insert 0, File.expand_path( File.join( File.dirname(__FILE__), 'lib' ) )
+require 'tree'         # To read the version information.
+
+PKG_NAME        = "rubytree"
+PKG_VERSION     = Tree::VERSION
+PKG_FULLNAME    = PKG_NAME + "-" + PKG_VERSION
+PKG_SUMMARY     = "Ruby implementation of the Tree data structure."
+PKG_DESCRIPTION = <<-END
+    Provides a generic tree data-structure with ability to
+    store keyed node-elements in the tree. The implementation
+    mixes in the Enumerable module.
+
+    Website:  http://rubytree.rubyforge.org/
+    END
 
 PKG_FILES = FileList[
                      '[A-Z]*',
+                     '*.rb',
                      'lib/**/*.rb',
                      'test/**/*.rb'
                     ]
 
-spec = Gem::Specification.new do |s|
-  s.name = "rubytree"
-  s.version = PKG_VERSION
-  s.platform = Gem::Platform::RUBY
-  s.author = "Anupam Sengupta"
-  s.email = "anupamsg@gmail.com"
-  s.homepage = "http://rubytree.rubyforge.org/"
-  s.rubyforge_project = 'rubytree'
-  s.summary = "Ruby implementation of the Tree data structure."
-  s.add_dependency('rake', '>= 0.7.2')
-
-  s.description = <<-END
-    Provides a generic tree data-structure with ability to
-    store keyed node-elements in the tree. The implementation
-    mixes in the Enumerable module.
+# Default is to create a rubygem.
+desc "Default Task"
+task :default => :gem
 
-    Website:  http://rubytree.rubyforge.org/
-    END
+begin                           # Try loading hoe
+  require 'hoe'
+  # If Hoe is found, use it to define tasks
+  # =======================================
+  Hoe.new(PKG_NAME, PKG_VERSION) do |p|
+    p.rubyforge_name = PKG_NAME
+    p.author = "Anupam Sengupta"
+    p.email = "anupamsg@gmail.com"
+    p.summary = PKG_SUMMARY
+    p.description = PKG_DESCRIPTION
+    p.url = "http://rubytree.rubyforge.org/"
+    p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+    p.remote_rdoc_dir = 'rdoc'
+    p.need_tar = true
+    p.need_zip = true
+    p.test_globs = ['test/test_*.rb']
+    p.spec_extras = {
+      :has_rdoc => true,
+      :platform => Gem::Platform::RUBY,
+      :has_rdoc => true,
+      :extra_rdoc_files => ['README', 'COPYING', 'ChangeLog', 'History.txt'],
+      :rdoc_options => ['--main', 'README'],
+      :autorequire => 'tree'
+    }
+  end
 
-  s.has_rdoc = true
-  s.extra_rdoc_files = ['README', 'COPYING', 'ChangeLog']
-  s.autorequire = "tree"
-  s.files = PKG_FILES.to_a
-  s.test_files = Dir.glob('test/test*.rb')
-end
+rescue LoadError                # If Hoe is not found
+  # If Hoe is not found, then use the usual Gemspec based Rake tasks
+  # ================================================================
+  spec = Gem::Specification.new do |s|
+    s.name = PKG_NAME
+    s.version = PKG_VERSION
+    s.platform = Gem::Platform::RUBY
+    s.author = "Anupam Sengupta"
+    s.email = "anupamsg@gmail.com"
+    s.homepage = "http://rubytree.rubyforge.org/"
+    s.rubyforge_project = 'rubytree'
+    s.summary = PKG_SUMMARY
+    s.add_dependency('rake', '>= 0.7.2')
+    s.description = PKG_DESCRIPTION
+    s.has_rdoc = true
+    s.extra_rdoc_files = ['README', 'COPYING', 'ChangeLog']
+    s.autorequire = "tree"
+    s.files = PKG_FILES.to_a
+    s.test_files = Dir.glob('test/test*.rb')
+  end
 
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_zip = true
-  pkg.need_tar = true
-end
+  desc "Prepares for installation"
+  task :prepare do
+    ruby "setup.rb config"
+    ruby "setup.rb setup"
+  end
 
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/test*.rb']
-  t.verbose = true
-end
+  desc "Installs the package #{PKG_NAME}"
+  task :install => [:prepare] do
+    ruby "setup.rb install"
+  end
+
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar = true
+  end
+
+  Rake::TestTask.new do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/test*.rb']
+    t.verbose = true
+  end
+
+end                            # End loading Hoerc
+# ================================================================
+
+
+# The following tasks are loaded independently of Hoe
 
-Rake::RDocTask.new(:rdoc) do |rd|
+# Hoe's rdoc task is ugly.
+Rake::RDocTask.new(:docs) do |rd|
   rd.rdoc_files.include("README", "COPYING", "ChangeLog", "lib/**/*.rb")
-  rd.title = "Rubytree Documentation"
+  rd.rdoc_dir = 'doc'
+  rd.title = "#{PKG_FULLNAME} Documentation"
 
   # Use the template only if it is present, otherwise, the standard template is
   # used.
@@ -108,7 +167,7 @@ begin
   RTagsTask.new do |rd|
     rd.vi = false
   end
-  rescue LoadError
+rescue LoadError
 end
 
 # Optional RCOV Task
@@ -117,9 +176,9 @@ begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |t|
     t.test_files = FileList['test/test*.rb']
-   # t.verbose = true     # uncomment to see the executed commands
+    # t.verbose = true     # uncomment to see the executed commands
   end
-  rescue LoadError
+rescue LoadError
 end
 
 #Rakefile,v $

data/TODO

@@ -0,0 +1 @@
+* Add logic in Rakefile to read the file list from Manifest.txt

data/lib/tree.rb

@@ -1,6 +1,6 @@
 # tree.rb
 #
-# $Revision: 1.19 $ by $Author: anupamsg $
+# $Revision: 1.24 $ by $Author: anupamsg $
 # $Name:  $
 #
 # = tree.rb - Generic Multi-way Tree implementation
@@ -47,7 +47,7 @@
 # This module mixes in the Enumerable module.
 module Tree
 
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 
   # == TreeNode Class Description
   #
@@ -108,9 +108,6 @@ module Tree
     attr_reader :content, :name, :parent
     attr_writer :content
 
-    @@fieldSep = '|'
-    @@recordSep = "\n"
-
     # Constructor which expects the name of the node
     #
     # Name of the node is expected to be unique across the
@@ -118,12 +115,14 @@ module Tree
     #
     # The content can be of any type, and is defaulted to _nil_.
     def initialize(name, content = nil)
-
       raise "Node name HAS to be provided" if name == nil
+      self_initialize name, content
+    end
 
+    # A common initialization routine (also used by the marshalling code).
+    def self_initialize(name, content)
       @name = name
       @content = content
-
       self.setAsRoot!
 
       @childrenHash = Hash.new
@@ -221,7 +220,7 @@ module Tree
       @content != nil
     end
 
-    # Private method which sets this node as a root node.
+    # Protected method which sets this node as a root node.
     def setAsRoot!
       @parent = nil
     end
@@ -276,7 +275,7 @@ module Tree
     # Traverses the tree in a pre-ordered sequence. This is equivalent to
     # TreeNode#each
     def preordered_each &block
-      each &block
+      each(&block)
     end
 
     # Performs breadth first traversal of the tree rooted at this node. The
@@ -431,40 +430,35 @@ module Tree
       each {|node| node.freeze}
     end
 
-    # Creates a dump representation and returns the same as a string
+    # Creates the marshal-dump represention of the tree rooted at this node.
+    def marshal_dump
+      self.collect { |node| node.createDumpRep }
+    end
+
+    # Creates a dump representation and returns the same as a hash
     def createDumpRep
-      strRep = String.new
-      strRep << @name << @@fieldSep << (isRoot? ? @name : @parent.name)
-      strRep << @@fieldSep << Marshal.dump(@content) << @@recordSep
-    end
-
-    def _dump(depth)
-      strRep = String.new
-      each {|node| strRep << node.createDumpRep}
-      strRep
-    end
-
-    # Loads a dump representation of the tree from the specified string
-    def TreeNode.loadDumpRep(str)
-      nodeHash = Hash.new
-      rootNode = nil
-      str.split(@@recordSep).each do |line|
-        name, parent, contentStr = line.split(@@fieldSep)
-        content = Marshal.load(contentStr)
-        currentNode = Tree::TreeNode.new(name, content)
-        nodeHash[name] = currentNode
-        if name != parent  # Do for a child node
-          nodeHash[parent].add(currentNode)
-        else
-          rootNode = currentNode
-        end
-      end
-      rootNode
+      { :name => @name, :parent => (isRoot? ? nil : @parent.name),  :content => Marshal.dump(@content)}
     end
 
-    # Loads a dump representation of the tree from the specified string.
-    def TreeNode._load(str)
-      loadDumpRep(str)
+    # Loads a marshalled dump of the tree and returns the root node of the
+    # reconstructed tree. See the Marshal class for additional details.
+    def marshal_load(dumped_tree_array)
+      nodes = { }
+      for node_hash in dumped_tree_array do
+        name        = node_hash[:name]
+        parent_name = node_hash[:parent]
+        content     = Marshal.load(node_hash[:content])
+
+        if parent_name then
+          nodes[name] = current_node = Tree::TreeNode.new(name, content)
+          nodes[parent_name].add current_node
+        else
+          # This is the root node, hence initialize self.
+          self_initialize(name, content)
+
+          nodes[name] = self    # Add self to the
+         end
+      end
     end
 
     # Returns depth of the tree from this node. A single leaf node has a
@@ -481,13 +475,31 @@ module Tree
       parent.children.size
     end
 
-    protected :parent=, :setAsRoot!
-    private_class_method :loadDumpRep
+    protected :parent=, :setAsRoot!, :self_initialize, :createDumpRep
 
   end
 end
 
 # $Log: tree.rb,v $
+# 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.