mongoid-tree 0.4.0 → 0.5.0

data/README.rdoc

@@ -156,12 +156,17 @@ Example:
 
 == Known issues
 
-See http://github.com/benedikt/mongoid-tree/issues
+See https://github.com/benedikt/mongoid-tree/issues
 
 
 == Repository
 
-See http://github.com/benedikt/mongoid-tree and feel free to fork it!
+See https://github.com/benedikt/mongoid-tree and feel free to fork it!
+
+
+== Contributors
+
+See a list of all contributors at https://github.com/benedikt/mongoid-tree/contributors. Thanks a lot everyone!
 
 
 == Copyright

data/lib/mongoid/tree/ordering.rb

@@ -38,10 +38,22 @@ module Mongoid
         field :position, :type => Integer
 
         before_save :assign_default_position
-        before_save :reposition_former_siblings, :if => :parent_id_changed?
+        before_save :reposition_former_siblings, :if => :sibling_reposition_required?
         after_destroy :move_lower_siblings_up
       end
 
+      ##
+      # :singleton-method: roots
+      # Returns all root documents ordered by position
+
+      module ClassMethods # :nodoc:
+
+        def roots
+          super.order_by(:position.asc)
+        end
+
+      end
+
       ##
       # Returns siblings below the current document.
       # Siblings with a position greater than this documents's position.
@@ -115,17 +127,22 @@ module Mongoid
       #
       # This method changes the node's parent if nescessary.
       def move_above(other)
-        update_attributes!(:parent_id => other.parent_id) unless sibling_of?(other)
+        unless sibling_of?(other)
+          self.parent_id = other.parent_id
+          save!
+        end
 
         if position > other.position
           new_position = other.position
           other.lower_siblings.where(:position.lt => self.position).each { |s| s.inc(:position, 1) }
           other.inc(:position, 1)
-          update_attributes!(:position => new_position)
+          self.position = new_position
+          save!
         else
           new_position = other.position - 1
           other.higher_siblings.where(:position.gt => self.position).each { |s| s.inc(:position, -1) }
-          update_attributes!(:position => new_position)
+          self.position = new_position
+          save!
         end
       end
 
@@ -134,17 +151,22 @@ module Mongoid
       #
       # This method changes the node's parent if nescessary.
       def move_below(other)
-        update_attributes!(:parent_id => other.parent_id) unless sibling_of?(other)
+        unless sibling_of?(other)
+          self.parent_id = other.parent_id
+          save!
+        end
 
         if position > other.position
           new_position = other.position + 1
           other.lower_siblings.where(:position.lt => self.position).each { |s| s.inc(:position, 1) }
-          update_attributes!(:position => new_position)
+          self.position = new_position
+          save!
         else
           new_position = other.position
           other.higher_siblings.where(:position.gt => self.position).each { |s| s.inc(:position, -1) }
           other.inc(:position, -1)
-          update_attributes!(:position => new_position)
+          self.position = new_position
+          save!
         end
       end
 
@@ -161,6 +183,10 @@ module Mongoid
         former_siblings.each { |s| s.inc(:position,  -1) }
       end
 
+      def sibling_reposition_required?
+        parent_id_changed? && persisted?
+      end
+
       def assign_default_position
         return unless self.position.nil? || self.parent_id_changed?
 

data/lib/mongoid/tree/traversal.rb

@@ -46,6 +46,41 @@ module Mongoid # :nodoc:
     #   node1, node2, node3, node4, node5, node6, node7
     #
     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:
+        def traverse(type = :depth_first, &block)
+          raise ArgumentError, "No block given" unless block_given?
+          roots.each { |root| root.traverse(type, &block) }
+          nil
+        end
+      end
 
       ##
       # Traverses the tree using the given traversal method (Default is :depth_first)
@@ -60,7 +95,7 @@ module Mongoid # :nodoc:
       #     results << node
       #   end
       def traverse(type = :depth_first, &block)
-        raise "No block given" unless block_given?
+        raise ArgumentError, "No block given" unless block_given?
         send("#{type}_traversal", &block)
       end
 
