awesome_nested_set 2.0.1 → 2.1.2

data/CHANGELOG

@@ -1,3 +1,27 @@
+2.1.1
+* Added 'depth' which indicates how many levels deep the node is.
+  This only works when you have a column called 'depth' in your table,
+  otherwise it doesn't set itself. [Philip Arndt]
+* Rails 3.2 support added. [Gabriel Sobrinho]
+* Oracle compatibility added. [Pikender Sharma]
+* Adding row locking to deletion, locking source of pivot values, and adding retry on collisions. [Markus J. Q. Roberts]
+* Added method and helper for sorting children by column. [bluegod]
+* Fixed .all_roots_valid? to work with Postgres. [Joshua Clayton]
+* Made compatible with polymorphic belongs_to. [Graham Randall]
+* Added in the association callbacks to the children :has_many association. [Michael Deering]
+* Modified helper to allow using array of objects as argument. [Rahmat Budiharso]
+* Fixed cases where we were calling attr_protected. [Jacob Swanner]
+* Fixed nil cases involving lft and rgt. [Stuart Coyle] and [Patrick Morgan]
+
+2.0.2
+* Fixed deprecation warning under Rails 3.1 [Philip Arndt]
+* Converted Test::Unit matchers to RSpec. [Uģis Ozols]
+* Added inverse_of to associations to improve performance rendering trees. [Sergio Cambra]
+* Added row locking and fixed some race conditions. [Markus J. Q. Roberts]
+
+2.0.1
+* Fixed a bug with move_to not using nested_set_scope [Andreas Sekine]
+
 2.0.0.pre
 * Expect Rails 3
 * Changed how callbacks work. Returning false in a before_move action does not block save operations. Use a validation or exception in the callback if you need that.

data/README.rdoc

@@ -16,7 +16,8 @@ This is a new implementation of nested set based off of BetterNestedSet that fix
 
 == Usage
 
-To make use of awesome_nested_set, your model needs to have 3 fields: lft, rgt, and parent_id:
+To make use of awesome_nested_set, your model needs to have 3 fields: lft, rgt, and parent_id.
+You can also have an optional field: depth:
 
   class CreateCategories < ActiveRecord::Migration
     def self.up
@@ -25,6 +26,7 @@ To make use of awesome_nested_set, your model needs to have 3 fields: lft, rgt,
         t.integer :parent_id
         t.integer :lft
         t.integer :rgt
+        t.integer :depth # this is optional.
       end
     end
 
@@ -39,7 +41,23 @@ Enable the nested set functionality by declaring acts_as_nested_set on your mode
     acts_as_nested_set
   end
 
-Run `rake rdoc` to generate the API docs and see CollectiveIdea::Acts::NestedSet::Model::SingletonMethods for more info.
+Run `rake rdoc` to generate the API docs and see CollectiveIdea::Acts::NestedSet for more info.
+
+== Protecting attributes from mass assignment
+
+It's generally best to "white list" the attributes that can be used in mass assignment:
+
+  class Category < ActiveRecord::Base
+    acts_as_nested_set
+    attr_accessible :name, :parent_id
+  end
+
+If for some reason that is not possible, you will probably want to protect the lft and rgt attributes:
+
+  class Category < ActiveRecord::Base
+    acts_as_nested_set
+    attr_protected :lft, :rgt
+  end
 
 == Conversion from other trees
 
@@ -70,15 +88,15 @@ You can learn more about nested sets at: http://threebit.net/tutorials/nestedset
 If you find what you might think is a bug:
 
 1. Check the GitHub issue tracker to see if anyone else has had the same issue.
-   http://github.com/collectiveidea/awesome_nested_set/issues/
+   https://github.com/collectiveidea/awesome_nested_set/issues/
 2. If you don't see anything, create an issue with information on how to reproduce it.
 
 If you want to contribute an enhancement or a fix:
 
-1. Fork the project on github.
-   http://github.com/collectiveidea/awesome_nested_set/
+1. Fork the project on GitHub.
+   https://github.com/collectiveidea/awesome_nested_set/
 2. Make your changes with tests.
 3. Commit the changes without making changes to the Rakefile, VERSION, or any other files that aren't related to your enhancement or fix
 4. Send a pull request.
 
-Copyright ©2008 Collective Idea, released under the MIT license
+Copyright ©2008 Collective Idea, released under the MIT license

data/lib/awesome_nested_set/awesome_nested_set.rb

@@ -23,6 +23,7 @@ module CollectiveIdea #:nodoc:
       # * +:parent_column+ - specifies the column name to use for keeping the position integer (default: parent_id)
       # * +:left_column+ - column name for left boundry data, default "lft"
       # * +:right_column+ - column name for right boundry data, default "rgt"
