mongoid-tree 0.7.0 → 1.0.0

data/lib/mongoid/tree/ordering.rb

@@ -44,6 +44,8 @@ module Mongoid
 
       ##
       # Returns a chainable criteria for this document's ancestors
+      #
+      # @return [Mongoid::Criteria] Mongoid criteria to retrieve the documents ancestors
       def ancestors
         base_class.unscoped.where(:_id.in => parent_ids)
       end
@@ -51,6 +53,8 @@ module Mongoid
       ##
       # Returns siblings below the current document.
       # Siblings with a position greater than this documents's position.
+      #
+      # @return [Mongoid::Criteria] Mongoid criteria to retrieve the documents lower_siblings
       def lower_siblings
         self.siblings.where(:position.gt => self.position)
       end
@@ -58,36 +62,48 @@ module Mongoid
       ##
       # Returns siblings above the current document.
       # Siblings with a position lower than this documents's position.
+      #
+      # @return [Mongoid::Criteria] Mongoid criteria to retrieve the documents higher_siblings
       def higher_siblings
         self.siblings.where(:position.lt => self.position)
       end
 
       ##
       # Returns the lowest sibling (could be self)
+      #
+      # @return [Mongoid::Document] The lowest sibling
       def last_sibling_in_list
         siblings_and_self.last
       end
 
       ##
       # Returns the highest sibling (could be self)
+      #
+      # @return [Mongoid::Document] The highest sibling
       def first_sibling_in_list
         siblings_and_self.first
       end
 
       ##
       # Is this the highest sibling?
+      #
+      # @return [Boolean] Whether the document is the highest sibling
       def at_top?
         higher_siblings.empty?
       end
 
       ##
       # Is this the lowest sibling?
+      #
+      # @return [Boolean] Whether the document is the lowest sibling
       def at_bottom?
         lower_siblings.empty?
       end
 
       ##
       # Move this node above all its siblings
+      #
+      # @return [undefined]
       def move_to_top
         return true if at_top?
         move_above(first_sibling_in_list)
@@ -95,6 +111,8 @@ module Mongoid
 
       ##
       # Move this node below all its siblings
+      #
+      # @return [undefined]
       def move_to_bottom
         return true if at_bottom?
         move_below(last_sibling_in_list)
@@ -102,6 +120,8 @@ module Mongoid
 
       ##
       # Move this node one position up
+      #
+      # @return [undefined]
       def move_up
         return if at_top?
         siblings.where(:position => self.position - 1).first.inc(:position, 1)
@@ -110,6 +130,8 @@ module Mongoid
 
       ##
       # Move this node one position down
+      #
+      # @return [undefined]
       def move_down
         return if at_bottom?
         siblings.where(:position => self.position + 1).first.inc(:position, -1)
@@ -120,6 +142,10 @@ module Mongoid
       # Move this node above the specified node
       #
       # This method changes the node's parent if nescessary.
+      #
+      # @param [Mongoid::Tree] other document to move this document above
+      #
+      # @return [undefined]
       def move_above(other)
         unless sibling_of?(other)
           self.parent_id = other.parent_id
@@ -144,6 +170,10 @@ module Mongoid
       # Move this node below the specified node
       #
       # This method changes the node's parent if nescessary.
+      #
+      # @param [Mongoid::Tree] other document to move this document below
+      #
+      # @return [undefined]
       def move_below(other)
         unless sibling_of?(other)
           self.parent_id = other.parent_id

data/lib/mongoid/tree/traversal.rb

@@ -1,4 +1,4 @@
-module Mongoid # :nodoc:
+module Mongoid
   module Tree
     ##
     # = Mongoid::Tree::Traversal
@@ -48,37 +48,34 @@ module Mongoid # :nodoc:
     module Traversal
       extend ActiveSupport::Concern
 
-      ##
-      # :singleton-method: traverse
-      # Traverses the entire tree, one root at a time, using the given traversal
-      # method (Default is :depth_first).
-      #
-      # See Mongoid::Tree::Traversal for available traversal methods.
-      #
-      # Example:
-      #
-      #   # Say we have the following tree, and want to print its hierarchy:
-      #   #   root_1
-      #   #     child_1_a
-      #   #   root_2
-      #   #     child_2_a
-      #   #       child_2_a_1
-      #
-      #   Node.traverse(:depth_first) do |node|
-      #     indentation = '  ' * node.depth
-      #
-      #     puts "#{indentation}#{node.name}"
-      #   end
-      #
 
       ##
