mongoid_tree 0.2.0 → 0.3.0

data/Rakefile

@@ -8,7 +8,7 @@ begin
         gem.summary = %Q{Materialized paths based tree implementation for Mongoid}
         gem.description = %Q{Fully featured tree implementation for Mongoid using materialized paths and relative associations. Featuring Depth and Breadth first search.}
         gem.email = "rkuhn@littleweblab.com"
-        gem.homepage = "http://github.com/rayls/mongoid_tree"
+        gem.homepage = "http://github.com/ticktricktrack/mongoid_tree"
         gem.authors = ["Rainer Kuhn"]
         # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
     end

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/features/modify_tree.feature

@@ -0,0 +1,46 @@
+Feature: Modify tree
+  In order make changes to a tree
+  As a tree hugger
+  I want move and delete branches
+
+  Scenario: Move Subtree
+    Given I have no nodes
+    And I create a tree
+    #
+    # http://en.wikipedia.org/wiki/File:Depth-first-tree.svg
+    # Node 9 and subtree are moved to Node 6
+    When I move a subtree
+    And I request the children depth first
+    Then I should get the children in the following order
+        | Node_1  |
+        | Node_2  |
+        | Node_3  |
+        | Node_4  |
+        | Node_5  |
+        | Node_6  |
+        | Node_9  |
+        | Node_10 |
+        | Node_11 |
+        | Node_7  |
+        | Node_8  |
+        | Node_12 |
+        
+  Scenario: Delete Subtree
+    Given I have no nodes
+    And I create a tree
+    #
+    # http://en.wikipedia.org/wiki/File:Depth-first-tree.svg
+    # Node 9 and subtree are deleted
+    When I delete a subtree
+    And I request the children depth first
+    Then I should get the children in the following order
+        | Node_1  |
+        | Node_2  |
+        | Node_3  |
+        | Node_4  |
+        | Node_5  |
+        | Node_6  |
+        | Node_7  |
+        | Node_8  |
+        | Node_12 |
+    And I should have 9 Nodes

data/features/step_definitions/mongoid_tree_steps.rb

@@ -1,25 +1,25 @@
 Given /^I have no nodes$/ do
-  Node.delete_all
+    Node.delete_all
 end
 
 Given /^the following nodes exist:$/ do |nodes_table|
-  # table is a Cucumber::Ast::Table
-  nodes_table.hashes.each do |hash|
-    node = Node.new(:name => hash[:name])
-    if !(hash[:parent] == "")
-      parent = Node.find(:first, :conditions => { :name => hash[:parent]})
-      parent.children << node
-      parent.save!
-      node.save!
-    else
-      Node.create( :name => hash[:name])
+    # table is a Cucumber::Ast::Table
+    nodes_table.hashes.each do |hash|
+        node = Node.new(:name => hash[:name])
+        if !(hash[:parent] == "")
+            parent = Node.find(:first, :conditions => { :name => hash[:parent]})
+            parent.children << node
+            parent.save!
+            node.save!
+        else
+            Node.create( :name => hash[:name])
+        end
     end
-  end
 end
 
 Given /^I create a tree$/ do
-    12.times{ Factory.create(:node) }
-    
+    12.times{ |i| Factory.create(:node, :name => "Node_#{i+1}") }
+
     Node.where(:name  => "Node_1").first.children << Node.where(:name => "Node_7").first
     Node.where(:name  => "Node_7").first.insert_before(Node.where(:name => "Node_2").first)
     Node.where(:name  => "Node_1").first.children << Node.where(:name => "Node_8").first
@@ -35,16 +35,32 @@ end
 
 
 When /^I request the children depth first$/ do
