basic_tree 0.1.1 → 1.0.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.rdoc

@@ -1,9 +1,69 @@
-= basic_tree
+= BasicTree
 
-Description goes here.
+A basic Ruby tree structure with nice syntax.
+
+== Example
+
+  fruit = BasicTree.new "Fruit" do
+    add "Apple" do
+      add "Red Delicious"
+    end
+    add "Banana" do
+      add "Manzano"
+      add "Plantain"
+    end
+    add "Orange"
+  end
+
+  fruit.object
+  # "Fruit"
+
+  banana = fruit.children[1]
+  banana.object
+  # "Banana"
+
+  plantain = banana.children[1]
+  plantain.object
+  # "Plantain"
+
+  plantain.parent.object
+  # "Banana""
+
+  plantain.path.map(&:object)
+  # ["Fruit", "Banana", "Plantain"]
+
+  plantain.ancestors.map(&:object) # ancestors is like path except it doesn't include itself
+  # ["Fruit", "Banana"]
+
+  banana.subtree.map(&:object)
+  # ["Banana", "Manzano", "Plantain"]
+
+  fruit.descendants.map(&:object) # descendants is like subtree except it doesn't include itself
+  # ["Apple", "Red Delicious", "Banana", "Manzano", "Plantain", "Orange"]
+
+  banana.siblings.map(&:object)
+  # ["Apple", "Orange"]
+
+  plantain.root.object
+  # "Fruit"
+
+  plantain.level
+  # 3
+
+  banana.root?
+  # false
+
+  fruit.root?
+  # true
+
+  banana.leaf?
+  # false
+
+  plantain.leaf?
+  # true
 
 == 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
@@ -14,4 +74,4 @@ Description goes here.
 
 == Copyright
 
-Copyright (c) 2010 Austin Schneider. See LICENSE for details.
+Copyright (c) 2010 Austin Schneider. See LICENSE for details.

data/lib/basic_tree.rb

@@ -2,21 +2,21 @@ class BasicTree
 
   include Enumerable
 
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 
-  def initialize(object, &block)
+  def initialize(object, parent = nil, &block)
     self.object = object
-    yield self if block_given?
+    if parent
+      self.parent = parent
+      parent.children << self
+    end
+    instance_eval(&block) if block_given?
   end
 
   attr_accessor :object, :parent
 
   def add(object, &block)
-    self.class.new(object) do |child|
-      children << child
-      child.parent = self
-      yield child if block_given?
-    end
+    self.class.new(object, self, &block)
   end
 
   def path

data/spec/{basic_tree_spec.rb → lib/basic_tree_spec.rb}

@@ -1,17 +1,21 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe BasicTree do
-  
+
   before do
-    @a = BasicTree.new "a" do |a|
-      @a1 = a.add "a1" do |a1|
-        @a11 = a1.add "a11"
-        @a12 = a1.add "a12"
+    @a = BasicTree.new "a" do
+      add "a1" do
+        add "a11"
+        add "a12"
       end
-      @a2 = a.add "a2"
+      add "a2"
     end
+    @a1 = @a.children[0]
+    @a2 = @a.children[1]
+    @a11 = @a1.children[0]
+    @a12 = @a1.children[1]
   end
-  
+
   it "path" do
     @a.path.should == [@a]
     @a1.path.should == [@a, @a1]
@@ -19,7 +23,7 @@ describe BasicTree do
     @a12.path.should == [@a, @a1, @a12]
     @a2.path.should == [@a, @a2]
   end
-  
+
   it "ancestors" do
     @a.ancestors.should == []
     @a1.ancestors.should == [@a]
@@ -27,7 +31,7 @@ describe BasicTree do
     @a12.ancestors.should == [@a, @a1]
     @a2.ancestors.should == [@a]
   end
-  
+
   it "descendants" do
     @a.descendants.should == [@a1, @a11, @a12, @a2]
     @a1.descendants.should == [@a11, @a12]
@@ -35,7 +39,7 @@ describe BasicTree do
     @a12.descendants.should == []
     @a2.descendants.should == []
   end
-  
+
   it "subtree" do
     @a.subtree.should == [@a, @a1, @a11, @a12, @a2]
     @a1.subtree.should == [@a1, @a11, @a12]
@@ -43,7 +47,7 @@ describe BasicTree do
     @a12.subtree.should == [@a12]
     @a2.subtree.should == [@a2]
   end
-  
+
   it "siblings" do
     @a.siblings.should == []
     @a1.siblings.should == [@a2]
@@ -51,13 +55,13 @@ describe BasicTree do
     @a12.siblings.should == [@a11]
     @a2.siblings.should == [@a1]
   end
-  
+
   it "root" do
     [@a, @a1, @a11, @a12, @a2].each do |m|
       m.root.should == @a
     end
   end
-  
+
   it "level" do
     @a.level.should == 1
     @a1.level.should == 2
@@ -65,7 +69,7 @@ describe BasicTree do
     @a12.level.should == 3
     @a2.level.should == 2
   end
-  
+
   it "root?" do
     @a.root?.should be_true
     @a1.root?.should be_false
@@ -73,7 +77,7 @@ describe BasicTree do
     @a12.root?.should be_false
     @a2.root?.should be_false
   end
-  
+
   it "leaf?" do
     @a.leaf?.should be_false
     @a1.leaf?.should be_false
@@ -81,5 +85,5 @@ describe BasicTree do
     @a12.leaf?.should be_true
     @a2.leaf?.should be_true
   end
-  
+
 end

data/spec/spec_helper.rb

@@ -1,9 +1,8 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rspec'
+# optionally add autorun support
+# require 'rspec/autorun'
 require 'basic_tree'
-require 'spec'
-require 'spec/autorun'
 
-Spec::Runner.configure do |config|
-  
+Rspec.configure do |c|
+  c.mock_with :rspec
 end

metadata

@@ -3,10 +3,10 @@ name: basic_tree
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-  - 0
-  - 1
   - 1
-  version: 0.1.1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Austin Schneider
@@ -41,6 +41,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
 - .rvmrc
 - Gemfile
 - Gemfile.lock
@@ -49,8 +50,7 @@ files:
 - Rakefile
 - basic_tree.gemspec
 - lib/basic_tree.rb
-- spec/basic_tree_spec.rb
-- spec/spec.opts
+- spec/lib/basic_tree_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/soccer022483/basic_tree

data/spec/spec.opts

@@ -1 +0,0 @@
---color