mongoid-tree 0.2.1 → 0.3.0

data/Gemfile.lock

@@ -1,20 +1,20 @@
 PATH
   remote: .
   specs:
-    mongoid-tree (0.2.1)
-      mongoid (>= 2.0.0.beta.14)
+    mongoid-tree (0.3.0)
+      mongoid (>= 2.0.0.beta.17)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.0.rc)
-      activesupport (= 3.0.0.rc)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
       builder (~> 2.1.2)
       i18n (~> 0.4.1)
-    activesupport (3.0.0.rc)
+    activesupport (3.0.0)
     autotest (4.3.2)
     bson (1.0.4)
-    bson_ext (1.0.4)
+    bson_ext (1.0.7)
     builder (2.1.2)
     diff-lcs (1.1.2)
     haml (2.2.24)
@@ -23,25 +23,25 @@ GEM
       rake (~> 0.8.2)
       rdoc (~> 2.3.0)
     i18n (0.4.1)
-    mongo (1.0.6)
+    mongo (1.0.7)
       bson (>= 1.0.4)
-    mongoid (2.0.0.beta.14)
-      activemodel (= 3.0.0.rc)
+    mongoid (2.0.0.beta.17)
+      activemodel (~> 3.0.0)
       bson (= 1.0.4)
-      mongo (= 1.0.6)
-      tzinfo (= 0.3.22)
+      mongo (= 1.0.7)
+      tzinfo (~> 0.3.22)
       will_paginate (~> 3.0.pre)
     rake (0.8.7)
     rdoc (2.3.0)
-    rspec (2.0.0.beta.19)
-      rspec-core (= 2.0.0.beta.19)
-      rspec-expectations (= 2.0.0.beta.19)
-      rspec-mocks (= 2.0.0.beta.19)
-    rspec-core (2.0.0.beta.19)
-    rspec-expectations (2.0.0.beta.19)
+    rspec (2.0.0.beta.20)
+      rspec-core (= 2.0.0.beta.20)
+      rspec-expectations (= 2.0.0.beta.20)
+      rspec-mocks (= 2.0.0.beta.20)
+    rspec-core (2.0.0.beta.20)
+    rspec-expectations (2.0.0.beta.20)
       diff-lcs (>= 1.1.2)
-    rspec-mocks (2.0.0.beta.19)
-    tzinfo (0.3.22)
+    rspec-mocks (2.0.0.beta.20)
+    tzinfo (0.3.23)
     will_paginate (3.0.pre2)
 
 PLATFORMS
@@ -51,6 +51,6 @@ DEPENDENCIES
   autotest (>= 4.3.2)
   bson_ext (>= 1.0.4)
   hanna (>= 0.1.12)
-  mongoid (>= 2.0.0.beta.14)
+  mongoid (>= 2.0.0.beta.17)
   mongoid-tree!
   rspec (>= 2.0.0.beta.18)

data/README.rdoc

@@ -4,7 +4,7 @@ A tree structure for Mongoid documents using the materialized path pattern
 
 == Requirements
 
-* mongoid (>= 2.0.0.beta.14)
+* mongoid (>= 2.0.0.beta.17)
 
 == Install
 
@@ -14,7 +14,7 @@ To install mongoid_tree, simply add it to your Gemfile:
 
 In order to get the latest development version of mongoid-tree:
 
-  gem 'mongoid-tree' :git => 'git://github.com/benedikt/mongoid-tree'
+  gem 'mongoid-tree', :git => 'git://github.com/benedikt/mongoid-tree'
 
 You might want to add the <tt>:require => 'mongoid/tree'</tt> option as well and finally run
 
@@ -68,6 +68,26 @@ It's possible to traverse the tree using different traversal methods. See Mongoi
     # Do something with Node n
   end
 