-  @root = Node.find(:first, :conditions => { :name => "Node_1" })
-  @root.should_not be(nil)
-  @children = @root.depth_first.map{|node| [node.name]}
+    @root = Node.find(:first, :conditions => { :name => "Node_1" })
+    @root.should_not be(nil)
+    @children = @root.depth_first.map{|node| [node.name]}
+    puts @children.inspect
+end
+
+When /^I request the children breadth first$/ do
+    @root = Node.find(:first, :conditions => { :name => "Node_1" })
+    @root.should_not be(nil)
+    @children = @root.breadth_first.map{|node| [node.name]}
+end
+
+When /^I move a subtree$/ do
+    Node.first(:conditions => {:name => "Node_9"}).move_to(Node.first(:conditions => {:name => "Node_6"}))
+end
+
+When /^I delete a subtree$/ do
+    Node.first(:conditions => {:name => "Node_9"}).destroy
 end
 
+
 Then /^I should get the children in the following order$/ do |expected_children_order|
-  # table is a Cucumber::Ast::Table
-  expected_children_order.diff!(@children)
+    # table is a Cucumber::Ast::Table
+    expected_children_order.diff!(@children)
 end
 
 Then /^I should have (\d+) Nodes$/ do |count|
-  Node.count.should be(count.to_i)
+    Node.count.should be(count.to_i)
 end

data/features/traversal.feature

@@ -1,6 +1,6 @@
 Feature: Tree Searches / Traversals
     In order to traverse
-    As a user
+    As a developer
     I want a depth-first representation of the tree
   
     Scenario: Depth First Search
@@ -22,6 +22,41 @@ Feature: Tree Searches / Traversals
              | Node_11 | Node_9 |
         And I should have 12 Nodes
         When I request the children depth first
+        Then I should get the children in the following order
+            | Node_1  |
+            | Node_2  |
+            | Node_3  |
+            | Node_4  |
+            | Node_5  |
+            | Node_6  |
+            | Node_7  |
+            | Node_8  |
+            | Node_9  |
+            | Node_10 |
+            | Node_11 |
+            | Node_12 |
+
+    
+    
+        Scenario: Depth First Search with other create Order
+        # For a visual representation see http://en.wikipedia.org/wiki/File:Depth-first-tree.svg
+        Given I have no nodes
+        And the following nodes exist:   
+             | name    | parent |
+             | Node_1  |        |
+             | Node_2  | Node_1 |
+             | Node_7  | Node_1 |
+             | Node_8  | Node_1 |
+             | Node_9  | Node_8 |
+             | Node_10 | Node_9 |
+             | Node_11 | Node_9 |
+             | Node_3  | Node_2 |
+             | Node_6  | Node_2 |
+             | Node_12 | Node_8 |
+             | Node_4  | Node_3 |
+             | Node_5  | Node_3 |
+        And I should have 12 Nodes
+        When I request the children depth first
         Then I should get the children in the following order
             |Node_1|
             |Node_2|
@@ -35,59 +70,48 @@ Feature: Tree Searches / Traversals
             |Node_10|
             |Node_11|
             |Node_12|
