acts_as_tree_rails3 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,18 @@
+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.markdown

@@ -0,0 +1,27 @@
+# acts_as_tree for Rails 3 # 
+
+Specify this +acts_as+ extension if you want to model a tree structure by providing a parent association and a children
+association. This requires that you have a foreign key column, which by default is called +parent_id+.
+
+  class Category < ActiveRecord::Base
+    acts_as_tree :order => "name"
+  end
+
+  Example:
+  root
+   \_ child1
+        \_ subchild1
+        \_ subchild2
+
+  root      = Category.create("name" => "root")
+  child1    = root.children.create("name" => "child1")
+  subchild1 = child1.children.create("name" => "subchild1")
+
+  root.parent   # => nil
+  child1.parent # => root
+  root.children # => [child1]
+  root.children.first.children.first # => subchild1
+
+Copyright (c) 2007 David Heinemeier Hansson, released under the MIT license  
+
+Includes patch from http://dev.rubyonrails.org/ticket/1924

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "acts_as_tree_rails3"
+    gem.summary = %Q{Make your model act as a tree structure}
+    gem.description = %Q{Model gets: root, siblings, ancestors, descendants and other methods for tree navigation}
+    gem.email = "jim@saturnflyer.com"
+    gem.homepage = "http://github.com/saturnflyer/acts_as_tree"
+    gem.authors = ["David Heinemeier Hansson",'and others']
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "acts_as_tree #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/lib/active_record/acts/tree.rb

@@ -0,0 +1,186 @@
+module ActiveRecord
+  module Acts
+    module Tree
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      # Specify this +acts_as+ extension if you want to model a tree structure by providing a parent association and a children
+      # association. This requires that you have a foreign key column, which by default is called +parent_id+.
+      #
+      #   class Category < ActiveRecord::Base
+      #     acts_as_tree :order => "name"
+      #   end
+      #
+      #   Example:
+      #   root
+      #    \_ child1
+      #         \_ subchild1
+      #         \_ subchild2
+      #
+      #   root      = Category.create("name" => "root")
+      #   child1    = root.children.create("name" => "child1")
+      #   subchild1 = child1.children.create("name" => "subchild1")
+      #
+      #   root.parent   # => nil
+      #   child1.parent # => root
+      #   root.children # => [child1]
+      #   root.children.first.children.first # => subchild1
+      #
+      # In addition to the parent and children associations, the following instance methods are added to the class
+      # after calling <tt>acts_as_tree</tt>:
+      # * <tt>siblings</tt> - Returns all the children of the parent, excluding the current node (<tt>[subchild2]</tt> when called on <tt>subchild1</tt>)
+      # * <tt>self_and_siblings</tt> - Returns all the children of the parent, including the current node (<tt>[subchild1, subchild2]</tt> when called on <tt>subchild1</tt>)
+      # * <tt>ancestors</tt> - Returns all the ancestors of the current node (<tt>[child1, root]</tt> when called on <tt>subchild2</tt>)
+      # * <tt>root</tt> - Returns the root of the current node (<tt>root</tt> when called on <tt>subchild2</tt>)
+      # * <tt>descendants</tt> - Returns a flat list of the descendants of the current node (<tt>[child1, subchild1, subchild2]</tt> when called on <tt>root</tt>)
+      module ClassMethods
+        # Configuration options are:
+        #
+        # * <tt>foreign_key</tt> - specifies the column name to use for tracking of the tree (default: +parent_id+)
+        # * <tt>order</tt> - makes it possible to sort the children according to this SQL snippet.
+        # * <tt>counter_cache</tt> - keeps a count in a +children_count+ column if set to +true+ (default: +false+).
+        def acts_as_tree(options = {})
+          configuration = {
+            :foreign_key => "parent_id",
+            :order => nil,
+            :counter_cache => nil,
+            :dependent => :destroy,
+            :touch => false
+          }
+          configuration.update(options) if options.is_a?(Hash)
+          
+          # facebooker seems unhappy with :touch
+          if configuration[:touch]
+            belongs_to :parent,
+                       :class_name => name,
+                       :foreign_key => configuration[:foreign_key],
+                       :counter_cache => configuration[:counter_cache],
+                       :touch => configuration[:touch]
+          else
+            belongs_to :parent,
+                       :class_name => name,
+                       :foreign_key => configuration[:foreign_key],
+                       :counter_cache => configuration[:counter_cache]
+          end
+          
+          has_many :children,
+                   :class_name => name,
+                   :foreign_key => configuration[:foreign_key],
+                   :order => configuration[:order],
+                   :dependent => configuration[:dependent]
+          
+          class_eval <<-EOV
+            include ActiveRecord::Acts::Tree::InstanceMethods
+            
+            scope       :roots,
+                        :conditions => "#{configuration[:foreign_key]} IS NULL",
+                        :order => #{configuration[:order].nil? ? "nil" : %Q{"#{configuration[:order]}"}}
+            
+            after_save :update_level_cache
+            after_update :update_parents_counter_cache
+            
+            def self.root
+              roots.first
+            end
+            
+            def self.childless
+              nodes = []
+              
+              find(:all).each do |node|
+                nodes << node if node.children.empty?
+              end
+              
+              nodes
+            end
+            
+            validates_each "#{configuration[:foreign_key]}" do |record, attr, value|
+              if value
+                if record.id == value
+                  record.errors.add attr, "cannot be it's own id"
+                elsif record.descendants.map {|c| c.id}.include?(value)
+                  record.errors.add attr, "cannot be a descendant's id"
+                end
+              end
+            end
+          EOV
+        end
+      end
+      
+      module InstanceMethods
+        # Returns list of ancestors, starting from parent until root.
+        #
+        #   subchild1.ancestors # => [child1, root]
+        def ancestors
+          node, nodes = self, []
+          nodes << node = node.parent until node.parent.nil? and return nodes
+        end
+        
+        def root?
+          parent == nil
+        end
+        
+        def leaf?
+          children.length == 0
+        end
+        
+        # Returns the root node of the tree.
+        def root
+          node = self
+          node = node.parent until node.parent.nil? and return node
+        end
+        
+        # Returns all siblings of the current node.
+        #
+        #   subchild1.siblings # => [subchild2]
+        def siblings
+          self_and_siblings - [self]
+        end
+        
+        # Returns all siblings and a reference to the current node.
+        #
+        #   subchild1.self_and_siblings # => [subchild1, subchild2]
+        def self_and_siblings
+          parent ? parent.children : self.class.roots
+        end
+        
+        # Returns a flat list of the descendants of the current node.
+        #
+        #   root.descendants # => [child1, subchild1, subchild2]
+        def descendants(node=self)
+          nodes = []
+          nodes << node unless node == self
+          
+          node.children.each do |child|
+            nodes += descendants(child)
+          end
+            
+          nodes.compact
+        end
+        
+        def childless
+          self.descendants.collect{|d| d.children.empty? ? d : nil}.compact
+        end
+        
+        private
+        
+        def update_parents_counter_cache
+          if self.respond_to?(:children_count) && parent_id_changed?
+            self.class.decrement_counter(:children_count, parent_id_was)
+            self.class.increment_counter(:children_count, parent_id)
+          end
+        end
+        
+        def update_level_cache
+          if respond_to?(:level_cache) && parent_id_changed?
+            _level_cache = ancestors.length
+            
+            if level_cache != _level_cache
+              self.class.update_all("level_cache = #{_level_cache}", ['id = ?', id])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_tree_rails3.rb