@@ -79,7 +114,6 @@ module Mongoid # :nodoc:
           queue += node.children
         end
       end
-
     end
   end
 end

data/lib/mongoid/tree.rb

@@ -84,8 +84,12 @@ module Mongoid # :nodoc:
 
     included do
       references_many :children, :class_name => self.name, :foreign_key => :parent_id, :inverse_of => :parent do
-        def <<(*objects)
-          super; objects.each { |c| c.parent = @parent }
+        def <<(*objects) # :nodoc:
+          super
+          objects.each do |c|
+            c.parent = @parent
+            c.save
+          end
         end
       end
 
@@ -274,7 +278,10 @@ module Mongoid # :nodoc:
     ##
     # Moves all children to this document's parent
     def move_children_to_parent
-      children.each { |c| c.update_attributes(:parent_id => self.parent_id) }
+      children.each do |c|
+        c.parent_id = self.parent_id
+        c.save
+      end
     end
 
     ##

data/spec/mongoid/tree/ordering_spec.rb

@@ -2,6 +2,8 @@ require 'spec_helper'
 
 describe Mongoid::Tree::Ordering do
 
+  subject { OrderedNode }
+
   it "should store position as an Integer with a default of nil" do
     f = OrderedNode.fields['position']
     f.should_not be_nil
@@ -11,7 +13,7 @@ describe Mongoid::Tree::Ordering do
 
   describe 'when saved' do
     before(:each) do
-      setup_ordered_tree <<-ENDTREE
+      setup_tree <<-ENDTREE
         - root:
           - child:
             - subchild:
@@ -60,11 +62,18 @@ describe Mongoid::Tree::Ordering do
       other_child.save!
       node(:another_child).position.should == 0
     end
+
+    it "should not reposition siblings when it's not yet saved" do
+      new_node = OrderedNode.new(:name => 'new')
+      new_node.parent = node(:root)
+      new_node.should_not_receive(:reposition_former_siblings)
+      new_node.save
+    end
   end
 
   describe 'destroy strategies' do
     before(:each) do
-      setup_ordered_tree <<-ENDTREE
+      setup_tree <<-ENDTREE
         - root:
           - child:
             - subchild
@@ -84,7 +93,7 @@ describe Mongoid::Tree::Ordering do
 
   describe 'utility methods' do
     before(:each) do
-      setup_ordered_tree <<-ENDTREE
+      setup_tree <<-ENDTREE
         - first_root:
           - first_child_of_first_root
           - second_child_of_first_root
@@ -159,7 +168,7 @@ describe Mongoid::Tree::Ordering do
 
   describe 'moving nodes around', :focus => true do
     before(:each) do
-      setup_ordered_tree <<-ENDTREE
+      setup_tree <<-ENDTREE
         - first_root:
           - first_child_of_first_root
           - second_child_of_first_root
@@ -175,7 +184,6 @@ describe Mongoid::Tree::Ordering do
     describe '#move_below' do
       it 'should fix positions within the current list when moving an sibling away from its current parent' do
         node_to_move = node(:first_child_of_first_root)
-        new_parent = node(:second_root)
         node_to_move.move_below(node(:first_child_of_second_root))
         node(:second_child_of_first_root).position.should == 0
       end
@@ -214,7 +222,6 @@ describe Mongoid::Tree::Ordering do
     describe '#move_above' do
       it 'should fix positions within the current list when moving an sibling away from its current parent' do
         node_to_move = node(:first_child_of_first_root)
-        new_parent = node(:second_root)
         node_to_move.move_above(node(:first_child_of_second_root))
         node(:second_child_of_first_root).position.should == 0
       end

data/spec/mongoid/tree/traversal_spec.rb

@@ -2,6 +2,8 @@ require 'spec_helper'
 
 describe Mongoid::Tree::Traversal do
 
+  subject { Node }
+
   describe '#traverse' do
 
     subject { Node.new }
@@ -10,7 +12,7 @@ describe Mongoid::Tree::Traversal do
       expect { subject.traverse }.to raise_error(/No block given/)
     end
 
