glebtv-mongoid_nested_set 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 953791c3a0f6c4ac721064a644618e1483cf0e84
+  data.tar.gz: 6b4bd39932a7b028bdf028d28224c6eb3f9b1cc5
+SHA512:
+  metadata.gz: 574d7024162ace5b17a05231ab3b9eb1cc2277cfd1b46882438e41582230cf19a07d9feaf9d43a4ac932a1015d96edbc79c81e9115fcbaf5bd2bd633fbed5e8c
+  data.tar.gz: 057192f6c849596541d59e1f124d8b292b4e07bb57b4b7efa9564351d9fafb9564ea4d7e1fb49ef926e264335e8802f5a8331bdf84363f3dca5e51cc1dc0713e

data/.document

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

data/.gitignore

@@ -0,0 +1,44 @@
+Gemfile.lock
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in glebtv-mongoid_nested_set.gemspec
+gemspec
+
+group :test do
+  gem 'rspec-expectations', "~> 2.0"
+  gem 'rr'
+  gem 'remarkable_mongoid'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Brandon Turner
+
+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,147 @@
+Mongoid Nested Set
+==================
+
+Mongoid Nested Set is an implementation of the nested set pattern for Mongoid.
+It is a port of [AwesomeNestedSet for ActiveRecord](https://github.com/galetahub/awesome_nested_set).
+It supports Mongoid 2 and Rails 3.
+
+Nested Set represents hierarchies of trees in MongoDB using references rather
+than embedded documents.  A tree is stored as a flat list of documents in a
+collection.  Nested Set allows quick, ordered queries of nodes and their
+descendants.  Tree modification is more costly.  The nested set pattern is
+ideal for models that are read more frequently than modified.
+
+For more on the nested set pattern: <http://en.wikipedia.org/wiki/Nested_set_model>
+
+
+## Installation
+
+Install as Gem
+
+    gem install mongoid_nested_set
+
+via Gemfile
+
+    gem 'mongoid_nested_set', '0.1.3'
+
+
+## Usage
+
+To start using Mongoid Nested Set, just declare `acts_as_nested_set` on your
+model:
+
+    class Category
+        include Mongoid::Document
+        acts_as_nested_set
+    end
+
+### Creating a root node
+
+    root = Category.create(:name => 'Root Category')
+
+### Inserting a node
+
+    child1 = root.children.create(:name => 'Child Category #1')
+
+    child2 = Category.create(:name => 'Child Category #2')
+    root.children << child2
+
+### Deleting a node
+
+    child1.destroy
+
+Descendants of a destroyed nodes will also be deleted.  By default, descendant's
+`destroy` method will not be called.  To enable calling descendant's `destroy`
+method:
+
+    class Category
+        include Mongoid::Document
+        acts_as_nested_set :dependent => :destroy
+    end
+
+### Moving a node
+
+Several methods exist for moving nodes:
+
+* move\_left
+* move\_right
+* move\_to\_left\_of(other_node)
+* move\_to\_right\_of(other_node)
+* move\_to\_child\_of(other_node)
+* move\_to\_root
+
+
+### Scopes
+
+Scopes restrict what is considered a list.  This is commonly used to represent multiple trees
+(or multiple roots) in a single collection.
+
+    class Category
+        include Mongoid::Document
+        acts_as_nested_set :scope => :root_id
+    end
+
+### Conversion from other trees
+
+Coming from acts_as_tree or adjacency list system where you only have parent_id?
+No problem.  Simply add `acts_as_nested_set` and run:
+
+    Category.rebuild!
+
+Your tree will be converted to a valid nested set.
+
+
+### Outline Numbering
+
+Mongoid Nested Set can manage outline numbers (e.g. 1.3.2) for your documents if
+you wish.  Simply add `:outline_number_field`:
+
+    acts_as_nested_set, :outline_number_field => 'number'
+
+Your documents will now include a `number` field (you can call it anything you
+wish) that will contain outline numbers.
+
+Don't like the outline numbers format?  Simply override `outline_number_seperator`,
+`build_outline_number`, or `outline_number_sequence` in your model classes.  For
+example:
+
+    class Category
+        include Mongoid::Document
+        acts_as_nested_set :scope => :root_id, :outline_number_field => 'number'
+
+        # Use a dash instead of a dot for outline numbers
+        # e.g. 1-3-2
+        def outline_number_seperator
+            '-'
+        end
+
+        # Use 0-based indexing instead of 1-based indexing
+        # e.g. 1.0
+        def outline_number_sequence(prev_siblings)
+            prev_siblings.count
+        end
+    end
+
+
+## References
+
+You can learn more about nested sets at:
+
+<http://en.wikipedia.org/wiki/Nested_set_model>  
+<http://dev.mysql.com/tech-resources/articles/hierarchical-data.html>
+
+
+## Contributing to mongoid\_nested\_set
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2010 Brandon Turner. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/glebtv-mongoid_nested_set.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mongoid_nested_set/version"
+
+Gem::Specification.new do |s|
+  s.name        = "glebtv-mongoid_nested_set"
+  s.version     = MongoidNestedSet::VERSION
+  s.authors     = ["GlebTV", "Brandon Turner"]
+  s.email       = ["bt@brandonturner.net"]
+  s.homepage    = "http://github.com/55ideas/mongoid_nested_set"
+  s.summary     = %q{Nested set based tree implementation for Mongoid}
+  s.description = %q{Fully featured tree implementation for Mongoid using the nested set model}
+  s.licenses    = ["MIT"]
+
+  s.rubyforge_project = "mongoid_nested_set"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency(%q<mongoid>, [">= 3.0.0"])
+
+  s.add_development_dependency(%q<rspec>, [">= 2.7.0"])
+  s.add_development_dependency(%q<bundler>, [">= 1.0.21"])
+  s.add_development_dependency(%q<simplecov>)
+  s.add_development_dependency(%q<simplecov-rcov>)
+end
+

data/lib/glebtv-mongoid_nested_set.rb

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

data/lib/mongoid_nested_set/base.rb

@@ -0,0 +1,90 @@
+module Mongoid::Acts::NestedSet
+
+  module Base
+
+    # Configuration options are:
+    #
+    # * +:parent_field+ - field name to use for keeping the parent id (default: parent_id)
+    # * +:left_field+ - field name for left boundary data, default 'lft'
+    # * +:right_field+ - field name for right boundary data, default 'rgt'
+    # * +:outline_number_field+ - field name for the number field, default nil.  If set,
+    #   the value will be used as a field name to keep track of each node's
+    #   "outline number" (e.g. 1.2.5).
+    # * +:scope+ - restricts what is to be considered a list.  Given a symbol, it'll attach
+    #   "_id" (if it hasn't been already) and use that as the foreign key restriction.  You
+    #   can also pass an array to scope by multiple attributes
+    # * +:dependent+ - behavior for cascading destroy.  If set to :destroy, all the child
+    #   objects are destroyed alongside this object by calling their destroy method.  If set
+    #   to :delete_all (default), all the child objects are deleted without calling their
+    #   destroy method.
+    # * +:klass+ - class to use for queries (defaults to self)
+    #
+    # See Mongoid::Acts::NestedSet::ClassMethods for a list of class methods and
+    # Mongoid::Acts::NestedSet::InstanceMethods for a list of instance methods added to
+    # acts_as_nested_set models
+    def acts_as_nested_set(options = {})
+      options = {
+        :parent_field => 'parent_id',
+        :left_field => 'lft',
+        :right_field => 'rgt',
+        :outline_number_field => nil,
+        :dependent => :delete_all, # or :destroy
+        :klass => self,
+      }.merge(options)
+
+      if options[:scope].is_a?(Symbol) && options[:scope].to_s !~ /_id$/
+        options[:scope] = "#{options[:scope]}_id".intern
+      end
+
+      class_attribute :acts_as_nested_set_options, :instance_writer => false
+      self.acts_as_nested_set_options = options
+
+      unless self.is_a?(Document::ClassMethods)
+        include Document
+        include OutlineNumber if outline_number_field_name
+
+        field left_field_name, :type => Integer
+        field right_field_name, :type => Integer
+        field outline_number_field_name, :type => String if outline_number_field_name
+        field :depth, :type => Integer
+
+        has_many   :children, :class_name => self.name, :foreign_key => parent_field_name, :inverse_of => :parent, :order => left_field_name.to_sym.asc
+        belongs_to :parent,   :class_name => self.name, :foreign_key => parent_field_name
+
+        attr_accessor :skip_before_destroy
+
+        #if accessible_attributes.blank?
+        #  attr_protected left_field_name.intern, right_field_name.intern
+        #end
+
+        define_callbacks :move, :terminator => "result == false"
+
+        before_create  :set_default_left_and_right
+        before_save    :store_new_parent
+        after_save     :move_to_new_parent
+        before_destroy :destroy_descendants
+
+        # no assignment to structure fields
+        [left_field_name, right_field_name].each do |field|
+          module_eval <<-"end_eval", __FILE__, __LINE__
+                  def #{field}=(x)
+                    raise NameError, "Unauthorized assignment to #{field}: it's an internal field handled by acts_as_nested_set code, use move_to_* methods instead.", "#{field}"
+                  end
+          end_eval
+        end
+
+        scope :roots, lambda {
+          where(parent_field_name => nil).asc(left_field_name)
+        }
+        scope :leaves, lambda {
+          where("this.#{quoted_right_field_name} - this.#{quoted_left_field_name} == 1").asc(left_field_name)
+        }
+        scope :with_depth, lambda { |level|
+          where(:depth => level).asc(left_field_name)
+        }
+
+      end
+    end
+  end
+
+end

data/lib/mongoid_nested_set/document.rb

@@ -0,0 +1,238 @@
+module Mongoid::Acts::NestedSet
+
+  module Document
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.send(:include, InstanceMethods)
+    end
+
+
+    module ClassMethods
+
+      include Rebuild
+      include Validation
+      include Fields
+
+      # Returns the first root
+      def root
+        roots.first
+      end
+
+
+      def scope_condition_by_options(options)
+        h = {}
+        scope_string = Array(acts_as_nested_set_options[:scope]).reject{|s| !options.has_key?(s) }.each do |c|
+          h[c] = options[c]
+        end
+        h
+      end
+
+
+      # Iterates over tree elements and determines the current level in the tree.
+      # Only accepts default ordering, ordering by an other field than lft
+      # does not work.  This method is much more efficient then calling level
+      # because it doesn't require any additional database queries.
+      # This method does not used the cached depth field.
+      #
+      # Example:
+      #   Category.each_with_level(Category.root.self_and_descendants) do |o, level|
+      #
+      def each_with_level(objects)
+        offset = nil
+        path = [nil]
+        objects.each do |o|
+          if offset == nil
+            offset = o.parent_id.nil? ? 0 : o.parent.level
+          end
+          if o.parent_id != path.last
+            # we are on a new level, did we descend or ascend?
+            if path.include?(o.parent_id)
+              # remove wrong tailing path elements
+              path.pop while path.last != o.parent_id
+            else
+              path << o.parent_id
+            end
+          end
+          yield(o, path.length - 1 + offset)
+        end
+      end
+
+
+      # Iterates over tree elements with ancestors.
+      # Only accepts default ordering, ordering by an other field than lft
+      # does not work.  This is much more efficient than calling ancestors for
+      # each object because it doesn't require any additional database queries.
+      #
+      # Example:
+      #   Category.each_with_ancestors(Category.root.self_and_descendants) do |o, ancestors|
+      #
+      def each_with_ancestors(objects)
+        ancestors = nil
+        last_parent = nil
+        objects.each do |o|
+          if ancestors == nil
+            ancestors = o.root? ? [] : o.ancestors.entries
+          end
+          if ancestors.empty? || o.parent_id != ancestors.last.id
+            # we are on a new level, did we descend or ascend?
+            if ancestors.any? {|a| a.id == o.parent_id}
+              # ascend
+              ancestors.pop while (!ancestors.empty? && ancestors.last.id != o.parent_id)
+            elsif !o.root?
+              # descend
+              ancestors << last_parent
+            end
+          end
+          yield(o, ancestors)
+          last_parent = o
+        end
+      end
+
+
+      # Provides a chainable relation to select all descendants of a set of records,
+      # excluding the record set itself.
+      # Similar to parent.descendants, except this allows you to find all descendants
+      # of a set of nodes, rather than being restricted to find the descendants of only
+      # a single node.
+      #
+      # Example:
+      #   parents = Category.roots.all
+      #   parents_descendants = Category.where(:deleted => false).descendants_of(parents)
+      #
+      def descendants_of(parents)
+        # TODO: Add root or scope?
+        conditions = parents.map do |parent|
+          {left_field_name => {"$gt" => parent.left}, right_field_name => {"$lt" => parent.right}}
+        end
+        where("$or" => conditions)
+      end
+
+
+      def before_move(*args, &block)
+        set_callback :move, :before, *args, &block
+      end
+
+
+      def after_move(*args, &block)
+        set_callback :move, :after, *args, &block
+      end
+
+    end
+
+
+
+
+    module InstanceMethods
+
+      include Comparable
+      include Relations
+      include Update
+      include Fields
+
+      # Value fo the parent field
+      def parent_id
+        self[parent_field_name]
+      end
+
+
+      # Value of the left field
+      def left
+        self[left_field_name]
+      end
+
+
+      # Value of the right field
+      def right
+        self[right_field_name]
+      end
+
+
+      # Returns true if this is a root node
+      def root?
+        parent_id.nil?
+      end
+
+
+      # Returns true if this is a leaf node
+      def leaf?
+        #!new_record? && right - left == 1
+        right - left == 1
+      end
+
+
+      # Returns true if this is a child node
+      def child?
+        !parent_id.nil?
+      end
+
+
+      # Returns true if depth is supported
+      def depth?
+        true
+      end
+
+
+      # Returns true if outline numbering is supported
+      def outline_numbering?
+        !!outline_number_field_name
+      end
+
+
+      # order by left field
+      def <=>(x)
+        left <=> x.left
+      end
+
+
+      # Redefine to act like active record
+      def ==(comparison_object)
+        comparison_object.equal?(self) ||
+          (comparison_object.instance_of?(scope_class) &&
+           comparison_object.id == id &&
+           !comparison_object.new_record?)
+      end
+
+
+      # Check if other model is in the same scope
+      def same_scope?(other)
+        Array(acts_as_nested_set_options[:scope]).all? do |attr|
+          self.send(attr) == other.send(attr)
+        end
+      end
+
+
+      def to_text
+        self_and_descendants.map do |node|
+          "#('*'*(node.level+1)} #{node.id} #{node.to_s} (#{node.parent_id}, #{node.left}, #{node.right})"
+        end.join("\n")
+      end
+
+
+      # All nested set queries should use this nested_set_scope, which performs finds
+      # using the :scope declared in the acts_as_nested_set declaration
+      def nested_set_scope
+        scopes = Array(acts_as_nested_set_options[:scope])
+        conditions = scopes.inject({}) do |conditions,attr|
+          conditions.merge attr => self[attr]
+        end unless scopes.empty?
+        scope_class.criteria.where(conditions).asc(left_field_name)
+      end
+
+
+
+      protected
+
+      def without_self(scope)
+        scope.where(:_id.ne => self.id)
+      end
+
+
+      # reload left, right, and parent
+      def reload_nested_set
+        reload
+      end
+
+    end
+  end # Document
+end # Mongoid::Acts::NestedSet

data/lib/mongoid_nested_set/fields.rb

@@ -0,0 +1,60 @@
+module Mongoid::Acts::NestedSet
+
+  # Mixed int both classes and instances to provide easy access to the field names
+  module Fields
+
+    def left_field_name
+      acts_as_nested_set_options[:left_field]
+    end
+
+
+    def right_field_name
+      acts_as_nested_set_options[:right_field]
+    end
+
+
+    def parent_field_name
+      acts_as_nested_set_options[:parent_field]
+    end
+
+
+    def outline_number_field_name
+      acts_as_nested_set_options[:outline_number_field]
+    end
+
+
+    def scope_field_names
+      Array(acts_as_nested_set_options[:scope])
+    end
+
+
+    def scope_class
+      acts_as_nested_set_options[:klass]
+    end
+
+
+    def quoted_left_field_name
+      # TODO
+      left_field_name
+    end
+
+
+    def quoted_right_field_name
+      # TODO
+      right_field_name
+    end
+
+
+    def quoted_parent_field_name
+      # TODO
+      parent_field_name
+    end
+
+
+    def quoted_scope_field_names
+      # TODO
+      scope_field_names
+    end
+
+  end
+end