mongo_mapper_acts_as_tree 0.1

data/README.rdoc

@@ -0,0 +1,49 @@
+= mongo_mapper_acts_as_tree
+
+This is a port of classic Rails {acts_as_tree}[http://github.com/rails/acts_as_tree] to Mongo Mapper. Specify this MongoMapper plugin 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, which by default is called parent_id.
+
+It has (almost) the same functionality and passes the original test-suite. Scope needs to be defined as symbol or array of symbols. It does not work for Embedded Documents. Please note, it is not yet optimized and therefore issues more queries than necessary.
+
+== Installation
+
+mongo_mapper_acts_as_list is available as RubyGem:
+
+  gem install mongo_mapper_acts_as_tree
+  
+== Example
+
+  class Category
+    include MongoMapper::Document
+
+    plugin MongoMapper::Plugins::ActsAsTree
+
+    key :parent_id, ObjectId
+    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
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Original Rails acts_as_tree Copyright (c) 2007 David Heinemeier Hansson, released under the MIT license

data/lib/mongo_mapper/plugins/acts_as_tree.rb

@@ -0,0 +1,63 @@
+module MongoMapper
+  module Plugins
+    module ActsAsTree
+      
+      require 'mongo_mapper'
+      
+      module ClassMethods
+        def acts_as_tree(options = {})
+          configuration = { :foreign_key => :parent_id, :order => nil, :counter_cache => nil }
+          configuration.update(options) if options.is_a?(Hash)
+
+          belongs_to :parent, :class_name => name, :foreign_key => configuration[:foreign_key], :counter_cache => configuration[:counter_cache]
+          many :children, :class_name => name, :foreign_key => configuration[:foreign_key], :order => configuration[:order], :dependent => :destroy
+
+          class_eval <<-EOV
+            include MongoMapper::Plugins::ActsAsTree::InstanceMethods
+
+            def self.roots
+              where("#{configuration[:foreign_key]}".to_sym => nil).sort("#{configuration[:order]}").all
+            end
+
+            def self.root
+              where("#{configuration[:foreign_key]}".to_sym => nil).sort("#{configuration[:order]}").first
+            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 while node.parent?
+          nodes
+        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 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
+      end
+      
+    end
+  end
+end

data/lib/mongo_mapper/plugins/version.rb

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+module MongoMapper
+  module Plugins
+    module ActsAsTree
+      Version = '0.1'
+    end
+  end
+end

data/test/acts_as_tree_test.rb

@@ -0,0 +1,202 @@
+require 'test_helper'
+
+
+
+# SETUP TEST
+
+# class ActiveSupport::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
+
+
+
+# SETUP CLASSES
+
+class Mixin
+  include MongoMapper::Document
+  plugin MongoMapper::Plugins::ActsAsTree
+  key :parent_id, ObjectId
+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
+
+
+
+# TESTS
+
+class TreeTest < ActiveSupport::TestCase
+  
+  def setup
+    @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 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 @root1.parent.nil?
+  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           
+end
+
+
+# SKIP THIS AS THERE IS NO EAGER LOADING IN MONGOMAPPER
+
+# 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 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 < ActiveSupport::TestCase
+  
+  def setup                               
+    @root1 = TreeMixinWithoutOrder.create!
+    @root2 = TreeMixinWithoutOrder.create!
+  end
+
+  def test_root
+    assert [@root1, @root2].include?(TreeMixinWithoutOrder.root)
+  end
+  
+  def test_roots
+    assert_equal [], [@root1, @root2] - TreeMixinWithoutOrder.roots
+  end
+end 

data/test/test_helper.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'mongo_mapper'
+require 'mongo_mapper/plugins/acts_as_tree'
+require 'test/unit'
+
+
+
+class ActiveSupport::TestCase
+  
+  # Drop all collections after each test case.
+  def teardown
+    MongoMapper.database.collections.each { |coll| coll.remove }
+  end
+
+  # Make sure that each test case has a teardown
+  # method to clear the db after each test.
+  def inherited(base)
+    base.define_method teardown do 
+      super
+    end
+  end
+
+end
+
+
+
+MongoMapper.connection = Mongo::Connection.new('127.0.0.1', 27017)
+MongoMapper.database = "mongo_mapper_acts_as_tree_test"
+MongoMapper.database.collections.each { |c| c.drop_indexes }

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: mongo_mapper_acts_as_tree
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Tomas Celizna
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-31 01:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: 
+email: 
+- tomas.celizna@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mongo_mapper/plugins/acts_as_tree.rb
+- lib/mongo_mapper/plugins/version.rb
+- test/acts_as_tree_test.rb
+- test/test_helper.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/tomasc/mongo_mapper_acts_as_tree
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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.3.7
+signing_key: 
+specification_version: 3
+summary: Port of classic Rails ActsAsTree for MongoMapper
+test_files: []
+