mm-referenced-tree 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Richard Livsey
+
+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,36 @@
+= MongoMapper::Plugins::ReferencedTree
+
+Yet another tree plugin for MongoMapper, uses an array of reference numbers.
+Useful when the leaf/branch numbers are meaningful, so you don't have to separately maintain them.
+
+== Usage
+
+Load it into a model:
+
+  plugin MongoMapper::Plugins::ReferencedTree
+
+Then call referenced_tree to configure it
+
+  referenced_tree :scope => :account_id
+
+== Options
+
+Available options are:
+
+* :scope - scope to a specific field (default - nil)
+
+== 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 in another branch so I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Install
+
+ $ gem install mm-referenced-tree
+
+== Copyright
+
+See LICENSE for details.

data/Rakefile

@@ -0,0 +1,74 @@
+require "rubygems"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+
+require "spec"
+require "spec/rake/spectask"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = %w(--format specdoc --colour)
+  t.libs = ["spec"]
+end
+
+task :default => ["spec"]
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+
+  # Change these as appropriate
+  s.name              = "mm-referenced-tree"
+  s.version           = "0.1.0"
+  s.summary           = "Yet another tree plugin for MongoMapper, built with an array of reference numbers"
+  s.author            = "Richard Livsey"
+  s.email             = "richard@livsey.org"
+  s.homepage          = "http://github.com/rlivsey/mm-referenced-tree"
+
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = %w(README.rdoc)
+  s.rdoc_options      = %w(--main README.rdoc)
+
+  # Add any extra files to include in the gem
+  s.files             = %w(LICENSE Rakefile README.rdoc) + Dir.glob("{spec,lib/**/*}")
+  s.require_paths     = ["lib"]
+
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  # s.add_dependency("some_other_gem", "~> 0.1.0")
+
+  # If your tests use any gems, include them here
+  s.add_development_dependency("rspec")
+end
+
+# This task actually builds the gem. We also regenerate a static
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+#
+# To publish your gem online, install the 'gemcutter' gem; Read more 
+# about that here: http://gemcutter.org/pages/gem_docs
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Build the gemspec file #{spec.name}.gemspec"
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+task :package => :gemspec
+
+# Generate documentation
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end

data/lib/mm-referenced-tree.rb

