collectiveidea-awesome_nested_set 1.1.1 → 1.2.0

data/.autotest

@@ -0,0 +1,13 @@
+Autotest.add_hook :initialize do |at|
+  at.clear_mappings
+
+  at.add_mapping %r%^lib/(.*)\.rb$% do |_, m|
+    at.files_matching %r%^test/#{m[1]}_test.rb$%
+  end
+
+  at.add_mapping(%r%^test/.*\.rb$%) {|filename, _| filename }
+
+  at.add_mapping %r%^test/fixtures/(.*)s.yml% do |_, _|
+    at.files_matching %r%^test/.*\.rb$%
+  end
+end

data/.gitignore

@@ -0,0 +1,5 @@
+awesome_nested_set.sqlite3.db
+test/debug.log
+rdoc
+coverage
+pkg

data/README.rdoc

@@ -4,18 +4,14 @@ Awesome Nested Set is an implementation of the nested set pattern for ActiveReco
 
 == What makes this so awesome?
 
-This is a new implementation of nested set based off of BetterNestedSet that fixes some bugs, removes tons of duplication, adds a few useful methods, adds STI support and adds 2 very helpful view helpers for select boxes.
+This is a new implementation of nested set based off of BetterNestedSet that fixes some bugs, removes tons of duplication, adds a few useful methods, and adds STI support.
 
 == Installation
 
-If you are on edge rails:
+If you are on Rails 2.1 or later:
 
   script/plugin install git://github.com/collectiveidea/awesome_nested_set.git
   
-If you are not on edge rails:
-
-  git clone git://github.com/collectiveidea/awesome_nested_set.git vendor/plugins/awesome_nested_set
-
 == Usage
 
 To make use of awesome_nested_set, your model needs to have 3 fields: lft, rgt, and parent_id:
@@ -44,14 +40,14 @@ Enable the nested set functionality by declaring acts_as_nested_set on your mode
 Run `rake rdoc` to generate the API docs and see CollectiveIdea::Acts::NestedSet::SingletonMethods for more info.
 
 == View Helper
-
-The view helper is called #nested_set_options. 
-
-Example usage:
-
-  <%= f.select :parent_id, nested_set_options(Category, @category) {|i| "#{'�' * i.level} #{i.name}" }) %>
-
-  <%= select_tag 'parent_id', options_for_select(nested_set_options(Category) {|i| "#{'�' * i.level} #{i.name}" } ) %>
+
+The view helper is called #nested_set_options. 
+
+Example usage:
+
+  <%= f.select :parent_id, nested_set_options(Category, @category) {|i| "#{'-' * i.level} #{i.name}" } %>
+
+  <%= select_tag 'parent_id', options_for_select(nested_set_options(Category) {|i| "#{'-' * i.level} #{i.name}" } ) %>
 
 See CollectiveIdea::Acts::NestedSet::Helper for more information about the helpers.
 

data/Rakefile

@@ -1,20 +1,28 @@
-require 'rake'
+begin
+  require 'jeweler'
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  exit 1
+end
 require 'rake/testtask'
 require 'rake/rdoctask'
-require 'rake/gempackagetask'
 require 'rcov/rcovtask'
 require "load_multi_rails_rake_tasks" 
 
-spec = eval(File.read("#{File.dirname(__FILE__)}/awesome_nested_set.gemspec"))
-PKG_NAME = spec.name
-PKG_VERSION = spec.version
- 
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_zip = true
-  pkg.need_tar = true
+Jeweler::Tasks.new do |s|
+  s.name = "awesome_nested_set"
+  s.summary = "An awesome nested set implementation for Active Record"
+  s.description = s.summary
+  s.email = "info@collectiveidea.com"
+  s.homepage = "http://github.com/collectiveidea/awesome_nested_set"
+  s.authors = ["Brandon Keepers", "Daniel Morrison"]
+  s.add_dependency "activerecord", ['>= 1.1']
+  s.has_rdoc = true
+  s.extra_rdoc_files = [ "README.rdoc"]
+  s.rdoc_options = ["--main", "README.rdoc", "--inline-source", "--line-numbers"]
+  s.test_files = Dir['test/**/*.{yml,rb}']
 end
 
-
 desc 'Default: run unit tests.'
 task :default => :test
 

data/VERSION

@@ -0,0 +1 @@
+1.2.0

data/awesome_nested_set.gemspec

