ramdiv-mongo_mapper_acts_as_tree 0.0.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,20 @@
+Copyright (c) 2009 Jakob Vidmar
+
+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.rdoc

@@ -0,0 +1,46 @@
+= mongo_mapper-acts_as_tree
+
+This is an implementation of a tree structure for MongoMapper. 
+
+== Installation
+
+Install as gem
+
+  gem install ramdiv-mongo_mapper_acts_as_tree
+  
+== Usage
+
+Enable the tree functionality by declaring acts_as_tree on your model
+
+  class Category
+    include MongoMapper::Document
+    include MongoMapper::Acts::Tree
+  
+    key :name, String
+  
+    acts_as_tree
+  end
+
+The method accepts :parent_id_field, :path_field, :depth_field, :order as a hash.
+
+  :parent_id_field, :path_field, :depth_field => override the default field names
+  :order => control the order (format "_field-name_ _[asc|desc]_")
+
+Check the test_tree.rb for examples.
+
+== !WARNING!
+
+This is not production-ready code. Bugs are to be expected.
+== 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
+
+Copyright (c) 2009 Jakob Vidmar. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ramdiv-mongo_mapper_acts_as_tree"
+    gem.summary = %Q{ActsAsTree plugin for MongoMapper}
+    gem.description = %Q{Port of the old, venerable ActsAsTree with a bit of a twist}
+    gem.email = "jakob.vidmar@gmail.com"
+    gem.homepage = "http://github.com/ramdiv/mongo_mapper_acts_as_tree"
+    gem.authors = ["Jakob Vidmar"]
+    gem.add_dependency("mongo_mapper", ">= 0.6.8")
+    
+    gem.add_development_dependency "shoulda", ">=2.10.2"
+  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|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mongo_mapper_acts_as_tree #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/mongo_mapper_acts_as_tree.rb

