shuber-acts_as_tree 1.0.0

data/CHANGELOG

@@ -0,0 +1,14 @@
+2009-01-15 - Sean Huber (shuber@huberry.com)
+  * Remove unused test/fixture files
+  * Remove nested active_record/acts/tree file structure
+  * Update README
+  * Add MIT-LICENSE
+  * Update documentation
+  * Clean up logic
+  * Gemify
+
+2008-08-18 - Sean Huber (shuber@huberry.com)
+	* Added is_root? instance method and tests
+
+2008-08-18 - Sean Huber (shuber@huberry.com)
+	* The foreign_key for "parent" can't be a reference to the current node or any of its children

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 David Heinemeier Hansson
+
+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,45 @@
+# acts\_as\_tree #
+
+Specify this `acts_as` extension if you want to model a tree structure by providing parent and children associations
+
+
+## Installation ##
+
+	gem install shuber-acts_as_tree --source http://gems.github.com
+	OR
+	script/plugin install git://github.com/shuber/acts_as_tree.git
+
+
+## Usage ##
+
+Requires a `:foreign_key` option which defaults to `:parent_id`
+
+	class Category < ActiveRecord::Base
+	  # schema
+	  #   id,        integer
+	  #   parent_id, integer
+	  #   name,      string
+	  
+	  acts_as_tree
+	end
+
+Also accepts `:order` and `:counter_cache` (defaults to `false`) options
+
+
+## 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

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test acts_as_tree gem/plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for acts_as_tree gem/plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'acts_as_tree'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.markdown')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

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

data/lib/acts_as_tree.rb

@@ -0,0 +1,125 @@
+module ActiveRecord
+  module Acts
+    module Tree
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+      
+      # Returns all children (recursively) of the current node
+      #
+      #   parent.all_children # [child1, child1_child1, child1_child2, child2, child2_child1, child3]
+      def all_children
+        self_and_all_children - [self]
+      end
+      
+      # Returns list of ancestors, starting from parent until root
+      #
+      #   subchild1.ancestors # [child1, root]
+      def ancestors
+        node, nodes = self, []
+        nodes << node = node.parent while node.parent
+        nodes
+      end
+      
+      # Checks if the current node is a root
+      #
+      #   parent.is_root? # true
+      #   child.is_root? # false
+      def is_root?
+        !new_record? && parent.nil?
+      end
+      
+      # Returns the root node of the tree
+      def root
+        node = self
+        node = node.parent while node.parent
+        node
+      end
+      
+      # Returns all siblings of the current node
+      #
+      #   subchild1.siblings # [subchild2]
+      def siblings
+        self_and_siblings - [self]
+      end
+      
+      # Returns all children (recursively) and a reference to the current node
+      #
+      #   parent.self_and_all_children # [parent, child1, child1_child1, child1_child2, child2, child2_child1, child3]
+      def self_and_all_children
+        children.inject([self]) { |array, child| array += child.self_and_all_children }.flatten
+      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
+      
+      module ClassMethods
+        # 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>all_children</tt> - Returns all of the children of the parent recursively
+        #   * <tt>self_and_all_children</tt> - Returns the parent and all of its children recursively
+        #
+        # 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 = {})
+          options = { :class_name => name, :counter_cache => nil, :foreign_key => :parent_id, :order => nil }.merge(options)
+          options[:order] = "#{table_name}.#{options[:order]} ASC" if options[:order].is_a?(Symbol)
+          
+          belongs_to :parent, :class_name => options[:class_name], :foreign_key => options[:foreign_key], :counter_cache => options[:counter_cache]
+          has_many :children, :class_name => options[:class_name], :foreign_key => options[:foreign_key], :order => options[:order], :dependent => :destroy
+          
+          named_scope :roots, :conditions => "#{table_name}.#{options[:foreign_key]} IS NULL", :order => options[:order]
+          
+          validate_on_update :ensure_foreign_key_does_not_reference_self_or_all_children
+          
+          define_method 'ensure_foreign_key_does_not_reference_self_or_all_children' do
+            if self_and_all_children.detect { |node| node.id == send(options[:foreign_key]) }
+              self.errors.add(options[:foreign_key], "can't be a reference to the current node or any of its children")
+              false
+            end
+          end
+        end
+        
+        # Returns the first root node
+        def root
+          roots.find(:first)
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActiveRecord::Acts::Tree

data/test/acts_as_tree_test.rb

@@ -0,0 +1,251 @@
+require 'test/unit'
+require 'rubygems'
+gem 'activerecord', '>= 2.1.0'
+require 'active_record'
+require File.dirname(__FILE__) + '/../lib/acts_as_tree'
+
+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", :dbfile => ":memory:")
+
+# AR keeps printing annoying schema statements
+$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
+    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 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 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.children, [@root_child1, @root_child2]
+    assert_equal @root_child1.children, [@child1_child]
+    assert_equal @child1_child.children, []
+    assert_equal @root_child2.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_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.children.size
+    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_all_children
+		assert_equal [@root_child1, @child1_child, @root_child2], @root1.all_children
+		assert_equal [@child1_child], @root_child1.all_children
+		assert_equal [], @child1_child.all_children
+	end
+	
+	def test_self_and_all_children
+		assert_equal [@root1, @root_child1, @child1_child, @root_child2], @root1.self_and_all_children
+		assert_equal [@child1_child], @child1_child.self_and_all_children
+	end
+
+	def test_should_not_reference_self_as_parent_id_on_update
+		@root1.parent_id = @root1.id
+		assert !@root1.save
+		assert @root1.errors.on(:parent_id)
+	end
+	
+	def test_should_not_reference_children_as_parent_id_on_update
+		@root1.parent_id = @root_child1.id
+		assert !@root1.save
+		assert @root1.errors.on(:parent_id)
+		
+		@root1.reload
+		@root1.parent_id = @child1_child.id
+		assert !@root1.save
+		assert @root1.errors.on(:parent_id)
+	end
+	
+	def test_is_root
+	  assert @root1.is_root?
+	  assert !@root_child1.is_root?
+	  assert !TreeMixin.new.is_root?
+  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.size
+      assert_equal 0, roots[1].children.size
+      assert_equal 0, roots[2].children.size
+    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,61 @@
+--- !ruby/object:Gem::Specification 
+name: shuber-acts_as_tree
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Sean Huber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-15 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Allows you to create tree structures with ActiveRecord
+email: shuber@huberry.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- init.rb
+- lib/acts_as_tree.rb
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+has_rdoc: false
+homepage: http://github.com/shuber/acts_as_tree
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Allows you to create tree structures with ActiveRecord
+test_files: 
+- test/acts_as_tree_test.rb