mongoid-tree-rational 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05a801b4f6d70f729fa1f32d6836dc5404beb672
-  data.tar.gz: 500f13152270fe33af60bb9536f796f790082310
+  metadata.gz: 88f9bff4026794de9ad93338fe6179d545afa3cd
+  data.tar.gz: 46ecc1059a6810f063840be8cfaf06ee0d327303
 SHA512:
-  metadata.gz: 868ea89f0264f823d4deb7046e0078a2b2b74059326dc8b477299856539ea7d265f058912eecd8160190eca5e8b434922b85b5e57d79b79f6c34e4d6d737ceaa
-  data.tar.gz: 72d879b3c8ac06062bde4ebfb2ddcb68e832ea517744fe8130cd1846728ffdb2a879842f686e6e007a9a85216f7897873765fcea5f61130cf59cba29aac97d52
+  metadata.gz: 31247f27931a5024419b8842a9acce0c7b0f45f0dc02ca9090b3ebd7efa2d1bd39f9ecf25928c976f29c435cbf1f090649940cefc2f79f0d78e435097b224ec8
+  data.tar.gz: b48ca68a54c1a8a4c3bdfd6112564536653d4d47ae6a8a4f328e85ffd39642c8058a3b02915e37d520eb9bd995246c50b9ba1562829f734d8812fa51a73dc73e

data/Gemfile

@@ -14,13 +14,12 @@ group :development do
   gem 'wdm', :platforms => [:mswin, :mingw], :require => false
   gem 'awesome_print'
   gem 'timecop'
+  platforms :rbx do
+    gem 'rubysl-rake', '~> 2.0'
+  end
 end
 
 group :development, :test do
   gem 'coveralls', :require => false
   gem 'simplecov', :require => false
 end
-
-platforms :rbx do
-  gem 'rubysl-rake', '~> 2.0'
-end

data/README.md

@@ -78,8 +78,7 @@ See `Mongoid::Tree` for more information on these methods.
 
 To use rational ordering, include the `Mongoid::Tree::RationalNumbering` module. This will add a `position` field to your document and provide additional utility methods:
 
