chrislloyd-eb_nested_set 0.3.2

data/spec/directory_spec.rb

@@ -0,0 +1,54 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/nested_set_behavior'
+
+class Directory < ActiveRecord::Base
+  acts_as_nested_set :left => :lft, :right => :rgt
+  
+  validates_presence_of :name
+end
+
+describe Directory do
+  
+  def invalid_attributes(options = {})
+    return {  }.merge(options)
+  end
+  
+  def valid_attributes(options = {})
+    $directory_no = $directory_no ? $directory_no + 1 : 0
+    return { :name => "directory#{$directory_no}" }.merge(options)
+  end
+  
+  before do
+    @model = Directory
+    @instance = @model.new
+  end
+  
+  it_should_behave_like "all nested set models"
+  
+  it "should throw an error when attempting to assign lft directly" do
+    lambda {
+      @instance.lft = 42
+    }.should raise_error(EvenBetterNestedSet::IllegalAssignmentError)
+    @instance.lft.should_not == 42
+  end
+  
+  it "should throw an error when attempting to assign rgt directly" do
+    lambda {
+      @instance.rgt = 42
+    }.should raise_error(EvenBetterNestedSet::IllegalAssignmentError)
+    @instance.rgt.should_not == 42
+  end
+  
+  it "should throw an error when mass assigning to lft" do
+    lambda {
+      @model.new(valid_attributes(:lft => 1))
+    }.should raise_error(EvenBetterNestedSet::IllegalAssignmentError)
+  end
+  
+  it "should throw an error when mass assigning to rgt" do
+    lambda {
+      @model.new(valid_attributes(:rgt => 1))
+    }.should raise_error(EvenBetterNestedSet::IllegalAssignmentError)
+  end
+  
+end

data/spec/employee_spec.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/nested_set_behavior'
+
+class Employee < ActiveRecord::Base
+  acts_as_nested_set :scope => :company
+  
+  validates_presence_of :name
+end
+
+describe Employee, "with nested sets for two different companies" do
+  before do
+    # Company 1...
+    Employee.with_options :company_id => 1 do |c1|
+      @c1_1 = c1.create!(:name => "Company 1 - 1")
+      @c1_2 = c1.create!(:name => "Company 1 - 2")
+      
+      @c1_11 = c1.create!(:name => "Company 1 - 11", :parent => @c1_1)
+      @c1_12 = c1.create!(:name => "Company 1 - 12", :parent => @c1_1)
+      
+      @c1_111 = c1.create!(:name => "Company 1 - 111", :parent => @c1_11)
+    end
+    
+    # Company 2...
+    Employee.with_options :company_id => 2 do |c2|
+      @c2_1 = c2.create!(:name => "Company 2 - 1")
+      @c2_11 = c2.create!(:name => "Company 2 - 11", :parent => @c2_1)
+    end
+  end
+  
+  after do
+    Employee.delete_all
+  end
+  
+  it "should not allow a new employee in one company to be a child of an employee in the other company, when parent is assigned to" do
+    @employee = Employee.create(:company_id => 1, :parent => @c2_11)
+    @employee.errors[:parent_id].should_not be_nil
+  end
+  
+  it "should not allow a new employee in one company to be a child of an employee in the other company, when parent_id is assigned to" do
+    @employee = Employee.create(:company_id => 1, :parent_id => @c2_11.id)
+    @employee.errors[:parent_id].should_not be_nil
+  end
+  
+  it "should not allow an existing employee in one company to become a child of an employee in the other company, when parent is assigned to" do
+    @c1_11.parent = @c2_11
+    @c1_11.save
+    @c1_11.errors[:parent_id].should_not be_nil
+  end
+  
+  it "should not allow an existing employee in one company to become a child of an employee in the other company, when parent_id is assigned to" do
+    @c1_11.parent_id = @c2_11.id
+    @c1_11.save
+    @c1_11.errors[:parent_id].should_not be_nil
+  end
+  
+  it "should keep the tree for company 1 and for company 2 entirely disjoint" do
+    c1_tree = (@c1_1.family + @c1_2.family).flatten
+    c2_tree = @c2_1.family
+    
+    (c1_tree & c2_tree).should be_empty
+  end
+  
+  it "should return the correct descendants when retrieving via a database query" do
+    @c1_1.descendants.should == [@c1_11, @c1_111, @c1_12]
+    @c1_2.descendants.should == []
+    @c2_1.descendants.should == [@c2_11]
+  end
+  
+  it "should return the correct levels when retrieving via a database query" do
+    @c1_1.family.map { |d| d.level }.should == [0, 1, 2, 1]
+    @c1_2.family.map { |d| d.level }.should == [0]
+    @c2_1.family.map { |d| d.level }.should == [0, 1]
+  end
+end