@@ -0,0 +1,68 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{awesome_nested_set}
+  s.version = "1.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brandon Keepers", "Daniel Morrison"]
+  s.date = %q{2009-07-15}
+  s.description = %q{An awesome nested set implementation for Active Record}
+  s.email = %q{info@collectiveidea.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".autotest",
+     ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "awesome_nested_set.gemspec",
+     "init.rb",
+     "lib/awesome_nested_set.rb",
+     "lib/awesome_nested_set/compatability.rb",
+     "lib/awesome_nested_set/helper.rb",
+     "lib/awesome_nested_set/named_scope.rb",
+     "rails/init.rb",
+     "test/awesome_nested_set/helper_test.rb",
+     "test/awesome_nested_set_test.rb",
+     "test/db/database.yml",
+     "test/db/schema.rb",
+     "test/fixtures/categories.yml",
+     "test/fixtures/category.rb",
+     "test/fixtures/departments.yml",
+     "test/fixtures/notes.yml",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/collectiveidea/awesome_nested_set}
+  s.rdoc_options = ["--main", "README.rdoc", "--inline-source", "--line-numbers"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{An awesome nested set implementation for Active Record}
+  s.test_files = [
+    "test/db/database.yml",
+     "test/fixtures/categories.yml",
+     "test/fixtures/departments.yml",
+     "test/fixtures/notes.yml",
+     "test/awesome_nested_set/helper_test.rb",
+     "test/awesome_nested_set_test.rb",
+     "test/db/schema.rb",
+     "test/fixtures/category.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 1.1"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 1.1"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 1.1"])
+  end
+end

data/lib/awesome_nested_set.rb

@@ -1,4 +1,4 @@
-module CollectiveIdea
+module CollectiveIdea #:nodoc:
   module Acts #:nodoc:
     module NestedSet #:nodoc:
       def self.included(base)
@@ -66,31 +66,37 @@ module CollectiveIdea
           write_inheritable_attribute :acts_as_nested_set_options, options
           class_inheritable_reader :acts_as_nested_set_options
           
-          include InstanceMethods
-          include Comparable
-          include Columns
-          extend Columns
-          extend ClassMethods
-
-          # no bulk assignment
-          attr_protected  left_column_name.intern,
-                          right_column_name.intern, 
-                          parent_column_name.intern
+          unless self.is_a?(ClassMethods)
+            include Comparable
+            include Columns
+            include InstanceMethods
+            extend Columns
+            extend ClassMethods
+
+            attr_accessor :skip_before_destroy
+          
+            # no bulk assignment
+            attr_protected  left_column_name.intern,
+                            right_column_name.intern, 
+                            parent_column_name.intern
                           
-          before_create :set_default_left_and_right
-          before_destroy :prune_from_tree
+            before_create :set_default_left_and_right
+            before_destroy :destroy_descendants
                           