-While rational numbering requires more processing when saving, it does give the benefit of querying an entire tree in one go.
-
+While rational numbering requires more processing when saving, it does give the benefit of querying an entire tree in one query. This is really use
 
 Mathematical details about rational numbers in nested trees can be found here: [http://arxiv.org/pdf/0806.3115v1.pdf](http://arxiv.org/pdf/0806.3115v1.pdf)
 
@@ -125,7 +124,7 @@ Node.rekey_all! # Will iterate over the entire tree and rekey every single node.
 end
 ```
 
-You can get the entire tree in one go like this:
+Examples on querying trees:
 
 ```ruby
 # - node_1
@@ -141,6 +140,14 @@ You can get the entire tree in one go like this:
 
 Node.all  # Get the entire tree
 # -> [node_1, node_1_1, node_1_2, node_2, node_2_1, node_2_1_1, node_2_1_2, node_2_2, node_2_2_1, node_2_2_2]
+node_1.tree # Get tree below node 1
+# -> [node_1_1, node_1_2]
+node_1.tree_and_self # Get tree below node 1 including node_1
+# -> [node_1, node_1_1, node_1_2]
+node_2.tree # Get tree below node 1 including node_1
+# -> [node_2_1, node_2_1_1, node_2_1_2, node_2_2, node_2_2_1, node_2_2_2]
+node_2.tree_and_self # Get tree below node 1 including node_1
+# -> [node_2, node_2_1, node_2_1_1, node_2_1_2, node_2_2, node_2_2_1, node_2_2_2]
 end
 ```
 

data/Rakefile

@@ -1,43 +1,14 @@
 #!/usr/bin/env rake
 begin
   require 'bundler/setup'
+  require "bundler/gem_tasks"
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
-  RDoc::Task = Rake::RDocTask
-end
-
-version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name        = "mongoid-tree-rational"
-  gem.version     = version
-  gem.homepage    = "https://github.com/boxcms/mongoid-tree-rational"
-  gem.license     = "MIT"
-  gem.summary     = %Q{A tree structure for Mongoid documents with rational numbers}
-  gem.description = %Q{A tree structure for Mongoid documents using the materialized path pattern and rational number sorting.}
-  gem.email       = "leifcr@gmail.com"
-  gem.authors     = ['Leif Ringstad', 'Benedikt Deicke']
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
 
-# RDoc::Task.new(:rdoc) do |rdoc|
-#   rdoc.rdoc_dir = 'rdoc'
-#   rdoc.title    = "Mongoid Tree Rational #{version}"
-#   rdoc.options << '--line-numbers'
-#   rdoc.rdoc_files.include('README.rdoc')
-#   rdoc.rdoc_files.include('lib/**/*.rb')
-# end
+require 'yard'
 
-# Bundler::GemHelper.install_tasks
+version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
 require 'rspec/core'
 require 'rspec/core/rake_task'
@@ -45,17 +16,14 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
 task :default => :spec
 
-# YARD::Rake::YardocTask.new(:doc)
+YARD::Rake::YardocTask.new(:doc)
 
-desc "Open an irb session"
+desc "Open an irb session with spec_helper loaded"
 task :test_console do
   require 'ap'
   sh "irb -rubygems -I lib -r ./spec/spec_helper.rb"
-end
+end
+
+gemspec = eval(File.read("mongoid-tree-rational.gemspec"))

data/lib/mongoid/tree.rb

@@ -361,7 +361,7 @@ module Mongoid
     ##
     # Forces rearranging of all children after next save
     #
-    # @return [undefined]
+    # @return [void]
     def rearrange_children!
       @rearrange_children = true
     end
@@ -377,7 +377,7 @@ module Mongoid
     ##
     # Nullifies all children's parent_id
     #
-    # @return [undefined]
+    # @return [void]
     def nullify_children
       children.each do |c|
         c.parent = c.parent_id = nil
@@ -388,7 +388,7 @@ module Mongoid
     ##
     # Moves all children to this document's parent
     #
-    # @return [undefined]
+    # @return [void]
     def move_children_to_parent
       children.each do |c|
         c.parent = self.parent
@@ -399,7 +399,7 @@ module Mongoid
     ##
     # Deletes all descendants using the database (doesn't invoke callbacks)
     #
-    # @return [undefined]
+    # @return [void]
     def delete_descendants
       base_class.delete_all(:conditions => { :parent_ids => self.id })
     end
@@ -407,7 +407,7 @@ module Mongoid
     ##
     # Destroys all children by calling their #destroy method (does invoke callbacks)
     #
-    # @return [undefined]
+    # @return [void]
     def destroy_children
       children.destroy_all
     end
@@ -419,7 +419,7 @@ module Mongoid
     # rearrangement when the parent_ids changed
     #
     # @private
-    # @return [undefined]
+    # @return [void]
     def rearrange
       if self.parent_id
         self.parent_ids = parent.parent_ids + [self.parent_id]

data/lib/mongoid/tree/ordering.rb

@@ -113,7 +113,7 @@ module Mongoid
       ##
       # Move this node above all its siblings
       #
-      # @return [undefined]
+      # @return [void]
       def move_to_top
         return true if at_top?
         move_above(first_sibling_in_list)
@@ -122,7 +122,7 @@ module Mongoid
       ##
       # Move this node below all its siblings
       #
-      # @return [undefined]
+      # @return [void]
       def move_to_bottom
         return true if at_bottom?
         move_below(last_sibling_in_list)
@@ -131,7 +131,7 @@ module Mongoid
       ##
       # Move this node one position up
       #
-      # @return [undefined]
+      # @return [void]
       def move_up
         switch_with_sibling_at_offset(-1) unless at_top?
       end
@@ -139,7 +139,7 @@ module Mongoid
       ##
       # Move this node one position down
       #
-      # @return [undefined]
+      # @return [void]
       def move_down
         switch_with_sibling_at_offset(1) unless at_bottom?
       end
@@ -151,7 +151,7 @@ module Mongoid
       #
       # @param [Mongoid::Tree] other document to move this document above
       #
-      # @return [undefined]
+      # @return [void]
       def move_above(other)
         ensure_to_be_sibling_of(other)
 
@@ -175,7 +175,7 @@ module Mongoid
       #
       # @param [Mongoid::Tree] other document to move this document below
       #
-      # @return [undefined]
+      # @return [void]
       def move_below(other)
         ensure_to_be_sibling_of(other)
 

data/lib/mongoid/tree/rational_numbering.rb

@@ -9,6 +9,31 @@ module Mongoid
     ##
     # = Mongoid::Tree::RationalNumbering
     #
+    # Provides rational number sorting on your tree structure.
+    # This makes it simple to query for a tree given a node in a single query.
+    # Given this tree
+    # Node 1
+    #   Node 1-1
+    #   Node 1-2
+    #     Node 1-2-1
+    #     Node 1-2-2
+    #       Node 1-2-2-1
+    #       Node 1-2-2-2
+    #     Node 1-2-3
+    #   Node 1-3
+    # Node 2
+    #   Node 2-1
+    #     Node 2-1-1
+    #     Node 2-1-2
+    #   Node 2-2
+    # Node 3
+    # Node 4
+    #
+    # The entire tree can be queried like this:
+    # node_2 = Node.where(title: "Node 2").first
+    # node_1.tree returns:
+    # ["Node 2", "Node 2-1", "Node 2-1-1", "Node 2-1-2", "Node 2-2"]
+    #
     # Mongoid::Tree doesn't use rational numbers by default. To enable rational numbering
     # of children include both Mongoid::Tree and Mongoid::Tree::RationalNumbering into
     # your document.
@@ -61,7 +86,7 @@ module Mongoid
         ##
         # Set options for rational numbers
         #
-        # @param [Hash] options a hash
+        # @param opts [Hash] a hash of options
         #
         # :auto_tree_timestamping (true/false)
         # Per default timestamps are only updated on the a node that is changed, and not siblings that are moved/shifted
@@ -110,7 +135,7 @@ module Mongoid
       ##
       # Initialize the rational tree document
       #
-      # @return [undefined]
+      # @return [void]
       #
       def initialize(*args)
         @_forced_rational_number = false
@@ -141,10 +166,10 @@ module Mongoid
       # if a document exists on the new position, all siblings are shifted right before moving this document
       # can move without updating conflicting siblings by using :force in options
       #
-      # @param [Integer] The positional value
-      # @param [Hash] Options: :force (defaults to false)
+      # @param _position  [Integer] The positional value
+      # @param opts       [Hash]    :force (defaults to false)
       #
-      # @return [undefined]
+      # @return [void]
       #
       def move_to_position(_position, opts = {})
         new_rational_number = parent_rational_number.child_from_position(_position)
@@ -158,11 +183,11 @@ module Mongoid
       # if a document exists on the new position, all siblings are shifted right before moving this document
       # can move without updating conflicting siblings by using :ignore_conflicts in options
       #
-      # @param [Integer] The nominator value
-      # @param [Integer] The denominator value
-      # @param [Hash] Options: :force (defaults to false)
+      # @param nv   [Integer] The nominator value
+      # @param dv   [Integer] The denominator value
+      # @param opts [Hash]    Options: :force (defaults to false)
       #
-      # @return [undefined]
+      # @return [void]
       #
       def move_to_rational_number(nv, dv, opts = {})
         # don't check for conflict if forced move
@@ -186,6 +211,12 @@ module Mongoid
       # If the given nv/dv is higher than the last sibling under the parent, the nv/dv will be recalculated
       # to appropriate nv/dv values
       #
+      # @param nv       [Integer] The nominator value
+      # @param dv       [Integer] The denominator value
+      # @param do_save  [Boolean] true/false if the model should be saved or just updated
+      #
+      # @return [Boolean] returns the save value or true if do_save is set to false
+      #
       def set_rational_number(nv,dv, do_save = true)
         # return true of already at the right spot
         # puts "#{self.name} - set_rational_number #{nv}/#{dv} self:#{self.rational_number_nv}/#{self.rational_number_dv}"
@@ -250,6 +281,11 @@ module Mongoid
       # Will return true if the parent is "root" and the node should be created
       # as a root element
       #
+      # @param nv [Integer] The nominator value
+      # @param dv [Integer] The denominator value
+      #
+      # @return [Boolean] returns true if the parent exists
+      #
       def parent_exists?(nv,dv)
         q_parent = base_class.where(:rational_number_nv => nv).where(:rational_number_dv => dv).excludes(:id => self.id).first
         if q_parent.nil?
@@ -264,8 +300,10 @@ module Mongoid
       #
       # Move conflicting nodes for a given value
       #
-      # @param [Integer] The nominator value
-      # @param [Integer] The denominator value
+      # @param nv [Integer] The nominator value
+      # @param dv [Integer] The denominator value
+      #
+      # @return [void]
       #
       def move_conflicting_nodes(nv,dv)
         # As we are moving to the position of the conflicting sibling, it all items can be shifted similar to "move_above"
@@ -301,6 +339,9 @@ module Mongoid
       #
       # Verifies parent keys from calculation and query
       #
+      # @param nv [Integer] The nominator value
+      # @param dv [Integer] The denominator value
+      #
       # @return [Boolean] true for correct, else false
       #
       def correct_rational_parent?(nv, dv)
@@ -328,7 +369,7 @@ module Mongoid
       #
       # Rekey each of the children (usually forcefully if a tree has gone "crazy")
       #
-      # @return [undefined]
+      # @return [void]
       #
       def rekey_children
         _pos = 1
@@ -340,10 +381,22 @@ module Mongoid
         end
       end
 
+      ##
+      #
+      # Should the former siblings be rekeyed?
+      #
+      # @return [Boolean] true if needed, else false
+      #
       def rekey_former_siblings?
         persisted? && self.previous_changes.include?("parent_id")
       end
 
+      ##
+      #
+      # Rekey former siblings after a move
+      #
+      # @return [void]
+      #
       def rekey_former_siblings
         former_siblings = base_class.where(:parent_id => attribute_was('parent_id')).
                                      and(:rational_number_value.gt => (attribute_was('rational_number_value') || 0)).
@@ -354,6 +407,12 @@ module Mongoid
         end
       end
 
+      ##
+      #
+      # Move a node to given rational number and save/update the node
+      #
+      # @return [void]
+      #
       def move_node_and_save_if_changed(node, new_rational_number)
         if new_rational_number != node.rational_number
           node.move_to_rational_number(new_rational_number.nv, new_rational_number.dv, {:force => true})
@@ -374,8 +433,9 @@ module Mongoid
       ##
       # Convert from rational number and set keys accordingly
       #
-      # @param  [RationalNumber] The rational number for this node
-      # @return [undefined]
+      # @param rational_number [RationalNumber] The rational number for this node
+      #
+      # @return [void]
       #
       def from_rational_number(rational_number)
         self.rational_number_nv    = rational_number.nv
@@ -389,14 +449,16 @@ module Mongoid
       # Returns a chainable criteria for this document's ancestors
       #
       # @return [Mongoid::Criteria] Mongoid criteria to retrieve the document's ancestors
+      #
       def ancestors
         base_class.unscoped { super }
       end
 
       ##
-      #
       # Returns the positional value for the current node
       #
+      # @return [integer] The positional value calculated from the rational number
+      #
       def position
         self.rational_number.position
       end
@@ -406,6 +468,7 @@ module Mongoid
       # Siblings with a position greater than this document's position.
       #
       # @return [Mongoid::Criteria] Mongoid criteria to retrieve the document's lower siblings
+      #
       def lower_siblings
         self.siblings.where(:rational_number_value.gt => self.rational_number_value)
       end
@@ -415,6 +478,7 @@ module Mongoid
       # Siblings with a position lower than this document's position.
       #
       # @return [Mongoid::Criteria] Mongoid criteria to retrieve the document's higher siblings
+      #
       def higher_siblings
         self.siblings.where(:rational_number_value.lt => self.rational_number_value)
       end
@@ -423,7 +487,10 @@ module Mongoid
       # Returns siblings between the current document and the other document
       # Siblings with a position between this document's position and the other document's position.
       #
+      # @param other [Mongoid:Document] The other mongoid document
+      #
       # @return [Mongoid::Criteria] Mongoid criteria to retrieve the documents between this and the other document
+      #
       def siblings_between(other)
         range = [self.rational_number_value, other.rational_number_value].sort
         self.siblings.where(:rational_number_value.gt => range.first, :rational_number_value.lt => range.last)
@@ -432,6 +499,10 @@ module Mongoid
       ##
       # Return the siblings between this and other + other
       #
+      # @param other [Mongoid:Document] The other mongoid document
+      #
+      # @return [Mongoid::Criteria] Mongoid criteria to retrieve the documents between this and the other document
+      #
       def siblings_between_including_other(other)
         range = [self.rational_number_value, other.rational_number_value].sort
         self.siblings.where(:rational_number_value.gte => range.first, :rational_number_value.lte => range.last)
@@ -441,6 +512,7 @@ module Mongoid
       # Returns the lowest sibling (could be self)
       #
       # @return [Mongoid::Document] The lowest sibling
+      #
       def last_sibling_in_list
         siblings_and_self.last
       end
@@ -449,6 +521,7 @@ module Mongoid
       # Returns the highest sibling (could be self)
       #
       # @return [Mongoid::Document] The highest sibling
+      #
       def first_sibling_in_list
         siblings_and_self.first
       end
@@ -457,6 +530,7 @@ module Mongoid
       # Is this the highest sibling?
       #
       # @return [Boolean] Whether the document is the highest sibling
+      #
       def at_top?
         higher_siblings.empty?
       end
@@ -465,6 +539,7 @@ module Mongoid
       # Is this the lowest sibling?
       #
       # @return [Boolean] Whether the document is the lowest sibling
+      #
       def at_bottom?
         lower_siblings.empty?
       end
@@ -472,7 +547,8 @@ module Mongoid
       ##
       # Move this node above all its siblings
       #
-      # @return [undefined]
+      # @return [void]
+      #
       def move_to_top
         return true if at_top?
         move_above(first_sibling_in_list)
@@ -481,7 +557,8 @@ module Mongoid
       ##
       # Move this node below all its siblings
       #
-      # @return [undefined]
+      # @return [void]
+      #
       def move_to_bottom
         return true if at_bottom?
         move_below(last_sibling_in_list)
@@ -490,7 +567,8 @@ module Mongoid
       ##
       # Move this node one position up
       #
-      # @return [undefined]
+      # @return [void]
+      #
       def move_up
         unless at_top?
           prev_sibling = higher_siblings.last
@@ -501,7 +579,8 @@ module Mongoid
       ##
       # Move this node one position down
       #
-      # @return [undefined]
+      # @return [void]
+      #
       def move_down
         unless at_bottom?
           next_sibling = lower_siblings.first
@@ -512,10 +591,11 @@ module Mongoid
       ##
       # Shift nodes between self and other (or including other) in one or the other direction
       #
-      # @param [Mongoid::Tree] other document to move this document above
-      # @param [Integer] +1 / -1 for the direction to shift nodes
-      # @param [Boolean] exclude the other object in the shift or not.
+      # @param other          [Mongoid::Document]   Other document to move this document above
+      # @param direction      [Integer]             +1 / -1 for the direction to shift nodes
+      # @param exclude_other  [Boolean]             exclude the other object in the shift or not.
       #
+      # @return [void]
       #
       def shift_nodes_position(other, direction, exclude_other = false)
         without_timestamping do
@@ -529,6 +609,14 @@ module Mongoid
         end
       end
 
+      ##
+      # Shift nodes between self and other (or including other) in one or the other direction
+      #
+      # @param other          [Mongoid::Document]   Other document to move this document above
+      # @param direction      [Integer]             +1 / -1 for the direction to shift nodes
+      #
+      # @return [void]
+      #
       def shift_lower_nodes_from_other(other, direction)
         # puts "#{self.name} shift_lower_nodes_from_other other: #{other.name} direction: #{direction} other.siblings_and_self.count: #{other.siblings_and_self.count}"
         range = [other.rational_number_value, other.siblings_and_self.last.rational_number_value].sort
@@ -536,6 +624,14 @@ module Mongoid
         shift_nodes(nodes_to_shift, direction)
       end
 
+      ##
+      # Shift nodes in a direction
+      #
+      # @param nodes_to_shift   [Array]     Array of documents to shift in a given direction
+      # @param direction        [Integer]   +1 / -1 for the direction to shift nodes
+      #
+      # @return [void]
+      #
       def shift_nodes(nodes_to_shift, direction)
         # puts "#{self.name} shift_nodes direction: #{direction}"
         without_timestamping do
@@ -553,9 +649,10 @@ module Mongoid
       #
       # This method changes the node's parent if nescessary.
       #
-      # @param [Mongoid::Tree] other document to move this document above
+      # @param other [Mongoid::Document] document to move this document above
+      #
+      # @return [void]
       #
-      # @return [undefined]
       def move_above(other)
         ensure_to_be_sibling_of(other)
         return if other.position == self.position + 1
@@ -576,9 +673,10 @@ module Mongoid
       #
       # This method changes the node's parent if nescessary.
       #
-      # @param [Mongoid::Tree] other document to move this document below
+      # @param other [Mongoid::Document] document to move this document above
+      #
+      # @return [void]
       #
-      # @return [undefined]
       def move_below(other)
         ensure_to_be_sibling_of(other)
         return if other.position + 1 == self.position
@@ -599,8 +697,10 @@ module Mongoid
 
       ##
       # Call block without triggeringtimestamps
-      # @param [&block] code block to call
-
+      # @param block code block to call
+      #
+      # @return [void]
+      #
       def without_timestamping(&block)
         # # puts "without_timestamping: Automagic timpestamping enabled? #{self.class.auto_tree_timestamping}"
         disable_timestamp_callback() if self.class.auto_tree_timestamping
@@ -612,7 +712,7 @@ module Mongoid
       # Disable the timestamps for the document type, and increase the disable count
       # Will only disable once, even if called multiple times
       #
-      # @return [undefined]
+      # @return [void]
       def disable_timestamp_callback
         # # puts "Disabling timestamp callback count: #{@@_disable_timestamp_count}"
         if self.respond_to?("updated_at")
@@ -625,7 +725,7 @@ module Mongoid
       # Enable the timestamps for the document type, and decrease the disable count
       # Will only enable once, even if called multiple times
       #
-      # @return [undefined]
+      # @return [void]
       def enable_timestamp_callback
         # # puts "Enabling timestamp callback count: #{@@_disable_timestamp_count}"
         if self.respond_to?("updated_at")
@@ -646,7 +746,7 @@ module Mongoid
       # If there are both changes to nv/dv and parent_id, nv/dv settings takes
       # precedence over parent_id changes
       #
-      # @return [undefined]
+      # @return [void]
       #
       def update_rational_number
         if self.rational_number_nv_changed? && self.rational_number_dv_changed? && !self.rational_number_value.nil? && !set_initial_rational_number?
@@ -745,9 +845,9 @@ module Mongoid
       #
       # Switch location with a given sibling
       #
-      # @param [Mongoid::Tree] other document to switch places with
+      # @param sibling [Mongoid:Document] The other sibling document to switch place with
       #
-      # @return [undefined]
+      # @return [void]
       #
       def switch_with_sibling(sibling)
         self_pos = self.position
@@ -764,9 +864,9 @@ module Mongoid
       #
       # Ensure this is a sibling of given other, if not, move it to the same parent
       #
-      # @param [Mongoid::Tree] other document to ensure sibling relation
+      # @param other [Mongoid:Document] The other mongoid document to ensure sibling relation
       #
-      # @return [undefined]
+      # @return [void]
       #
       def ensure_to_be_sibling_of(other)
         return if sibling_of?(other)
@@ -774,6 +874,15 @@ module Mongoid
         save!
       end
 
+      ##
+      #
+      # Make sure the correct parent is set, if not, update the parent accordingly
+      #
+      # @param nv [Integer] The nominator value
+      # @param dv [Integer] The denominator value
+      #
+      # @return [void]
+      #
       def ensure_to_have_correct_parent(nv,dv)
         # puts "#{self.name} ensure_to_have_correct_parent #{nv}/#{dv}"
         new_rational_number = RationalNumber.new(nv,dv)
@@ -798,7 +907,10 @@ module Mongoid
         self.parent = new_parent
       end
 
+      ##
+      #
       # Shifting/rekeying of lower siblings on destroy
+      #
       def move_lower_siblings
         without_timestamping do
           lower_siblings.each do |sibling|

data/lib/mongoid/tree/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module RationalTree
+    VERSION = '2.0.1'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-tree-rational
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Leif Ringstad
@@ -32,214 +32,83 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rational_number
+  name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubysl-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.6.0
-- !ruby/object:Gem::Dependency
-  name: rb-inotify
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rb-fsevent
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: wdm
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 description: A tree structure for Mongoid documents using the materialized path pattern
   and rational number sorting.
 email: leifcr@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.md
+extra_rdoc_files: []
 files:
-- ".rspec"
-- ".travis.yml"
 - Gemfile
-- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -250,7 +119,7 @@ files:
 - lib/mongoid/tree/ordering.rb
 - lib/mongoid/tree/rational_numbering.rb
 - lib/mongoid/tree/traversal.rb
-- mongoid-tree-rational.gemspec
+- lib/mongoid/tree/version.rb
 - spec/mongoid/tree/ordering_spec.rb
 - spec/mongoid/tree/rational_numbering_spec.rb
 - spec/mongoid/tree/traversal_spec.rb
@@ -282,4 +151,12 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A tree structure for Mongoid documents with rational numbers
-test_files: []
+test_files:
+- spec/mongoid/tree/rational_numbering_spec.rb
+- spec/mongoid/tree/traversal_spec.rb
+- spec/mongoid/tree/ordering_spec.rb
+- spec/mongoid/tree_spec.rb
+- spec/spec_helper.rb
+- spec/support/models/node.rb
+- spec/support/macros/tree_macros.rb
+has_rdoc: 

data/.rspec

@@ -1,2 +0,0 @@
---color
---format documentation

data/.travis.yml

@@ -1,10 +0,0 @@
-before_install:
-  - gem update --system
-  - gem --version
-language: ruby
-rvm:
-  - 2.0.0
-  - 2.1.2
-  - rbx-2
-services:
-  - mongodb

data/Guardfile

@@ -1,6 +0,0 @@
-guard 'rspec' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^spec/support/.+\.rb$}) { "spec" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end

data/mongoid-tree-rational.gemspec

@@ -1,104 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: mongoid-tree-rational 2.0.0 ruby lib
-
-Gem::Specification.new do |s|
-  s.name = "mongoid-tree-rational"
-  s.version = "2.0.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Leif Ringstad", "Benedikt Deicke"]
-  s.date = "2014-08-20"
-  s.description = "A tree structure for Mongoid documents using the materialized path pattern and rational number sorting."
-  s.email = "leifcr@gmail.com"
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.md"
-  ]
-  s.files = [
-    ".rspec",
-    ".travis.yml",
-    "Gemfile",
-    "Guardfile",
-    "LICENSE",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "lib/mongoid/locale/en.yml",
-    "lib/mongoid/locale/nb.yml",
-    "lib/mongoid/tree.rb",
-    "lib/mongoid/tree/ordering.rb",
-    "lib/mongoid/tree/rational_numbering.rb",
-    "lib/mongoid/tree/traversal.rb",
-    "mongoid-tree-rational.gemspec",
-    "spec/mongoid/tree/ordering_spec.rb",
-    "spec/mongoid/tree/rational_numbering_spec.rb",
-    "spec/mongoid/tree/traversal_spec.rb",
-    "spec/mongoid/tree_spec.rb",
-    "spec/spec_helper.rb",
-    "spec/support/macros/tree_macros.rb",
-    "spec/support/models/node.rb"
-  ]
-  s.homepage = "https://github.com/boxcms/mongoid-tree-rational"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.2"
-  s.summary = "A tree structure for Mongoid documents with rational numbers"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<mongoid>, ["<= 5.0", ">= 4.0"])
-      s.add_runtime_dependency(%q<rational_number>, [">= 0"])
-      s.add_runtime_dependency(%q<rubysl-rake>, ["~> 2.0"])
-      s.add_development_dependency(%q<rake>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<yard>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<guard-rspec>, [">= 2.6.0"])
-      s.add_development_dependency(%q<rb-inotify>, [">= 0"])
-      s.add_development_dependency(%q<rb-fsevent>, [">= 0"])
-      s.add_development_dependency(%q<wdm>, [">= 0"])
-      s.add_development_dependency(%q<awesome_print>, [">= 0"])
-      s.add_development_dependency(%q<timecop>, [">= 0"])
-      s.add_development_dependency(%q<coveralls>, [">= 0"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
-    else
-      s.add_dependency(%q<mongoid>, ["<= 5.0", ">= 4.0"])
-      s.add_dependency(%q<rational_number>, [">= 0"])
-      s.add_dependency(%q<rubysl-rake>, ["~> 2.0"])
-      s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<yard>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<guard-rspec>, [">= 2.6.0"])
-      s.add_dependency(%q<rb-inotify>, [">= 0"])
-      s.add_dependency(%q<rb-fsevent>, [">= 0"])
-      s.add_dependency(%q<wdm>, [">= 0"])
-      s.add_dependency(%q<awesome_print>, [">= 0"])
-      s.add_dependency(%q<timecop>, [">= 0"])
-      s.add_dependency(%q<coveralls>, [">= 0"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<mongoid>, ["<= 5.0", ">= 4.0"])
-    s.add_dependency(%q<rational_number>, [">= 0"])
-    s.add_dependency(%q<rubysl-rake>, ["~> 2.0"])
-    s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<yard>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<guard-rspec>, [">= 2.6.0"])
-    s.add_dependency(%q<rb-inotify>, [">= 0"])
-    s.add_dependency(%q<rb-fsevent>, [">= 0"])
-    s.add_dependency(%q<wdm>, [">= 0"])
-    s.add_dependency(%q<awesome_print>, [">= 0"])
-    s.add_dependency(%q<timecop>, [">= 0"])
-    s.add_dependency(%q<coveralls>, [">= 0"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
-  end
-end
-