collectiveidea-awesome_nested_set 1.2.0 → 1.3.0

data/README.rdoc

@@ -1,6 +1,6 @@
 = AwesomeNestedSet
 
-Awesome Nested Set is an implementation of the nested set pattern for ActiveRecord models. It is replacement for acts_as_nested_set and BetterNestedSet, but awesomer.
+Awesome Nested Set is an implementation of the nested set pattern for ActiveRecord models. It is replacement for acts_as_nested_set and BetterNestedSet, but awesomer. It supports Rails 2.1 and later.
 
 == What makes this so awesome?
 
@@ -8,7 +8,7 @@ This is a new implementation of nested set based off of BetterNestedSet that fix
 
 == Installation
 
-If you are on Rails 2.1 or later:
+Install as a plugin:
 
   script/plugin install git://github.com/collectiveidea/awesome_nested_set.git
   
@@ -60,5 +60,20 @@ You can learn more about nested sets at:
   http://api.rubyonrails.com/classes/ActiveRecord/Acts/NestedSet/ClassMethods.html
   http://opensource.symetrie.com/trac/better_nested_set/
 
+== How to contribute
 
-Copyright (c) 2008 Collective Idea, released under the MIT license
+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/
+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/
+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

data/Rakefile

@@ -28,7 +28,7 @@ task :default => :test
 
 desc 'Test the awesome_nested_set plugin.'
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
+  t.libs += ['lib', 'test']
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
@@ -45,7 +45,7 @@ end
 namespace :test do
   desc "just rcov minus html output"
   Rcov::RcovTask.new(:coverage) do |t|