-    [:depth_first].each do |method|
+    [:depth_first, :breadth_first].each do |method|
       it "should support #{method} traversal" do
         expect { subject.traverse(method) {} }.to_not raise_error
       end
@@ -68,8 +70,11 @@ describe Mongoid::Tree::Traversal do
     end
 
     describe 'with reordered nodes' do
+
+      subject { OrderedNode }
+
       before do
-        setup_ordered_tree <<-ENDTREE
+        setup_tree <<-ENDTREE
           node1:
             - node2:
               - node3
@@ -111,4 +116,60 @@ describe Mongoid::Tree::Traversal do
 
   end
 
+  describe '.traverse' do
+
+    describe 'when not given a block' do
+
+      it 'raises an error' do
+        expect {Node.traverse}.to raise_error ArgumentError, 'No block given'
+      end
+    end
+
+    before :each do
+      setup_tree <<-ENDTREE
+        - root1
+        - root2
+      ENDTREE
+
+      @block = Proc.new {}
+      @root1 = node(:root1)
+      @root2 = node(:root2)
+
+      Node.stub(:roots).and_return [@root1, @root2]
+    end
+
+    it 'grabs each root' do
+      Node.should_receive(:roots).and_return []
+
+      Node.traverse &@block
+    end
+
+    it 'defaults the "type" arg to :depth_first' do
+      @root1.should_receive(:traverse).with(:depth_first)
+      @root2.should_receive(:traverse).with(:depth_first)
+
+      Node.traverse &@block
+    end
+
+    it 'traverses each root' do
+      @root1.should_receive(:traverse)
+      @root2.should_receive(:traverse)
+
+      Node.traverse &@block
+    end
+
+    describe 'when the "type" arg is :breadth_first' do
+
+      it 'traverses breadth-first' do
+        @root1.should_receive(:traverse).with(:breadth_first)
+        @root2.should_receive(:traverse).with(:breadth_first)
+
+        Node.traverse :breadth_first, &@block
+      end
+    end
+
+    it 'returns nil' do
+      Node.traverse(&@block).should be nil
+    end
+  end
 end

data/spec/mongoid/tree_spec.rb

@@ -2,29 +2,31 @@ require 'spec_helper'
 
 describe Mongoid::Tree do
 
+  subject { Node }
+
   it "should reference many children as inverse of parent with index" do
-    a = Node.associations['children']
-    a.should_not be_nil
-    a.association.should == Mongoid::Associations::ReferencesMany
-    a.options.class_name.should == 'Node'
-    a.options.foreign_key.should == 'parent_id'
+    a = Node.reflect_on_association(:children)
+    a.should be
+    a.association.should eql(Mongoid::Associations::ReferencesMany)
+    a.options.class_name.should eql('Node')
+    a.options.foreign_key.should eql('parent_id')
     Node.index_options.should have_key('parent_id')
   end
 
   it "should be referenced in one parent as inverse of children" do
-    a = Node.associations['parent']
-    a.should_not be_nil
-    a.association.should == Mongoid::Associations::ReferencedIn
-    a.options.class_name.should == 'Node'
-    a.options.inverse_of.should == :children
+    a = Node.reflect_on_association(:parent)
+    a.should be
+    a.association.should eql(Mongoid::Associations::ReferencedIn)
+    a.options.class_name.should eql('Node')
+    a.options.inverse_of.should eql(:children)
     a.options.index.should be_true
   end
 
   it "should store parent_ids as Array with [] as default with index" do
     f = Node.fields['parent_ids']
-    f.should_not be_nil
-    f.options[:type].should == Array
-    f.options[:default].should == []
+    f.should be
+    f.options[:type].should eql(Array)
+    f.options[:default].should eql([])
     Node.index_options.should have_key(:parent_ids)
   end
 
@@ -84,7 +86,9 @@ describe Mongoid::Tree do
     end
 
     it "should rebuild its children's parent_ids when its own parent_id is removed" do
-      node(:child).update_attributes(:parent_id => nil)
+      c = node(:child)
+      c.parent_id = nil
+      c.save
       node(:subchild).parent_ids.should == [node(:child).id]
     end
 

data/spec/support/macros/tree_macros.rb

