eb_nested_set 0.3.3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jonas Nicklas
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# EvenBetterNestedSet
+
+A nested set is a datastruture in a database, sort of like a tree, but unlike a tree it allows you to find all descendants of a node with a single query. Loading a deeply nested structure with nested sets is therefore a lot more efficient than using a tree. So what's the disadvantage? Nested sets are a lot harder to maintain, since inserting and moving records requires management and it is easy to corrupt the dataset. Enter: EvenBetterNestedSet. Amount of micromanaging you need to do: 0. EvenBetterNestedSet does it all for you.
+
+## Declaring nested sets
+
+This is how you declare a nested set:
+
+    class Directory < ActiveRecord::Base
+    
+      acts_as_nested_set
+    
+    end
+    
+The directories table should have the columns 'parent_id', 'left' and 'right'.
+
+Now just set the parent to wherever you want your node to be located and EvenBetterNestedSet will do the rest for you.
+    
+    d = Directory.new
+    
+    d.children.create!(:name => 'blah')
+    d.children.create!(:name => 'gurr')
+    d.children.create!(:name => 'doh')
+    
+    d.bounds #=> 1..8
+    d.children[1].bounds #=> 4..5
+    d.children[1].name #=> 'gurr'
+    d.children[1].parent #=> d
+    
+    c = Directory.create!(:name => 'test', :parent => d.directory[1]
+
+## Finding with nested sets
+
+EvenBetterNestedSet will not automatically cache children for you, because it assumes that this is not always the preferred behaviour. If you want to cache children to a nested set, just do:
+
+    d = Directory.find(42)
+    d.cache_nested_set
+    
+or more conveniently:
+
+    d = Directory.find_with_nested_set(42)

data/Rakefile

@@ -0,0 +1,87 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'spec/rake/spectask'
+
+GEM = "eb_nested_set"
+GEM_VERSION = "0.3.3"
+AUTHOR = "Jonas Nicklas"
+EMAIL = "jonas.nicklas@gmail.com"
+HOMEPAGE = "http://github.com/jnicklas/even_better_nested_set/tree/master"
+SUMMARY = "A cool acts_as_nested_set alternative"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.md', 'LICENSE']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(LICENSE README.md Rakefile init.rb) + Dir.glob("{lib,spec}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the plugin locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION} --no-update-sources}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+namespace :jruby do
+
+  desc "Run :package and install the resulting .gem with jruby"
+  task :install => :package do
+    sh %{#{SUDO} jruby -S gem install pkg/#{GEM}-#{GEM_VERSION}.gem --no-rdoc --no-ri}
+  end
+  
+end
+
+spec_files = FileList['spec/*_spec.rb']
+
+desc 'Default: run unit tests.'
+task :default => 'spec'
+
+task :specs => :spec
+desc "Run all examples"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts = ['--color']
+  t.spec_files = spec_files
+end
+
+namespace :spec do
+  desc "Run all examples with RCov"
+  Spec::Rake::SpecTask.new('rcov') do |t|
+    t.spec_files = spec_files
+    t.rcov = true
+    t.rcov_dir = "doc/coverage"
+    t.rcov_opts = ['--exclude', 'spec,rspec-*,rcov-*,gems']
+    t.spec_opts = ['--color']
+  end
+  
+  desc "Generate an html report"
+  Spec::Rake::SpecTask.new('report') do |t|
+    t.spec_files = spec_files
+    t.rcov = true
+    t.rcov_dir = "doc/coverage"
+    t.rcov_opts = ['--exclude', 'spec']
+    t.spec_opts = ['--color', "--format", "html:doc/reports/specs.html"]
+    t.fail_on_error = false
+  end
+
+end

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'lib', 'even_better_nested_set')

data/lib/eb_nested_set.rb

@@ -0,0 +1,349 @@
+module EvenBetterNestedSet
+  
+  def self.included(base)
+    super
+    base.extend ClassMethods
+  end
+  
+  class NestedSetError < StandardError; end
+  class IllegalAssignmentError < NestedSetError; end
+  
+  module NestedSet
+    
+    def self.included(base)
+      super
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      
+      attr_accessor :nested_set_options
+      
+      def find_last_root
+        find(:first, :order => "#{nested_set_column(:right)} DESC", :conditions => { :parent_id => nil })
+      end
+
+      def find_boundaries(id)
+        query = "SELECT #{nested_set_column(:left)}, #{nested_set_column(:right)}" +
+                "FROM #{quote_db_property(table_name)}" +
+                "WHERE #{quote_db_property(primary_key)} = #{id}"
+        connection.select_rows(query).first
+      end
+
+      def nested_set
+        sort_nodes_to_nested_set(find(:all, :order => "#{nested_set_column(:left)} ASC"))
+      end
+      
+      def find_with_nested_set(*args)
+        result = find(*args)
+        if result.respond_to?(:cache_nested_set)
+          result.cache_nested_set
+        elsif result.respond_to?(:each)
+          result.each do |node|
+            node.cache_nested_set
+          end
+        end
+        result
+      end
+
+      def sort_nodes_to_nested_set(nodes)
+        roots = []
+        hashmap = {}
+        for node in nodes.sort_by { |n| n.left }
+          # if the parent is not in the hashmap, parent will be nil, therefore node will be a root node
+          # in that case
+          parent = node.parent_id ? hashmap[node.parent_id] : nil
+          
+          # make sure this is called at least once on every node, so leaves know that they have *no* children
+          node.cache_children()
+
+          if parent
+            node.cache_parent(parent)
+            parent.cache_children(node)
+          else
+            roots << node
+          end
+
+          hashmap[node.id] = node
+        end
+        return roots
+      end
+      
+      def nested_set_column(name)
+        quote_db_property(nested_set_options[name])
+      end
+      
+      # Recalculates the left and right values for the entire tree
+      def recalculate_nested_set
+        transaction do
+          left = 1
+          roots.each do |root|
+            left = root.recalculate_nested_set(left)
+          end
+        end
+      end
+      
+      def quote_db_property(property)
+        "`#{property}`".gsub('.','`.`')
+      end
+      
+    end
+    
+    def root?
+      not parent_id?
+    end
+    
+    def descendant_of?(node)
+      node.left < self.left && self.right < node.right
+    end
+  
+    def root
+      transaction do
+        reload_boundaries
+        @root ||= base_class.roots.find(:first, :conditions => ["#{nested_set_column(:left)} <= ? AND #{nested_set_column(:right)} >= ?", left, right])
+      end
+    end
+    
+    alias_method :patriarch, :root
+    
+    def ancestors(force_reload=false)
+      @ancestors = nil if force_reload
+      @ancestors ||= base_class.find(
+        :all,:conditions => ["#{nested_set_column(:left)} < ? AND #{nested_set_column(:right)} > ?", left, right],
+        :order => "#{nested_set_column(:left)} DESC"
+      )
+    end
+    
+    def lineage(force_reload=false)
+      [self, *ancestors(force_reload)]
+    end
+    
+    def kin
+      patriarch.family
+    end
+    
+    def descendants
+      base_class.descendants(self)
+    end
+    
+    def cache_nested_set
+      @cached_children || base_class.sort_nodes_to_nested_set(family)
+    end
+    
+    def family
+      [self, *descendants]
+    end
+    
+    def family_ids(force_reload=false)
+      return @family_ids unless @family_ids.nil? or force_reload
+      
+      transaction do
+        reload_boundaries
+        query = "SELECT id FROM #{self.class.quote_db_property(base_class.table_name)} " + 
+                "WHERE #{nested_set_column(:left)} >= #{left} AND #{nested_set_column(:right)} <= #{right} " +
+                "ORDER BY #{nested_set_column(:left)}"
+        @family_ids = base_class.connection.select_values(query).map(&:to_i)
+      end
+    end
+    
+    def generation
+      root? ? base_class.roots : parent.children
+    end
+    
+    def siblings
+      generation - [self]
+    end
+    
+    def level
+      if root?
+        0
+      elsif @ancestors
+        @ancestors.size
+      else
+        base_class.count :conditions => ["#{nested_set_column(:left)} < ? AND #{nested_set_column(:right)} > ?", left, right]
+      end
+    end
+    
+    def bounds
+      left..right
+    end
+    
+    def children
+      @cached_children || uncached_children
+    end
+    
+    def children?
+      children.empty?
+    end
+    
+    def cache_parent(parent) #:nodoc:
+      self.parent = parent
+    end
+    
+    def cache_children(*nodes) #:nodoc:
+      @cached_children ||= []
+      @cached_children.push(*nodes)
+    end
+    
+    def left
+      read_attribute(self.class.nested_set_options[:left])
+    end
+    
+    def right
+      read_attribute(self.class.nested_set_options[:right])
+    end
+    
+    def recalculate_nested_set(left)
+      child_left = left + 1
+      children.each do |child|
+        child_left = child.recalculate_nested_set(child_left)
+      end
+      set_boundaries(left, child_left)
+      save_without_validation!
+      
+      right + 1
+    end
+    
+    protected
+    
+    def illegal_nesting
+      if parent_id? and family_ids.include?(parent_id)
+        errors.add(:parent_id, 'cannot move node to its own descendant')
+      end
+    end
+    
+    def remove_node
+      base_class.delete_all ["#{nested_set_column(:left)} > ? AND #{nested_set_column(:right)} < ?", left, right] # TODO: Figure out what to do with children's destroy callbacks
+      
+      shift!(-node_width, right)
+    end
+    
+    def append_node
+      boundary = 1
+      
+      if parent_id?
+        transaction do
+          boundary = parent(true).right
+          shift! 2, boundary
+        end      
+      elsif last_root = base_class.find_last_root
+        boundary = last_root.right + 1
+      end
+      
+      set_boundaries(boundary, boundary + 1)
+    end
+    
+    def move_node
+      if parent_id_changed?
+        transaction do
+          reload_boundaries
+          
+          if parent_id.blank? # moved to root
+            shift_difference = base_class.find_last_root.right - left + 1
+          else # moved to non-root
+            new_parent = base_class.find_by_id(parent_id)
+
+            # open up a space
+            boundary = new_parent.right
+            shift! node_width, boundary
+            
+            reload_boundaries
+            
+            shift_difference = (new_parent.right - left)
+          end
+          # move itself and children into place
+          shift! shift_difference, left, right
+          
+          # close up the space that was left behind after move
+          shift! -node_width, left
+          
+          reload_boundaries
+        end
+      end
+    end
+    
+    def shift!(positions, left_boundary, right_boundary=nil)
+      if right_boundary
+        base_class.update_all "#{nested_set_column(:left)}  = (#{nested_set_column(:left)}  + #{positions})", ["#{nested_set_column(:left)}  >= ? AND #{nested_set_column(:left)}  <= ?", left_boundary, right_boundary]
+        base_class.update_all "#{nested_set_column(:right)} = (#{nested_set_column(:right)} + #{positions})", ["#{nested_set_column(:right)} >= ? AND #{nested_set_column(:right)} <= ?", left_boundary, right_boundary]
+      else
+        base_class.update_all "#{nested_set_column(:left)}  = (#{nested_set_column(:left)}  + #{positions})", ["#{nested_set_column(:left)} >= ?", left_boundary]
+        base_class.update_all "#{nested_set_column(:right)} = (#{nested_set_column(:right)} + #{positions})", ["#{nested_set_column(:right)} >= ?", left_boundary]
+      end
+    end
+    
+    def node_width
+      right - left + 1
+    end
+    
+    def set_boundaries(left, right)
+      write_attribute(self.class.nested_set_options[:left], left)
+      write_attribute(self.class.nested_set_options[:right], right)
+    end
+        
+    def reload_boundaries
+      set_boundaries(*base_class.find_boundaries(id))
+    end
+    
+    def base_class
+      self.class.base_class
+    end
+    
+    def validate_parent_is_within_scope
+      if self.class.nested_set_options[:scope] && parent_id
+        parent.reload # Make sure we are testing the record corresponding to the parent_id
+        if self.send(self.class.nested_set_options[:scope]) != parent.send(self.class.nested_set_options[:scope])
+          errors.add(:parent_id, "cannot be a record with a different #{self.class.nested_set_options[:scope]} to this record")
+        end
+      end
+    end
+  end
+  
+  module ClassMethods
+    
+    def acts_as_nested_set(options = {})
+      options = { :left => :left, :right => :right }.merge!(options)
+      options[:scope] = "#{options[:scope]}_id" if options[:scope]
+      
+      include NestedSet
+      
+      self.nested_set_options = options
+      
+      class_eval <<-RUBY, __FILE__, __LINE__+1
+        def #{options[:left]}=(left)
+          raise EvenBetterNestedSet::IllegalAssignmentError, "#{options[:left]} is an internal attribute used by EvenBetterNestedSet, do not assign it directly as is may corrupt the data in your database"
+        end
+
+        def #{options[:right]}=(right)
+          raise EvenBetterNestedSet::IllegalAssignmentError, "#{options[:right]} is an internal attribute used by EvenBetterNestedSet, do not assign it directly as is may corrupt the data in your database"
+        end
+      RUBY
+      
+      named_scope :roots, :conditions => { :parent_id => nil }, :order => "#{nested_set_column(:left)} asc"
+      
+      has_many :uncached_children, :class_name => self.name, :foreign_key => :parent_id, :order => "#{nested_set_column(:left)} asc"
+      protected :uncached_children, :uncached_children=
+      
+      belongs_to :parent, :class_name => self.name, :foreign_key => :parent_id
+      
+      named_scope :descendants, lambda { |node|
+        left, right = find_boundaries(node.id)
+        { :conditions => ["#{nested_set_column(:left)} > ? and #{nested_set_column(:right)} < ?", left, right],
+          :order => "#{nested_set_column(:left)} asc" }
+      }
+      
+      before_create :append_node
+      before_update :move_node
+      before_destroy :reload
+      after_destroy :remove_node
+      validate_on_update :illegal_nesting
+      validate :validate_parent_is_within_scope
+      
+      delegate :nested_set_column, :to => "self.class"
+    end
+    
+  end
+  
+end
+
+ActiveRecord::Base.send(:include, EvenBetterNestedSet) if defined?(ActiveRecord)

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

data/spec/spec_helper.rb

@@ -0,0 +1,83 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rubygems'
+require 'active_record'
+# require 'ruby-debug' # Slows down the tests massively
+
+require 'eb_nested_set'
+
+require 'spec'
+
+# change this if sqlite is unavailable
+dbconfig = case ENV["DB"]
+  when "postgresql"
+    {
+      :adapter => 'postgresql',
+      :database => 'even_better_nested_set_test',
+      :host => '127.0.0.1'
+    }
+  when "mysql"
+    {
+      :adapter => 'mysql',
+      :database => 'even_better_nested_set_test',
+      :host => '127.0.0.1'
+    }
+  else
+    {
+      :adapter => 'sqlite3',
+      :database => File.join(File.dirname(__FILE__), 'db', 'test.sqlite3')
+    }
+  end
+
+ActiveRecord::Base.establish_connection(dbconfig)
+ActiveRecord::Migration.verbose = false
+
+def show_model_variables_for(context, model)
+  context.instance_variables.sort.each do |i|
+    m = eval(i)
+    if m.is_a?(model)
+      m.reload
+      puts "#{i.ljust(8)}\t#{m.left}\t#{m.right}\t#{m.name}"
+    end
+  end
+end
+
+#ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+
+class TestMigration < ActiveRecord::Migration
+  def self.up
+    create_table :directories, :force => true do |t|
+      t.column :lft, :integer
+      t.column :rgt, :integer
+      t.column :parent_id, :integer
+      t.column :name, :string
+    end
+    
+    create_table :employees, :force => true do |t|
+      t.column :left, :integer
+      t.column :right, :integer
+      t.column :parent_id, :integer
+      t.column :name, :string
+      t.column :company_id, :integer
+    end
+  end
+
+  def self.down
+    drop_table :directories
+    drop_table :employees
+  rescue
+    nil
+  end
+end
+
+def without_changing_the_database
+  ActiveRecord::Base.transaction do
+    yield
+    raise ActiveRecord::Rollback
+  end
+end
+
+TestMigration.down
+TestMigration.up

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: eb_nested_set
+version: !ruby/object:Gem::Version 
+  version: 0.3.3
+platform: ruby
+authors: 
+- Jonas Nicklas
+autorequire: eb_nested_set
+bindir: bin
+cert_chain: []
+
+date: 2009-02-15 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: A cool acts_as_nested_set alternative
+email: jonas.nicklas@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- init.rb
+- lib/eb_nested_set.rb
+- spec/db
+- spec/db/test.sqlite3
+- spec/directory_spec.rb
+- spec/employee_spec.rb
+- spec/nested_set_behavior.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jnicklas/even_better_nested_set/tree/master
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A cool acts_as_nested_set alternative
+test_files: []
+