RubyTree¶ ↑

DESCRIPTION:¶ ↑

RubyTree is a Ruby implementation of the generic tree data structure. It provides a node-based model to store keyed node-elements in the tree and provides simple APIs to access, modify and traverse the structure.

RubyTree is node-centric, where individual nodes in the tree are the primary structural elements.

RubyTree mixes in the Enumerable module to allow access to the tree as a standard collection.

RubyTree is an open source project and is hosted at:

rubytree.rubyforge.org and also at github.com/evolve75/RubyTree.

The library is available as a standard gem at rubygems.org/gems/rubytree.

EXAMPLE:¶ ↑

The following example code implements this tree structure:

                +------------+
                |    ROOT    |
                +-----+------+
        +-------------+------------+
        |                          |
+-------+-------+          +-------+-------+
|  CHILD 1      |          |  CHILD 2      |
+-------+-------+          +---------------+
        |
        |
+-------+-------+
| GRANDCHILD 1  |
+---------------+

# ..... Example starts.
require 'tree'                 # Load the library

# ..... Create the root node first.  Note that every node has a name and an optional content payload.
root_node = Tree::TreeNode.new("ROOT", "Root Content")

# ..... Now insert the child nodes.  Note that you can "chain" the child insertions for a given path to any depth.
root_node << Tree::TreeNode.new("CHILD1", "Child1 Content") << Tree::TreeNode.new("GRANDCHILD1", "GrandChild1 Content")
root_node << Tree::TreeNode.new("CHILD2", "Child2 Content")

# ..... Lets print the representation to stdout.  This is primarily used for debugging purposes.
root_node.print_tree

# ..... Lets directly access children and grandchildren of the root.  The can be "chained" for a given path to any depth.
child1 = root_node["CHILD1"]
grand_child1 = root_node["CHILD1"]["GRANDCHILD1"]

# ..... Lets retrieve siblings of the current node as an array.
siblings_of_child1 = child1.siblings

# ..... Lets retrieve immediate children of the root node as an array.
children_of_root = root_node.children

# ..... This is a depth-first and L-to-R pre-ordered traversal.
root_node.each { |node| node.content.reverse }

# ..... Lets remove a child node from the root node.
root_node.remove!(child1)

REQUIREMENTS:¶ ↑

Ruby 1.8.x or 1.9.x
Run-time Dependencies:
- structured_warnings
- JSON for converting to/from the JSON format
Development dependencies (not required for installing the gem):
- Rake for building the package
- Yard for the documentation

INSTALL:¶ ↑

To install the gem, run this command from a terminal/shell:

$ gem install rubytree

This should install the gem file for RubyTree. Note that you might need to have super-user privileges (root/sudo) to successfully install the gem.

Installing from the tgz/zip file¶ ↑

RubyTree also be downloaded as a tar/zip file (or as a gem) from:

rubyforge.org/frs/?group_id=1215&release_id=8817

The file-name is one of:

rubytree-<VERSION>.gem - The rubygem
rubytree-<VERSION>.tgz - GZipped source files
rubytree-<VERSION>.zip - Zipped  source files

Download the appropriate file-type for your system.

Extract the archive file (tgz or zip) and run the following command from the top-level source directory:

$ ruby ./setup.rb

You may need administrator/super-user privileges to complete the setup using this method. Note that the source code contains the Rakefile for building using Rake, which might an easier mechanism for building and installing the gem.

DOCUMENTATION:¶ ↑

The primary class for this implementation is {Tree::TreeNode}. See the class documentation for an example of using the library.

If the ri documentation was generated during install, you can use this command at the terminal to view the text mode ri documentation:

$ ri Tree::TreeNode

Documentation for the latest released version is available at:

rubytree.rubyforge.org/rdoc

Documentation for the latest git HEAD is available at:

rdoc.info/projects/evolve75/RubyTree

Note that the documentation is formatted for YARD.

DEVELOPERS:¶ ↑

This section is only for modifying RubyTree itself. It is not required for
using the library!

You can download the latest released source code using the tar or zip version as mentioned above in the installation section.

Alternatively, you can checkout the latest commit/revision from the version control system. Note that RubyTree’s primary SCM is git and is available on github.

Using the git Repository¶ ↑

For cloning the git repository, use one of the following commands:

$ git clone git://github.com/evolve75/RubyTree.git

$ git clone http://github.com/evolve75/RubyTree.git

The git repository is available on the web at: github.com/evolve75/RubyTree

Setting up the Development Environment¶ ↑

RubyTree uses Bundler to manage its dependencies. This allows for a simplified dependency management, for both run-time as well as during build.

After checking out the source, run:

$ gem install bundler
$ bundle install
$ rake test
$ rake doc:yard
$ rake gem:package

These steps will install any missing dependencies, run the tests/specs, generate the documentation, and finally generate the gem file.

Note that the documentation uses YARD, which will be downloaded and installed automatically by Bundler.

ACKNOWLEDGMENTS:¶ ↑

A big thanks to the following contributors for helping improve RubyTree:

Dirk Breuer for contributing the JSON conversion code.
Vincenzo Farruggia for contributing the (sub)tree cloning code.
Eric Cline for the Rails JSON encoding fix.

LICENSE:¶ ↑

RubyTree is released under the BSD license.

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.

  __       _           _
  /__\_   _| |__  _   _| |_ _ __ ___  ___
 / \// | | | '_ \| | | | __| '__/ _ \/ _ \
/ _  \ |_| | |_) | |_| | |_| | |  __/  __/
\/ \_/\__,_|_.__/ \__, |\__|_|  \___|\___|
                 |___/

# Local Variables: # mode: rdoc # coding: utf-8-unix # End:

markthomas/RubyTree