@@ -0,0 +1,300 @@
+require 'mongo_mapper'
+
+module MongoMapper
+  module Plugins
+    module ReferencedTree
+
+      module ClassMethods
+        def referenced_tree(options={})
+          options.reverse_merge!({
+            :scope => nil
+          })
+
+          write_inheritable_attribute :referenced_tree_options, options
+          class_inheritable_reader    :referenced_tree_options
+
+          key :reference, Array
+          key :depth,     Integer
+
+          before_create :assign_reference
+          before_create :reposition_subsequent_nodes
+          after_destroy :delete_descendants_and_renumber_siblings
+          before_update :renumber_tree_if_reference_changed
+        end
+
+        # renumber a full set of nodes
+        # pass the scope into the query to limit it to the nodes you want
+        # Eg. Something.renumber_tree(:account_id => 123)
+        # TODO - make this work on associations, IE account.nodes.renumber_tree
+        def renumber_tree(query={})
+          reference     = [0]
+          level         = 1
+          level_offset  = 0
+
+          where(query).sort(:reference.asc).all.each do |node|
+
+            # it's a level up
+            if node.reference.size > (level + level_offset)
+              if reference == [0]
+                level_offset = 1
+              else
+                level             += 1
+                reference[level-1] = 0
+              end
+
+            # back down a level or more
+            elsif node.reference.size < (level + level_offset)
+              level     = node.depth
+
+              if level_offset > 0
+
+                if level == 1
+                  level_offset = 0
+                else
+                  level -= level_offset
+                end
+              end
+
+              reference = reference[0, level]
+            end
+
+            reference[level-1] += 1
+
+            if node.reference != reference
+              node.set(:reference => reference)
+            end
+          end
+        end
+      end
+
+      module InstanceMethods
+
+        # removes this node and renumbers siblings and descendants
+        def destroy
+          super
+        end
+
+        # removes this node and all descendants, renumbers siblings
+        def destroy_with_children
+          @destroy_descendants = true
+          destroy
+        end
+
+        # Provides a formatted version of the reference
+        #
+        # [1,2,3] => "1.2.3"
+        #
+        # override this in your model if you want to format the references differently
+        def formatted_reference
+          reference.join(".")
+        end
+
+        def reference=(ref)
+          self.depth = ref.size
+          super
+        end
+
+        # set the reference without calling #save, so no callbacks are triggered
+        # good for renumbering on mass without triggering auto-renumbering
+        # but may end up with the tree being out of sync if you don't reorder all nodes
+        def set_reference(ref)
+          self.reference = ref
+          set(:reference => ref, :depth => depth)
+        end
+
+        # TODO - implement this
+        # increases the depth of the node if possible
+        # can't indent if there's nothing before it on the same level (to become the new parent)
+        def indent
+        end
+
+        # TODO - implement this
+        # decreases the depth of the node if possible
+        # can't outdent further than 1
+        def outdent
+        end
+
+        # returns the parent for the node
+        # so [1,2,3] would look for a node with reference of [1,2]
+        def parent
+          return if root?
+          query         = query_for_reference(reference[0, depth-1])
+          query[:depth] = depth - 1
+          scoped_find.first(query)
+        end
+
+        def parent=(obj)
+          ref = obj.reference
+
+          if child = obj.children.last
+            ref << (child.reference.last + 1)
+          else
+            ref << 1
+          end
+
+          self.reference = ref
+        end
+
+        def root?
+          depth == 1
+        end
+
+        def root
+          scoped_find.first(:"reference.0" => reference[0], :depth => 1)
+        end
+
+        def roots
+          scoped_find.all(:depth => 1)
+        end
+
+        def ancestors
+          return if root?
+          scoped_find.all(:depth => {:"$lt" => depth}, :"reference.0" => reference[0])
+        end
+
+        def siblings
+          query         = query_for_reference(reference[0, depth-1])
+          query[:depth] = depth
+          query[:id]    = {:"$ne" => self.id}
+          scoped_find.all(query)
+        end
+
+        def previous_siblings
+          query = query_for_reference(reference[0, depth-1])
+          query[:"reference.#{depth-1}"] = {:"$lt" => reference.last + 1}
+          query[:depth] = depth
+          query[:id] = {:"$ne" => self.id}
+          scoped_find.all(query)
+        end
+
+        def next_siblings
+          query = query_for_reference(reference[0, depth-1])
+          query[:"reference.#{depth-1}"] = {:"$gt" => reference.last - 1}
+          query[:depth] = depth
+          query[:id] = {:"$ne" => self.id}
+          scoped_find.all(query)
+        end
+
+        def self_and_siblings
+          query         = query_for_reference(reference[0, depth-1])
+          query[:depth] = depth
+          scoped_find.all(query)
+        end
+
+        def children
+          query         = query_for_reference(reference[0, depth])
+          query[:depth] = depth + 1
+          scoped_find.all(query)
+        end
+
+        def descendants
+          query         = query_for_reference(reference[0, depth])
+          query[:depth] = {:"$gt" => depth}
+          scoped_find.all(query)
+        end
+
+        def self_and_descendants
+          [self] + descendants
+        end
+
+        def is_ancestor_of?(other)
+          return false if other.depth <= depth
+          other.reference[0, depth] == reference
+        end
+
+        def is_or_is_ancestor_of?(other)
+          other == self || is_ancestor_of?(other)
+        end
+
+        def is_descendant_of?(other)
+          return false if other.depth >= depth
+          reference[0, other.depth] == other.reference
+        end
+
+        def is_or_is_descendant_of?(other)
+          other == self || is_descendant_of?(other)
+        end
+
+        def is_sibling_of?(other)
+          return false if other.depth != depth
+          reference[0, depth-1] == other.reference[0, depth-1]
+        end
+
+        def is_or_is_sibling_of?(other)
+          other == self || is_sibling_of?(other)
+        end
+
+        private
+
+        def query_for_reference(ref)
+          query = {}
+          ref.each_with_index do |r, i|
+            query[:"reference.#{i}"] = r
+          end
+          query
+        end
+
+        def scoped_find
+          if referenced_tree_options[:scope]
+            self.class.sort(:reference.asc).where(referenced_tree_options[:scope] => self[referenced_tree_options[:scope]])
+          else
+            self.class.sort(:reference.asc)
+          end
+        end
+
+        def assign_reference
+          return unless reference.blank?
+
+          if root_node = roots.last
+            self.reference = [root_node.reference[0] + 1]
+          else
+            self.reference = [1]
+          end
+        end
+
+        def delete_descendants_and_renumber_siblings
+          if @destroy_descendants
+            self.children.each do |child|
+              child.destroy_with_children
+            end
+          end
+
+          # TODO - should be able to do this without renumbering the whole tree
+          # it's more complicated just decrementing the subsequent nodes though, as some need to change levels
+          #
+          # query = query_for_reference(reference[0, depth-1])
+          # query[:"reference.#{depth-1}"] = {:"$gt" => reference.last - 1}
+          #
+          # self.class.decrement(
+          #   query,
+          #   {:"reference.#{depth-1}" => 1}
+          # )
+
+          renumber_tree
+        end
+
+        # TODO - massively excessive - only renumber the required points
+        # To do that we need to figure out where it's moving from/to etc...
+        def renumber_tree_if_reference_changed
+          renumber_tree if reference_changed?
+        end
+
+        def renumber_tree
+          scope = {}
+          if referenced_tree_options[:scope]
+            scope[referenced_tree_options[:scope]] = self[referenced_tree_options[:scope]]
+          end
+
+          self.class.renumber_tree(scope)
+        end
+
+        def reposition_subsequent_nodes
+          self.class.set(
+            query_for_reference(reference),
+            {:"reference.#{depth-1}" => (reference[depth-1] + 1)}
+          )
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: mm-referenced-tree
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Richard Livsey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-19 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  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
+description: 
+email: richard@livsey.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- LICENSE
+- Rakefile
+- README.rdoc
+- lib/mm-referenced-tree.rb
+has_rdoc: true
+homepage: http://github.com/rlivsey/mm-referenced-tree
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: Yet another tree plugin for MongoMapper, built with an array of reference numbers
+test_files: []
+