-    # t.libs << 'test'
+    t.libs << 'test'
     t.test_files = FileList['test/**/*_test.rb']
     t.output_dir = 'coverage'
     t.verbose = true

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/awesome_nested_set.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{awesome_nested_set}
-  s.version = "1.2.0"
+  s.version = "1.3.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.date = %q{2009-08-11}
   s.description = %q{An awesome nested set implementation for Active Record}
   s.email = %q{info@collectiveidea.com}
   s.extra_rdoc_files = [
@@ -22,10 +22,9 @@ Gem::Specification.new do |s|
      "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/application.rb",
      "test/awesome_nested_set/helper_test.rb",
      "test/awesome_nested_set_test.rb",
      "test/db/database.yml",
@@ -46,6 +45,7 @@ Gem::Specification.new do |s|
      "test/fixtures/categories.yml",
      "test/fixtures/departments.yml",
      "test/fixtures/notes.yml",
+     "test/application.rb",
      "test/awesome_nested_set/helper_test.rb",
      "test/awesome_nested_set_test.rb",
      "test/db/schema.rb",

data/lib/awesome_nested_set.rb

@@ -72,19 +72,23 @@ module CollectiveIdea #:nodoc:
             include InstanceMethods
             extend Columns
             extend ClassMethods
+            
+            belongs_to :parent, :class_name => self.base_class.class_name,
+              :foreign_key => parent_column_name
 
             attr_accessor :skip_before_destroy
           
             # no bulk assignment
             attr_protected  left_column_name.intern,
-                            right_column_name.intern, 
-                            parent_column_name.intern
+                            right_column_name.intern
                           
-            before_create :set_default_left_and_right
+            before_create  :set_default_left_and_right
+            before_save    :store_new_parent
+            after_save     :move_to_new_parent
             before_destroy :destroy_descendants
                           
             # no assignment to structure fields
-            [left_column_name, right_column_name, parent_column_name].each do |column|
+            [left_column_name, right_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."
@@ -283,11 +287,6 @@ module CollectiveIdea #:nodoc:
           self_and_ancestors.find(:first)
         end
 
-        # Returns the immediate parent
-        def parent
-          nested_set_scope.find_by_id(parent_id) if parent_id
-        end
-
         # Returns the array of all parents and self
         def self_and_ancestors
           nested_set_scope.scoped :conditions => [
@@ -434,6 +433,19 @@ module CollectiveIdea #:nodoc:
           self.class.base_class.scoped options
         end
         
+        def store_new_parent
+          @move_to_new_parent_id = parent_id_changed? ? parent_id : false
+          true # force callback to return true
+        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)
+          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

data/rails/init.rb

@@ -1,4 +1,3 @@
-require 'awesome_nested_set/compatability'
 require 'awesome_nested_set'
 
 ActiveRecord::Base.class_eval do

data/test/application.rb

@@ -0,0 +1 @@
+# This file is here to satisfy test_help from Rails < 2.3

data/test/awesome_nested_set/helper_test.rb

@@ -1,9 +1,9 @@
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 module CollectiveIdea
   module Acts #:nodoc:
     module NestedSet #:nodoc:
-      class AwesomeNestedSetTest < Test::Unit::TestCase
+      class AwesomeNestedSetTest < TestCaseClass
         include Helper
         fixtures :categories
         
@@ -38,4 +38,4 @@ module CollectiveIdea
       end
     end
   end
-end
+end

data/test/awesome_nested_set_test.rb

@@ -1,10 +1,10 @@
-require File.dirname(__FILE__) + '/test_helper'
+require 'test_helper'
 
 class Note < ActiveRecord::Base
   acts_as_nested_set :scope => [:notable_id, :notable_type]
 end
 
-class AwesomeNestedSetTest < Test::Unit::TestCase
+class AwesomeNestedSetTest < TestCaseClass
 
   class Default < ActiveRecord::Base
     acts_as_nested_set
@@ -66,15 +66,10 @@ class AwesomeNestedSetTest < Test::Unit::TestCase
     assert_raises(ActiveRecord::ActiveRecordError) { Category.new.rgt = 1 }
   end
   
-  def test_parent_column_protected_from_assignment
-    assert_raises(ActiveRecord::ActiveRecordError) { Category.new.parent_id = 1 }
-  end
-  
   def test_colums_protected_on_initialize
-    c = Category.new(:lft => 1, :rgt => 2, :parent_id => 3)
+    c = Category.new(:lft => 1, :rgt => 2)
     assert_nil c.lft
     assert_nil c.rgt
-    assert_nil c.parent_id
   end
   
   def test_scoped_appends_id
@@ -619,4 +614,58 @@ class AwesomeNestedSetTest < Test::Unit::TestCase
     assert Category.valid?
   end
   
+  def test_assigning_parent_id_on_create
+    category = Category.create!(:name => "Child", :parent_id => categories(:child_2).id)
+    assert_equal categories(:child_2), category.parent
+    assert_equal categories(:child_2).id, category.parent_id
+    assert_not_nil category.left
+    assert_not_nil category.right
+    assert Category.valid?
+  end
+
+  def test_assigning_parent_on_create
+    category = Category.create!(:name => "Child", :parent => categories(:child_2))
+    assert_equal categories(:child_2), category.parent
+    assert_equal categories(:child_2).id, category.parent_id
+    assert_not_nil category.left
+    assert_not_nil category.right
+    assert Category.valid?
+  end
+
+  def test_assigning_parent_id_to_nil_on_create
+    category = Category.create!(:name => "New Root", :parent_id => nil)
+    assert_nil category.parent
+    assert_nil category.parent_id
+    assert_not_nil category.left
+    assert_not_nil category.right
+    assert Category.valid?
+  end
+
+  def test_assigning_parent_id_on_update
+    category = categories(:child_2_1)
+    category.parent_id = categories(:child_3).id
+    category.save
+    assert_equal categories(:child_3), category.parent
+    assert_equal categories(:child_3).id, category.parent_id
+    assert Category.valid?
+  end
+
+  def test_assigning_parent_on_update
+    category = categories(:child_2_1)
+    category.parent = categories(:child_3)
+    category.save
+    assert_equal categories(:child_3), category.parent
+    assert_equal categories(:child_3).id, category.parent_id
+    assert Category.valid?
+  end
+
+  def test_assigning_parent_id_to_nil_on_update
+    category = categories(:child_2_1)
+    category.parent_id = nil
+    category.save
+    assert_nil category.parent
+    assert_nil category.parent_id
+    assert Category.valid?
+  end
+
 end

data/test/test_helper.rb

@@ -1,16 +1,16 @@
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 plugin_test_dir = File.dirname(__FILE__)
+RAILS_ROOT = plugin_test_dir
 
 require 'rubygems'
 require 'test/unit'
 require 'multi_rails_init'
-require 'active_record' 
-require 'action_controller'
-require 'action_view'
-require 'active_record/fixtures'
+require 'test_help'
 
 require plugin_test_dir + '/../init.rb'
 
+TestCaseClass = ActiveSupport::TestCase rescue Test::Unit::TestCase
+
 ActiveRecord::Base.logger = Logger.new(plugin_test_dir + "/debug.log")
 
 ActiveRecord::Base.configurations = YAML::load(IO.read(plugin_test_dir + "/db/database.yml"))
@@ -21,10 +21,10 @@ load(File.join(plugin_test_dir, "db", "schema.rb"))
 Dir["#{plugin_test_dir}/fixtures/*.rb"].each {|file| require file }
 
 
-class Test::Unit::TestCase #:nodoc:
+class TestCaseClass #:nodoc:
   self.fixture_path = File.dirname(__FILE__) + "/fixtures/"
   self.use_transactional_fixtures = true
   self.use_instantiated_fixtures  = false
   
   fixtures :categories, :notes, :departments
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: collectiveidea-awesome_nested_set
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Brandon Keepers
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-15 00:00:00 -07:00
+date: 2009-08-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,10 +41,9 @@ files:
 - 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/application.rb
 - test/awesome_nested_set/helper_test.rb
 - test/awesome_nested_set_test.rb
 - test/db/database.yml
@@ -56,6 +55,7 @@ files:
 - test/test_helper.rb
 has_rdoc: false
 homepage: http://github.com/collectiveidea/awesome_nested_set
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --main
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: An awesome nested set implementation for Active Record
@@ -88,6 +88,7 @@ test_files:
 - test/fixtures/categories.yml
 - test/fixtures/departments.yml
 - test/fixtures/notes.yml
+- test/application.rb
 - test/awesome_nested_set/helper_test.rb
 - test/awesome_nested_set_test.rb
 - test/db/schema.rb

data/lib/awesome_nested_set/compatability.rb

@@ -1,29 +0,0 @@
-# Rails <2.x doesn't define #except
-class Hash #:nodoc:
-  # Returns a new hash without the given keys.
-  def except(*keys)
-    clone.except!(*keys)
-  end unless method_defined?(:except)
-
-  # Replaces the hash without the given keys.
-  def except!(*keys)
-    keys.map! { |key| convert_key(key) } if respond_to?(:convert_key)
-    keys.each { |key| delete(key) }
-    self
-  end unless method_defined?(:except!)
-end
-
-# NamedScope is new to Rails 2.1
-unless defined? ActiveRecord::NamedScope
-  require 'awesome_nested_set/named_scope'
-  ActiveRecord::Base.class_eval do
-    include CollectiveIdea::NamedScope
-  end
-end
-
-# Rails 1.2.x doesn't define #quoted_table_name
-class ActiveRecord::Base  #:nodoc:
-  def self.quoted_table_name
-    self.connection.quote_column_name(self.table_name)
-  end unless methods.include?('quoted_table_name')
-end

data/lib/awesome_nested_set/named_scope.rb

@@ -1,140 +0,0 @@
-# Taken from Rails 2.1
-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:
-    #
-    #   Shirt.scoped(:conditions => {:color => 'red'}).scoped(:include => :washing_instructions)
-    #
-    # These anonymous scopes tend to be useful when procedurally generating complex queries, where passing
-    # intermediate values (scopes) around as first-class objects is convenient.
-    def self.included(base)
-      base.class_eval do
-        extend ClassMethods
-        named_scope :scoped, lambda { |scope| scope }
-      end
-    end
-
-    module ClassMethods #:nodoc:
-      def scopes
-        read_inheritable_attribute(:scopes) || write_inheritable_attribute(:scopes, {})
-      end
-
-      # Adds a class method for retrieving and querying objects. A scope represents a narrowing of a database query,
-      # such as <tt>:conditions => {:color => :red}, :select => 'shirts.*', :include => :washing_instructions</tt>.
-      #
-      #   class Shirt < ActiveRecord::Base
-      #     named_scope :red, :conditions => {:color => 'red'}
-      #     named_scope :dry_clean_only, :joins => :washing_instructions, :conditions => ['washing_instructions.dry_clean_only = ?', true]
-      #   end
-      # 
-      # The above calls to <tt>named_scope</tt> define class methods <tt>Shirt.red</tt> and <tt>Shirt.dry_clean_only</tt>. <tt>Shirt.red</tt>, 
-      # in effect, represents the query <tt>Shirt.find(:all, :conditions => {:color => 'red'})</tt>.
-      #
-      # Unlike Shirt.find(...), however, the object returned by <tt>Shirt.red</tt> is not an Array; it resembles the association object
-      # constructed by a <tt>has_many</tt> declaration. For instance, you can invoke <tt>Shirt.red.find(:first)</tt>, <tt>Shirt.red.count</tt>,
-      # <tt>Shirt.red.find(:all, :conditions => {:size => 'small'})</tt>. Also, just
-      # as with the association objects, name scopes acts like an Array, implementing Enumerable; <tt>Shirt.red.each(&block)</tt>,
-      # <tt>Shirt.red.first</tt>, and <tt>Shirt.red.inject(memo, &block)</tt> all behave as if Shirt.red really were an Array.
-      #
-      # These named scopes are composable. For instance, <tt>Shirt.red.dry_clean_only</tt> will produce all shirts that are both red and dry clean only.
-      # Nested finds and calculations also work with these compositions: <tt>Shirt.red.dry_clean_only.count</tt> returns the number of garments
-      # for which these criteria obtain. Similarly with <tt>Shirt.red.dry_clean_only.average(:thread_count)</tt>.
-      #
-      # All scopes are available as class methods on the ActiveRecord descendent upon which the scopes were defined. But they are also available to
-      # <tt>has_many</tt> associations. If,
-      #
-      #   class Person < ActiveRecord::Base
-      #     has_many :shirts
-      #   end
-      #
-      # then <tt>elton.shirts.red.dry_clean_only</tt> will return all of Elton's red, dry clean
-      # only shirts.
-      #
-      # Named scopes can also be procedural.
-      #
-      #   class Shirt < ActiveRecord::Base
-      #     named_scope :colored, lambda { |color|
-      #       { :conditions => { :color => color } }
-      #     }
-      #   end
-      #
-      # In this example, <tt>Shirt.colored('puce')</tt> finds all puce shirts.
-      #
-      # Named scopes can also have extensions, just as with <tt>has_many</tt> declarations:
-      #
-      #   class Shirt < ActiveRecord::Base
-      #     named_scope :red, :conditions => {:color => 'red'} do
-      #       def dom_id
-      #         'red_shirts'
-      #       end
-      #     end
-      #   end
-      #
-      #
-      # For testing complex named scopes, you can examine the scoping options using the
-      # <tt>proxy_options</tt> method on the proxy itself.
-      #
-      #   class Shirt < ActiveRecord::Base
-      #     named_scope :colored, lambda { |color|
-      #       { :conditions => { :color => color } }
-      #     }
-      #   end
-      #
-      #   expected_options = { :conditions => { :colored => 'red' } }
-      #   assert_equal expected_options, Shirt.colored('red').proxy_options
-      def named_scope(name, options = {}, &block)
-        scopes[name] = lambda do |parent_scope, *args|
-          Scope.new(parent_scope, case options
-            when Hash
-              options
-            when Proc
-              options.call(*args)
-          end, &block)
-        end
-        (class << self; self end).instance_eval do
-          define_method name do |*args|
-            scopes[name].call(self, *args)
-          end
-        end
-      end
-    end
-
-    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
-
-      def initialize(proxy_scope, options, &block)
-        [options[:extend]].flatten.each { |extension| extend extension } if options[:extend]
-        extend Module.new(&block) if block_given?
-        @proxy_scope, @proxy_options = proxy_scope, options.except(:extend)
-      end
-
-      def reload
-        load_found; self
-      end
-
-      protected
-      def proxy_found
-        @found || load_found
-      end
-
-      private
-      def method_missing(method, *args, &block)
-        if scopes.include?(method)
-          scopes[method].call(self, *args)
-        else
-          with_scope :find => proxy_options do
-            proxy_scope.send(method, *args, &block)
-          end
-        end
-      end
-
-      def load_found
-        @found = find(:all)
-      end
-    end
-  end
-end