-          # no assignment to structure fields
-          [left_column_name, right_column_name, parent_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."
-              end
-            end_eval
-          end
+            # no assignment to structure fields
+            [left_column_name, right_column_name, parent_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."
+                end
+              end_eval
+            end
           
-          named_scope :roots, :conditions => {parent_column_name => nil}, :order => quoted_left_column_name
-          named_scope :leaves, :conditions => "#{quoted_right_column_name} - #{quoted_left_column_name} = 1", :order => quoted_left_column_name
+            named_scope :roots, :conditions => {parent_column_name => nil}, :order => quoted_left_column_name
+            named_scope :leaves, :conditions => "#{quoted_right_column_name} - #{quoted_left_column_name} = 1", :order => quoted_left_column_name
+
+            define_callbacks("before_move", "after_move") if self.respond_to?(:define_callbacks)
+          end
           
         end
         
@@ -263,6 +269,14 @@ module CollectiveIdea
         def <=>(x)
           left <=> x.left
         end
+        
+        # Redefine to act like active record
+        def ==(comparison_object)
+          comparison_object.equal?(self) ||
+            (comparison_object.instance_of?(self.class) &&
+              comparison_object.id == id &&
+              !comparison_object.new_record?)
+        end
 
         # Returns root
         def root
@@ -277,7 +291,7 @@ module CollectiveIdea
         # Returns the array of all parents and self
         def self_and_ancestors
           nested_set_scope.scoped :conditions => [
-            "#{self.class.table_name}.#{quoted_left_column_name} <= ? AND #{self.class.table_name}.#{quoted_right_column_name} >= ?", left, right
+            "#{self.class.quoted_table_name}.#{quoted_left_column_name} <= ? AND #{self.class.quoted_table_name}.#{quoted_right_column_name} >= ?", left, right
           ]
         end
 
@@ -298,7 +312,7 @@ module CollectiveIdea
 
         # Returns a set of all of its nested children which do not have children  
         def leaves
-          descendants.scoped :conditions => "#{self.class.table_name}.#{quoted_right_column_name} - #{self.class.table_name}.#{quoted_left_column_name} = 1"
+          descendants.scoped :conditions => "#{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
@@ -310,7 +324,7 @@ module CollectiveIdea
         # Returns a set of itself and all of its nested children
         def self_and_descendants
           nested_set_scope.scoped :conditions => [
-            "#{self.class.table_name}.#{quoted_left_column_name} >= ? AND #{self.class.table_name}.#{quoted_right_column_name} <= ?", left, right
+            "#{self.class.quoted_table_name}.#{quoted_left_column_name} >= ? AND #{self.class.quoted_table_name}.#{quoted_right_column_name} <= ?", left, right
           ]
         end
 
@@ -349,14 +363,13 @@ module CollectiveIdea
 
         # Find the first sibling to the left
         def left_sibling
-          siblings.find(:first, :conditions => ["#{self.class.table_name}.#{quoted_left_column_name} < ?", left],
-            :order => "#{self.class.table_name}.#{quoted_left_column_name} DESC")
+          siblings.find(:first, :conditions => ["#{self.class.quoted_table_name}.#{quoted_left_column_name} < ?", left],
+            :order => "#{self.class.quoted_table_name}.#{quoted_left_column_name} DESC")
         end
 
         # Find the first sibling to the right
         def right_sibling
-          siblings.find(:first, :conditions => ["#{self.class.table_name}.#{quoted_left_column_name} > ?", left],
-            :order => quoted_left_column_name)
+          siblings.find(:first, :conditions => ["#{self.class.quoted_table_name}.#{quoted_left_column_name} > ?", left])
         end
 
         # Shorthand method for finding the left sibling and moving to the left of it.
@@ -406,7 +419,7 @@ module CollectiveIdea
       protected
       
         def without_self(scope)
-          scope.scoped :conditions => ["#{self.class.table_name}.#{self.class.primary_key} != ?", self]
+          scope.scoped :conditions => ["#{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
@@ -431,29 +444,38 @@ module CollectiveIdea
       
         # 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 prune_from_tree
-          return if right.nil? || left.nil?
-          diff = right - left + 1
-
-          delete_method = acts_as_nested_set_options[:dependent] == :destroy ?
-            :destroy_all : :delete_all
-
+        def destroy_descendants
+          return if right.nil? || left.nil? || skip_before_destroy
+          
           self.class.base_class.transaction do
-            nested_set_scope.send(delete_method,
-              ["#{quoted_left_column_name} > ? AND #{quoted_right_column_name} < ?",
-                left, right]
-            )
+            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]
+              )
+            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]
+              ["#{quoted_left_column_name} > ?", right]
             )
             nested_set_scope.update_all(
               ["#{quoted_right_column_name} = (#{quoted_right_column_name} - ?)", diff],
-              ["#{quoted_right_column_name} >= ?", right]
+              ["#{quoted_right_column_name} > ?", 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}, " +
@@ -462,7 +484,7 @@ module CollectiveIdea
         
         def move_to(target, position)
           raise ActiveRecord::ActiveRecordError, "You cannot move a new node" if self.new_record?
-
+          return if callback(:before_move) == false
           transaction do
             if target.is_a? self.class.base_class
               target.reload_nested_set
@@ -525,6 +547,7 @@ module CollectiveIdea
           end
           target.reload_nested_set if target
           self.reload_nested_set
+          callback(:after_move)
         end
 
       end

data/lib/awesome_nested_set/compatability.rb

@@ -1,5 +1,5 @@
 # Rails <2.x doesn't define #except
-class Hash
+class Hash #:nodoc:
   # Returns a new hash without the given keys.
   def except(*keys)
     clone.except!(*keys)
@@ -22,7 +22,7 @@ unless defined? ActiveRecord::NamedScope
 end
 
 # Rails 1.2.x doesn't define #quoted_table_name
-class ActiveRecord::Base
+class ActiveRecord::Base  #:nodoc:
   def self.quoted_table_name
     self.connection.quote_column_name(self.table_name)
   end unless methods.include?('quoted_table_name')

data/lib/awesome_nested_set/helper.rb

@@ -1,9 +1,8 @@
-module CollectiveIdea
+module CollectiveIdea #:nodoc:
   module Acts #:nodoc:
     module NestedSet #:nodoc:
       # This module provides some helpers for the model classes using acts_as_nested_set.
-      # It is included by default in all views. If you need to remove it, edit the last line
-      # of init.rb.
+      # It is included by default in all views.
       #
       module Helper
         # Returns options for select.

data/lib/awesome_nested_set/named_scope.rb

@@ -1,6 +1,6 @@
 # Taken from Rails 2.1
-module CollectiveIdea
-  module NamedScope
+module CollectiveIdea #:nodoc:
+  module NamedScope #:nodoc:
     # All subclasses of ActiveRecord::Base have two named_scopes:
     # * <tt>all</tt>, which is similar to a <tt>find(:all)</tt> query, and
     # * <tt>scoped</tt>, which allows for the creation of anonymous scopes, on the fly:
@@ -16,7 +16,7 @@ module CollectiveIdea
       end
     end
 
-    module ClassMethods
+    module ClassMethods #:nodoc:
       def scopes
         read_inheritable_attribute(:scopes) || write_inheritable_attribute(:scopes, {})
       end
@@ -101,7 +101,7 @@ module CollectiveIdea
       end
     end
 
-    class Scope
+    class Scope #:nodoc:
       attr_reader :proxy_scope, :proxy_options
       [].methods.each { |m| delegate m, :to => :proxy_found unless m =~ /(^__|^nil\?|^send|class|extend|find|count|sum|average|maximum|minimum|paginate)/ }
       delegate :scopes, :with_scope, :to => :proxy_scope

data/test/awesome_nested_set_test.rb

@@ -591,4 +591,32 @@ class AwesomeNestedSetTest < Test::Unit::TestCase
     assert_equal ["\"notable_id\"", "\"notable_type\""], Note.quoted_scope_column_names
   end
   
+  def test_equal_in_same_scope
+    assert_equal notes(:scope1), notes(:scope1)
+    assert_not_equal notes(:scope1), notes(:child_1)
+  end
+  
+  def test_equal_in_different_scopes
+    assert_not_equal notes(:scope1), notes(:scope2)
+  end
+  
+  def test_delete_does_not_invalidate
+    Category.acts_as_nested_set_options[:dependent] = :delete
+    categories(:child_2).destroy
+    assert Category.valid?
+  end
+
+  def test_destroy_does_not_invalidate
+    Category.acts_as_nested_set_options[:dependent] = :destroy
+    categories(:child_2).destroy
+    assert Category.valid?
+  end
+
+  def test_destroy_multiple_times_does_not_invalidate
+    Category.acts_as_nested_set_options[:dependent] = :destroy
+    categories(:child_2).destroy
+    categories(:child_2).destroy
+    assert Category.valid?
+  end
+  
 end

data/test/fixtures/notes.yml

@@ -32,7 +32,7 @@ child_3:
 scope2:
   id: 5
   body: Top Level 2
-  lft: 11
-  rgt: 12
+  lft: 1
+  rgt: 2
   notable_id: 1
   notable_type: Departments

data/test/test_helper.rb

@@ -4,7 +4,6 @@ plugin_test_dir = File.dirname(__FILE__)
 require 'rubygems'
 require 'test/unit'
 require 'multi_rails_init'
-# gem 'activerecord', '>= 2.0'
 require 'active_record' 
 require 'action_controller'
 require 'action_view'

metadata

@@ -1,19 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: collectiveidea-awesome_nested_set
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors: 
-- Collective Idea
+- Brandon Keepers
+- Daniel Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-10-09 00:00:00 -07:00
+date: 2009-07-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -21,7 +23,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "1.1"
     version: 
-description: An awesome replacement for acts_as_nested_set and better_nested_set.
+description: An awesome nested set implementation for Active Record
 email: info@collectiveidea.com
 executables: []
 
@@ -30,26 +32,30 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
-- init.rb
+- .autotest
+- .gitignore
 - MIT-LICENSE
-- Rakefile
 - README.rdoc
+- Rakefile
+- VERSION
+- awesome_nested_set.gemspec
+- init.rb
 - lib/awesome_nested_set.rb
 - lib/awesome_nested_set/compatability.rb
 - lib/awesome_nested_set/helper.rb
 - lib/awesome_nested_set/named_scope.rb
 - rails/init.rb
-- test/awesome_nested_set_test.rb
-- test/test_helper.rb
 - test/awesome_nested_set/helper_test.rb
+- test/awesome_nested_set_test.rb
 - test/db/database.yml
 - test/db/schema.rb
 - test/fixtures/categories.yml
 - test/fixtures/category.rb
 - test/fixtures/departments.yml
 - test/fixtures/notes.yml
-has_rdoc: true
-homepage: http://collectiveidea.com
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/collectiveidea/awesome_nested_set
 post_install_message: 
 rdoc_options: 
 - --main
@@ -75,15 +81,15 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
-summary: An awesome replacement for acts_as_nested_set and better_nested_set.
+specification_version: 3
+summary: An awesome nested set implementation for Active Record
 test_files: 
-- test/awesome_nested_set_test.rb
-- test/test_helper.rb
-- test/awesome_nested_set/helper_test.rb
 - test/db/database.yml
-- test/db/schema.rb
 - test/fixtures/categories.yml
-- test/fixtures/category.rb
 - test/fixtures/departments.yml
 - test/fixtures/notes.yml
+- test/awesome_nested_set/helper_test.rb
+- test/awesome_nested_set_test.rb
+- test/db/schema.rb
+- test/fixtures/category.rb
+- test/test_helper.rb