-      # The methods in this module are class-level methods documented above.
-      # They're extended into the base class automatically.
-      module ClassMethods # :nodoc:
+      # This module implements class methods that will be available 
+      # on the document that includes Mongoid::Tree::Traversal
+      module ClassMethods
+        ##
+        # Traverses the entire tree, one root at a time, using the given traversal
+        # method (Default is :depth_first).
+        # 
+        # See Mongoid::Tree::Traversal for available traversal methods.
+        #
+        # @example
+        #
+        #   # Say we have the following tree, and want to print its hierarchy:
+        #   #   root_1
+        #   #     child_1_a
+        #   #   root_2
+        #   #     child_2_a
+        #   #       child_2_a_1
+        #
+        #   Node.traverse(:depth_first) do |node|
+        #     indentation = '  ' * node.depth
+        #
+        #     puts "#{indentation}#{node.name}"
+        #   end
+        #
         def traverse(type = :depth_first, &block)
-          res = []
-          roots.each { |root| res.concat root.traverse(type, &block) }
-          res
+          roots.collect { |root| root.traverse(type, &block) }.flatten
         end
       end
 
@@ -88,7 +85,7 @@ module Mongoid # :nodoc:
       #
       # See Mongoid::Tree::Traversal for available traversal methods.
       #
-      # Example:
+      # @example
       #
       #   results = []
       #   root.traverse(:depth_first) do |node|
@@ -96,28 +93,29 @@ module Mongoid # :nodoc:
       #   end
       #
       #   root.traverse(:depth_first).map(&:name)
+      #   root.traverse(:depth_first, &:name)
       #
       def traverse(type = :depth_first, &block)
-        res = []
-        block ||= lambda { |node| res << node }
+        block ||= lambda { |node| node }
         send("#{type}_traversal", &block)
-        res
       end
 
       private
 
       def depth_first_traversal(&block)
-        block.call(self)
-        self.children.each { |c| c.send(:depth_first_traversal, &block) }
+        result = [block.call(self)] + self.children.collect { |c| c.send(:depth_first_traversal, &block) }
+        result.flatten
       end
 
       def breadth_first_traversal(&block)
+        result = []
         queue = [self]
         while queue.any? do
           node = queue.shift
-          block.call(node)
+          result << block.call(node)
           queue += node.children
         end
+        result
       end
     end
   end

data/spec/mongoid/tree/traversal_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Mongoid::Tree::Traversal do
 
-  subject { Node }
+  subject { OrderedNode }
 
   describe '#traverse' do
 
@@ -22,53 +22,59 @@ describe Mongoid::Tree::Traversal do
       subject.should_receive(:depth_first_traversal)
       subject.traverse {}
     end
-
   end
 
   describe 'depth first traversal' do
 
-    it "should traverse correctly" do
-      setup_tree <<-ENDTREE
-        node1:
-          - node2:
-            - node3
-          - node4:
-            - node5
-            - node6
-          - node7
-      ENDTREE
-
-      result = []
-      node(:node1).traverse(:depth_first) { |node| result << node }
-      result.collect { |n| n.name.to_sym }.should == [:node1, :node2, :node3, :node4, :node5, :node6, :node7]
-    end
-
-    it "should traverse correctly on merged trees" do
-
-      setup_tree <<-ENDTREE
-        - node4:
-          - node5
-          - node6:
+    describe 'with unmodified tree' do
+      before do
+        setup_tree <<-ENDTREE
+          node1:
+            - node2:
+              - node3
+            - node4:
+              - node5
+              - node6
             - node7
+        ENDTREE
+      end
 
-        - node1:
-          - node2:
-            - node3
-      ENDTREE
+      it "should traverse correctly" do
+        result = []
+        node(:node1).traverse(:depth_first) { |node| result << node }
+        result.collect { |n| n.name.to_sym }.should == [:node1, :node2, :node3, :node4, :node5, :node6, :node7]
+      end
 
+      it "should return and array containing the results of the block for each node" do
+        result = node(:node1).traverse(:depth_first) { |n| n.name.to_sym }
+        result.should == [:node1, :node2, :node3, :node4, :node5, :node6, :node7]
+      end
+    end
 
-      node(:node1).children << node(:node4)
+    describe 'with merged trees' do
+      before do
+        setup_tree <<-ENDTREE
+          - node4:
+            - node5
+            - node6:
+              - node7
 
+          - node1:
+            - node2:
+              - node3
+        ENDTREE
 
-      result = []
-      node(:node1).traverse(:depth_first) { |node| result << node }
-      result.collect { |n| n.name.to_sym }.should == [:node1, :node2, :node3, :node4, :node5, :node6, :node7]
+        node(:node1).children << node(:node4)
+      end
+
+      it "should traverse correctly" do
+        result = node(:node1).traverse(:depth_first) { |n| n.name.to_sym }
+        result.should == [:node1, :node2, :node3, :node4, :node5, :node6, :node7]
+      end
     end
 
     describe 'with reordered nodes' do
 