@@ -0,0 +1,177 @@
+require "mongo_mapper"
+
+module MongoMapper
+  module Acts
+    module Tree
+      def self.included(model)
+        model.class_eval do 
+          extend InitializerMethods
+        end
+      end
+      
+      module InitializerMethods
+        def acts_as_tree(options = {})
+          options = {
+            :parent_id_field => "parent_id",
+            :path_field      => "path",
+            :depth_field     => "depth"
+          }.merge(options)
+          
+          write_inheritable_attribute :acts_as_tree_options, options
+          class_inheritable_reader :acts_as_tree_options
+          
+          include InstanceMethods
+          include Fields
+          extend Fields
+          extend ClassMethods
+          
+          key parent_id_field,  String
+          key path_field,       String,  :default => ""
+          key depth_field,      Integer, :default => 0
+          
+          after_save      :move_children
+          before_save     :will_save_tree
+          # before_destroy  :destroy_descendants
+        end
+      end
+      
+      module ClassMethods
+        def roots
+          self.find(:all, :conditions => {parent_id_field => nil}, :order => tree_order)
+        end
+      end
+      
+      module InstanceMethods
+        def ==(other)
+          return true if other.equal?(self)
+          return true if other.instance_of?(self.class) and other._id == self._id
+          false
+        end
+      
+        def parent=(var)
+          var = self.find(var) if var.is_a? String
+          
+          if self.descendents.include? var
+            @_cyclic = true
+          else
+            @_parent = var
+            fix_position
+            @_will_move = true
+          end
+        end
+        
+        def will_save_tree
+          !@_cyclic
+        end
+        
+        def fix_position
+          if parent.nil?
+            self[parent_id_field] = nil
+            self[path_field] = ""
+            self[depth_field] = 0
+          else
+            self[parent_id_field] = parent.id
+            self[path_field] = parent[path_field] + ":" + parent.id.to_s
+            self[depth_field] = parent[depth_field] + 1
+          end
+        end
+        
+        def parent
+          @_parent or (self[parent_id_field] ? self.class.find(self[parent_id_field]) : nil)
+        end
+        
+        def root?
+          self[parent_id_field].nil?
+        end
+        
+        def root
+          self.class.find(self[path_field].split(":")[1]) or self
+        end
+        
+        def ancestors
+          return [] if root?
+          self.class.find(self[path_field].split(":")[1..-1].collect{|i| Mongo::ObjectID.from_string(i)})
+        end
+        
+        def self_and_ancestors
+          ancestors << self
+        end
+        
+        def siblings
+          self.class.find(:all, :conditions => {:_id => {"$ne" => self._id}, parent_id_field => self[parent_id_field]}, :order => tree_order)
+        end
+        
+        def self_and_siblings
+          self.class.find(:all, :conditions => {parent_id_field => self[parent_id_field]}, :order => tree_order)
+        end
+        
+        def children
+          self.class.find(:all, :conditions => {parent_id_field => self._id.to_s}, :order => tree_order)
+        end
+        
+        def descendents
+          return [] if new_record?
+          sorting_options = tree_order.split(",").map(&:strip).map(&:split).map{|item| [item[0], ((item[1].nil? or item[1].downcase == "asc") ? "asc" : "desc")]}.flatten
+          self.class.collection.find({path_field => /#{self._id}/}, {:sort => sorting_options}).map{|i| self.class.new(i)} or []
+        end
+        
+        def self_and_descendents
+          [self] + self.descendents
+        end
+        
+        def is_ancestor_of?(other)
+          !(other[path_field] =~ /#{self._id}/).nil?
+        end
+        
+        def is_or_is_ancestor_of?(other)
+          (other == self) or is_ancestor_of?(other)
+        end
+        
+        def is_descendant_of?(other)
+          !(self[path_field] =~ /#{other._id}/).nil?
+        end
+        
+        def is_or_is_descendant_of?(other)
+          (other == self) or is_descendant_of?(other)
+        end
+        
+        def is_sibling_of?(other)
+          (other != self) and (other[parent_id_field] == self[parent_id_field])
+        end
+        
+        def is_or_is_sibling_of?(other)
+          (other == self) or is_sibling_of?(other)
+        end
+        
+        def move_children
+          if @_will_move
+            @_will_move = false
+            for child in self.children
+              child.fix_position
+              child.save
+            end
+            @_will_move = true
+          end
+        end
+      end
+      
+      module Fields
+        def parent_id_field
+          acts_as_tree_options[:parent_id_field]
+        end
+        
+        def path_field
+          acts_as_tree_options[:path_field]
+        end
+        
+        def depth_field
+          acts_as_tree_options[:depth_field]
+        end
+        
+        def tree_order
+          acts_as_tree_options[:order] or ""
+        end
+      end
+    end
+  end
+end

data/ramdiv-mongo_mapper_acts_as_tree.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ramdiv-mongo_mapper_acts_as_tree}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jakob Vidmar"]
+  s.date = %q{2009-12-20}
+  s.description = %q{Port of the old, venerable ActsAsTree with a bit of a twist}
+  s.email = %q{jakob.vidmar@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/mongo_mapper_acts_as_tree.rb",
+     "ramdiv-mongo_mapper_acts_as_tree.gemspec",
+     "test/helper.rb",
+     "test/models/category.rb",
+     "test/models/ordered_category.rb",
+     "test/test_order.rb",
+     "test/test_tree.rb"
+  ]
+  s.homepage = %q{http://github.com/ramdiv/mongo_mapper_acts_as_tree}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{ActsAsTree plugin for MongoMapper}
+  s.test_files = [
+    "test/helper.rb",
+     "test/models/category.rb",
+     "test/models/ordered_category.rb",
+     "test/test_order.rb",
+     "test/test_tree.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<mongo_mapper>, [">= 0.6.8"])
+      s.add_development_dependency(%q<shoulda>, [">= 2.10.2"])
+    else
+      s.add_dependency(%q<mongo_mapper>, [">= 0.6.8"])
+      s.add_dependency(%q<shoulda>, [">= 2.10.2"])
+    end
+  else
+    s.add_dependency(%q<mongo_mapper>, [">= 0.6.8"])
+    s.add_dependency(%q<shoulda>, [">= 2.10.2"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'mongo_mapper'
+
+MongoMapper.database = "acts_as_tree-test"
+
+Dir["#{File.dirname(__FILE__)}/models/*.rb"].each {|file| require file}
+
+class Test::Unit::TestCase
+  # Drop all columns after each test case.
+    def teardown
+    MongoMapper.database.collections.each do |coll|
+      coll.remove
+    end
+  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
+  
+  def eql_arrays?(first, second)
+    first.collect(&:_id).to_set == second.collect(&:_id).to_set
+  end
+end

data/test/models/category.rb

@@ -0,0 +1,11 @@
+require "mongo_mapper"
+require "mongo_mapper_acts_as_tree"
+
+class Category
+  include MongoMapper::Document
+  include MongoMapper::Acts::Tree
+  
+  key :name, String
+  
+  acts_as_tree
+end

data/test/models/ordered_category.rb

@@ -0,0 +1,12 @@
+require "mongo_mapper"
+require "mongo_mapper_acts_as_tree"
+
+class OrderedCategory
+  include MongoMapper::Document
+  include MongoMapper::Acts::Tree
+  
+  key :name,  String
+  key :value, Integer
+  
+  acts_as_tree :order => "value asc"
+end

data/test/test_order.rb

@@ -0,0 +1,28 @@
+require 'helper'
+require 'set'
+
+class TestMongomapperActsAsTree < Test::Unit::TestCase
+  context "Ordered tree" do
+    setup do
+      @root_1     = OrderedCategory.create(:name => "Root 1", :value => 2)
+      @child_1    = OrderedCategory.create(:name => "Child 1", :parent => @root_1, :value => 1)
+      @child_2    = OrderedCategory.create(:name => "Child 2", :parent => @root_1, :value => 9)
+      @child_2_1  = OrderedCategory.create(:name => "Child 2.1", :parent => @child_2, :value => 2)
+      @child_3    = OrderedCategory.create(:name => "Child 3", :parent => @root_1, :value => 5)
+      @root_2     = OrderedCategory.create(:name => "Root 2", :value => 1)
+    end
+    
+    should "be in order" do
+      assert_equal OrderedCategory.roots, [@root_2, @root_1]
+      
+      assert_equal @root_1.children, [@child_1, @child_3, @child_2]
+
+      assert_equal @root_1.descendents, [@child_1, @child_2_1, @child_3, @child_2]
+      assert_equal @root_1.self_and_descendents, [@root_1, @child_1, @child_2_1, @child_3, @child_2]
+      
+      assert_equal @child_2.siblings, [@child_1, @child_3]
+      assert_equal @child_2.self_and_siblings, [@child_1, @child_3, @child_2]
+      assert_equal @root_1.self_and_siblings, [@root_2, @root_1]
+    end
+  end
+end

data/test/test_tree.rb

@@ -0,0 +1,139 @@
+require 'helper'
+require 'set'
+
+class TestMongomapperActsAsTree < Test::Unit::TestCase
+  context "Tree" do
+    setup do
+      @root_1     = Category.create(:name => "Root 1")
+      @child_1    = Category.create(:name => "Child 1", :parent => @root_1)
+      @child_2    = Category.create(:name => "Child 2", :parent => @root_1)
+      @child_2_1  = Category.create(:name => "Child 2.1", :parent => @child_2)
+      @child_3    = Category.create(:name => "Child 3", :parent => @root_1)
+      @root_2     = Category.create(:name => "Root 2")
+    end
+    
+    should "have roots" do
+      assert eql_arrays?(Category.roots, [@root_1, @root_2])
+    end
+  
+    context "node" do
+      should "have a root" do
+        assert_equal @root_1.root, @root_1
+        assert_not_equal @root_1.root, @root_2.root
+        assert_equal @root_1, @child_2_1.root
+      end
+      
+      should "have ancestors" do
+        assert_equal @root_1.ancestors, []
+        assert_equal @child_2_1.ancestors, [@root_1, @child_2]
+        assert_equal @root_1.self_and_ancestors, [@root_1]
+        assert_equal @child_2_1.self_and_ancestors, [@root_1, @child_2, @child_2_1]
+      end
+      
+      should "have siblings" do
+        assert eql_arrays?(@root_1.siblings, [@root_2])
+        assert eql_arrays?(@child_2.siblings, [@child_1, @child_3])
+        assert eql_arrays?(@child_2_1.siblings, [])
+        assert eql_arrays?(@root_1.self_and_siblings, [@root_1, @root_2])
+        assert eql_arrays?(@child_2.self_and_siblings, [@child_1, @child_2, @child_3])
+        assert eql_arrays?(@child_2_1.self_and_siblings, [@child_2_1])
+      end
+      
+      should "set depth" do
+        assert_equal 0, @root_1.depth
+        assert_equal 1, @child_1.depth
+        assert_equal 2, @child_2_1.depth
+      end
+      
+      should "have children" do
+        assert @child_2_1.children.empty?
+        assert eql_arrays?(@root_1.children, [@child_1, @child_2, @child_3])
+      end
+      
+      should "have descendents" do
+        assert eql_arrays?(@root_1.descendents, [@child_1, @child_2, @child_3, @child_2_1])
+        assert eql_arrays?(@child_2.descendents, [@child_2_1])
+        assert @child_2_1.descendents.empty?
+        assert eql_arrays?(@root_1.self_and_descendents, [@root_1, @child_1, @child_2, @child_3, @child_2_1])
+        assert eql_arrays?(@child_2.self_and_descendents, [@child_2, @child_2_1])
+        assert eql_arrays?(@child_2_1.self_and_descendents, [@child_2_1])
+      end
+      
+      should "be able to tell if ancestor" do
+        assert @root_1.is_ancestor_of?(@child_1)
+        assert !@root_2.is_ancestor_of?(@child_2_1)
+        assert !@child_2.is_ancestor_of?(@child_2)
+        
+        assert @root_1.is_or_is_ancestor_of?(@child_1)
+        assert !@root_2.is_or_is_ancestor_of?(@child_2_1)
+        assert @child_2.is_or_is_ancestor_of?(@child_2)
+      end
+      
+      should "be able to tell if descendent" do
+        assert !@root_1.is_descendant_of?(@child_1)
+        assert @child_1.is_descendant_of?(@root_1)
+        assert !@child_2.is_descendant_of?(@child_2)
+        
+        assert !@root_1.is_or_is_descendant_of?(@child_1)
+        assert @child_1.is_or_is_descendant_of?(@root_1)
+        assert @child_2.is_or_is_descendant_of?(@child_2)
+      end
+      
+      should "be able to tell if sibling" do
+        assert !@root_1.is_sibling_of?(@child_1)
+        assert !@child_1.is_sibling_of?(@child_1)
+        assert !@child_2.is_sibling_of?(@child_2)
+        
+        assert !@root_1.is_or_is_sibling_of?(@child_1)
+        assert @child_1.is_or_is_sibling_of?(@child_2)
+        assert @child_2.is_or_is_sibling_of?(@child_2)
+      end
+      
+      context "when moving" do
+        should "recalculate path and depth" do
+          @child_3.parent = @child_2
+          @child_3.save
+          
+          assert @child_2.is_or_is_ancestor_of?(@child_3)
+          assert @child_3.is_or_is_descendant_of?(@child_2)
+          assert @child_2.children.include?(@child_3)
+          assert @child_2.descendents.include?(@child_3)
+          assert @child_2_1.is_or_is_sibling_of?(@child_3)
+          assert_equal 2, @child_3.depth
+        end
+        
+        should "move children on save" do
+          @child_2.parent = @root_2
+          
+          assert !@root_2.is_or_is_ancestor_of?(@child_2_1)
+          assert !@child_2_1.is_or_is_descendant_of?(@root_2)
+          assert !@root_2.descendents.include?(@child_2_1)
+          
+          @child_2.save
+          @child_2_1.reload
+
+          assert @root_2.is_or_is_ancestor_of?(@child_2_1)
+          assert @child_2_1.is_or_is_descendant_of?(@root_2)
+          assert @root_2.descendents.include?(@child_2_1)
+        end
+        
+        should "check agains cyclic graph" do
+          @root_1.parent = @child_2_1
+          assert !@root_1.save
+        end
+      end
+    end
+    
+    context "root node" do
+      should "not have a parent" do
+        assert_nil @root_1.parent
+      end
+    end
+    
+    context "child_node" do
+      should "have a parent" do
+        assert_equal @child_2, @child_2_1.parent
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: ramdiv-mongo_mapper_acts_as_tree
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Jakob Vidmar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-20 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.10.2
+    version: 
+description: Port of the old, venerable ActsAsTree with a bit of a twist
+email: jakob.vidmar@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/mongo_mapper_acts_as_tree.rb
+- ramdiv-mongo_mapper_acts_as_tree.gemspec
+- test/helper.rb
+- test/models/category.rb
+- test/models/ordered_category.rb
+- test/test_order.rb
+- test/test_tree.rb
+has_rdoc: true
+homepage: http://github.com/ramdiv/mongo_mapper_acts_as_tree
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: ActsAsTree plugin for MongoMapper
+test_files: 
+- test/helper.rb
+- test/models/category.rb
+- test/models/ordered_category.rb
+- test/test_order.rb
+- test/test_tree.rb