mongoid-tree-rational 0.1.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05a801b4f6d70f729fa1f32d6836dc5404beb672
+  data.tar.gz: 500f13152270fe33af60bb9536f796f790082310
+SHA512:
+  metadata.gz: 868ea89f0264f823d4deb7046e0078a2b2b74059326dc8b477299856539ea7d265f058912eecd8160190eca5e8b434922b85b5e57d79b79f6c34e4d6d737ceaa
+  data.tar.gz: 72d879b3c8ac06062bde4ebfb2ddcb68e832ea517744fe8130cd1846728ffdb2a879842f686e6e007a9a85216f7897873765fcea5f61130cf59cba29aac97d52

data/.travis.yml

@@ -4,9 +4,7 @@ before_install:
 language: ruby
 rvm:
   - 2.0.0
-  - 1.9.3
-  - 2.0.0
-  - jruby-19mode
-  - rbx-19mode
+  - 2.1.2
+  - rbx-2
 services:
   - mongodb

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'mongoid', ['<= 4.0', '>= 3.0']
+gem 'mongoid', ['<= 5.0', '>= 4.0']
 gem 'rational_number'
 
 group :development do
@@ -12,12 +12,15 @@ group :development do
   gem 'rb-inotify', :require => false
   gem 'rb-fsevent', :require => false
   gem 'wdm', :platforms => [:mswin, :mingw], :require => false
-  gem 'hirb'
-  gem 'wirble'
   gem 'awesome_print'
+  gem 'timecop'
 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

@@ -4,9 +4,10 @@ A tree structure for Mongoid documents using rational numbers and materialized p
 
 ## Requirements
 
-* mongoid (~> 3.0)
+* mongoid (~> 4.0)
 
-This version will only support mongoid 3.0+
+Version 2.x.x supports mongoid 4.x
+Version 0.1.x supports Mongoid 3.x
 
 ## Install
 
@@ -18,7 +19,7 @@ In order to get the latest development version of mongoid-tree:
 
     gem 'mongoid-tree-rational', :git => 'git://github.com/boxcms/mongoid-tree-rational', :require => 'mongoid/tree'
 
-You might want to remove the `:require => 'mongoid/tree'` option and explicitly `require 'mongoid/tree'` where needed and finally run
+You might want to add `:require => nil` option and explicitly `require 'mongoid/tree'` where needed and finally run
 
     bundle install
 