-    
-    
-        Scenario: Depth First Search with other create Order
-            # For a visual representation see http://en.wikipedia.org/wiki/File:Depth-first-tree.svg
-            Given I have no nodes
-            And the following nodes exist:   
-                 | name    | parent |
-                 | Node_1  |        |
-                 | Node_2  | Node_1 |
-                 | Node_7  | Node_1 |
-                 | Node_8  | Node_1 |
-                 | Node_9  | Node_8 |
-                 | Node_10 | Node_9 |
-                 | Node_11 | Node_9 |
-                 | Node_3  | Node_2 |
-                 | Node_6  | Node_2 |
-                 | Node_12 | Node_8 |
-                 | Node_4  | Node_3 |
-                 | Node_5  | Node_3 |
-            And I should have 12 Nodes
-            When I request the children depth first
-            Then I should get the children in the following order
-                |Node_1|
-                |Node_2|
-                |Node_3|
-                |Node_4|
-                |Node_5|
-                |Node_6|
-                |Node_7|
-                |Node_8|
-                |Node_9|
-                |Node_10|
-                |Node_11|
-                |Node_12|
-                
-        # This scenario creates a tree using ".children << node", insert_before(node), insert_after(node)
-        # Details in the "And i have a tree" step
-        Scenario: Depth First Search with insert
-            # For a visual representation see http://en.wikipedia.org/wiki/File:Depth-first-tree.svg
-            Given I have no nodes
-            And I create a tree                
-            And I should have 12 Nodes
-            When I request the children depth first
-            Then I should get the children in the following order
-                |Node_1|
-                |Node_2|
-                |Node_3|
-                |Node_4|
-                |Node_5|
-                |Node_6|
-                |Node_7|
-                |Node_8|
-                |Node_9|
-                |Node_10|
-                |Node_11|
-                |Node_12|
+            
+    # This scenario creates a tree using ".children << node", insert_before(node), insert_after(node)
+    # Details in the "And i have a tree" step
+    Scenario: Depth First Search with insert
+        # For a visual representation see http://en.wikipedia.org/wiki/File:Depth-first-tree.svg
+        Given I have no nodes
+        And I create a tree                
+        And I should have 12 Nodes
+        When I request the children depth first
+        Then I should get the children in the following order
+            | Node_1  |
+            | Node_2  |
+            | Node_3  |
+            | Node_4  |
+            | Node_5  |
+            | Node_6  |
+            | Node_7  |
+            | Node_8  |
+            | Node_9  |
+            | Node_10 |
+            | Node_11 |
+            | Node_12 |
+
+    # Same tree as in the Depth-First-Examples
+    # For a visual representation see http://en.wikipedia.org/wiki/File:Depth-first-tree.svg
+    # More info on BFS
+    # http://en.wikipedia.org/wiki/Breadth-first_search
+    # http://www.cs.bu.edu/teaching/cs112/spring-2000/breadth-first/
+    Scenario: Bread First Search
+      Given I have no nodes
+      And I create a tree
+      When I request the children breadth first
+      Then I should get the children in the following order
+        | Node_1  |
+        | Node_2  |
+        | Node_7  |
+        | Node_8  |
+        | Node_3  |
+        | Node_6  |
+        | Node_9  |
+        | Node_12 |
+        | Node_4  |
+        | Node_5  |
+        | Node_10 |
+        | Node_11 |

data/lib/mongoid_tree.rb

@@ -3,9 +3,13 @@ module Mongoid
         module Tree
             extend ActiveSupport::Concern
             include Comparable
-            
+
             included do
-                references_many :children, :class_name => self.name, :stored_as => :array, :inverse_of => :parents do
+                references_many :children, 
+                                :class_name => self.name, 
+                                :stored_as => :array, 
+                                :inverse_of => :parents,
+                                :dependent => :destroy do
                     def <<(*objects)
                         objects.flatten.each_with_index do |object, index|
                             reverse_key = reverse_key(object)
@@ -18,13 +22,15 @@ module Mongoid
                             object.send(reverse_key).concat(@parent.send(reverse_key))
                         end
                         super(objects)
-                        
+
                     end
                 end
-                
-                #referenced_in :parent, :class_name  => self.name, :inverse_of => :children
-                references_many :parents, :class_name => self.name, :stored_as => :array, :inverse_of => :children
-                
+
+                references_many :parents, 
+                                :class_name => self.name, 
+                                :stored_as => :array, 
+                                :inverse_of => :children
+
                 # This stores the position in the children array of the parent object.
                 # Makes it easier to flatten / export / import a tree
                 field :position, :type => Integer
@@ -32,34 +38,49 @@ module Mongoid
             end
 
             module InstanceMethods
-                
+
                 def parent
                     self.parents.last
                 end
-                
+
                 def depth
                     self.parents.count
                 end
-                
+
                 #Comparable
                 def <=> (another_node)
                     self.position <=> another_node.position
                 end
-                
-                
-                # TODO change this into a Mongoid Query
+
+                # Returns the whole subtree including itself as array
                 def depth_first
                     result = [self]
-                    if children.empty?
+                    if self.child_ids.empty?
                         return result
                     else
-                        self.children.each do |child|
+                        self.children.sort.each do |child|
                             result += child.depth_first
                         end    
                     end
                     return result                    
                 end