+      # * +:depth_column+ - column name for the depth data, default "depth"
       # * +:scope+ - restricts what is to be considered a list. Given a symbol, it'll attach "_id"
       #   (if it hasn't been already) and use that as the foreign key restriction. You
       #   can also pass an array to scope by multiple attributes.
@@ -36,14 +37,16 @@ module CollectiveIdea #:nodoc:
       #   Example: <tt>acts_as_nested_set :counter_cache => :children_count</tt>
       #
       # See CollectiveIdea::Acts::NestedSet::Model::ClassMethods for a list of class methods and
-      # CollectiveIdea::Acts::NestedSet::Model::InstanceMethods for a list of instance methods added
+      # CollectiveIdea::Acts::NestedSet::Model for a list of instance methods added
       # to acts_as_nested_set models
       def acts_as_nested_set(options = {})
         options = {
           :parent_column => 'parent_id',
           :left_column => 'lft',
           :right_column => 'rgt',
+          :depth_column => 'depth',
           :dependent => :delete_all, # or :destroy
+          :polymorphic => false,
           :counter_cache => false
         }.merge(options)
 
@@ -51,33 +54,42 @@ module CollectiveIdea #:nodoc:
           options[:scope] = "#{options[:scope]}_id".intern
         end
 
-        write_inheritable_attribute :acts_as_nested_set_options, options
-        class_inheritable_reader :acts_as_nested_set_options
+        class_attribute :acts_as_nested_set_options
+        self.acts_as_nested_set_options = options
 
         include CollectiveIdea::Acts::NestedSet::Model
         include Columns
         extend Columns
 
         belongs_to :parent, :class_name => self.base_class.to_s,
-          :foreign_key => parent_column_name,
-          :counter_cache => options[:counter_cache]
-        has_many :children, :class_name => self.base_class.to_s,
-          :foreign_key => parent_column_name, :order => quoted_left_column_name
+                            :foreign_key => parent_column_name,
+                            :counter_cache => options[:counter_cache],
+                            :inverse_of => (:children unless options[:polymorphic]),
+                            :polymorphic => options[:polymorphic]
 
-        attr_accessor :skip_before_destroy
+        has_many_children_options = {
+          :class_name => self.base_class.to_s,
+          :foreign_key => parent_column_name,
+          :order => left_column_name,
+          :inverse_of => (:parent unless options[:polymorphic]),
+        }
 
-        # no bulk assignment
-        if accessible_attributes.blank?
-          attr_protected  left_column_name.intern, right_column_name.intern
+        # Add callbacks, if they were supplied.. otherwise, we don't want them.
+        [:before_add, :after_add, :before_remove, :after_remove].each do |ar_callback|
+          has_many_children_options.update(ar_callback => options[ar_callback]) if options[ar_callback]
         end
 
+        has_many :children, has_many_children_options
+
+        attr_accessor :skip_before_destroy
+
         before_create  :set_default_left_and_right
         before_save    :store_new_parent
-        after_save     :move_to_new_parent
+        after_save     :move_to_new_parent, :set_depth!
         before_destroy :destroy_descendants
 
         # no assignment to structure fields
-        [left_column_name, right_column_name].each do |column|
+        [left_column_name, right_column_name, depth_column_name].each do |column|
           module_eval <<-"end_eval", __FILE__, __LINE__
             def #{column}=(x)
               raise ActiveRecord::ActiveRecordError, "Unauthorized assignment to #{column}: it's an internal field handled by acts_as_nested_set code, use move_to_* methods instead."
@@ -85,10 +97,7 @@ module CollectiveIdea #:nodoc:
           end_eval
         end
 
-        scope :roots, where(parent_column_name => nil).order(quoted_left_column_name)
-        scope :leaves, where("#{quoted_right_column_name} - #{quoted_left_column_name} = 1").order(quoted_left_column_name)
-
-        define_callbacks :move, :terminator => "result == false"
+        define_model_callbacks :move
       end
 
       module Model
@@ -100,12 +109,23 @@ module CollectiveIdea #:nodoc:
             roots.first
           end
 
+          def roots
+            where(parent_column_name => nil).order(quoted_left_column_name)
+          end
+
+          def leaves
+            where("#{quoted_right_column_name} - #{quoted_left_column_name} = 1").order(quoted_left_column_name)
+          end
+
           def valid?
             left_and_rights_valid? && no_duplicates_for_columns? && all_roots_valid?
           end
 
           def left_and_rights_valid?