@@ -258,9 +259,43 @@ class Node
 end
 ```
 
+### Timestamps
+
+Per default timestamps are only updated on the a node that is changed, and not siblings that are moved/shifted due to changes on a given node. Usually the tree position of a document does not give information about changes to the content of the document. This behaviour can be changed through the option ```auto_tree_timestamping``` .
+
+Disable auto timestamps:
+
+```ruby
+class Node
+  include Mongoid::Document
+  include Mongoid::Tree
+  include Mongoid::Tree::RationalNumbering
+
+  self.auto_tree_timestamping = false
+
+  validates_associated :parent, :children
+end
+```
+
+Enable auto timestamps: (default behaviour)
+
+```ruby
+class Node
+  include Mongoid::Document
+  include Mongoid::Tree
+  include Mongoid::Tree::RationalNumbering
+
+  self.auto_tree_timestamping = false
+
+  validates_associated :parent, :children
+end
+```
+
+
+
 ## Build Status
 
-mongoid-tree is on [Travis CI](http://travis-ci.org/boxcms/mongoid-tree-rational) running the specs on Ruby Head, Ruby 1.9.3, JRuby (1.9 mode), and Rubinius (1.9 mode).
+mongoid-tree is on tested on [Travis CI](http://travis-ci.org/boxcms/mongoid-tree-rational) running the specs against ruby 2.0.0, ruby 2.1.2 and rbx-2
 
 ## Known issues
 

data/Rakefile

@@ -56,8 +56,6 @@ task :default => :spec
 
 desc "Open an irb session"
 task :test_console do
-  require 'wirble'
   require 'ap'
-  require 'hirb'
   sh "irb -rubygems -I lib -r ./spec/spec_helper.rb"
 end

data/VERSION

@@ -1 +1 @@
-0.1.0
+2.0.0

data/lib/mongoid/locale/en.yml

@@ -3,7 +3,7 @@ en:
     errors:
       messages:
         tree:
-          cyclic: "Can't be children of a descendant"
+          cyclic: "Can't be child of a descendant"
           search_class_mismatch: "Mismatch between search classes. Parent: %{parent_search_class} Node: %{node_search_class}"
           rational:
             incorrect_parent:      "Positional values doesn't match parent (check nv/dv values)"

data/lib/mongoid/tree.rb

@@ -1,3 +1,5 @@
+require 'active_support/concern'
+
 module Mongoid
   ##
   # = Mongoid::Tree
@@ -88,8 +90,10 @@ module Mongoid
 
       belongs_to :parent, :class_name => self.name, :inverse_of => :children, :index => true, :validate => false
 
-      field :parent_ids, :type => Array, :default => []
+      field :parent_ids, type: Array, default: []
       index :parent_ids => 1
+      field :depth, type: Integer
+      index depth: 1
 
       set_callback :save, :after, :rearrange_children, :if => :rearrange_children?
       set_callback :validation, :before do
@@ -248,7 +252,7 @@ module Mongoid
     #
     # @return [Fixnum] Depth of this document
     def depth
-      parent_ids.count
+      super || parent_ids.count
     end
 
     ##
@@ -273,13 +277,7 @@ module Mongoid
     #
     # @return [Mongoid::Criteria] Mongoid criteria to retrieve the documents ancestors
     def ancestors
-      if parent_ids.any?
-        base_class.and({
-          '$or' => parent_ids.map { |id| { :_id => id } }
-        })
-      else
-        base_class.where(:_id.in => [])
-      end
+      base_class.where(:_id.in => parent_ids).order(:depth => :asc)
     end
 
     ##
@@ -428,6 +426,7 @@ module Mongoid
       else
         self.parent_ids = []
       end
+      self.depth = parent_ids.size
       rearrange_children! if self.parent_ids_changed?
     end
 

data/lib/mongoid/tree/ordering.rb

@@ -33,9 +33,9 @@ module Mongoid
       extend ActiveSupport::Concern
 
       included do
-        field :position, :type => Integer
+        field :position, type: Integer
 
-        default_scope asc(:position)
+        default_scope ->{ asc(:position) }
 
         before_save :assign_default_position, :if => :assign_default_position?
         before_save :reposition_former_siblings, :if => :sibling_reposition_required?
@@ -157,11 +157,11 @@ module Mongoid
 
         if position > other.position
           new_position = other.position
-          self.siblings_between(other).inc(:position, 1)
-          other.inc(:position, 1)
+          self.siblings_between(other).inc(position: 1)
+          other.inc(position: 1)
         else
           new_position = other.position - 1
-          self.siblings_between(other).inc(:position, -1)
+          self.siblings_between(other).inc(position: -1)
         end
 
         self.position = new_position
@@ -181,11 +181,11 @@ module Mongoid
 
         if position > other.position
           new_position = other.position + 1
-          self.siblings_between(other).inc(:position, 1)
+          self.siblings_between(other).inc(position: 1)
         else
           new_position = other.position
-          self.siblings_between(other).inc(:position, -1)
-          other.inc(:position, -1)
+          self.siblings_between(other).inc(position: -1)
+          other.inc(position: -1)
         end
 
         self.position = new_position
@@ -195,8 +195,8 @@ module Mongoid
     private
 
       def switch_with_sibling_at_offset(offset)
-        siblings.where(:position => self.position + offset).first.inc(:position, -offset)
-        inc(:position, offset)
+        siblings.where(position: self.position + offset).first.inc(position: -offset)
+        inc(position: offset)
       end
 
       def ensure_to_be_sibling_of(other)
@@ -206,14 +206,14 @@ module Mongoid
       end
 
       def move_lower_siblings_up
-        lower_siblings.inc(:position, -1)
+        lower_siblings.inc(position: -1)
       end
 
       def reposition_former_siblings
         former_siblings = base_class.where(:parent_id => attribute_was('parent_id')).
                                      and(:position.gt => (attribute_was('position') || 0)).
                                      excludes(:id => self.id)
-        former_siblings.inc(:position,  -1)
+        former_siblings.inc(position:  -1)
       end
 
       def sibling_reposition_required?

data/lib/mongoid/tree/rational_numbering.rb

@@ -22,11 +22,11 @@ module Mongoid
       @@_disable_timestamp_count = 0
 
       included do
-        field :rational_number_nv,    :type => Integer, :default => 0
-        field :rational_number_dv,    :type => Integer, :default => 1
-        field :rational_number_snv,   :type => Integer, :default => 1
-        field :rational_number_sdv,   :type => Integer, :default => 0
-        field :rational_number_value, :type => BigDecimal
+        field :rational_number_nv,    type: Integer, default: 0
+        field :rational_number_dv,    type: Integer, default: 1
+        field :rational_number_snv,   type: Integer, default: 1
+        field :rational_number_sdv,   type: Integer, default: 0
+        field :rational_number_value, type: BigDecimal
 
         validate          :validate_rational_hierarchy
 
@@ -47,11 +47,35 @@ module Mongoid
 
         after_destroy :move_lower_siblings
 
-        default_scope asc(:rational_number_value)
+        default_scope ->{ asc(:rational_number_value) }
 
       end # included do
 
       module ClassMethods
+        attr_writer :auto_tree_timestamping
+
+        def auto_tree_timestamping
+          @auto_tree_timestamping.nil? ? true : @auto_tree_timestamping
+        end
+
+        ##
+        # Set options for rational numbers
+        #
+        # @param [Hash] options a hash
+        #
+        # :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
+        # due to changes on a given node. Usually the tree position of a document does not give information about
+        # changes to the content of the document. This behaviour can be changed through the option
+        # ':auto_tree_timestamping'.
+
+        def rational_number_options(opts)
+          if !opts[:auto_tree_timestamping].nil?
+            @auto_tree_timestamping = !!opts[:auto_tree_timestamping]
+          else
+            @auto_tree_timestamping = true
+          end
+        end
 
         # helper metods for nv/dv
 
@@ -103,7 +127,6 @@ module Mongoid
       #
       def validate_rational_hierarchy
         if self.rational_number_nv_changed? && self.rational_number_dv_changed?
-          # puts "#{self.name} #{self.changes.inspect}"
           unless correct_rational_parent?(self.rational_number_nv, self.rational_number_dv)
             errors.add(:base, I18n.t(:cyclic, :scope => [:mongoid, :errors, :messages, :tree]))
           end
@@ -147,6 +170,10 @@ module Mongoid
 
         # shouldn't be any conflicting sibling now...
         self.from_rational_number(RationalNumber.new(nv,dv))
+        # if parent_id is unknown, find parent and set correct parent_id
+        if self.parent_id.nil? and self.rational_number.root?
+          # puts "!!!!!!!!! #{self.name} move_to_rational_number missing parent and NOT root rational number!"
+        end
       end
 
       ##
@@ -173,7 +200,7 @@ module Mongoid
         other = base_class.where(:rational_number_nv => nv).where(:rational_number_dv => dv).excludes(:id => self.id).first
         already_sibling_of = other.nil? ? false : self.sibling_of?(other)
 
-        # puts "  conflict: #{other.nil?} already_sibling_of :#{already_sibling_of}"
+        # puts "  conflicting node: #{other.nil? ? '-' : other.name } already_sibling_of :#{already_sibling_of}"
         return false if ensure_to_have_correct_parent(nv,dv) == false
 
         move_to_rational = RationalNumber.new(nv,dv)
@@ -245,12 +272,15 @@ module Mongoid
 
         conflicting_sibling = base_class.where(:rational_number_nv => nv).where(:rational_number_dv => dv).excludes(:id => self.id).first
         if (conflicting_sibling != nil)
-          # ensure_to_be_sibling_of(conflicting_sibling)
-          return if conflicting_sibling.position == self.position + 1
-          # If there are nodes between this and conflicting_sibling before move, make sure their position shifted before moving
-          _direction = (self.position > conflicting_sibling.position ? 1 : -1)
-          _position = (_direction < 0 ? conflicting_sibling.position + _direction : conflicting_sibling.position)
-          shift_nodes_position(conflicting_sibling, _direction, (_direction > 0 ? false : true))
+        # puts "moving conflicting nodes"
+          without_timestamping do
+            # ensure_to_be_sibling_of(conflicting_sibling)
+            return if conflicting_sibling.position == self.position + 1
+            # If there are nodes between this and conflicting_sibling before move, make sure their position shifted before moving
+            _direction = (self.position > conflicting_sibling.position ? 1 : -1)
+            _position = (_direction < 0 ? conflicting_sibling.position + _direction : conflicting_sibling.position)
+            shift_nodes_position(conflicting_sibling, _direction, (_direction > 0 ? false : true))
+          end
         end
       end
 
@@ -261,6 +291,7 @@ module Mongoid
       # @return [RationalNumber] returns the rational number for the ancestor or nil for "not found"
       #
       def query_ancestor_rational_number
+        # puts "  #{self.name} query_ancestor_rational_number parent_id: #{self.parent_id}"
         check_parent = base_class.where(:_id => self.parent_id).first
         return nil if (check_parent.nil? || check_parent == [])
         check_parent.rational_number
@@ -274,6 +305,7 @@ module Mongoid
       #
       def correct_rational_parent?(nv, dv)
         q_rational_number = query_ancestor_rational_number
+        # puts "  #{self.name} correct_rational_parent? nv: #{nv} dv: #{dv} query_ancestor_rational_number: #{q_rational_number.inspect}"
         if q_rational_number.nil?
           if RationalNumber.new(nv,dv).parent.root?
             return true
@@ -330,37 +362,6 @@ module Mongoid
         end
       end
 
-      ##
-      #
-      # Not needed, as each child gets the rational number updated after updating path?
-      # @return [undefined]
-      #
-      # def children_update_rational_number
-      #   if rearrange_children?
-      #     _position = 0
-      #     # self.disable_timestamp_callback()
-      #     self.children.each do |child|
-      #       child.update_rational_number!(:position => _position)
-      #       _position += 1
-      #     end
-      #     # self.enable_timestamp_callback()
-      #   end
-      # end
-
-      ##
-      # Enable timestamping callback if existing
-      #
-      def enable_timestamp_callback
-
-      end
-
-      ##
-      # Disable timestamping callback if existing
-      #
-      def disable_timestamp_callback
-
-      end
-
       ##
       # Convert to rational number
       #
@@ -517,29 +518,33 @@ module Mongoid
       #
       #
       def shift_nodes_position(other, direction, exclude_other = false)
-        # puts "#{self.name} shift_nodes_position other: #{other.name} direction #{direction} exclude_other: #{exclude_other}"
-        if exclude_other
-          nodes_to_shift = siblings_between(other)
-        else
-          nodes_to_shift = siblings_between_including_other(other)
+        without_timestamping do
+          # puts "#{self.name} shift_nodes_position other: #{other.name} direction #{direction} exclude_other: #{exclude_other}"
+          if exclude_other
+            nodes_to_shift = siblings_between(other)
+          else
+            nodes_to_shift = siblings_between_including_other(other)
+          end
+          shift_nodes(nodes_to_shift, direction)
         end
-        shift_nodes(nodes_to_shift, direction)
       end
 
       def shift_lower_nodes_from_other(other, direction)
-        # puts "#{self.name} shift_lower_nodes_from_other other: #{other.name} direction: #{direction}"
-        range = [other.rational_number_value, other.siblings.last.rational_number_value].sort
+        # 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
         nodes_to_shift = other.siblings_and_self.where(:rational_number_value.gte => range.first, :rational_number_value.lte => range.last)
         shift_nodes(nodes_to_shift, direction)
       end
 
       def shift_nodes(nodes_to_shift, direction)
         # puts "#{self.name} shift_nodes direction: #{direction}"
-        nodes_to_shift.each do |node_to_shift|
-          pos = node_to_shift.position + direction
-          # puts "  shifting #{node_to_shift.name} from position #{node_to_shift.position} to #{pos}"
-          node_to_shift.move_to_position(pos, {:force => true})
-          node_to_shift.save_with_force_rational_numbers!
+        without_timestamping do
+          nodes_to_shift.each do |node_to_shift|
+            pos = node_to_shift.position + direction
+            # puts "  shifting #{node_to_shift.name} from position #{node_to_shift.position} to #{pos}"
+            node_to_shift.move_to_position(pos, {:force => true})
+            node_to_shift.save_with_force_rational_numbers!
+          end
         end
       end
 
@@ -589,14 +594,29 @@ module Mongoid
         @_rational_moving_nodes = false
       end
 
+
+      ## These are only used when a document is shifted/moved because of repositioning another document.
+
+      ##
+      # Call block without triggeringtimestamps
+      # @param [&block] code block to call
+
+      def without_timestamping(&block)
+        # # puts "without_timestamping: Automagic timpestamping enabled? #{self.class.auto_tree_timestamping}"
+        disable_timestamp_callback() if self.class.auto_tree_timestamping
+        yield
+        enable_timestamp_callback()  if self.class.auto_tree_timestamping
+      end
+
       ##
       # Disable the timestamps for the document type, and increase the disable count
       # Will only disable once, even if called multiple times
       #
       # @return [undefined]
       def disable_timestamp_callback
+        # # puts "Disabling timestamp callback count: #{@@_disable_timestamp_count}"
         if self.respond_to?("updated_at")
-          self.class.skip_callback(:save, :before, :update_timestamps ) if @@_disable_timestamp_count == 0
+          self.class.skip_callback(:update, :before, :set_updated_at ) if @@_disable_timestamp_count == 0
           @@_disable_timestamp_count += 1
         end
       end
@@ -607,9 +627,10 @@ module Mongoid
       #
       # @return [undefined]
       def enable_timestamp_callback
+        # # puts "Enabling timestamp callback count: #{@@_disable_timestamp_count}"
         if self.respond_to?("updated_at")
           @@_disable_timestamp_count -= 1
-          self.class.set_callback(:save, :before, :update_timestamps ) if @@_disable_timestamp_count == 0
+          self.class.set_callback(:update, :before, :set_updated_at ) if @@_disable_timestamp_count == 0
         end
       end
 
@@ -692,6 +713,7 @@ module Mongoid
       # save when forcing rational numbers
       #
       def save_with_force_rational_numbers!
+        # puts "-- Saving #{self.name} #{self.updated_at.utc}" if self.respond_to?("updated_at")
         @_forced_rational_number = true
         self.save!
         @_forced_rational_number = false
@@ -730,9 +752,11 @@ module Mongoid
       def switch_with_sibling(sibling)
         self_pos = self.position
         sibling_pos = sibling.position
-        sibling.move_to_position(self_pos, {:force => true})
-        self.move_to_position(sibling_pos, {:force => true})
-        sibling.save_with_force_rational_numbers!
+        without_timestamping do
+          sibling.move_to_position(self_pos, {:force => true})
+          self.move_to_position(sibling_pos, {:force => true})
+          sibling.save_with_force_rational_numbers!
+        end
         self.save_with_force_rational_numbers!
       end
 
@@ -755,13 +779,18 @@ module Mongoid
         new_rational_number = RationalNumber.new(nv,dv)
         new_parent = nil
         # puts "  root: #{new_rational_number.root?} #{("parent: " + self.parent.name + " nv/dv : "+ self.parent.rational_number.nv.to_s+ "/"+ self.parent.rational_number.dv.to_s) unless self.parent.nil?}#{"parent: nil" if self.parent.nil?}"
-        if self.parent == nil
+        if self.parent.nil?
+          # puts "    new_rational_number.parent == RationalNumber.new #{new_rational_number.parent == RationalNumber.new}"
           return true if new_rational_number.parent == RationalNumber.new
+          new_parent = base_class.where(:rational_number_nv => new_rational_number.parent.nv, :rational_number_dv => new_rational_number.parent.dv).first
         elsif new_rational_number.parent.root?
+          # puts "    new_rational_number.parent.root? #{new_rational_number.parent.root?}"
           new_parent = nil
         else
+          # puts "    self.parent.rational_number == new_rational_number.parent #{self.parent.rational_number == new_rational_number.parent}"
           return true if self.parent.rational_number == new_rational_number.parent
-          new_parent = base_class.where(:rational_number_nv => new_rational_number.parent.nv, :rational_number_dv => new_rational_number.dv)
+          # puts "    searching for parent: #{new_rational_number.parent.nv}, #{new_rational_number.parent.dv}"
+          new_parent = base_class.where(:rational_number_nv => new_rational_number.parent.nv, :rational_number_dv => new_rational_number.parent.dv).first
           return false if new_parent.nil? # INVALID PARENT
         end
         # If entered here, the parent needs to change
@@ -769,14 +798,13 @@ module Mongoid
         self.parent = new_parent
       end
 
-      # FIX THESE SHIT CASE FUCK!
-
+      # Shifting/rekeying of lower siblings on destroy
       def move_lower_siblings
-        lower_siblings.each do |sibling|
-          disable_timestamp_callback
-          sibling.move_to_position(sibling.position - 1)
-          sibling.save_with_force_rational_numbers!
-          enable_timestamp_callback
+        without_timestamping do
+          lower_siblings.each do |sibling|
+            sibling.move_to_position(sibling.position - 1)
+            sibling.save_with_force_rational_numbers!
+          end
         end
       end
 
@@ -791,8 +819,6 @@ module Mongoid
       #   parent_id_changed? && persisted?
       # end
 
-
-
     end # RationalNumbering
   end # Tree
 end # Mongoid