data/spec/nested_set_behavior.rb

@@ -0,0 +1,586 @@
+describe "all nested set models", :shared => true do
+
+  describe @model, 'model with acts_as_nested_set' do
+  
+    before do
+      @instance = @model.new(valid_attributes)
+    end
+    
+    it "should change the parent_id in the database when a parent is assigned" do
+      without_changing_the_database do
+        @parent = @model.create!(valid_attributes)
+        
+        @instance.parent = @parent
+        @instance.save!
+        @instance = @model.find(@instance.id)
+        
+        @instance.parent_id.should == @parent.id
+      end
+    end
+    
+    it "should change the parent_id in the database when a parent_id is assigned" do
+      without_changing_the_database do
+        @parent = @model.create!(valid_attributes)
+        
+        @instance.parent_id = @parent.id
+        @instance.save!
+        @instance = @model.find(@instance.id)
+        
+        @instance.parent_id.should == @parent.id
+      end
+    end
+  
+    describe '#bounds' do
+    
+      it "should return a range, from left to right" do
+        without_changing_the_database do
+          @instance.save!
+          @instance.left.should == 1
+          @instance.right.should == 2
+          @instance.bounds.should == (1..2)
+        end
+      end
+    
+    end
+
+  end
+  
+  describe @model, "with many descendants" do
+    before do
+      @r1 = @model.create!(valid_attributes)
+      @r2 = @model.create!(valid_attributes)
+      @r3 = @model.create!(valid_attributes)
+
+      @r1c1 = @model.create!(valid_attributes(:parent => @r1))
+      @r1c2 = @model.create!(valid_attributes(:parent => @r1))
+      @r1c3 = @model.create!(valid_attributes(:parent => @r1))
+      @r2c1 = @model.create!(valid_attributes(:parent => @r2))
+
+      @r1c1s1 = @model.create!(valid_attributes(:parent => @r1c1))
+      @r1c2s1 = @model.create!(valid_attributes(:parent => @r1c2))
+      @r1c2s2 = @model.create!(valid_attributes(:parent => @r1c2))
+      @r1c2s3 = @model.create!(valid_attributes(:parent => @r1c2))
+
+      @r1c2s2m1 = @model.create!(valid_attributes(:parent => @r1c2s2))
+    end
+    
+    after do
+      @model.delete_all
+    end
+    
+    it "should find all root nodes" do
+      @model.roots.all.should == [@r1, @r2, @r3]
+    end
+    
+    it "should find a root nodes" do
+      @model.roots.first.should == @r1
+    end
+    
+    it "should maintain the integrity of the tree if a node is deleted" do
+      @r1c2.destroy
+      
+      @r1.reload
+      @r1c3.reload
+      
+      @r1.bounds.should == (1..8)
+      @r1c3.bounds.should == (6..7)
+    end
+    
+    it "should maintain the integrity of the tree if a node is moved" do
+      @r1c2.parent_id = @r2.id
+      @r1c2.save!
+      
+      reload_models(@r1, @r1c3, @r2, @r1c2, @r1c2s1)
+      
+      @r1.bounds.should == (1..8)
+      @r1c3.bounds.should == (6..7)
+      @r2.bounds.should == (9..22)
+      @r1c2.bounds.should == (12..21)
+      @r1c2s1.bounds.should == (13..14)
+    end
+    
+    it "should change the parent, left and right in the database when a node is moved" do
+      
+      @r1c2.parent_id = @r2.id
+      
+      @r1c2.save!
+      @r1c2 = @model.find(@r1c2.id)
+
+      @r1c2.bounds.should == (12..21)
+      @r1c2.parent_id.should == @r2.id
+    end
+    
+    it "should maintain the integrity of the tree if a node is moved to a root position" do
+      @r1c2.parent_id = nil
+      @r1c2.save!
+      
+      reload_models(@r1, @r1c3, @r2, @r1c2, @r1c2s1)
+      
+      @r1.bounds.should == (1..8)
+      @r1c3.bounds.should == (6..7)
+      @r1c2.bounds.should == (15..24)
+      @r1c2s1.bounds.should == (16..17)
+    end
+    
+    it "should maintain the integrity of the tree if a node is moved to a root position by assigning a blank string (mass assignment)" do
+      @r1c2.parent_id = ""
+      @r1c2.save!
+      
+      reload_models(@r1, @r1c3, @r2, @r1c2, @r1c2s1)
+      
+      @r1.bounds.should == (1..8)
+      @r1c3.bounds.should == (6..7)
+      @r1c2.bounds.should == (15..24)
+      @r1c2s1.bounds.should == (16..17)
+    end
+    
+    it "should maintain the integrity of the tree if a root is to a non-root position" do
+      @r1c2.reload
+      @r2.parent_id = @r1c2.id
+      @r2.save!
+      
+      reload_models(@r1, @r2, @r2c1, @r1c3, @r3, @r1c2)
+      
+      @r1.bounds.should == (1..22)
+      @r1c2.bounds.should == (6..19)
+      @r1c3.bounds.should == (20..21)
+      @r3.bounds.should == (23..24)
+      @r2.bounds.should == (15..18)
+      @r2c1.bounds.should == (16..17)
+    end
+    
+    it "should maintain the integrity of the tree if a node is moved through the parent association" do
+      @r1c2.parent = @r2
+      @r1c2.save!
+      
+      reload_models(@r1, @r1c3, @r2, @r1c2, @r1c2s1)
+      
+      @r1.bounds.should == (1..8)
+      @r1c3.bounds.should == (6..7)
+      @r2.bounds.should == (9..22)
+      @r1c2.bounds.should == (12..21)
+      @r1c2s1.bounds.should == (13..14)
+    end
+    
+    it "should maintain the integrity of the tree if a node is moved to a root position through the parent association" do
+      @r1c2.parent = nil
+      @r1c2.save!
+      
+      reload_models(@r1, @r1c3, @r2, @r1c2, @r1c2s1)
+      
+      @r1.bounds.should == (1..8)
+      @r1c3.bounds.should == (6..7)
+      @r1c2.bounds.should == (15..24)
+      @r1c2s1.bounds.should == (16..17)
+    end
+    
+    it "should maintain the integrity of the tree if a root is to a non-root position through the parent association" do
+      @r1c2.reload
+      @r2.parent = @r1c2
+      @r2.save!
+      
+      reload_models(@r1, @r2, @r2c1, @r1c3, @r3, @r1c2)
+      
+      @r1.bounds.should == (1..22)
+      @r1c2.bounds.should == (6..19)
+      @r1c3.bounds.should == (20..21)
+      @r3.bounds.should == (23..24)
+      @r2.bounds.should == (15..18)
+      @r2c1.bounds.should == (16..17)
+    end
+    
+    it "should be invalid if parent is a descendant" do
+      @r2.parent = @r2c1
+      @r2.should_not be_valid
+    end
+    
+    it "should be invalid if parent is self" do
+      @r2.parent = @r2
+      @r2.should_not be_valid
+    end
+    
+    describe ".nested_set" do
+      it "should find all nodes as a nested set and cache that data" do
+        roots = @model.nested_set
+      
+        @model.delete_all
+      
+        roots[0].should == @r1
+        roots[0].children[0].should == @r1c1
+        roots[0].children[0].children[0].should == @r1c1s1
+        roots[0].children[1].should == @r1c2
+        roots[0].children[1].children[0].should == @r1c2s1
+        roots[0].children[1].children[1].should == @r1c2s2
+        roots[0].children[1].children[1].children[0].should == @r1c2s2m1
+        roots[0].children[1].children[2].should == @r1c2s3
+        roots[0].children[2].should == @r1c3
+        roots[1].should == @r2
+        roots[1].children[0].should == @r2c1
+        roots[2].should == @r3
+        
+        roots[1].children[0].parent.should == @r2
+      end
+    end
+    
+    describe ".find_with_nested_set" do
+      it "should find a single node and cache it's descendants" do
+        node = @model.find_with_nested_set(@r1c2.id)
+      
+        @model.delete_all
+
+        node.should == @r1c2
+        node.children[0].should == @r1c2s1
+        node.children[1].should == @r1c2s2
+        node.children[1].children[0].should == @r1c2s2m1
+        node.children[2].should == @r1c2s3
+      end
+      
+      it "should allow find with conditions" do
+        node = @model.find_with_nested_set(:first, :conditions => { :id => @r1c2.id })
+      
+        @model.delete_all
+
+        node.should == @r1c2
+        node.children[0].should == @r1c2s1
+        node.children[1].should == @r1c2s2
+        node.children[1].children[0].should == @r1c2s2m1
+        node.children[2].should == @r1c2s3
+      end
+      
+      it "should allow find all with conditions" do
+        nodes = @model.find_with_nested_set(:all, :conditions => { :parent_id => @r1.id })
+      
+        @model.delete_all
+
+        nodes[0].should == @r1c1
+        nodes[0].children[0].should == @r1c1s1
+        nodes[1].should == @r1c2
+        nodes[1].children[0].should == @r1c2s1
+        nodes[1].children[1].should == @r1c2s2
+        nodes[1].children[1].children[0].should == @r1c2s2m1
+        nodes[1].children[2].should == @r1c2s3
+        nodes[2].should == @r1c3
+      end
+    end
+    
+    describe ".sort_nodes_to_nested_set" do
+      it "should accept a list of nodes and sort them to a nested set" do
+        roots = @model.sort_nodes_to_nested_set(@model.find(:all))
+        roots[0].should == @r1
+        roots[0].children[0].should == @r1c1
+        roots[0].children[0].children[0].should == @r1c1s1
+        roots[0].children[1].should == @r1c2
+        roots[0].children[1].children[0].should == @r1c2s1
+        roots[0].children[1].children[1].should == @r1c2s2
+        roots[0].children[1].children[1].children[0].should == @r1c2s2m1
+        roots[0].children[1].children[2].should == @r1c2s3
+        roots[0].children[2].should == @r1c3
+        roots[1].should == @r2
+        roots[1].children[0].should == @r2c1
+        roots[2].should == @r3
+      end
+    end
+    
+    describe ".recalculate_nested_set" do
+      def values
+        @model.find(:all, :order => :id).map { |node| [node.left, node.right] }
+      end
+      
+      before do
+        @model.find(:all, :order => :id).each do |i|
+          i.send(:set_boundaries, rand(1000), rand(1000))
+          i.save_without_validation!
+        end
+      end
+      
+      it "should correctly restore the left and right values for a messed up nested set" do
+        @model.recalculate_nested_set
+        [@r1, @r2, @r3].each(&:reload)
+        
+        expected = [
+          [@r1c1, @r1c2, @r1c3, @r1c1s1, @r1c2s1, @r1c2s2, @r1c2s3, @r1c2s2m1],
+          [@r2c1],
+          [],
+          [@r1c1s1],
+          [@r1c2s1, @r1c2s2, @r1c2s3, @r1c2s2m1],
+          [],
+          [],
+          [],
+          [],
+          [@r1c2s2m1],
+          [],
+          []
+        ]
+        
+        [@r1, @r2, @r3, @r1c1, @r1c2, @r1c3, @r2c1, @r1c1s1, @r1c2s1, @r1c2s2, @r1c2s3, @r1c2s2m1].each_with_index do |node, i|
+          node.descendants.find(:all, :order => :id).should == expected[i]
+        end
+      end
+      
+      it "should leave all records valid after running" do
+        @model.recalculate_nested_set
+        @model.find(:all).each do |node|
+          node.should be_valid
+        end
+      end
+    end
+    
+    describe "#cache_nested_set" do
+      it "should cache all descendant nodes so that calls to #children or #parent don't hit the database" do
+        @r1c2.cache_nested_set
+        
+        @model.delete_all
+        
+        @r1c2.children[0].should == @r1c2s1
+        @r1c2.children[1].should == @r1c2s2
+        @r1c2.children[1].children[0].should == @r1c2s2m1
+        @r1c2.children[2].should == @r1c2s3
+        
+        @r1c2.children[1].children[0].parent.should == @r1c2s2
+      end
+    end
+    
+    describe "#parent" do
+      it "should find the parent node" do
+        @r1c1.parent.should == @r1
+        @r1c2s2.parent.should == @r1c2
+        @r1c2s2m1.parent.should == @r1c2s2
+      end
+    end
+    
+    describe "#children" do
+      it "should find all nodes that are direct descendants of this one" do
+        @r1.children.should == [@r1c1, @r1c2, @r1c3]
+        @r1c2s2.children.should == [@r1c2s2m1]
+      end
+      
+      it "should allow creation of children" do
+        child = @r1c2.children.create!(valid_attributes)
+
+        child.parent_id.should == @r1c2.id
+        child.bounds.should == (15..16)
+      end
+      
+      it "should allow addition of children" do
+        @r2.children << @r1c2
+
+        reload_models(@r1, @r1c3, @r2, @r1c2, @r1c2s1)
+
+        @r1.bounds.should == (1..8)
+        @r1c3.bounds.should == (6..7)
+        @r2.bounds.should == (9..22)
+        @r1c2.bounds.should == (12..21)
+        @r1c2s1.bounds.should == (13..14)
+      end
+    end
+    
+    describe "#patriarch" do
+      it "should find the root node that this node descended from" do
+        @r1c1.patriarch.should == @r1
+        @r1c2s2.patriarch.should == @r1
+        @r1c2s2m1.patriarch.should == @r1
+        @r2c1.patriarch.should == @r2
+        @r1.patriarch.should == @r1
+      end
+    end
+    
+    describe "#root" do
+      it "should find the root node that this node descended from" do
+        @r1c1.root.should == @r1
+        @r1c2s2.root.should == @r1
+        @r1c2s2m1.root.should == @r1
+        @r2c1.root.should == @r2
+        @r1.root.should == @r1
+      end
+    end
+
+    describe "#root?" do
+      it "should be true if node doesn't have a parent" do
+        @r1.should be_root
+        @model.roots.should include(@r1)
+        @r1.parent.should be_nil
+      end
+    end
+    
+    describe "#descendant_of(other_node)" do
+      it "should be true if other_node is an ancestor of node" do
+        reload_models @r1, @r1c2s2
+        
+        @r1c2s2.should be_descendant_of(@r1)
+        @r1c2s2.ancestors.should include(@r1)
+        @r1.descendants.should include(@r1c2s2)
+      end
+    end
+
+    describe "#generation" do
+      it "should find all nodes in the same generation as this one for a root node" do
+        @r1.generation.should == [@r1, @r2, @r3]
+      end
+      
+      it "should find all nodes in the same generation as this one" do
+        @r1c1.generation.should == [@r1c1, @r1c2, @r1c3]
+      end
+    end
+    
+    describe "#siblings" do
+      it "should find all sibling nodes for a root node" do
+        @r1.siblings.should == [@r2, @r3]
+      end
+      
+      it "should find all sibling nodes for a child node" do
+        @r1c1.siblings.should == [@r1c2, @r1c3]
+      end
+    end
+    
+    describe "#descendants" do
+      it "should find all descendants of this node" do
+        @r1.descendants.should == [@r1c1, @r1c1s1, @r1c2, @r1c2s1, @r1c2s2, @r1c2s2m1, @r1c2s3, @r1c3]
+      end
+    end
+    
+    describe "#family" do
+      it "should combine self and descendants" do
+        @r1.family.should == [@r1, @r1c1, @r1c1s1, @r1c2, @r1c2s1, @r1c2s2, @r1c2s2m1, @r1c2s3, @r1c3]
+      end
+    end
+    
+    describe "#family_ids" do
+      it "should find all ids of the node's nested set" do
+        @r1c1.family_ids.should == [@r1c1.id, @r1c1s1.id]
+        @r1c2.family_ids.should == [@r1c2.id, @r1c2s1.id, @r1c2s2.id, @r1c2s2m1.id, @r1c2s3.id]
+      end
+    end
+    
+    describe "#ancestors" do
+      it "should return a node's parent and its parent's parents" do
+        @r1c2s2m1.ancestors.should == [@r1c2s2, @r1c2, @r1]
+      end
+    end
+    
+    describe "#lineage" do
+      it "should return a node, it's parent and its parent's parents" do
+        @r1c2s2m1.lineage.should == [@r1c2s2m1, @r1c2s2, @r1c2, @r1]
+      end
+    end
+    
+    describe "#level" do
+      it "should give the depth from the node to its root" do
+        @r1.level.should == 0
+        @r1c2.level.should == 1
+        @r1c2s2.level.should == 2
+        @r1c2s2m1.level.should == 3
+      end
+    end
+    
+    describe "#kin" do
+      it "should find the patriarch and all its descendants" do
+        @r1c2s2.kin.should == [@r1, @r1c1, @r1c1s1, @r1c2, @r1c2s1, @r1c2s2, @r1c2s2m1, @r1c2s3, @r1c3]
+      end
+    end
+
+  end
+
+  describe @model, "with acts_as_nested_set" do
+  
+    it "should add a new root node if the parent is not set" do
+      without_changing_the_database do
+        @instance = @model.create!(valid_attributes)
+        @instance.parent_id.should be_nil
+        
+        @instance.bounds.should == (1..2)
+      end
+    end
+  
+    it "should add a new root node if the parent is not set and there already are some root nodes" do
+      without_changing_the_database do
+        @model.create!(valid_attributes)
+        @model.create!(valid_attributes)
+        @instance = @model.create!(valid_attributes)
+        @instance.reload
+
+        @instance.parent_id.should be_nil
+        @instance.bounds.should == (5..6)
+      end
+    end
+  
+    it "should append a child node to a parent" do
+      without_changing_the_database do
+        @parent = @model.create!(valid_attributes)
+        @parent.bounds.should == (1..2)
+      
+        @instance = @model.create!(valid_attributes(:parent => @parent))
+        
+        @parent.reload
+        
+        @instance.parent.should == @parent
+
+        @instance.bounds.should == (2..3)
+        @parent.bounds.should == (1..4)
+      end
+    end
+    
+    it "should rollback changes if the save is not successfull for some reason" do
+      without_changing_the_database do
+        @parent = @model.create!(valid_attributes)
+        @parent.bounds.should == (1..2)
+      
+        @instance = @model.create(invalid_attributes(:parent => @parent))
+        @instance.should be_a_new_record
+        
+        @parent.reload
+
+        @parent.bounds.should == (1..2)
+      end
+    end
+    
+    it "should append a child node to a parent and shift other nodes out of the way" do
+      without_changing_the_database do
+        @root1 = @model.create!(valid_attributes)
+        @root2 = @model.create!(valid_attributes)
+        
+        @root1.bounds.should == (1..2)
+        @root2.bounds.should == (3..4)
+        
+        @child1 = @model.create!(valid_attributes(:parent => @root1))
+        reload_models(@root1, @root2)
+        
+        @root1.bounds.should == (1..4)
+        @root2.bounds.should == (5..6)
+        @child1.bounds.should == (2..3)
+        
+        @child2 = @model.create!(valid_attributes(:parent => @root1))
+        reload_models(@root1, @root2, @child1)
+        
+        @root1.bounds.should == (1..6)
+        @root2.bounds.should == (7..8)
+        @child1.bounds.should == (2..3)
+        @child2.bounds.should == (4..5)
+        
+        @subchild1 = @model.create!(valid_attributes(:parent => @child2))
+        reload_models(@root1, @root2, @child1, @child2)
+        
+        @root1.bounds.should == (1..8)
+        @root2.bounds.should == (9..10)
+        @child1.bounds.should == (2..3)
+        @child2.bounds.should == (4..7)
+        @subchild1.bounds.should == (5..6)
+        
+        @subchild2 = @model.create!(valid_attributes(:parent => @child1))
+        reload_models(@root1, @root2, @child1, @child2, @subchild1)
+        
+        @root1.bounds.should == (1..10)
+        @root2.bounds.should == (11..12)
+        @child1.bounds.should == (2..5)
+        @child2.bounds.should == (6..9)
+        @subchild1.bounds.should == (7..8)
+        @subchild2.bounds.should == (3..4)
+      end
+    end
+  
+  end
+  
+  def reload_models(*attrs)
+    attrs.each {|m| m.reload }
+  end
+
+end