+                alias :dfs :depth_first
 
+                # Returns the whole subtree including itself as array
+                def breadth_first
+                    result = []
+                    queue = [self]
+                    while !queue.empty?
+                        node = queue.shift
+                        result << node
+                        node.children.sort.each do |child|
+                            queue << child
+                        end
+                    end
+                    return result
+                end
+                alias :bfs :breadth_first
+                
                 def insert_before( new_child )
                     new_child.position = self.position
                     self.parent.children.each do |child|
@@ -79,10 +100,31 @@ module Mongoid
                     end
                     self.parent.children << new_child
                 end
+                
+                def move_to(target_node)
+                    # unhinge - I was getting a nil on another implementation, so this is a bit longer but works
+                    child_ids_array = self.parent.child_ids.clone
+                    child_ids_array.delete(self.id)
+                    parent.update_attributes(:child_ids => child_ids_array )
+                    self.update_attributes(:parent_ids => [])
+                    # and append
+                    target_node.children << self
+                    # recurse through subtree
+                    self.rebuild_paths
+                end
+                
+                def rebuild_paths
+                    self.update_path
+                    self.children.each do |child|
+                        child.rebuild_paths
+                    end
+                end
+                
+                def update_path
+                    self.update_attributes(:parent_ids => self.parent.parent_ids + [self.parent.id])
+                end
+                
             end
-
-
-
         end
     end
-end
+end

data/mongoid_tree.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid_tree}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rainer Kuhn"]
-  s.date = %q{2010-08-12}
+  s.date = %q{2010-08-13}
   s.description = %q{Fully featured tree implementation for Mongoid using materialized paths and relative associations. Featuring Depth and Breadth first search.}
   s.email = %q{rkuhn@littleweblab.com}
   s.extra_rdoc_files = [
@@ -45,6 +45,7 @@ Gem::Specification.new do |s|
      "doc/js/jquery.js",
      "doc/method_list.html",
      "doc/top-level-namespace.html",
+     "features/modify_tree.feature",
      "features/step_definitions/mongoid_tree_steps.rb",
      "features/support/env.rb",
      "features/traversal.feature",
@@ -55,7 +56,7 @@ Gem::Specification.new do |s|
      "spec/mongoid_tree_spec.rb",
      "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/rayls/mongoid_tree}
+  s.homepage = %q{http://github.com/ticktricktrack/mongoid_tree}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}

data/spec/mongoid_tree_spec.rb

@@ -122,6 +122,19 @@ describe "MongoidTree" do
         getNode(5).parent_ids.should eql([getNode(1).id, getNode(2).id, getNode(3).id])
         getNode(10).parent_ids.should eql([getNode(1).id, getNode(8).id, getNode(9).id])
       end
+      
+      context "Moving a subtree" do
+        it "should rebuild the paths" do
+          getNode(9).move_to(getNode(6))
+          getNode(2).child_ids.should eql([getNode(3).id, getNode(6).id])
+          getNode(8).child_ids.should eql([getNode(12).id])
+          
+          
+          getNode(9).parent_ids.should eql([getNode(1).id, getNode(2).id, getNode(6).id])
+          getNode(10).parent_ids.should eql([getNode(1).id, getNode(2).id, getNode(6).id, getNode(9).id])
+          getNode(11).parent_ids.should eql([getNode(1).id, getNode(2).id, getNode(6).id, getNode(9).id])
+          end
+      end
 
     end
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Rainer Kuhn
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-12 00:00:00 +02:00
+date: 2010-08-13 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -56,6 +56,7 @@ files:
 - doc/js/jquery.js
 - doc/method_list.html
 - doc/top-level-namespace.html
+- features/modify_tree.feature
 - features/step_definitions/mongoid_tree_steps.rb
 - features/support/env.rb
 - features/traversal.feature
@@ -66,7 +67,7 @@ files:
 - spec/mongoid_tree_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/rayls/mongoid_tree
+homepage: http://github.com/ticktricktrack/mongoid_tree
 licenses: []
 
 post_install_message: