rubytree 0.8.3 → 0.9.0

data/Rakefile

@@ -2,12 +2,12 @@
 #
 # Rakefile - This file is part of the RubyTree package.
 #
-# Copyright (c) 2006, 2007, 2009, 2010, 2011, 2012  Anupam Sengupta
+# Copyright (c) 2006, 2007, 2009, 2010, 2011, 2012, 2013  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:
+# 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.
@@ -40,7 +40,7 @@ PKG_VER  = GEM_SPEC.version
 GEM_NAME = "#{PKG_NAME}-#{PKG_VER}.gem"
 
 desc "Default Task (Run the tests)"
-task :default => 'test:rcov'
+task :default => 'test:unit'
 
 desc "Display the current gem version"
 task :version do
@@ -50,7 +50,7 @@ end
 require 'rake/clean'
 task :clean => 'gem:clobber_package'
 CLEAN.include('coverage')
-task :clobber => [:clean, 'doc:clobber_rdoc', 'doc:clobber_yard', 'tag:clobber_tags']
+task :clobber => [:clean, 'doc:clobber_rdoc', 'doc:clobber_yard']
 
 desc "Open an irb session preloaded with this library"
 task :console do
@@ -58,20 +58,28 @@ task :console do
 end
 
 namespace :doc do               # ................................ Documentation
-
-  require 'rdoc/task'
-  Rake::RDocTask.new do |rdoc|
-    rdoc.rdoc_dir = 'rdoc'
-    rdoc.title    = "#{PKG_NAME}-#{PKG_VER}"
-    rdoc.main     = 'README.rdoc'
-    rdoc.rdoc_files.include(GEM_SPEC.extra_rdoc_files)
-    rdoc.rdoc_files.include('lib/**/*.rb')
+  begin
+    gem 'rdoc', ">= 2.4.2"      # To get around a stupid bug in Ruby 1.9.2 Rake.
+    require 'rdoc/task'
+    Rake::RDocTask.new do |rdoc|
+      rdoc.rdoc_dir = 'rdoc'
+      rdoc.title    = "#{PKG_NAME}-#{PKG_VER}"
+      rdoc.main     = 'README.rdoc'
+      rdoc.rdoc_files.include(GEM_SPEC.extra_rdoc_files)
+      rdoc.rdoc_files.include('lib/**/*.rb')
+    end
+  rescue LoadError
+    # Oh well.
   end
 
-  require 'yard'
-  YARD::Rake::YardocTask.new do |t|
-    t.files   = ['lib/**/*.rb', '-', GEM_SPEC.extra_rdoc_files]
-    t.options = ['--no-private', '--embed-mixins']
+  begin
+    require 'yard'
+    YARD::Rake::YardocTask.new do |t|
+      t.files   = ['lib/**/*.rb', '-', GEM_SPEC.extra_rdoc_files]
+      t.options = ['--no-private', '--embed-mixins']
+    end
+  rescue LoadError
+    # Oh well.
   end
 
   desc "Remove YARD Documentation"
@@ -92,22 +100,39 @@ namespace :test do              # ................................ Test related
     test.verbose = false
   end
 
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new(:rcov) do |t|
-    t.libs << "test"
-    t.test_files = FileList['test/**/test_*.rb']
-    t.verbose = true
-    t.rcov_opts << '--exclude /gems/,/Library/,/usr/,spec,lib/tasks'
+  desc "Run the examples"
+  Rake::TestTask.new(:examples) do |example|
+    example.libs << 'lib' << 'examples'
+    example.pattern = 'examples/**/example_*.rb'
+    example.verbose = true
+    example.warning = false
+  end
+
+  begin
+    require 'rcov/rcovtask'
+    Rcov::RcovTask.new(:rcov) do |t|
+      t.libs << "test"
+      t.test_files = FileList['test/**/test_*.rb']
+      t.verbose = true
+      t.rcov_opts << '--exclude /gems/,/Library/,/usr/,spec,lib/tasks'
+    end
+  rescue LoadError
+    # Oh well. Can't have everything.
   end
 
 end
 
-namespace :tag do               # ................................ Emacs Tags
-  require 'rtagstask'
-  RTagsTask.new(:tags) do |rd|
-    rd.vi = false
+ namespace :tag do               # ................................ Emacs Tags
+  begin
+    require 'rtagstask'
+    RTagsTask.new(:tags) do |rd|
+      rd.vi = false
+      CLEAN.include('TAGS')
+    end
+  rescue LoadError
+    # Oh well. Can't have everything.
   end
-end
+ end
 
 namespace :gem do               # ................................ Gem related
   require 'rubygems/package_task'

data/TAGS

@@ -0,0 +1,218 @@
+
+../.dir-locals.el,0
+
+../examples/example_basic.rb,0
+
+../lib/rubytree.rb,0
+
+../lib/tree/binarytree.rb,544
+module TreeTree
43,1900
+  class BinaryTreeNode < TreeNodeBinaryTreeNode
52,2207
+    def left_childleft_child
62,2488
+    def right_childright_child
74,2879
+    def is_left_child?is_left_child?
83,3155
+    def is_right_child?is_right_child?
93,3486
+    def add(child)add
110,4143
+    def inordered_each(&block)inordered_each
128,4662
+    def set_child_at(child, at_index)set_child_at
159,5598
+    def left_child=(child)left_child=
178,6266
+    def right_child=(child)right_child=
190,6635
+    def swap_childrenswap_children
195,6781
+
+../lib/tree/tree_deps.rb,0
+
+../lib/tree/utils/camel_case_method_handler.rb,271
+module Tree::UtilsTree
41,1848
+  module CamelCaseMethodHandlerCamelCaseMethodHandler
44,2002
+    def self.included(base)included
45,2034
+      def method_missing(meth, *args, &blk)method_missing
49,2180
+      def to_snake_case(camel_cased_word)to_snake_case
66,2792
+
+../lib/tree/utils/json_converter.rb,263
+module Tree::Utils::JSONConverterTree
42,1899
+  def self.included(base)included
44,1934
+  def as_json(options = {})as_json
61,2385
+  def to_json(*a)to_json
89,3093
+  module ClassMethodsClassMethods
94,3243
+    def json_create(json_hash)json_create
113,3956
+
+../lib/tree/utils/metrics_methods.rb,451
+module Tree::UtilsTree
41,1833
+  module TreeMetricsHandlerTreeMetricsHandler
43,1916
+    def self.included(base)included
44,1944
+      def sizesize
56,2311
+      def lengthlength
67,2655
+      def node_heightnode_height
80,3072
+      def node_depthnode_depth
96,3683
+      def levellevel
105,3869
+      def depthdepth
124,4554
+      def breadthbreadth
140,5191
+      def in_degreein_degree
154,5654
+      def out_degreeout_degree
165,5967
+
+../lib/tree/utils/tree_merge_handler.rb,259
+module Tree::Utils::TreeMergeHandlerTree
40,1769
+  def merge(other_tree)merge
57,2498
+  def merge!(other_tree)merge!
72,3132
+  def check_merge_prerequisites(other_tree)check_merge_prerequisites
85,3439
+  def merge_trees(tree1, tree2)merge_trees
102,4084
+
+../lib/tree/utils/utils.rb,32
+module Tree::UtilsTree
39,1838
+
+../lib/tree/version.rb,25
+module TreeTree
38,1717
+
+../lib/tree.rb,2022
+module TreeTree
53,2335
+  class TreeNodeTreeNode
90,3884
+    def rootroot
131,5161
+    def is_root?is_root?
142,5467
+    def has_content?has_content?
150,5650
+    def is_leaf?is_leaf?
161,5904
+    def parentageparentage
173,6279
+    def has_children?has_children?
191,6705
+    def initialize(name, content = nil)initialize
214,7531
+    def detached_copydetached_copy
232,8148
+    def detached_subtree_copydetached_subtree_copy
242,8434
+    def marshal_dumpmarshal_dump
256,8873
+    def create_dump_rep           # :nodoc:create_dump_rep
262,9041
+    def marshal_load(dumped_tree_array)marshal_load
277,9579
+    def to_sto_s
302,10363
+    def <<(child)<<
325,11134
+    def add(child, at_index = -1)add
360,12640
+    def insertion_rangeinsertion_range
379,13509
+    def remove!(child)remove!
401,14296
+    def parent=(parent)         # :nodoc:parent=
416,14699
+    def remove_from_parent!remove_from_parent!
429,15084
+    def remove_all!remove_all!
440,15456
+    def set_as_root!              # :nodoc:set_as_root!
451,15685
+    def freeze_tree!freeze_tree!
461,16011
+    def [](name_or_index, num_as_name=false)[]
501,17529
+    def each(&block)             # :yields: nodeeach
526,18496
+    def preordered_each(&block)  # :yields: nodepreordered_each
554,19456
+    def postordered_each(&block)postordered_each
566,19868
+    def breadth_each(&block)breadth_each
602,21294
+    def childrenchildren
628,22232
+    def each_leaf &blockeach_leaf
649,22853
+    def first_childfirst_child
666,23275
+    def last_childlast_child
674,23486
+    def first_siblingfirst_sibling
690,23933
+    def is_first_sibling?is_first_sibling?
700,24207
+    def last_siblinglast_sibling
714,24623
+    def is_last_sibling?is_last_sibling?
724,24893
+    def siblingssiblings
740,25446
+    def is_only_child?is_only_child?
759,25998
+    def next_siblingnext_sibling
772,26401
+    def previous_siblingprevious_sibling
788,26875
+    def <=>(other)<=>
804,27386
+    def print_tree(level = 0)print_tree
812,27615
+
+../test/test_binarytree.rb,798
+module TestTreeTestTree
39,1717
+  class TestBinaryTreeNode < Test::Unit::TestCaseTestBinaryTreeNode
41,1774
+    def setupsetup
44,1864
+    def teardownteardown
52,2167
+    def test_initializetest_initialize
59,2326
+    def test_addtest_add
67,2715
+    def test_inordered_eachtest_inordered_each
90,3629
+    def test_left_childtest_left_child
134,5097
+    def test_right_childtest_right_child
142,5410
+    def test_left_child_equalstest_left_child_equals
150,5723
+    def test_right_child_equalstest_right_child_equals
169,6713
+    def test_is_left_child_ehtest_is_left_child_eh
189,7830
+    def test_is_right_child_ehtest_is_right_child_eh
204,8369
+    def test_swap_childrentest_swap_children
218,8915
+    def test_old_camelCase_method_namestest_old_camelCase_method_names
236,9798
+
+../test/test_rubytree_require.rb,180
+module TestTreeTestTree
38,1678
+  class TestRequireRubytree < Test::Unit::TestCaseTestRequireRubytree
41,1757
+    def test_create_a_simple_nodetest_create_a_simple_node
44,1880
+
+../test/test_subclassed_node.rb,301
+module TestTreeTestTree
39,1688
+  class TestSubclassedTreeNode < Test::Unit::TestCaseTestSubclassedTreeNode
42,1739
+    class MyNode < Tree::TreeNodeMyNode
45,1864
+      def my_dummy_methodmy_dummy_method
47,1961
+    def test_subclassed_camelcase_methodstest_subclassed_camelcase_methods
52,2022
+
+../test/test_thread_and_fiber.rb,331
+module TestTreeTestTree
39,1695
+  class TestFiberAndThreadOnNode < Test::Unit::TestCaseTestFiberAndThreadOnNode
41,1745
+    def create_long_depth_trees(depth=100)create_long_depth_trees
44,1839
+    def test_fiber_for_recursiontest_fiber_for_recursion
59,2256
+    def test_thread_for_recursiontest_thread_for_recursion
73,2803
+
+../test/test_tree.rb,3873
+module TestTreeTestTree
39,1719
+  class TestTreeNode < Test::Unit::TestCaseTestTreeNode
41,1769
+    def setupsetup
65,2600
+    def setup_test_treesetup_test_tree
77,3020
+    def teardownteardown
84,3170
+    def test_has_version_numbertest_has_version_number
89,3262
+    def test_root_setuptest_root_setup
94,3413
+    def test_roottest_root
111,4463
+    def test_has_content_ehtest_has_content_eh
124,5013
+    def test_length_is_sizetest_length_is_size
135,5471
+    def test_spaceshiptest_spaceship
141,5661
+    def test_is_comparabletest_is_comparable
167,6444
+    def test_to_stest_to_s
185,7226
+    def test_first_siblingtest_first_sibling
218,8944
+    def test_is_first_sibling_ehtest_is_first_sibling_eh
231,9672
+    def test_is_last_sibling_ehtest_is_last_sibling_eh
242,10155
+    def test_last_siblingtest_last_sibling
253,10623
+    def test_siblingstest_siblings
265,11277
+    def test_is_only_child_ehtest_is_only_child_eh
293,12200
+    def test_next_siblingtest_next_sibling
304,12636
+    def test_previous_siblingtest_previous_sibling
315,13136
+    def test_addtest_add
326,13665
+    def test_add_at_specific_positiontest_add_at_specific_position
350,14474
+    def test_remove_bangtest_remove_bang
414,17527
+    def test_remove_all_bangtest_remove_all_bang
446,18490
+    def test_remove_from_parent_bangtest_remove_from_parent_bang
456,18796
+    def test_childrentest_children
475,19511
+    def test_first_childtest_first_child
511,21100
+    def test_last_childtest_last_child
520,21428
+    def test_findtest_find
529,21744
+    def test_parentagetest_parentage
544,22339
+    def test_eachtest_each
553,22671
+    def test_each_leaftest_each_leaf
572,23355
+    def test_parenttest_parent
599,24550
+    def test_indexed_accesstest_indexed_access
610,24969
+    def test_print_treetest_print_tree
621,25342
+    def test_marshal_dumptest_marshal_dump
628,25502
+    def test_collecttest_collect
673,27745
+    def test_freeze_tree_bangtest_freeze_tree_bang
683,28011
+    def test_contenttest_content
697,28533
+    def test_depthtest_depth
705,28924
+    def do_deprecated_depthdo_deprecated_depth
716,29297
+    def test_node_heighttest_node_height
734,29865
+    def test_node_depthtest_node_depth
759,31074
+    def test_leveltest_level
772,31511
+    def test_breadthtest_breadth
787,32054
+    def test_breadth_eachtest_breadth_each
806,32701
+    def test_preordered_eachtest_preordered_each
847,34007
+    def test_postordered_eachtest_postordered_each
886,35261
+    def test_detached_copytest_detached_copy
925,36516
+    def test_detached_subtree_copytest_detached_subtree_copy
942,37244
+    def test_has_children_ehtest_has_children_eh
976,39496
+    def test_is_leaf_ehtest_is_leaf_eh
982,39658
+    def test_is_root_ehtest_is_root_eh
989,39864
+    def test_content_equalstest_content_equals
995,40027
+    def test_sizetest_size
1003,40292
+    def test_lt2                # Test the << methodtest_lt2
1012,40556
+    def test_index              #  Test the [] methodtest_index
1023,41048
+    def test_in_degreetest_in_degree
1044,42144
+    def test_out_degreetest_out_degree
1055,42611
+    def test_json_serializationtest_json_serialization
1066,43098
+    def test_json_deserializationtest_json_deserialization
1090,43898
+    def test_json_roundtriptest_json_roundtrip
1118,45084
+    def test_old_camelCase_method_namestest_old_camelCase_method_names
1134,45825
+    def test_integer_node_namestest_integer_node_names
1165,46893
+    def test_add_node_to_self_as_childtest_add_node_to_self_as_child
1196,48123
+    def test_single_node_becomes_leaftest_single_node_becomes_leaf
1208,48548
+    def test_unique_node_namestest_unique_node_names
1219,48895
+    def setup_other_test_treesetup_other_test_tree
1227,49139
+    def test_mergetest_merge
1255,50128
+    def test_merge_bangtest_merge_bang
1284,51566