@@ -0,0 +1,2 @@
+require 'active_record/acts/tree'
+ActiveRecord::Base.send :include, ActiveRecord::Acts::Tree

data/rails/init.rb

@@ -0,0 +1 @@
+require 'acts_as_tree_rails3'

data/test/acts_as_tree_test.rb

@@ -0,0 +1,311 @@
+require 'test/unit'
+
+require 'rubygems'
+require 'active_record'
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require File.dirname(__FILE__) + '/../init'
+
+class Test::Unit::TestCase
+  def assert_queries(num = 1)
+    $query_count = 0
+    yield
+  ensure
+    assert_equal num, $query_count, "#{$query_count} instead of #{num} queries were executed."
+  end
+
+  def assert_no_queries(&block)
+    assert_queries(0, &block)
+  end
+end
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+# AR keeps printing annoying schema statements
+$stdout_orig = $stdout
+$stdout = StringIO.new
+
+def setup_db
+  ActiveRecord::Base.logger
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :mixins do |t|
+      t.column :type, :string
+      t.column :parent_id, :integer
+      t.column :children_count, :integer, :default => 0
+      t.column :level_cache, :integer, :default => 0
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Mixin < ActiveRecord::Base
+end
+
+class TreeMixin < Mixin
+  acts_as_tree :foreign_key => "parent_id", :order => "id"
+end
+
+class TreeMixinWithCounterCache < Mixin
+  acts_as_tree :foreign_key => "parent_id", :order => "id", :counter_cache => :children_count
+end
+
+class TreeMixinWithoutOrder < Mixin
+  acts_as_tree :foreign_key => "parent_id"
+end
+
+class RecursivelyCascadedTreeMixin < Mixin
+  acts_as_tree :foreign_key => "parent_id"
+  has_one :first_child, :class_name => 'RecursivelyCascadedTreeMixin', :foreign_key => :parent_id
+end
+
+class TreeMixinNullify < Mixin
+  acts_as_tree :foreign_key => "parent_id", :order => "id", :dependent => :nullify
+end
+
+class TreeTest < Test::Unit::TestCase
+  def setup
+    setup_db
+    @root1 = TreeMixin.create!
+    @root_child1 = TreeMixin.create! :parent_id => @root1.id
+    @child1_child = TreeMixin.create! :parent_id => @root_child1.id
+    @root_child2 = TreeMixin.create! :parent_id => @root1.id
+    @root2 = TreeMixin.create!
+    @root3 = TreeMixin.create!
+  end
+  
+  def teardown
+    teardown_db
+  end
+  
+  def test_children
+    assert_equal @root1.reload.children, [@root_child1, @root_child2]
+    assert_equal @root_child1.reload.children, [@child1_child]
+    assert_equal @child1_child.reload.children, []
+    assert_equal @root_child2.reload.children, []
+  end
+  
+  def test_parent
+    assert_equal @root_child1.parent, @root1
+    assert_equal @root_child1.parent, @root_child2.parent
+    assert_nil @root1.parent
+  end
+  
+  def test_nullify
+    root4 = TreeMixinNullify.create!
+    root4_child = TreeMixinNullify.create! :parent_id => root4.id
+    assert_equal 2, TreeMixinNullify.count
+    assert_equal root4.id, root4_child.parent_id
+    root4.destroy
+    assert_equal 1, TreeMixinNullify.count
+    assert_nil root4_child.reload.parent_id
+  end
+  
+  def test_delete
+    assert_equal 6, TreeMixin.count
+    @root1.destroy
+    assert_equal 2, TreeMixin.count
+    @root2.destroy
+    @root3.destroy
+    assert_equal 0, TreeMixin.count
+  end
+  
+  def test_insert
+    @extra = @root1.children.create
+    
+    assert @extra
+    
+    assert_equal @extra.parent, @root1
+    
+    assert_equal 3, @root1.reload.children.count
+    assert @root1.children.include?(@extra)
+    assert @root1.children.include?(@root_child1)
+    assert @root1.children.include?(@root_child2)
+  end
+  
+  def test_ancestors
+    assert_equal [], @root1.ancestors
+    assert_equal [@root1], @root_child1.ancestors
+    assert_equal [@root_child1, @root1], @child1_child.ancestors
+    assert_equal [@root1], @root_child2.ancestors
+    assert_equal [], @root2.ancestors
+    assert_equal [], @root3.ancestors
+  end
+  
+  def test_root
+    assert_equal @root1, TreeMixin.root
+    assert_equal @root1, @root1.root
+    assert_equal @root1, @root_child1.root
+    assert_equal @root1, @child1_child.root
+    assert_equal @root1, @root_child2.root
+    assert_equal @root2, @root2.root
+    assert_equal @root3, @root3.root
+  end
+  
+  def test_roots
+    assert_equal [@root1, @root2, @root3], TreeMixin.roots
+  end
+  
+  def test_siblings
+    assert_equal [@root2, @root3], @root1.siblings
+    assert_equal [@root_child2], @root_child1.siblings
+    assert_equal [], @child1_child.siblings
+    assert_equal [@root_child1], @root_child2.siblings
+    assert_equal [@root1, @root3], @root2.siblings
+    assert_equal [@root1, @root2], @root3.siblings
+  end
+  
+  def test_self_and_siblings
+    assert_equal [@root1, @root2, @root3], @root1.self_and_siblings
+    assert_equal [@root_child1, @root_child2], @root_child1.self_and_siblings
+    assert_equal [@child1_child], @child1_child.self_and_siblings
+    assert_equal [@root_child1, @root_child2], @root_child2.self_and_siblings
+    assert_equal [@root1, @root2, @root3], @root2.self_and_siblings
+    assert_equal [@root1, @root2, @root3], @root3.self_and_siblings
+  end
+  
+  def test_root
+    assert_equal true, @root1.root?
+    assert_equal false, @child1_child.root?
+  end
+  
+  def test_leaf
+    assert_equal false, @root1.leaf?
+    assert_equal true, @child1_child.leaf?
+  end
+end
+
+class TreeTestWithCounterCache < Test::Unit::TestCase
+  def setup
+    teardown_db
+    setup_db
+    @root = TreeMixinWithCounterCache.create!
+    @child1 = TreeMixinWithCounterCache.create! :parent_id => @root.id
+    @child1_child1 = TreeMixinWithCounterCache.create! :parent_id => @child1.id
+    @child2 = TreeMixinWithCounterCache.create! :parent_id => @root.id
+  end
+  
+  def teardown
+    teardown_db
+  end
+  
+  def test_counter_cache
+    assert_equal 2, @root.reload.children_count
+    assert_equal 1, @child1.reload.children_count
+  end
+  
+  def test_update_parents_counter_cache
+    @child1_child1.update_attributes(:parent_id => @root.id)
+    assert_equal 3, @root.reload.children_count
+    assert_equal 0, @child1.reload.children_count
+  end
+  
+end
+
+class TreeTestWithLevelCache < Test::Unit::TestCase
+  def setup
+    teardown_db
+    setup_db
+    @root1 = TreeMixin.create!
+    @root_child1 = TreeMixin.create! :parent_id => @root1.id
+    @child1_child = TreeMixin.create! :parent_id => @root_child1.id
+    @root_child2 = TreeMixin.create! :parent_id => @root1.id
+    @root2 = TreeMixin.create!
+  end
+  
+  def teardown
+    teardown_db
+  end
+  
+  def test_level_cache
+    assert_equal 0, @root1.reload.level_cache
+    assert_equal 1, @root_child1.reload.level_cache
+    assert_equal 2, @child1_child.reload.level_cache
+    assert_equal 0, @root2.reload.level_cache
+  end
+  
+  def test_level_cache_are_updated
+    @child1_child.reload.parent_id = nil
+    @child1_child.save
+    
+    @root2.reload.parent_id = @root_child2.reload.id
+    @root2.save
+    
+    assert_equal 0, @root1.reload.level_cache
+    assert_equal 1, @root_child1.reload.level_cache
+    assert_equal 0, @child1_child.reload.level_cache
+    assert_equal 2, @root2.reload.level_cache
+  end
+end
+
+class TreeTestWithEagerLoading < Test::Unit::TestCase
+  
+  def setup
+    teardown_db
+    setup_db
+    @root1 = TreeMixin.create!
+    @root_child1 = TreeMixin.create! :parent_id => @root1.id
+    @child1_child = TreeMixin.create! :parent_id => @root_child1.id
+    @root_child2 = TreeMixin.create! :parent_id => @root1.id
+    @root2 = TreeMixin.create!
+    @root3 = TreeMixin.create!
+    
+    @rc1 = RecursivelyCascadedTreeMixin.create!
+    @rc2 = RecursivelyCascadedTreeMixin.create! :parent_id => @rc1.id
+    @rc3 = RecursivelyCascadedTreeMixin.create! :parent_id => @rc2.id
+    @rc4 = RecursivelyCascadedTreeMixin.create! :parent_id => @rc3.id
+  end
+  
+  def teardown
+    teardown_db
+  end
+  
+  def test_eager_association_loading
+    roots = TreeMixin.find(:all, :include => :children, :conditions => "mixins.parent_id IS NULL", :order => "mixins.id")
+    assert_equal [@root1, @root2, @root3], roots
+    assert_no_queries do
+      assert_equal 2, roots[0].children.count
+      assert_equal 0, roots[1].children.count
+      assert_equal 0, roots[2].children.count
+    end
+  end
+  
+  def test_eager_association_loading_with_recursive_cascading_three_levels_has_many
+    root_node = RecursivelyCascadedTreeMixin.find(:first, :include => { :children => { :children => :children } }, :order => 'mixins.id')
+    assert_equal @rc4, assert_no_queries { root_node.children.first.children.first.children.first }
+  end
+  
+  def test_eager_association_loading_with_recursive_cascading_three_levels_has_one
+    root_node = RecursivelyCascadedTreeMixin.find(:first, :include => { :first_child => { :first_child => :first_child } }, :order => 'mixins.id')
+    assert_equal @rc4, assert_no_queries { root_node.first_child.first_child.first_child }
+  end
+  
+  def test_eager_association_loading_with_recursive_cascading_three_levels_belongs_to
+    leaf_node = RecursivelyCascadedTreeMixin.find(:first, :include => { :parent => { :parent => :parent } }, :order => 'mixins.id DESC')
+    assert_equal @rc1, assert_no_queries { leaf_node.parent.parent.parent }
+  end
+end
+
+class TreeTestWithoutOrder < Test::Unit::TestCase
+  def setup
+    setup_db
+    @root1 = TreeMixinWithoutOrder.create!
+    @root2 = TreeMixinWithoutOrder.create!
+  end
+  
+  def teardown
+    teardown_db
+  end
+  
+  def test_root
+    assert [@root1, @root2].include?(TreeMixinWithoutOrder.root)
+  end
+  
+  def test_roots
+    assert_equal [], [@root1, @root2] - TreeMixinWithoutOrder.roots
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_tree_rails3
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- David Heinemeier Hansson
+- and others
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-19 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: "Model gets: root, siblings, ancestors, descendants and other methods for tree navigation"
+email: jim@saturnflyer.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- init.rb
+- lib/active_record/acts/tree.rb
+- lib/acts_as_tree_rails3.rb
+- rails/init.rb
+- test/acts_as_tree_test.rb
+has_rdoc: true
+homepage: http://github.com/saturnflyer/acts_as_tree
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Make your model act as a tree structure
+test_files: 
+- test/acts_as_tree_test.rb