@@ -3,11 +3,7 @@ require 'yaml'
 module Mongoid::Tree::TreeMacros
 
   def setup_tree(tree)
-    create_tree(YAML.load(tree), {:ordered => false})
-  end
-
-  def setup_ordered_tree(tree)
-    create_tree(YAML.load(tree), {:ordered => true})
+    create_tree(YAML.load(tree))
   end
 
   def node(name)
@@ -25,22 +21,21 @@ module Mongoid::Tree::TreeMacros
   end
 
 private
-  def create_tree(object, opts={})
+  def create_tree(object)
     case object
-      when String: return create_node(object, opts)
-      when Array: object.each { |tree| create_tree(tree, opts) }
-      when Hash:
+      when String then return create_node(object)
+      when Array then object.each { |tree| create_tree(tree) }
+      when Hash then
         name, children = object.first
-        node = create_node(name, opts)
-        children.each { |c| node.children << create_tree(c, opts) }
+        node = create_node(name)
+        children.each { |c| node.children << create_tree(c) }
         return node
     end
   end
 
-  def create_node(name, opts={})
-    node_class = opts[:ordered] ? OrderedNode : Node
+  def create_node(name)
     @nodes ||= HashWithIndifferentAccess.new
-    @nodes[name] = node_class.create(:name => name)
+    @nodes[name] = subject.create(:name => name)
   end
 end
 

data/spec/support/models/node.rb

@@ -4,6 +4,8 @@ class Node
   include Mongoid::Tree::Traversal
 
   field :name
+
+  attr_accessible :name
 end
 
 class SubclassedNode < Node

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid-tree
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Benedikt Deicke
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-03 00:00:00 +01:00
+date: 2010-12-20 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,11 +44,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 5
         segments: 
         - 2
-        - 0
-        version: "2.0"
+        - 3
+        version: "2.3"
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -107,10 +107,9 @@ files:
 - README.rdoc
 - Rakefile
 - Gemfile
-- Gemfile.lock
 - .rspec
 has_rdoc: true
-homepage: http://github.com/benedikt/mongoid-tree
+homepage: https://github.com/benedikt/mongoid-tree
 licenses: []
 
 post_install_message: 

data/Gemfile.lock

@@ -1,57 +0,0 @@
-PATH
-  remote: .
-  specs:
-    mongoid-tree (0.4.0)
-      mongoid (>= 2.0.0.beta.20)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activemodel (3.0.1)
-      activesupport (= 3.0.1)
-      builder (~> 2.1.2)
-      i18n (~> 0.4.1)
-    activesupport (3.0.1)
-    autotest (4.4.2)
-    bson (1.1.1)
-    bson_ext (1.1.1)
-    builder (2.1.2)
-    diff-lcs (1.1.2)
-    haml (2.2.24)
-    hanna (0.1.12)
-      haml (~> 2.2.8)
-      rake (~> 0.8.2)
-      rdoc (~> 2.3.0)
-    i18n (0.4.2)
-    mongo (1.1.1)
-      bson (>= 1.1.1)
-    mongoid (2.0.0.beta.20)
-      activemodel (~> 3.0)
-      mongo (~> 1.1)
-      tzinfo (~> 0.3.22)
-      will_paginate (~> 3.0.pre)
-    rake (0.8.7)
-    rdoc (2.3.0)
-    rspec (2.0.1)
-      rspec-core (~> 2.0.1)
-      rspec-expectations (~> 2.0.1)
-      rspec-mocks (~> 2.0.1)
-    rspec-core (2.0.1)
-    rspec-expectations (2.0.1)
-      diff-lcs (>= 1.1.2)
-    rspec-mocks (2.0.1)
-      rspec-core (~> 2.0.1)
-      rspec-expectations (~> 2.0.1)
-    tzinfo (0.3.23)
-    will_paginate (3.0.pre2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  autotest (>= 4.3.2)
-  bson_ext (>= 1.0.4)
-  hanna (>= 0.1.12)
-  mongoid (>= 2.0.0.beta.20)
-  mongoid-tree!
-  rspec (~> 2.0)