-            joins("LEFT OUTER JOIN #{quoted_table_name} AS parent ON " +
+            ## AS clause not supported in Oracle in FROM clause for aliasing table name
+            joins("LEFT OUTER JOIN #{quoted_table_name}" +
+                (connection.adapter_name.match(/Oracle/).nil? ?  " AS " : " ") +
+                "parent ON " +
                 "#{quoted_table_name}.#{quoted_parent_column_name} = parent.#{primary_key}").
             where(
                 "#{quoted_table_name}.#{quoted_left_column_name} IS NULL OR " +
@@ -134,7 +154,7 @@ module CollectiveIdea #:nodoc:
           # Wrapper for each_root_valid? that can deal with scope.
           def all_roots_valid?
             if acts_as_nested_set_options[:scope]
-              roots.group(scope_column_names).group_by{|record| scope_column_names.collect{|col| record.send(col.to_sym)}}.all? do |scope, grouped_roots|
+              roots.group_by {|record| scope_column_names.collect {|col| record.send(col.to_sym) } }.all? do |scope, grouped_roots|
                 each_root_valid?(grouped_roots)
               end
             else
@@ -198,7 +218,7 @@ module CollectiveIdea #:nodoc:
             path = [nil]
             objects.each do |o|
               if o.parent_id != path.last
-                # we are on a new level, did we decent or ascent?
+                # we are on a new level, did we descend or ascend?
                 if path.include?(o.parent_id)
                   # remove wrong wrong tailing paths elements
                   path.pop while path.last != o.parent_id
@@ -209,317 +229,388 @@ module CollectiveIdea #:nodoc:
               yield(o, path.length - 1)
             end
           end
+
+          # Same as each_with_level - Accepts a string as a second argument to sort the list
+          # Example:
+          #    Category.each_with_level(Category.root.self_and_descendants, :sort_by_this_column) do |o, level|
+          def sorted_each_with_level(objects, order)
+            path = [nil]
+            children = []
+              objects.each do |o|
+              children << o if o.leaf?
+              if o.parent_id != path.last
+                if !children.empty? && !o.leaf?
+                  children.sort_by! &order
+                  children.each { |c| yield(c, path.length-1) }
+                  children = []
+                end
+                # we are on a new level, did we decent or ascent?
+                if path.include?(o.parent_id)
+                  # remove wrong wrong tailing paths elements
+                  path.pop while path.last != o.parent_id
+                else
+                  path << o.parent_id
+                end
+              end
+              yield(o,path.length-1) if !o.leaf?
+            end
+            if !children.empty?
+              children.sort_by! &order
+              children.each { |c| yield(c, path.length-1) }
+            end
+          end
         end
 
         # Any instance method that returns a collection makes use of Rails 2.1's named_scope (which is bundled for Rails 2.0), so it can be treated as a finder.
         #
         #   category.self_and_descendants.count
         #   category.ancestors.find(:all, :conditions => "name like '%foo%'")
-        module InstanceMethods
-          # Value of the parent column
-          def parent_id
-            self[parent_column_name]
-          end
+        # Value of the parent column
+        def parent_id
+          self[parent_column_name]
+        end
 
-          # Value of the left column
-          def left
-            self[left_column_name]
-          end
+        # Value of the left column
+        def left
+          self[left_column_name]
+        end
 
-          # Value of the right column
-          def right
-            self[right_column_name]
-          end
+        # Value of the right column
+        def right
+          self[right_column_name]
+        end
 
-          # Returns true if this is a root node.
-          def root?
-            parent_id.nil?
-          end
+        # Returns true if this is a root node.
+        def root?
+          parent_id.nil?
+        end
 
-          def leaf?
-            !new_record? && right - left == 1
-          end
+        # Returns true if this is the end of a branch.
+        def leaf?
+          persisted? && right.to_i - left.to_i == 1
+        end
 
-          # Returns true is this is a child node
-          def child?
-            !parent_id.nil?
-          end
+        # Returns true is this is a child node
+        def child?
+          !parent_id.nil?
+        end
 
-          # Returns root
-          def root
-            self_and_ancestors.where(parent_column_name => nil).first
-          end
+        # Returns root
+        def root
+          self_and_ancestors.where(parent_column_name => nil).first
+        end
 
-          # Returns the array of all parents and self
-          def self_and_ancestors
-            nested_set_scope.where([
-              "#{self.class.quoted_table_name}.#{quoted_left_column_name} <= ? AND #{self.class.quoted_table_name}.#{quoted_right_column_name} >= ?", left, right
-            ])
-          end
+        # Returns the array of all parents and self
+        def self_and_ancestors
+          nested_set_scope.where([
+            "#{self.class.quoted_table_name}.#{quoted_left_column_name} <= ? AND #{self.class.quoted_table_name}.#{quoted_right_column_name} >= ?", left, right
+          ])
+        end
 
-          # Returns an array of all parents
-          def ancestors
-            without_self self_and_ancestors
-          end
+        # Returns an array of all parents
+        def ancestors
+          without_self self_and_ancestors
+        end
 
-          # Returns the array of all children of the parent, including self
-          def self_and_siblings
-            nested_set_scope.where(parent_column_name => parent_id)
-          end
+        # Returns the array of all children of the parent, including self
+        def self_and_siblings
+          nested_set_scope.where(parent_column_name => parent_id)
+        end
 
-          # Returns the array of all children of the parent, except self
-          def siblings
-            without_self self_and_siblings
-          end
+        # Returns the array of all children of the parent, except self
+        def siblings
+          without_self self_and_siblings
+        end
 
-          # Returns a set of all of its nested children which do not have children
-          def leaves
-            descendants.where("#{self.class.quoted_table_name}.#{quoted_right_column_name} - #{self.class.quoted_table_name}.#{quoted_left_column_name} = 1")
-          end
+        # Returns a set of all of its nested children which do not have children
+        def leaves
+          descendants.where("#{self.class.quoted_table_name}.#{quoted_right_column_name} - #{self.class.quoted_table_name}.#{quoted_left_column_name} = 1")
+        end
 
-          # Returns the level of this object in the tree
-          # root level is 0
-          def level
-            parent_id.nil? ? 0 : ancestors.count
-          end
+        # Returns the level of this object in the tree
+        # root level is 0
+        def level
+          parent_id.nil? ? 0 : ancestors.count
+        end
 
-          # Returns a set of itself and all of its nested children
-          def self_and_descendants
-            nested_set_scope.where([
-              "#{self.class.quoted_table_name}.#{quoted_left_column_name} >= ? AND #{self.class.quoted_table_name}.#{quoted_right_column_name} <= ?", left, right
-            ])
-          end
+        # Returns a set of itself and all of its nested children
+        def self_and_descendants
+          nested_set_scope.where([
+            "#{self.class.quoted_table_name}.#{quoted_left_column_name} >= ? AND #{self.class.quoted_table_name}.#{quoted_right_column_name} <= ?", left, right
+          ])
+        end
 
-          # Returns a set of all of its children and nested children
-          def descendants
-            without_self self_and_descendants
-          end
+        # Returns a set of all of its children and nested children
+        def descendants
+          without_self self_and_descendants
+        end
 
-          def is_descendant_of?(other)
-            other.left < self.left && self.left < other.right && same_scope?(other)
-          end
+        def is_descendant_of?(other)
+          other.left < self.left && self.left < other.right && same_scope?(other)
+        end
 
-          def is_or_is_descendant_of?(other)
-            other.left <= self.left && self.left < other.right && same_scope?(other)
-          end
+        def is_or_is_descendant_of?(other)
+          other.left <= self.left && self.left < other.right && same_scope?(other)
+        end
 
-          def is_ancestor_of?(other)
-            self.left < other.left && other.left < self.right && same_scope?(other)
-          end
+        def is_ancestor_of?(other)
+          self.left < other.left && other.left < self.right && same_scope?(other)
+        end
 
-          def is_or_is_ancestor_of?(other)
-            self.left <= other.left && other.left < self.right && same_scope?(other)
-          end
+        def is_or_is_ancestor_of?(other)
+          self.left <= other.left && other.left < self.right && same_scope?(other)
+        end
 
-          # Check if other model is in the same scope
-          def same_scope?(other)
-            Array(acts_as_nested_set_options[:scope]).all? do |attr|
-              self.send(attr) == other.send(attr)
-            end
+        # Check if other model is in the same scope
+        def same_scope?(other)
+          Array(acts_as_nested_set_options[:scope]).all? do |attr|
+            self.send(attr) == other.send(attr)
           end
+        end
 
-          # Find the first sibling to the left
-          def left_sibling
-            siblings.where(["#{self.class.quoted_table_name}.#{quoted_left_column_name} < ?", left]).
-                    order("#{self.class.quoted_table_name}.#{quoted_left_column_name} DESC").last
-          end
+        # Find the first sibling to the left
+        def left_sibling
+          siblings.where(["#{self.class.quoted_table_name}.#{quoted_left_column_name} < ?", left]).
+                  order("#{self.class.quoted_table_name}.#{quoted_left_column_name} DESC").last
+        end
 
-          # Find the first sibling to the right
-          def right_sibling
-            siblings.where(["#{self.class.quoted_table_name}.#{quoted_left_column_name} > ?", left]).first
-          end
+        # Find the first sibling to the right
+        def right_sibling
+          siblings.where(["#{self.class.quoted_table_name}.#{quoted_left_column_name} > ?", left]).first
+        end
 
-          # Shorthand method for finding the left sibling and moving to the left of it.
-          def move_left
-            move_to_left_of left_sibling
-          end
+        # Shorthand method for finding the left sibling and moving to the left of it.
+        def move_left
+          move_to_left_of left_sibling
+        end
 
-          # Shorthand method for finding the right sibling and moving to the right of it.
-          def move_right
-            move_to_right_of right_sibling
-          end
+        # Shorthand method for finding the right sibling and moving to the right of it.
+        def move_right
+          move_to_right_of right_sibling
+        end
 
-          # Move the node to the left of another node (you can pass id only)
-          def move_to_left_of(node)
-            move_to node, :left
-          end
+        # Move the node to the left of another node (you can pass id only)
+        def move_to_left_of(node)
+          move_to node, :left
+        end
 
-          # Move the node to the left of another node (you can pass id only)
-          def move_to_right_of(node)
-            move_to node, :right
-          end
+        # Move the node to the left of another node (you can pass id only)
+        def move_to_right_of(node)
+          move_to node, :right
+        end
 
-          # Move the node to the child of another node (you can pass id only)
-          def move_to_child_of(node)
-            move_to node, :child
-          end
+        # Move the node to the child of another node (you can pass id only)
+        def move_to_child_of(node)
+          move_to node, :child
+        end
 
-          # Move the node to root nodes
-          def move_to_root
-            move_to nil, :root
-          end
+        # Move the node to root nodes
+        def move_to_root
+          move_to nil, :root
+        end
 
-          def move_possible?(target)
-            self != target && # Can't target self
-            same_scope?(target) && # can't be in different scopes
-            # !(left..right).include?(target.left..target.right) # this needs tested more
-            # detect impossible move
-            !((left <= target.left && right >= target.left) or (left <= target.right && right >= target.right))
-          end
+        def move_possible?(target)
+          self != target && # Can't target self
+          same_scope?(target) && # can't be in different scopes
+          # !(left..right).include?(target.left..target.right) # this needs tested more
+          # detect impossible move
+          !((left <= target.left && right >= target.left) or (left <= target.right && right >= target.right))
+        end
 
-          def to_text
-            self_and_descendants.map do |node|
-              "#{'*'*(node.level+1)} #{node.id} #{node.to_s} (#{node.parent_id}, #{node.left}, #{node.right})"
-            end.join("\n")
-          end
+        def to_text
+          self_and_descendants.map do |node|
+            "#{'*'*(node.level+1)} #{node.id} #{node.to_s} (#{node.parent_id}, #{node.left}, #{node.right})"
+          end.join("\n")
+        end
 
-        protected
+      protected
 
-          def without_self(scope)
-            scope.where(["#{self.class.quoted_table_name}.#{self.class.primary_key} != ?", self])
-          end
+        def without_self(scope)
+          scope.where(["#{self.class.quoted_table_name}.#{self.class.primary_key} != ?", self])
+        end
 
-          # All nested set queries should use this nested_set_scope, which performs finds on
-          # the base ActiveRecord class, using the :scope declared in the acts_as_nested_set
-          # declaration.
-          def nested_set_scope
-            options = {:order => quoted_left_column_name}
-            scopes = Array(acts_as_nested_set_options[:scope])
-            options[:conditions] = scopes.inject({}) do |conditions,attr|
-              conditions.merge attr => self[attr]
-            end unless scopes.empty?
-            self.class.base_class.scoped options
-          end
+        # All nested set queries should use this nested_set_scope, which performs finds on
+        # the base ActiveRecord class, using the :scope declared in the acts_as_nested_set
+        # declaration.
+        def nested_set_scope(options = {})
+          options = {:order => quoted_left_column_name}.merge(options)
+          scopes = Array(acts_as_nested_set_options[:scope])
+          options[:conditions] = scopes.inject({}) do |conditions,attr|
+            conditions.merge attr => self[attr]
+          end unless scopes.empty?
+          self.class.base_class.unscoped.scoped options
+        end
+
+        def store_new_parent
+          @move_to_new_parent_id = send("#{parent_column_name}_changed?") ? parent_id : false
+          true # force callback to return true
+        end
 
-          def store_new_parent
-            @move_to_new_parent_id = send("#{parent_column_name}_changed?") ? parent_id : false
-            true # force callback to return true
+        def move_to_new_parent
+          if @move_to_new_parent_id.nil?
+            move_to_root
+          elsif @move_to_new_parent_id
+            move_to_child_of(@move_to_new_parent_id)
           end
+        end
 
-          def move_to_new_parent
-            if @move_to_new_parent_id.nil?
-              move_to_root
-            elsif @move_to_new_parent_id
-              move_to_child_of(@move_to_new_parent_id)
+        def set_depth!
+          if nested_set_scope.column_names.map(&:to_s).include?(depth_column_name.to_s)
+            in_tenacious_transaction do
+              reload
+
+              nested_set_scope.where(:id => id).update_all(["#{quoted_depth_column_name} = ?", level])
             end
+            self[depth_column_name.to_sym] = self.level
           end
+        end
 
-          # on creation, set automatically lft and rgt to the end of the tree
-          def set_default_left_and_right
-            maxright = nested_set_scope.maximum(right_column_name) || 0
-            # adds the new node to the right of all existing nodes
-            self[left_column_name] = maxright + 1
-            self[right_column_name] = maxright + 2
-          end
+        # on creation, set automatically lft and rgt to the end of the tree
+        def set_default_left_and_right
+          highest_right_row = nested_set_scope(:order => "#{quoted_right_column_name} desc").find(:first, :limit => 1,:lock => true )
+          maxright = highest_right_row ? (highest_right_row[right_column_name] || 0) : 0
+          # adds the new node to the right of all existing nodes
+          self[left_column_name] = maxright + 1
+          self[right_column_name] = maxright + 2
+        end
 
-          # Prunes a branch off of the tree, shifting all of the elements on the right
-          # back to the left so the counts still work.
-          def destroy_descendants
-            return if right.nil? || left.nil? || skip_before_destroy
+        def in_tenacious_transaction(&block)
+          retry_count = 0
+          begin
+            transaction(&block)
+          rescue ActiveRecord::StatementInvalid => error
+            raise unless connection.open_transactions.zero?
+            raise unless error.message =~ /Deadlock found when trying to get lock|Lock wait timeout exceeded/
+            raise unless retry_count < 10
+            retry_count += 1
+            logger.info "Deadlock detected on retry #{retry_count}, restarting transaction"
+            sleep(rand(retry_count)*0.1) # Aloha protocol
+            retry
+          end
+        end
 
-            self.class.base_class.transaction do
-              if acts_as_nested_set_options[:dependent] == :destroy
-                descendants.each do |model|
-                  model.skip_before_destroy = true
-                  model.destroy
-                end
-              else
-                nested_set_scope.delete_all(
-                  ["#{quoted_left_column_name} > ? AND #{quoted_right_column_name} < ?",
-                    left, right]
-                )
+        # Prunes a branch off of the tree, shifting all of the elements on the right
+        # back to the left so the counts still work.
+        def destroy_descendants
+          return if right.nil? || left.nil? || skip_before_destroy
+
+          in_tenacious_transaction do
+            reload_nested_set
+            # select the rows in the model that extend past the deletion point and apply a lock
+            self.class.base_class.find(:all,
+              :select => "id",
+              :conditions => ["#{quoted_left_column_name} >= ?", left],
+              :lock => true
+            )
+
+            if acts_as_nested_set_options[:dependent] == :destroy
+              descendants.each do |model|
+                model.skip_before_destroy = true
+                model.destroy
               end
-
-              # update lefts and rights for remaining nodes
-              diff = right - left + 1
-              nested_set_scope.update_all(
-                ["#{quoted_left_column_name} = (#{quoted_left_column_name} - ?)", diff],
-                ["#{quoted_left_column_name} > ?", right]
-              )
-              nested_set_scope.update_all(
-                ["#{quoted_right_column_name} = (#{quoted_right_column_name} - ?)", diff],
-                ["#{quoted_right_column_name} > ?", right]
+            else
+              nested_set_scope.delete_all(
+                ["#{quoted_left_column_name} > ? AND #{quoted_right_column_name} < ?",
+                  left, right]
               )
-
-              # Don't allow multiple calls to destroy to corrupt the set
-              self.skip_before_destroy = true
             end
-          end
 
-          # reload left, right, and parent
-          def reload_nested_set
-            reload(:select => "#{quoted_left_column_name}, " +
-              "#{quoted_right_column_name}, #{quoted_parent_column_name}")
+            # update lefts and rights for remaining nodes
+            diff = right - left + 1
+            nested_set_scope.update_all(
+              ["#{quoted_left_column_name} = (#{quoted_left_column_name} - ?)", diff],
+              ["#{quoted_left_column_name} > ?", right]
+            )
+            nested_set_scope.update_all(
+              ["#{quoted_right_column_name} = (#{quoted_right_column_name} - ?)", diff],
+              ["#{quoted_right_column_name} > ?", right]
+            )
+
+            # Don't allow multiple calls to destroy to corrupt the set
+            self.skip_before_destroy = true
           end
+        end
 
-          def move_to(target, position)
-            raise ActiveRecord::ActiveRecordError, "You cannot move a new node" if self.new_record?
-            run_callbacks :move do
-              transaction do
-                if target.is_a? self.class.base_class
-                  target.reload_nested_set
-                elsif position != :root
-                  # load object if node is not an object
-                  target = nested_set_scope.find(target)
-                end
-                self.reload_nested_set
+        # reload left, right, and parent
+        def reload_nested_set
+          reload(
+            :select => "#{quoted_left_column_name}, #{quoted_right_column_name}, #{quoted_parent_column_name}",
+            :lock => true
+          )
+        end
 
-                unless position == :root || move_possible?(target)
-                  raise ActiveRecord::ActiveRecordError, "Impossible move, target node cannot be inside moved tree."
-                end
+        def move_to(target, position)
+          raise ActiveRecord::ActiveRecordError, "You cannot move a new node" if self.new_record?
+          run_callbacks :move do
+            in_tenacious_transaction do
+              if target.is_a? self.class.base_class
+                target.reload_nested_set
+              elsif position != :root
+                # load object if node is not an object
+                target = nested_set_scope.find(target)
+              end
+              self.reload_nested_set
 
-                bound = case position
-                  when :child;  target[right_column_name]
-                  when :left;   target[left_column_name]
-                  when :right;  target[right_column_name] + 1
-                  when :root;   1
-                  else raise ActiveRecord::ActiveRecordError, "Position should be :child, :left, :right or :root ('#{position}' received)."
-                end
+              unless position == :root || move_possible?(target)
+                raise ActiveRecord::ActiveRecordError, "Impossible move, target node cannot be inside moved tree."
+              end
 
-                if bound > self[right_column_name]
-                  bound = bound - 1
-                  other_bound = self[right_column_name] + 1
-                else
-                  other_bound = self[left_column_name] - 1
-                end
+              bound = case position
+                when :child;  target[right_column_name]
+                when :left;   target[left_column_name]
+                when :right;  target[right_column_name] + 1
+                when :root;   1
+                else raise ActiveRecord::ActiveRecordError, "Position should be :child, :left, :right or :root ('#{position}' received)."
+              end
 
-                # there would be no change
-                return if bound == self[right_column_name] || bound == self[left_column_name]
+              if bound > self[right_column_name]
+                bound = bound - 1
+                other_bound = self[right_column_name] + 1
+              else
+                other_bound = self[left_column_name] - 1
+              end
 
-                # we have defined the boundaries of two non-overlapping intervals,
-                # so sorting puts both the intervals and their boundaries in order
-                a, b, c, d = [self[left_column_name], self[right_column_name], bound, other_bound].sort
+              # there would be no change
+              return if bound == self[right_column_name] || bound == self[left_column_name]
 
-                new_parent = case position
-                  when :child;  target.id
-                  when :root;   nil
-                  else          target[parent_column_name]
-                end
+              # we have defined the boundaries of two non-overlapping intervals,
+              # so sorting puts both the intervals and their boundaries in order
+              a, b, c, d = [self[left_column_name], self[right_column_name], bound, other_bound].sort
+
+              # select the rows in the model between a and d, and apply a lock
+              self.class.base_class.select('id').lock(true).where(
+                ["#{quoted_left_column_name} >= :a and #{quoted_right_column_name} <= :d", {:a => a, :d => d}]
+              )
 
-                self.nested_set_scope.update_all([
-                  "#{quoted_left_column_name} = CASE " +
-                    "WHEN #{quoted_left_column_name} BETWEEN :a AND :b " +
-                      "THEN #{quoted_left_column_name} + :d - :b " +
-                    "WHEN #{quoted_left_column_name} BETWEEN :c AND :d " +
-                      "THEN #{quoted_left_column_name} + :a - :c " +
-                    "ELSE #{quoted_left_column_name} END, " +
-                  "#{quoted_right_column_name} = CASE " +
-                    "WHEN #{quoted_right_column_name} BETWEEN :a AND :b " +
-                      "THEN #{quoted_right_column_name} + :d - :b " +
-                    "WHEN #{quoted_right_column_name} BETWEEN :c AND :d " +
-                      "THEN #{quoted_right_column_name} + :a - :c " +
-                    "ELSE #{quoted_right_column_name} END, " +
-                  "#{quoted_parent_column_name} = CASE " +
-                    "WHEN #{self.class.base_class.primary_key} = :id THEN :new_parent " +
-                    "ELSE #{quoted_parent_column_name} END",
-                  {:a => a, :b => b, :c => c, :d => d, :id => self.id, :new_parent => new_parent}
-                ])
+              new_parent = case position
+                when :child;  target.id
+                when :root;   nil
+                else          target[parent_column_name]
               end
-              target.reload_nested_set if target
-              self.reload_nested_set
+
+              self.nested_set_scope.update_all([
+                "#{quoted_left_column_name} = CASE " +
+                  "WHEN #{quoted_left_column_name} BETWEEN :a AND :b " +
+                    "THEN #{quoted_left_column_name} + :d - :b " +
+                  "WHEN #{quoted_left_column_name} BETWEEN :c AND :d " +
+                    "THEN #{quoted_left_column_name} + :a - :c " +
+                  "ELSE #{quoted_left_column_name} END, " +
+                "#{quoted_right_column_name} = CASE " +
+                  "WHEN #{quoted_right_column_name} BETWEEN :a AND :b " +
+                    "THEN #{quoted_right_column_name} + :d - :b " +
+                  "WHEN #{quoted_right_column_name} BETWEEN :c AND :d " +
+                    "THEN #{quoted_right_column_name} + :a - :c " +
+                  "ELSE #{quoted_right_column_name} END, " +
+                "#{quoted_parent_column_name} = CASE " +
+                  "WHEN #{self.class.base_class.primary_key} = :id THEN :new_parent " +
+                  "ELSE #{quoted_parent_column_name} END",
+                {:a => a, :b => b, :c => c, :d => d, :id => self.id, :new_parent => new_parent}
+              ])
             end
+            target.reload_nested_set if target
+            self.set_depth!
+            self.reload_nested_set
           end
-
         end
 
       end
@@ -534,6 +625,10 @@ module CollectiveIdea #:nodoc:
           acts_as_nested_set_options[:right_column]
         end
 
+        def depth_column_name
+          acts_as_nested_set_options[:depth_column]
+        end
+
         def parent_column_name
           acts_as_nested_set_options[:parent_column]
         end
@@ -550,6 +645,10 @@ module CollectiveIdea #:nodoc:
           connection.quote_column_name(right_column_name)
         end
 
+        def quoted_depth_column_name
+          connection.quote_column_name(depth_column_name)
+        end
+
         def quoted_parent_column_name
           connection.quote_column_name(parent_column_name)
         end
@@ -561,4 +660,5 @@ module CollectiveIdea #:nodoc:
 
     end
   end
-end
+end
+

data/lib/awesome_nested_set/helper.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 module CollectiveIdea #:nodoc:
   module Acts #:nodoc:
     module NestedSet #:nodoc:
@@ -21,8 +22,12 @@ module CollectiveIdea #:nodoc:
         #     }) %>
         #
         def nested_set_options(class_or_item, mover = nil)
-          class_or_item = class_or_item.roots if class_or_item.is_a?(Class)
-          items = Array(class_or_item)
+          if class_or_item.is_a? Array
+            items = class_or_item.reject { |e| !e.root? }
+          else
+            class_or_item = class_or_item.roots if class_or_item.is_a?(Class)
+            items = Array(class_or_item)
+          end
           result = []
           items.each do |root|
             result += root.self_and_descendants.map do |i|
@@ -33,8 +38,52 @@ module CollectiveIdea #:nodoc:
           end
           result
         end
-
+        
+        # Returns options for select as nested_set_options, sorted by an specific column
+        # It requires passing a string with the name of the column to sort the set with
+        # You can exclude some items from the tree.
+        # You can pass a block receiving an item and returning the string displayed in the select.
+        #
+        # == Params
+        #  * +class_or_item+ - Class name or top level times
+        #  * +:column+ - Column to sort the set (this will sort each children for all root elements)
+        #  * +mover+ - The item that is being move, used to exlude impossible moves
+        #  * +&block+ - a block that will be used to display: { |item| ... item.name }
+        #
+        # == Usage
+        #
+        #   <%= f.select :parent_id, nested_set_options(Category, :sort_by_this_column,  @category) {|i|
+        #       "#{'–' * i.level} #{i.name}"
+        #     }) %>
+        #
+        def sorted_nested_set_options(class_or_item, order, mover = nil)
+          if class_or_item.is_a? Array
+            items = class_or_item.reject { |e| !e.root? }
+          else
+            class_or_item = class_or_item.roots if class_or_item.is_a?(Class)
+            items = Array(class_or_item)
+          end
+          result = []
+          children = []
+          items.each do |root|
+            root.self_and_descendants.map do |i|
+              if mover.nil? || mover.new_record? || mover.move_possible?(i)
+                if !i.leaf?
+                  children.sort_by! &order
+                  children.each { |c| result << [yield(c), c.id] }
+                  children = []
+                  result << [yield(i), i.id]
+                else
+                  children << i
+                 end
+              end   
+            end.compact
+          end
+          children.sort_by! &order
+          children.each { |c| result << [yield(c), c.id] }
+          result
+        end
       end
     end
   end
-end
+end

data/lib/awesome_nested_set/version.rb

@@ -1,3 +1,3 @@
 module AwesomeNestedSet
-  VERSION = '2.0.1' unless defined?(::AwesomeNestedSet::VERSION)
-end
+  VERSION = '2.1.2' unless defined?(::AwesomeNestedSet::VERSION)
+end

metadata

@@ -1,18 +1,23 @@
 --- !ruby/object:Gem::Specification 
 name: awesome_nested_set
 version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: 
-  version: 2.0.1
+  segments: 
+  - 2
+  - 1
+  - 2
+  version: 2.1.2
 platform: ruby
 authors: 
 - Brandon Keepers
 - Daniel Morrison
+- Philip Arndt
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-06-16 00:00:00 -04:00
-default_executable: 
+date: 2012-01-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -22,6 +27,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
         version: 3.0.0
   type: :runtime
   version_requirements: *id001
@@ -41,7 +51,6 @@ files:
 - MIT-LICENSE
 - README.rdoc
 - CHANGELOG
-has_rdoc: true
 homepage: http://github.com/collectiveidea/awesome_nested_set
 licenses: []
 
@@ -58,17 +67,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: An awesome nested set implementation for Active Record