mongo_tree 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michael Parrish
+
+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,15 @@
+# mongo_tree
+
+mongo_tree is a plugin for [MongoMapper](http://github.com/jnunemaker/mongomapper) that implements [a number of tree modeling strategies](http://www.mongodb.org/display/DOCS/Trees+in+MongoDB) for MongoDB.
+
+Probably not quite ready for use just yet.
+
+## 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.

data/lib/mongo_tree.rb

@@ -0,0 +1,46 @@
+require 'mongo_mapper'
+require 'active_support/all'
+
+module MongoTree
+  autoload :Children, 'mongo_tree/children'
+  autoload :Base,     'mongo_tree/base'
+  
+  module Strategies
+    autoload :FullTreeRoot,       'mongo_tree/strategies/full_tree_root'
+    autoload :FullTreeNode,       'mongo_tree/strategies/full_tree_node'
+    autoload :ChildLink,          'mongo_tree/strategies/child_link'
+    autoload :ParentLink,         'mongo_tree/strategies/parent_link'
+    autoload :AncestorArray,      'mongo_tree/strategies/ancestor_array'
+    autoload :MaterializedPath,   'mongo_tree/strategies/materialized_path'
+  end
+  
+  module ClassMethods
+    def acts_as_tree(strategy, options = {})
+      @mongo_tree_options = options
+      
+      case strategy
+      when :full_tree
+        if options.has_key?(:embeds)
+          self.send :include, MongoTree::Strategies::FullTreeRoot
+        elsif options.has_key?(:root)
+          self.send :include, MongoTree::Strategies::FullTreeNode
+        else
+          raise 'The full_tree strategy needs to have either the :root or the :embeds class specified'
+        end
+      when :child_link
+        self.send :include, MongoTree::Strategies::ChildLink
+      when :parent_link
+        self.send :include, MongoTree::Strategies::ParentLink
+      when :ancestor_array
+        self.send :include, MongoTree::Strategies::AncestorArray
+      when :materialized_path
+        self.send :include, MongoTree::Strategies::MaterializedPath
+      else
+        # I guess this is an okay default?
+        self.send :include, MongoTree::Strategies::ParentLink
+      end
+    end
+  end
+end
+
+MongoMapper::Plugins.send :include, MongoTree

data/lib/mongo_tree/base.rb

@@ -0,0 +1,63 @@
+module MongoTree
+  module Base
+    def self.included(base)
+      base.extend ClassMethods
+      base.send :include, InstanceMethods
+    end
+    
+    module ClassMethods
+      def roots
+        self.all(:parent_id => nil)
+      end
+    end
+    
+    module InstanceMethods
+      def root
+        current = self
+
+        until current.parent.nil?
+          current = current.parent
+        end
+
+        current
+      end
+      
+      def depth
+        ancestors.length
+      end
+      
+      def children
+        MongoTree::Children.new(self.class.all(:parent_id => self.id), self)
+      end
+      
+      def children=(nodes)
+        nodes.each{ |node| children << node }
+      end
+      
+      def ancestors
+        collected = []
+        current = self.parent
+
+        until current.nil?
+          collected << current
+          current = current.parent
+        end
+
+        collected
+      end
+
+      def descendants
+        collected = []
+        nodes = self.children
+
+        until nodes.empty?
+          current = nodes.shift
+          collected << current
+          nodes += current.children
+        end
+
+        collected
+      end
+    end
+  end
+end

data/lib/mongo_tree/children.rb

@@ -0,0 +1,26 @@
+module MongoTree
+  class Children < Array
+    def initialize(array, parent, &update_method)
+      @parent = parent
+      @update_method = block_given? ? update_method : Proc.new { |child, parent| child.parent_id = parent.id }
+      super(array)
+    end
+  
+    def <<(*docs)
+      @parent.save if @parent.new?
+      flatten_deeper(docs).collect do |doc|
+        @update_method.call(doc, @parent)
+        doc.save if doc.changed? || doc.new?
+      end
+    
+      super.uniq
+    end
+    alias_method :push, :<<
+    alias_method :concat, :<<
+  
+    private
+    def flatten_deeper(docs)
+      docs.collect{ |doc| (doc.respond_to?(:flatten) && !doc.is_a?(Hash)) ? doc.flatten : doc }.flatten
+    end
+  end
+end

data/lib/mongo_tree/strategies/ancestor_array.rb

@@ -0,0 +1,76 @@
+module MongoTree
+  module Strategies
+    module AncestorArray
+      include MongoTree::Base
+      
+      def self.included(base)
+        base.class_eval do
+          class << self
+            attr_accessor :mongo_tree_options
+          end
+          
+          @mongo_tree_options = { :path_attribute => :id }.merge(@mongo_tree_options)
+          
+          key :parent_id, ObjectId
+          key :ancestor_ids, Array, :index => true
+          belongs_to :parent, :class_name => self.name
+          before_save :update_ancestors, :if => Proc.new{ |doc| doc.changes.has_key? "parent_id" }
+          after_save :update_children, :if => Proc.new{ |doc| doc.changes.has_key? "parent_id" }
+        end
+        
+        base.extend ClassMethods
+        base.send :include, InstanceMethods
+      end
+      
+      module ClassMethods
+        def roots
+          self.all(:parent_id => nil)
+        end
+      end
+      
+      module InstanceMethods
+        def root
+          self.class.first(path_attribute => self.ancestor_ids.first)
+        end
+
+        def depth
+          ancestor_ids.length
+        end
+
+        def siblings
+          self.class.all(:parent_id => self.parent_id, path_attribute.ne => self.send(path_attribute))
+        end
+
+        def ancestors
+          self.ancestor_ids.map{ |id| self.class.first(path_attribute => id) }
+        end
+
+        def descendants
+          self.class.all(:ancestor_ids.all => self.ancestor_ids << self.send(path_attribute))
+        end
+
+        protected
+        def update_ancestors
+          self.ancestor_ids = []
+          current = self
+
+          until current.parent.nil?
+            self.ancestor_ids.unshift(current.parent.send(path_attribute))
+            current = current.parent
+          end
+        end
+
+        def update_children
+          self.class.all(:parent_id => self.id).map do |child|
+            child.instance_eval{ update_ancestors }
+            child.save
+          end
+        end
+        
+        def path_attribute
+          self.class.mongo_tree_options[:path_attribute].to_sym
+        end
+      end
+    end
+  end
+end

data/lib/mongo_tree/strategies/child_link.rb

@@ -0,0 +1,53 @@
+module MongoTree
+  module Strategies
+    module ChildLink
+      include MongoTree::Base
+      
+      def self.included(base)
+        base.class_eval do
+          key :child_id, ObjectId, :index => true
+          many :children, :class_name => self.name, :foreign_key => "child_id"
+        end
+        
+        base.extend ClassMethods
+        base.send :include, InstanceMethods
+      end
+      
+      module ClassMethods
+        def roots
+          self.all(:child_id => nil)
+        end
+      end
+      
+      module InstanceMethods
+        def parent
+          @parent ||= self.class.find(self.child_id)
+        end
+
+        def parent=(node)
+          @parent = node
+          self.child_id = node.id
+          save if changed?
+        end
+
+        def siblings
+          return nil if parent.nil?
+          parent.children.reject{ |node| node == self }
+        end
+        
+        def descendants
+          collected = []
+          nodes = self.children
+
+          until nodes.empty?
+            current = nodes.shift
+            collected << current
+            nodes += current.children
+          end
+
+          collected
+        end
+      end
+    end
+  end
+end

data/lib/mongo_tree/strategies/full_tree_node.rb

@@ -0,0 +1,97 @@
+module MongoTree
+  module Strategies
+    module FullTreeNode
+      include MongoTree::Base
+      
+      def self.included(base)
+        base.class_eval do
+          class << self
+            attr_accessor :mongo_tree_options
+          end
+          
+          @mongo_tree_options = {
+            :root => "#{self.name}".sub(/Node/, '')
+          }.merge(@mongo_tree_options)
+          
+          many :children, :class_name => self.name
+        end
+        
+        base.extend ClassMethods
+        base.send :include, InstanceMethods
+      end
+      
+      module ClassMethods
+      end
+      
+      module InstanceMethods
+        def root
+          self._root_document
+        end
+
+        def parent
+          self._parent_document
+        end
+        
+        def parent=(target)
+          bson = root_class.collection.find_one(root.id)
+          my_bson = nil
+          
+          modify_children(bson, self) do |parent, found|
+            my_bson = found
+            parent['children'].delete(found)
+          end
+          
+          modify_children(bson, target) do |parent, found|
+            found['children'] << my_bson
+          end
+          
+          root_class.collection.update({'_id' => root.id}, bson)
+          root.reload
+        end
+
+        def siblings
+          self._parent_document.children.reject{ |n| n.id == self.id }
+        end
+
+        def ancestors
+          collected = []
+          current = parent
+
+          until current == root
+            collected.unshift(current)
+            current = current.parent
+          end
+
+          collected.unshift(root)
+        end
+        
+        protected
+        def root_class
+          self.class.mongo_tree_options[:root].to_s.constantize
+        end
+        
+        def modify_children(tree, node, &block)
+          current = tree
+          found = nil
+          
+          ancestors = node.ancestors
+          ancestors.shift
+
+          until ancestors.empty?
+            ancestor = ancestors.shift
+            current = current['children'].select{ |child| child['_id'] == ancestor['_id'] }.first
+          end
+          
+          if current['_id'] == node.id
+            found = current
+          else
+            found = current['children'].select{ |child| child['_id'] == node.id }.first
+          end
+          
+          yield(current, found)
+          return tree
+        end
+      end
+    end
+  end
+end

data/lib/mongo_tree/strategies/full_tree_root.rb

@@ -0,0 +1,48 @@
+module MongoTree
+  module Strategies
+    module FullTreeRoot
+      include MongoTree::Base
+      
+      def self.included(base)
+        base.class_eval do
+          class << self
+            attr_accessor :mongo_tree_options
+          end
+          
+          @mongo_tree_options = {
+            :embeds => "#{self.name}Node"
+          }.merge(@mongo_tree_options)
+          
+          many :children, :class_name => @mongo_tree_options[:embeds].to_s
+        end
+        
+        base.extend ClassMethods
+        base.send :include, InstanceMethods
+      end
+      
+      module ClassMethods
+        def roots
+          self.all
+        end
+      end
+      
+      module InstanceMethods
+        def depth
+          0
+        end
+
+        def parent
+          nil
+        end
+
+        def siblings
+          []
+        end
+
+        def ancestors
+          []
+        end
+      end
+    end
+  end
+end

data/lib/mongo_tree/strategies/materialized_path.rb

@@ -0,0 +1,119 @@
+module MongoTree
+  module Strategies
+    module MaterializedPath
+      include MongoTree::Base
+      
+      def self.included(base)
+        base.class_eval do
+          class << self
+            attr_accessor :mongo_tree_options
+          end
+          
+          @mongo_tree_options = {
+            :path_attribute => :id,
+            :path_delimiter => ','
+          }.merge(@mongo_tree_options)
+          
+          key :path, String, :index => true
+          key :depth, Integer, :default => 0
+          validates_presence_of @mongo_tree_options[:path_attribute].to_sym
+          before_save :update_path_and_depth, :if => Proc.new{ |doc| doc.changes.has_key? "path" }
+          after_save :update_children, :if => Proc.new{ |doc| doc.changes.has_key? "path" }
+        end
+        
+        base.extend ClassMethods
+        base.send :include, InstanceMethods
+      end
+      
+      module ClassMethods
+        def roots
+          self.all(:depth => 0)
+        end
+      end
+      
+      module InstanceMethods
+        def path
+          if self[:path].nil?
+            self.send(path_attribute).to_s
+          else
+            self[:path]
+          end
+        end
+
+        def root
+          find_by_path_attribute(path_array.first)
+        end
+
+        def parent
+          @parent ||= find_parent_from_path
+        end
+
+        def parent=(node)
+          @parent = node
+          update_path_and_depth
+        end
+
+        def children
+          docs = self.class.all(:path => /^#{ self.path },/, :depth => self.depth + 1)
+          MongoTree::Children.new(docs, self) do |child, parent|
+            child.parent = parent
+          end
+        end
+
+        def siblings
+          return [] if @parent.nil?
+          self.class.all(:path => /^#{ @parent.path },/, :depth => self.depth, path_attribute.ne => self.send(path_attribute).to_s)
+        end
+
+        def ancestors
+          return [] if self.path.nil?
+          path_array[0..-2].map{ |n| find_by_path_attribute(n) }
+        end
+
+        def descendants
+          return [] if self.path.nil?
+          self.class.all(:path => /^#{ self.path },/)
+        end
+
+        protected
+        def path_attribute
+          self.class.mongo_tree_options[:path_attribute].to_sym
+        end
+        
+        def path_delimiter
+          self.class.mongo_tree_options[:path_delimiter].to_s
+        end
+        
+        def path_array
+          self.path.split(path_delimiter)
+        end
+
+        def find_by_path_attribute(id)
+          self.class.first(path_attribute => id)
+        end
+
+        def find_parent_from_path
+          return nil if self.path.nil? || self.path.length < 2
+          @parent = find_by_path_attribute(path_array[-2])
+        end
+
+        def update_path_and_depth
+          @parent ||= find_parent_from_path
+          self.path = @parent.nil? ? send(path_attribute).to_s : "#{ @parent.path }#{ path_delimiter }#{ send(path_attribute).to_s }"
+          self.depth = path_array.length - 1
+        end
+
+        def update_children
+          old_path = self.changes['path'].first
+          old_depth = self.changes.has_key?('depth') ? self.changes['depth'].first : self.depth
+          return if old_path.nil? || old_depth.nil?
+
+          self.class.all(:path => /^#{ old_path },/, :depth => old_depth + 1).map do |child|
+            child.instance_eval{ update_path_and_depth }
+            child.save
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo_tree/strategies/parent_link.rb

@@ -0,0 +1,43 @@
+module MongoTree
+  module Strategies
+    module ParentLink
+      include MongoTree::Base
+      
+      def self.included(base)
+        base.class_eval do
+          key :parent_id, ObjectId, :index => true
+          belongs_to :parent, :class_name => self.name
+        end
+        
+        base.extend ClassMethods
+        base.send :include, InstanceMethods
+      end
+      
+      module ClassMethods
+        def roots
+          self.all(:parent_id => nil)
+        end
+      end
+      
+      module InstanceMethods
+        def siblings
+          self.class.all(:parent_id => self.parent_id, :id.ne => self.id)
+        end
+        
+        def descendants
+          collected = []
+          nodes = [self]
+
+          until nodes.empty?
+            current = nodes.shift
+            current_children = self.class.all(:parent_id => current.id)
+            nodes += current_children
+            collected += current_children
+          end
+
+          collected
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'mongo_tree'
+
+class Test::Unit::TestCase
+end

data/test/test_mongo_tree.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestMongoTree < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: mongo_tree
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Parrish
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 8
+        - 2
+        version: 0.8.2
+  type: :runtime
+  version_requirements: *id002
+description: A MongoMapper plugin that adds a number of tree strategies.
+email: mtparrish@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- LICENSE
+- README.markdown
+- lib/mongo_tree.rb
+- lib/mongo_tree/base.rb
+- lib/mongo_tree/children.rb
+- lib/mongo_tree/strategies/ancestor_array.rb
+- lib/mongo_tree/strategies/child_link.rb
+- lib/mongo_tree/strategies/full_tree_node.rb
+- lib/mongo_tree/strategies/full_tree_root.rb
+- lib/mongo_tree/strategies/materialized_path.rb
+- lib/mongo_tree/strategies/parent_link.rb
+- test/helper.rb
+- test/test_mongo_tree.rb
+has_rdoc: true
+homepage: http://github.com/parrish/mongo_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 
+      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: A MongoMapper plugin that adds a number of tree strategies.
+test_files: 
+- test/helper.rb
+- test/test_mongo_tree.rb