data/TODO.org

@@ -1,5 +1,8 @@
 # -*- mode: org; coding: utf-8-unix; fill-column: 120; -*-
 #+OPTIONS: ^:{}
+#+TODO: TODO(t) STARTED(s) | DONE(d) CANCELED(c)
+#+LINK: Issue https://github.com/evolve75/RubyTree/issues/%s
+#+LINK: Pull https://github.com/evolve75/RubyTree/pull/%s
 
 * R0.7.0                                                                                  :ARCHIVE:
 *** DONE Start using signed tags from R0.7.0                                              :ARCHIVE:
@@ -17,8 +20,6 @@
     CLOSED: [2010-01-30 Sat 23:56]
 
 
-
-
 * R0.8.0                                                                                  :ARCHIVE:
 *** DONE Convert all method names to the canonical /^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/ pattern :ARCHIVE:
     See Roodi report at http://getcaliper.com/caliper/tool?tool=roodi&repo=git://github.com/evolve75/RubyTree.git
@@ -30,44 +31,10 @@
 *** DONE Fix [[http://rubyforge.org/tracker/index.php?func%3Ddetail&aid%3D28613&group_id%3D1215&atid%3D4793][bug #28613]] which was affecting the `leftChild=' and `rightChild=' methods for binary trees. :ARCHIVE:
 
 
-
-* R0.8.3
+* R0.8.3                                                                                  :ARCHIVE:
 
   This is a bugfix release.
 
-*** TODO [#A] Resolve the infinite loop bug if a node is added to itself as a child       :Partial:
-    Issue https://github.com/evolve75/RubyTree/issues/5
-
-    This is a subtle problem to resolve.  The specific case of a node
-    being added to itself is trivial to resolve, and the fix has been
-    put in for 0.8.3.
-
-    However, the general problem is that in the current code, a node
-    can be added as a child to any portion of the tree down the
-    hierarchy (e.g., as a grandchild), which will need a more thorough
-    detection code in the ~TreeNode#add~ method, if it is to be done at
-    runtime.
-
-    The issue is really to prevent the tree becoming a graph.  Note
-    that the issue is with duplicate nodes, /not/ duplicated content.
-
-    A few options exist:
-    1. Perform a runtime check in the ~TreeNode#add~ method.  This will
-       cause a performance hit as the tree becomes larger.
-    2. Allow the additions to go through, but create a new ~validate~
-       method that checks for such cycles.
-    3. Create separate configuration object which can be attached to
-       the root of the tree, which allows per-tree configuration of
-       the behavior - this does allow for the user to take control,
-       but also introduces complications during tree mergers and
-       spitting subtrees.
-    4. Create a registry (to be maintained at the root?) of all nodes,
-       and use this for validating the node additions (and preventing
-       duplicates).  This needs to be a hash (to allow O(1) access),
-       and will sacrifice memory.  There might be a need to
-       restructure the internals to make better use of memory.
-
-
 *** DONE Make Rubytree compatible with Bundler                                            :ARCHIVE:
     CLOSED: [2012-08-21 Tue 21:04]
 
@@ -149,15 +116,120 @@
     Left the code as-is, since we need some way to un-ambiguously find the root, regardless of the node given.
 
 
+
 * R0.9.0
-*** TODO Fix the inconsistency of returning root as its first sibling, and returning a nil instead.  Ditto for last sibling.
-*** TODO fix the inconsistency of returning nil for the root, and an empty array for nodes which have no siblings.
-*** TODO We should perhaps return nil as root's root.
-*** TODO The semantic of length is probably unclear.  Should return the node_depth instead (or remove the method)
-    The current equivalence of length to size should also be removed.
+  DEADLINE: <2013-02-24 Sun>
+
+  This release contains the following features and fixes:
+
+  1. Ability to merge in another tree at a chosen node
+  2. Support for the [[http://ruby-doc.org/core-1.8.7/Comparable.html][Comparable]] mixin module
+  3. Ability to export the tree to a hash, and create a new tree from
+     another existing hash
+  4. Fix (partial) for preventing cyclic graphs in the tree
+  5. Refactored =each= method to prevent stack errors while navigating
+     deep trees
+  6. Check to ensure that the added node's name is unique to the destination tree
+  7. Fix for the issue where tree traversal would fail if the binary-tree's left child was nil
+  8. Fixed the return type for the iterator methods (each, postordered_each, breadth_each, etc.). They now return an
+     Enumerator if *no* block is provided, or else return the receiver node itself, if a block *was* provided. This is
+     consistent with how Ruby's standard collections work
+  9. Structural changes in the code to refactor out the non-core functions into modules
+  10. Massive documentation updates
+  11. Addition of the examples directory (only a bare-bones placeholder for now, with the basic example code)
+  12. Ability to run the examples from the Rakefile
+  13. Various bundler and travis-ci related changes
+
+
+*** DONE Fix the stack exhaustion issue due to deep recursion on very large unbalanced trees :ARCHIVE:
+    CLOSED: [2013-12-28 Sat 10:59]
+    See [[Issue:12][Issue #12.]]  The following methods need fixes:
+    - [X] [[file:lib/tree.rb::def%20each(][each]]
+    - [X] [[file:lib/tree.rb::def%20postordered_each][postordered_each]]
+
+*** DONE Extract non-essential methods from Tree::TreeNode into separate files.           :ARCHIVE:
+    CLOSED: [2013-12-31 Tue 21:55]
+    - [X] Handling of CamelCase methods
+    - [X] Convertion to and from [[http://flori.github.com/json/][JSON]]
+    - [X] The merge feature
+    - [X] The metrics measurements
+
+*** DONE Fix the documentation strings for the methods (the Yard attributes)              :ARCHIVE:
+    CLOSED: [2013-12-31 Tue 21:55] DEADLINE: <2013-12-28 Sat>
+
+*** DONE Implement an `inordered_each` method for the [[file:lib/tree/b][BinaryTree]]                          :ARCHIVE:
+    CLOSED: [2013-12-28 Sat 16:32] DEADLINE: <2013-12-28 Sat>
+*** DONE Add some example code to the Gem                                                 :ARCHIVE:
+    CLOSED: [2013-12-28 Sat 12:12]
+*** DONE Pull in the unique node name validation from [[Pull:9][ysf]]                                 :ARCHIVE:
+    CLOSED: [2013-02-21 Thu 20:29]
+    Will need to make this configurable.
+
+*** DONE Pull in the tree merge feature from [[Pull:9][Dazoakley]]                                    :ARCHIVE:
+    CLOSED: [2013-02-21 Thu 20:26]
+
+*** DONE Rename the [[file:COPYING.rdoc][COPYING.rdoc]] file to LICENSING.rdoc                                   :ARCHIVE:
+    CLOSED: [2012-08-25 Sat 21:19]
+
+*** CANCELED Fix the inconsistency of returning root as its first sibling, and returning a nil instead.  Ditto for last sibling. :ARCHIVE:
+    CLOSED: [2012-08-25 Sat 20:49]
+    This is actually consistent.
+*** CANCELED fix the inconsistency of returning nil for the root, and an empty array for nodes which have no siblings. :ARCHIVE:
+    CLOSED: [2012-08-25 Sat 20:51]
+    Already fixed in [[R0.8.3]].
+
+*** CANCELED We should perhaps return nil as root's root. (Scrapped).                     :ARCHIVE:
+    CLOSED: [2012-08-25 Sat 20:35]
+    This proposed change does make sense at one level (since the root node does not have any parent), but returning root
+    as root's root (no pun intended) makes accessing the root from anywhere in the tree much easier.
+
+
+* Next Release
+** STARTED [#A] Resolve the infinite loop bug if a node is added to itself as a child     :Partial:
+   [[Issue:5][Issue #5.]]
+
+   This is a subtle problem to resolve.  The specific case of a node
+   being added to itself is trivial to resolve, and the fix has been
+   put in for 0.8.3.
+
+   However, the general problem is that in the current code, a node
+   can be added as a child to any portion of the tree down the
+   hierarchy (e.g., as a grandchild), which will need a more thorough
+   detection code in the ~TreeNode#add~ method, if it is to be done at
+   runtime.
+
+   The issue is really to prevent the tree becoming a graph.  Note
+   that the issue is with duplicate nodes, /not/ duplicated content.
+
+   A few options exist:
+   1. Perform a runtime check in the ~TreeNode#add~ method.  This will
+      cause a performance hit as the tree becomes larger.
+   2. Allow the additions to go through, but create a new ~validate~
+      method that checks for such cycles.
+   3. Create separate configuration object which can be attached to
+      the root of the tree, which allows per-tree configuration of
+      the behavior - this does allow for the user to take control,
+      but also introduces complications during tree mergers and
+      spitting subtrees.
+   4. Create a registry (to be maintained at the root?) of all nodes,
+      and use this for validating the node additions (and preventing
+      duplicates).  This needs to be a hash (to allow O(1) access),
+      and will sacrifice memory.  There might be a need to
+      restructure the internals to make better use of memory.
+** TODO Expand the examples section, and add supporting documentation
+** TODO Pull the =hash= converter code from [[https://github.com/markthomas/RubyTree/commits/master][Mark Thomas]] ([[Issue:13][Issue #13]]).
+
+
 
 
 * Unplanned / Not assigned to any release
+*** TODO Create a cycle-detection/validation mechanism to prevent cyclic graphs of nodes.
+*** TODO Revert the forced install of rubygem 2.1.11 from [[file:.travis.yml][.travis.yml]]
+*** TODO Create a generic validation method to check for various issues in the created tree.
+*** TODO Add a FAQ document to the project.
+*** TODO The semantic of length is probably unclear.  Should return the node_depth instead (or remove the method)
+    The current equivalence of length to size should also be removed.
+
 *** TODO Create the basic UML diagrams and upload to the Site
     DEADLINE: <2010-01-04 Mon>