-      subject { OrderedNode }
-
       before do
         setup_tree <<-ENDTREE
           node1:
@@ -79,6 +85,7 @@ describe Mongoid::Tree::Traversal do
               - node5
             - node7
         ENDTREE
+
         node(:node5).move_above(node(:node6))
       end
 
@@ -99,8 +106,8 @@ describe Mongoid::Tree::Traversal do
 
   describe 'breadth first traversal' do
 
-    it "should traverse correctly" do
-      tree = setup_tree <<-ENDTREE
+    before do
+      setup_tree <<-ENDTREE
         node1:
           - node2:
             - node5
@@ -109,12 +116,19 @@ describe Mongoid::Tree::Traversal do
             - node7
           - node4
       ENDTREE
+    end
 
+    it "should traverse correctly" do
       result = []
       node(:node1).traverse(:breadth_first) { |n| result << n }
       result.collect { |n| n.name.to_sym }.should == [:node1, :node2, :node3, :node4, :node5, :node6, :node7]
     end
 
+    it "should return and array containing the results of the block for each node" do
+      result = node(:node1).traverse(:breadth_first) { |n| n.name.to_sym }
+      result.should == [:node1, :node2, :node3, :node4, :node5, :node6, :node7]
+    end
+
   end
 
   describe '.traverse' do

data/spec/mongoid/tree_spec.rb

@@ -7,16 +7,16 @@ describe Mongoid::Tree do
   it "should reference many children as inverse of parent with index" do
     a = Node.reflect_on_association(:children)
     a.should be
-    a.macro.should eql(:references_many)
+    a.macro.should eql(:has_many)
     a.class_name.should eql('Node')
     a.foreign_key.should eql('parent_id')
-    Node.index_options.should have_key('parent_id')
+    Node.index_options.should have_key('parent_id' => 1)
   end
 
   it "should be referenced in one parent as inverse of children" do
     a = Node.reflect_on_association(:parent)
     a.should be
-    a.macro.should eql(:referenced_in)
+    a.macro.should eql(:belongs_to)
     a.class_name.should eql('Node')
     a.inverse_of.should eql(:children)
   end
@@ -26,7 +26,7 @@ describe Mongoid::Tree do
     f.should be
     f.options[:type].should eql(Array)
     f.options[:default].should eql([])
-    Node.index_options.should have_key(:parent_ids)
+    Node.index_options.should have_key(:parent_ids => 1)
   end
 
   describe 'when new' do
@@ -45,7 +45,7 @@ describe Mongoid::Tree do
     it "should save its unsaved children" do
       root = Node.new(:name => 'root'); child = Node.new(:name => 'child')
       root.children << child
-      child.should_receive(:save).at_most(2).times
+      child.should_receive(:save)
       root.save
     end
   end
@@ -66,15 +66,15 @@ describe Mongoid::Tree do
     it "should set the child's parent_id when added to parent's children" do
       root = Node.create; child = Node.create
       root.children << child
-      child.parent.should == root
-      child.parent_id.should == root.id
+      child.parent.should eq(root)
+      child.parent_id.should eq(root.id)
     end
 
     it "should set the child's parent_id parent is set on child" do
       root = Node.create; child = Node.create
       child.parent = root
-      child.parent.should == root
-      child.parent_id.should == root.id
+      child.parent.should eq(root)
+      child.parent_id.should eq(root.id)
     end
 
     it "should rebuild its parent_ids" do
@@ -245,9 +245,9 @@ describe Mongoid::Tree do
 
     describe '#depth' do
       it "should return the depth of this document" do
-        node(:root).depth.should == 0
-        node(:child).depth.should == 1
-        node(:subchild).depth.should == 2
+        node(:root).depth.should eq(0)
+        node(:child).depth.should eq(1)
+        node(:subchild).depth.should eq(2)
       end
     end
 
@@ -317,7 +317,7 @@ describe Mongoid::Tree do
       end
 
       it "#siblings_and_self should return the documents siblings and itself" do
-        node(:child).siblings_and_self.is_a?(Mongoid::Criteria).should == true
+        node(:child).siblings_and_self.should be_kind_of(Mongoid::Criteria)
         node(:child).siblings_and_self.to_a.should == [node(:child), node(:other_child)]
       end
 
@@ -378,5 +378,15 @@ describe Mongoid::Tree do
 
     end
 
+    describe 'cascading to embedded documents' do
+
+      it 'should not raise a NoMethodError' do
+        node = NodeWithEmbeddedDocument.new
+        document = node.build_embedded_document
+        expect { node.save }.to_not raise_error NoMethodError
+      end
+
+    end
+
   end
 end