+=== Destroying
+
+Mongoid::Tree does not handle destroying of nodes by default. However it provides several strategies that help you to deal with children of deleted documents. You can simply add them as <tt>before_destroy</tt> callbacks.
+
+Available strategies are:
+
+* :nullify_children -- Sets the children's parent_id to null
+* :move_children_to_parent -- Moves the children to the current document's parent
+* :destroy_children -- Destroys all children by calling their #destroy method (invokes callbacks)
+* :delete_descendants -- Deletes all descendants using a database query (doesn't invoke callbacks)
+
+Example:
+
+  class Node
+    include Mongoid::Document
+    include Mongoid::Tree
+
+    before_destroy :nullify_children
+  end
+
 === Callbacks
 
 There are two callbacks that are called before and after the rearranging process. This enables you to do additional computations after the documents position in the tree is updated. See Mongoid::Tree for details.

data/lib/mongoid/tree.rb

@@ -30,6 +30,28 @@ module Mongoid # :nodoc:
   #   node.children.create
   #   node.children.first.parent # => node
   #
+  # === Destroying
+  #
+  # Mongoid::Tree does not handle destroying of nodes by default. However it provides
+  # several strategies that help you to deal with children of deleted documents. You can
+  # simply add them as <tt>before_destroy</tt> callbacks.
+  #
+  # Available strategies are:
+  #
+  # * :nullify_children -- Sets the children's parent_id to null
+  # * :move_children_to_parent -- Moves the children to the current document's parent
+  # * :destroy_children -- Destroys all children by calling their #destroy method (invokes callbacks)
+  # * :delete_descendants -- Deletes all descendants using a database query (doesn't invoke callbacks)
+  #
+  # Example:
+  #
+  #   class Node
+  #     include Mongoid::Document
+  #     include Mongoid::Tree
+  #
+  #     before_destroy :nullify_children
+  #   end
+  #
   # === Callbacks
   #
   # Mongoid::Tree offers callbacks for its rearranging process. This enables you to
@@ -162,13 +184,13 @@ module Mongoid # :nodoc:
     ##
     # Returns this document's root node
     def root
-      self.class.find(parent_ids.first)
+      base_class.find(parent_ids.first)
     end
 
     ##
     # Returns this document's ancestors
     def ancestors
-      self.class.where(:_id.in => parent_ids)
+      base_class.where(:_id.in => parent_ids)
     end
 
     ##
@@ -186,7 +208,7 @@ module Mongoid # :nodoc:
     ##
     # Returns this document's descendants
     def descendants
-      self.class.where(:parent_ids => self.id)
+      base_class.where(:parent_ids => self.id)
     end
 
     ##
@@ -210,13 +232,13 @@ module Mongoid # :nodoc:
     ##
     # Returns this document's siblings and itself
     def siblings_and_self
-      self.class.where(:parent_id => self.parent_id)
+      base_class.where(:parent_id => self.parent_id)
     end
 
     ##
     # Returns all leaves of this document (be careful, currently involves two queries)
     def leaves
-      self.class.where(:_id.nin => self.class.only(:parent_id).collect(&:parent_id)).and(:parent_ids => self.id)
+      base_class.where(:_id.nin => base_class.only(:parent_id).collect(&:parent_id)).and(:parent_ids => self.id)
     end
 
     ##
@@ -231,11 +253,44 @@ module Mongoid # :nodoc:
       !!@rearrange_children
     end
 
+    ##
+    # Nullifies all children's parent_id
+    def nullify_children
+      children.each { |c| c.parent = nil; c.save }
+    end
+
+    ##
+    # Moves all children to this documents parent
+    def move_children_to_parent
+      children.each { |c| c.update_attributes(:parent_id => self.parent_id) }
+    end
+
+    ##
+    # Deletes all children using the database (doesn't invoke callbacks)
+    def delete_descendants
+      base_class.delete_all(:conditions => { :parent_ids => self.id })
+    end
+
+    ##
+    # Destroys all children by calling their (does invoke callbacks)
+    def destroy_children
+      children.destroy_all
+    end
+
     private
 
+    def base_class
+      @base_class ||= begin
+        parent_classes = self.class.ancestors.select{|c| !c.name[/^Mongoid|ActiveModel|ActiveSupport/i]}
+        parent_classes[parent_classes.index(Object) - 1]
+      end
+    end
+
     def rearrange
       if self.parent_id
-        self.parent_ids = self.class.find(self.parent_id).parent_ids + [self.parent_id]
+        self.parent_ids = base_class.find(self.parent_id).parent_ids + [self.parent_id]
+      else
+        self.parent_ids = []
       end
 
       rearrange_children! if self.parent_ids_changed?

data/spec/mongoid/tree_spec.rb

@@ -75,6 +75,11 @@ describe Mongoid::Tree do
       subsubchild.parent_ids.should == [node(:other_root).id, other_child.id, subchild.id]
     end
 
+    it "should rebuild its children's parent_ids when its own parent_id is removed" do
+      node(:child).update_attributes(:parent_id => nil)
+      node(:subchild).parent_ids.should == [node(:child).id]
+    end
+
     it "should not rebuild its children's parent_ids when it's not required" do
       root = node(:root)
       root.should_not_receive(:rearrange_children)
@@ -90,6 +95,72 @@ describe Mongoid::Tree do
 
   end
 
+  describe 'when subclassed' do
+
+    before(:each) do
+      setup_tree <<-ENDTREE
+        - root:
+           - child:
+             - subchild
+           - other_child
+        - other_root
+      ENDTREE
+    end
+
+    it "should allow to store any subclass within the tree" do
+      subclassed = SubclassedNode.create!(:name => 'subclassed_subchild')
+      node(:child).children << subclassed
+      subclassed.root.should == node(:root)
+    end
+
+  end
+
+  describe 'destroy strategies' do
+
+    before(:each) do
+      setup_tree <<-ENDTREE
+        - root:
+           - child:
+             - subchild
+           - other_child
+        - other_root
+      ENDTREE
+    end
+
+    describe ':nullify_children' do
+      it "should set its children's parent_id to null" do
+        node(:root).nullify_children
+        node(:child).should be_root
+        node(:subchild).reload.should_not be_descendant_of node(:root)
+      end
+    end
+
+    describe ':move_children_to_parent' do
+      it "should set its childen's parent_id to the documents parent_id" do
+        node(:child).move_children_to_parent
+        node(:child).should be_leaf
+        node(:root).children.to_a.should =~ [node(:child), node(:other_child), node(:subchild)]
+      end
+    end
+
+    describe ':destroy_children' do
+      it "should destroy all children" do
+        root = node(:root)
+        root.children.should_receive(:destroy_all)
+        root.destroy_children
+      end
+    end
+
+    describe ':delete_descendants' do
+      it "should delete all descendants" do
+        root = node(:root)
+        Node.should_receive(:delete_all).with(:conditions => { :parent_ids => root.id })
+        root.delete_descendants
+      end
+    end
+
+  end
+
   describe 'utility methods' do
 
     before(:each) do

data/spec/support/models/node.rb

@@ -5,3 +5,6 @@ class Node
   field :name
 end
 
+class SubclassedNode < Node
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid-tree
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Benedikt Deicke
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-29 00:00:00 +02:00
+date: 2010-08-31 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,14 +26,14 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 62196479
+        hash: 62196417
         segments: 
         - 2
         - 0
         - 0
         - beta
-        - 14
-        version: 2.0.0.beta.14
+        - 17
+        version: 2.0.0.beta.17
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency