redwood 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+coverage
+rdoc
+pkg
+doc
+.bundle

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+group :test do
+	gem 'contest'
+end
+
+group :development do
+	gem 'rake'
+	gem 'jeweler'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Mark Wunsch
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,17 @@
+= redwood
+
+Not quite baked yet.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Mark Wunsch. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require "rubygems"
+require "bundler"
+Bundler.setup(:development)
+
+require 'rake'
+
+begin
+  require 'jeweler'
+  $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+  require "redwood"
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "redwood"
+    gemspec.summary = "Ruby trees"
+    gemspec.description = "A simple library to create and manage basic tree-esque structures."
+    gemspec.version = Redwood::VERSION
+    gemspec.homepage = "http://github.com/mwunsch/redwood"
+    gemspec.authors = ["Mark Wunsch"]
+    gemspec.email = ["mark@markwunsch.com"]
+    gemspec.add_development_dependency "bundler", ">= 0.9.7"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "redwood #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r redwood"
+end

data/lib/redwood.rb

@@ -0,0 +1,114 @@
+# The Redood module can be mixed in to give tree-like methods to an object.
+# Its primary implementation is the Redwood::Node class. Its only requirement
+# is that the tree-infused-object's children and parent is an object that 
+# also mixes in Redwood. See Redwood::Node for the canononical representation.
+
+module Redwood
+  VERSION = "0.0.1" 
+  
+  def parent
+    @parent
+  end
+  
+  def name
+  end
+  
+  def value
+  end
+  
+  def root?
+    parent.nil?
+  end
+  
+  def leaf?
+    children.empty?
+  end
+  
+  def root
+    if root?
+      self
+    else
+      parent.root
+    end
+  end
+
+  def children
+    @children ||= []
+  end
+  
+  def siblings
+    if parent
+      parent.children.reject {|child| child == self }
+    end
+  end
+  
+  def only_child?
+    if parent
+      siblings.empty?
+    end
+  end
+  
+  def childless?
+    children.nil? || children.empty?
+  end
+  
+  def has_children?
+    !childless?
+  end
+
+  def ancestors
+    return @ancestors if @ancestors
+    @ancestors = []
+    if parent
+      @ancestors << parent
+      parent.ancestors.each {|ancestor| @ancestors << ancestor }
+    end
+    @ancestors
+  end
+
+  def descendants
+    return @descendants if @descendants
+    @descendants = []
+    if !children.empty?
+      (@descendants << children).flatten!
+      children.each {|descendant| @descendants << descendant.descendants }
+      @descendants.flatten!   
+    end
+    @descendants
+  end
+
+  def depth
+    ancestors.size + 1
+  end
+  
+  def view(content = :name)
+    treeview = ''
+    if parent
+      treeview += parent.children.last.eql?(self) ? "`" : "|"
+      treeview << "--\s"
+    end
+    treeview << "#{self.send(content)}"
+    if !children.empty?
+      treeview << "\n"
+      children.each do |child|
+        if parent
+          child.ancestors.reverse_each do |ancestor|
+            if !ancestor.root?
+              if ancestor.only_child? || ancestor.parent.children.last.eql?(ancestor)
+                treeview << "\s\s\s\s"
+              else
+                treeview << "|\s\s\s"
+              end                
+            end
+          end
+        end
+        treeview << child.view(content)
+        treeview << "\n" if !children.last.eql?(child)          
+      end
+    end
+    treeview
+  end
+  
+end
+
+require 'redwood/node'

data/lib/redwood/node.rb

@@ -0,0 +1,25 @@
+module Redwood
+  class Node
+    include Redwood
+    
+    attr_reader :name
+    
+    def initialize(name=nil, parent=nil)
+      @name = name
+      @parent = parent
+    end
+    
+    # Creates a child, adds it to children, and returns the child
+    def add_child(name)
+      child = self.class.new(name, self)
+      children << child
+      child
+    end
+    
+    def [](key)
+      selected_child = children.select {|child| child.name == key }
+      selected_child.size.eql?(1) ? selected_child.first : selected_child
+    end
+    
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require "rubygems"
+require "bundler"
+Bundler.setup(:test)
+
+require 'test/unit'
+require 'contest'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'redwood'

data/test/test_redwood.rb

@@ -0,0 +1,131 @@
+require 'helper'
+
+class TestRedwood < Test::Unit::TestCase  
+  describe 'Node' do
+    test 'has a name' do
+      node = Redwood::Node.new(:test)
+      assert_equal :test, node.name
+    end
+    
+    test 'can be without children' do
+      node = Redwood::Node.new
+      assert node.childless?
+      assert !node.has_children?
+    end
+    
+    test 'can be a root element' do
+      node = Redwood::Node.new
+      assert node.root?
+    end
+    
+    test 'add a child' do
+      node = Redwood::Node.new
+      assert node.children.empty?
+      node.add_child(:child)
+      assert_equal :child, node.children.first.name
+    end
+    
+    test 'has children' do
+      node = Redwood::Node.new
+      node.add_child(:child)
+      assert_equal 1, node.children.size
+    end
+    
+    test 'lookup children by named key' do
+      node = Redwood::Node.new
+      child = node.add_child(:child)
+      assert_equal child, node[:child]
+    end
+    
+    test 'has siblings' do
+      node = Redwood::Node.new
+      child = node.add_child(:child)
+      bro = node.add_child(:bro)
+      sis = node.add_child(:sis)
+      assert_equal 2, child.siblings.size
+      assert child.siblings.include?(bro)
+      assert child.siblings.include?(sis)
+      assert !child.siblings.include?(child)
+    end
+    
+    test 'is an only child' do
+      parent_one = Redwood::Node.new
+      parent_two = Redwood::Node.new
+      parent_one.add_child(:one_child)
+      parent_one.add_child(:one_bro)
+      parent_two.add_child(:two_child)
+      
+      assert !parent_one.children.first.only_child?
+      assert parent_two.children.first.only_child?
+    end
+    
+    test 'has ancestors' do
+      node = Redwood::Node.new(:parent)
+      son = node.add_child(:son)
+      daughter = node.add_child(:daughter)
+      grandson = son.add_child(:grandson)
+      greatgrandson = grandson.add_child(:greatgrandson)
+      
+      ancestors = greatgrandson.ancestors
+      
+      assert ancestors.include?(grandson)
+      assert ancestors.include?(son)
+      assert ancestors.include?(node)
+      assert !ancestors.include?(greatgrandson)
+      assert !ancestors.include?(daughter)
+    end
+    
+    test 'has a root' do
+      node = Redwood::Node.new(:parent)
+      son = node.add_child(:son)
+      grandson = son.add_child(:grandson)
+      greatgrandson = grandson.add_child(:greatgrandson)
+      
+      assert_equal node, greatgrandson.root
+      assert_equal node, node.root
+    end
+    
+    test 'has descendants' do
+      node = Redwood::Node.new(:parent)
+      son = node.add_child(:son)
+      daughter = node.add_child(:daughter)
+      grandson = son.add_child(:grandson)
+      granddaughter = daughter.add_child(:granddaughter)
+      greatgrandson = grandson.add_child(:greatgrandson)
+      
+      descendants = node.descendants
+      assert descendants.include?(son)
+      assert descendants.include?(daughter)
+      assert descendants.include?(grandson)
+      assert descendants.include?(granddaughter)
+      assert descendants.include?(greatgrandson)
+      assert !descendants.include?(node)
+    end
+    
+    test 'has a depth' do
+      node = Redwood::Node.new(:parent)
+      son = node.add_child(:son)
+      daughter = node.add_child(:daughter)
+      grandson = son.add_child(:grandson)
+      greatgrandson = grandson.add_child(:greatgrandson)
+      
+      assert_equal 1, node.depth
+      assert_equal daughter.depth, son.depth
+      assert_equal 3, grandson.depth
+      assert_equal 4, greatgrandson.depth
+    end
+    
+    test 'has a treeview' do
+      node = Redwood::Node.new(:parent)
+      dog = node.add_child(:dog)
+      puppy = dog.add_child(:puppy)
+      son = node.add_child(:son)      
+      daughter = node.add_child(:daughter)
+      grandson = son.add_child(:grandson)
+      
+      assert_respond_to node, :view
+      assert_equal String, node.view.class
+    end
+        
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: redwood
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mark Wunsch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-09 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 7
+        version: 0.9.7
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+description: A simple library to create and manage basic tree-esque structures.
+email: 
+- mark@markwunsch.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/redwood.rb
+- lib/redwood/node.rb
+- test/helper.rb
+- test/test_redwood.rb
+has_rdoc: true
+homepage: http://github.com/mwunsch/redwood
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby trees
+test_files: 
+- test/helper.rb
+- test/test_redwood.rb