mongoid_orderable 6.0.4 → 6.0.6

data/lib/mongoid/orderable/generators/movable.rb

@@ -1,62 +1,62 @@
-# frozen_string_literal: true
-
-module Mongoid
-module Orderable
-module Generators
-  class Movable < Base
-    def generate(field_name)
-      generate_move_to_helpers(field_name)
-      generate_insert_at_helpers(field_name)
-      generate_shorthand_helpers(field_name)
-    end
-
-    protected
-
-    def generate_move_to_helpers(field_name)
-      generate_method("move_#{field_name}_to") do |target_position|
-        move_field_to target_position, field: field_name
-      end
-
-      generate_method("move_#{field_name}_to!") do |target_position|
-        move_field_to target_position, field: field_name
-        save
-      end
-
-      generate_method("move_#{field_name}_to=") do |target_position|
-        move_field_to target_position, field: field_name
-      end
-    end
-
-    def generate_insert_at_helpers(field_name)
-      klass.class_eval do
-        alias_method "insert_#{field_name}_at!", "move_#{field_name}_to!"
-        alias_method "insert_#{field_name}_at",  "move_#{field_name}_to"
-        alias_method "insert_#{field_name}_at=", "move_#{field_name}_to="
-      end
-    end
-
-    def generate_shorthand_helpers(field_name)
-      %i[top bottom].each do |symbol|
-        generate_method "move_#{field_name}_to_#{symbol}" do
-          move_to symbol, field: field_name
-        end
-
-        generate_method "move_#{field_name}_to_#{symbol}!" do
-          move_to! symbol, field: field_name
-        end
-      end
-
-      %i[higher lower].each do |symbol|
-        generate_method "move_#{field_name}_#{symbol}" do
-          move_to symbol, field: field_name
-        end
-
-        generate_method "move_#{field_name}_#{symbol}!" do
-          move_to! symbol, field: field_name
-        end
-      end
-    end
-  end
-end
-end
-end
+# frozen_string_literal: true
+
+module Mongoid
+module Orderable
+module Generators
+  class Movable < Base
+    def generate(field_name)
+      generate_move_to_helpers(field_name)
+      generate_insert_at_helpers(field_name)
+      generate_shorthand_helpers(field_name)
+    end
+
+    private
+
+    def generate_move_to_helpers(field_name)
+      generate_method("move_#{field_name}_to") do |target_position|
+        move_field_to target_position, field: field_name
+      end
+
+      generate_method("move_#{field_name}_to!") do |target_position|
+        move_field_to target_position, field: field_name
+        save
+      end
+
+      generate_method("move_#{field_name}_to=") do |target_position|
+        move_field_to target_position, field: field_name
+      end
+    end
+
+    def generate_insert_at_helpers(field_name)
+      klass.class_eval do
+        alias_method "insert_#{field_name}_at!", "move_#{field_name}_to!"
+        alias_method "insert_#{field_name}_at",  "move_#{field_name}_to"
+        alias_method "insert_#{field_name}_at=", "move_#{field_name}_to="
+      end
+    end
+
+    def generate_shorthand_helpers(field_name)
+      %i[top bottom].each do |symbol|
+        generate_method "move_#{field_name}_to_#{symbol}" do
+          move_to symbol, field: field_name
+        end
+
+        generate_method "move_#{field_name}_to_#{symbol}!" do
+          move_to! symbol, field: field_name
+        end
+      end
+
+      %i[higher lower].each do |symbol|
+        generate_method "move_#{field_name}_#{symbol}" do
+          move_to symbol, field: field_name
+        end
+
+        generate_method "move_#{field_name}_#{symbol}!" do
+          move_to! symbol, field: field_name
+        end
+      end
+    end
+  end
+end
+end
+end

data/lib/mongoid/orderable/generators/position.rb

@@ -1,26 +1,26 @@
-# frozen_string_literal: true
-
-module Mongoid
-module Orderable
-module Generators
-  class Position < Base
-    def generate(field_name)
-      klass.class_eval <<~KLASS, __FILE__, __LINE__ + 1
-        def orderable_position(field = nil)
-          field ||= default_orderable_field
-          send "orderable_\#{field}_position"
-        end
-      KLASS
-
-      generate_method("orderable_#{field_name}_position") do
-        send field_name
-      end
-
-      generate_method("orderable_#{field_name}_position=") do |value|
-        send "#{field_name}=", value
-      end
-    end
-  end
-end
-end
-end
+# frozen_string_literal: true
+
+module Mongoid
+module Orderable
+module Generators
+  class Position < Base
+    def generate(field_name)
+      klass.class_eval <<~KLASS, __FILE__, __LINE__ + 1
+        def orderable_position(field = nil)
+          field ||= default_orderable_field
+          send("orderable_\#{field}_position")
+        end
+      KLASS
+
+      generate_method("orderable_#{field_name}_position") do
+        send(field_name)
+      end
+
+      generate_method("orderable_#{field_name}_position=") do |value|
+        send("#{field_name}=", value)
+      end
+    end
+  end
+end
+end
+end

data/lib/mongoid/orderable/generators/scope.rb

@@ -1,26 +1,26 @@
-# frozen_string_literal: true
-
-module Mongoid
-module Orderable
-module Generators
-  class Scope < Base
-    def generate(field_name, order_scope)
-      criteria = criteria(order_scope)
-      klass.class_eval do
-        scope "orderable_#{field_name}_scope", criteria
-      end
-    end
-
-    protected
-
-    def criteria(order_scope)
-      case order_scope
-      when Proc then order_scope
-      when Array then ->(doc) { where(order_scope.each_with_object({}) {|f, h| h[f] = doc.send(f) }) }
-      else ->(_doc) { where({}) }
-      end
-    end
-  end
-end
-end
-end
+# frozen_string_literal: true
+
+module Mongoid
+module Orderable
+module Generators
+  class Scope < Base
+    def generate(field_name, order_scope)
+      criteria = criteria(order_scope)
+      klass.class_eval do
+        scope "orderable_#{field_name}_scope", criteria
+      end
+    end
+
+    private
+
+    def criteria(order_scope)
+      case order_scope
+      when Proc then order_scope
+      when Array then ->(doc) { where(order_scope.each_with_object({}) {|f, h| h[f] = doc.send(f) }) }
+      else ->(_doc) { where({}) }
+      end
+    end
+  end
+end
+end
+end

data/lib/mongoid/orderable/handlers/base.rb

@@ -1,189 +1,215 @@
-# frozen_string_literal: true
-
-module Mongoid
-module Orderable
-module Handlers
-  class Base
-    attr_reader :doc
-
-    def initialize(doc)
-      @doc = doc
-    end
-
-    protected
-
-    delegate :orderable_keys,
-             :orderable_field,
-             :orderable_position,
-             :orderable_if,
-             :orderable_unless,
-             :orderable_scope,
-             :orderable_scope_changed?,
-             :orderable_top,
-             :orderable_bottom,
-             :_id,
-             :new_record?,
-             :persisted?,
-             :embedded?,
-             :collection_name,
-             to: :doc
-
-    def use_transactions
-      false
-    end
-
-    def any_field_changed?
-      orderable_keys.any? {|field| changed?(field) }
-    end
-
-    def apply_all_positions
-      orderable_keys.map {|field| apply_one_position(field, move_all[field]) }
-    end
-
-    def apply_one_position(field, target_position)
-      return unless allowed?(field) && changed?(field)
-
-      set_lock(field) if use_transactions
-
-      f = orderable_field(field)
-      scope = orderable_scope(field)
-      scope_changed = orderable_scope_changed?(field)
-
-      # Set scope-level lock if scope changed
-      if use_transactions && persisted? && scope_changed
-        set_lock(field, true)
-        scope_changed = orderable_scope_changed?(field)
-      end
-
-      # Get the current position as exists in the database
-      current = if !persisted? || scope_changed
-                  nil
-                elsif persisted? && !embedded?
-                  scope.where(_id: _id).pluck(f).first
-                else
-                  orderable_position(field)
-                end
-
-      # If scope changed, remove the position from the old scope
-      if persisted? && !embedded? && scope_changed
-        existing_doc = doc.class.unscoped.find(_id)
-        self.class.new(existing_doc).send(:remove_one_position, field)
-      end
-
-      # Return if there is no instruction to change the position
-      in_list = persisted? && current
-      return if in_list && !target_position
-
-      # Use $inc operator to shift the position of the other documents
-      target = resolve_target_position(field, target_position, in_list)
-      if !in_list
-        scope.gte(f => target).inc(f => 1)
-      elsif target < current
-        scope.where(f => { '$gte' => target, '$lt' => current }).inc(f => 1)
-      elsif target > current
-        scope.where(f => { '$gt' => current, '$lte' => target }).inc(f => -1)
-      end
-
-      # If persisted, update the field in the database atomically
-      doc.set({ f => target }.merge(changed_scope_hash(field))) if use_transactions && persisted?
-      doc.send("orderable_#{field}_position=", target)
-    end
-
-    def remove_all_positions
-      orderable_keys.each do |field|
-        remove_one_position(field)
-      end
-    end
-
-    def remove_one_position(field)
-      return unless allowed?(field)
-      f = orderable_field(field)
-      current = orderable_position(field)
-      set_lock(field) if use_transactions
-      orderable_scope(field).gt(f => current).inc(f => -1)
-    end
-
-    def move_all
-      doc.send(:move_all)
-    end
-
-    def resolve_target_position(field, target_position, in_list)
-      target_position ||= 'bottom'
-
-      unless target_position.is_a? Numeric
-        target_position = case target_position.to_s
-                          when 'top' then (min ||= orderable_top(field))
-                          when 'bottom' then (max ||= orderable_bottom(field, in_list))
-                          when 'higher' then orderable_position(field).pred
-                          when 'lower' then orderable_position(field).next
-                          when /\A\d+\Z/ then target_position.to_i
-                          else raise Mongoid::Orderable::Errors::InvalidTargetPosition.new(target_position)
-                          end
-      end
-
-      if target_position <= (min ||= orderable_top(field))
-        target_position = min
-      elsif target_position > (max ||= orderable_bottom(field, in_list))
-        target_position = max
-      end
-
-      target_position
-    end
-
-    def allowed?(field)
-      cond_if = orderable_if(field)
-      cond_unless = orderable_unless(field)
-
-      (cond_if.nil? || resolve_condition(cond_if)) &&
-        (cond_unless.nil? || !resolve_condition(cond_unless))
-    end
-
-    def resolve_condition(condition)
-      case condition
-      when Proc
-        condition.arity.zero? ? doc.instance_exec(&condition) : condition.call(doc)
-      when Symbol
-        doc.send(condition)
-      else
-        condition || false
-      end
-    end
-
-    def changed?(field)
-      return true if new_record? || !doc.send(orderable_field(field)) || move_all[field]
-      changeable_keys(field).any? {|f| doc.send("#{f}_changed?") }
-    end
-
-    def changeable_keys(field)
-      [orderable_field(field)] | scope_keys(field)
-    end
-
-    def scope_keys(field)
-      orderable_scope(field).selector.keys.map do |f|
-        doc.fields[f]&.options&.[](:as) || f
-      end
-    end
-
-    def changed_scope_hash(field)
-      scope_keys(field).each_with_object({}) do |f, hash|
-        hash[f] = doc.send(f) if doc.send("#{f}_changed?")
-      end
-    end
-
-    def set_lock(field, generic = false)
-      return unless use_transactions
-      model_name = doc.class.orderable_configs[field][:lock_collection].to_s.singularize.classify
-      model = Mongoid::Orderable::Models.const_get(model_name)
-      attrs = lock_scope(field, generic)
-      model.where(attrs).find_one_and_update(attrs.merge(updated_at: Time.now), { upsert: true })
-    end
-
-    def lock_scope(field, generic = false)
-      sel = orderable_scope(field).selector
-      scope = ([collection_name] + (generic ? [field] : sel.to_a.flatten)).map(&:to_s).join('|')
-      { scope: scope }
-    end
-  end
-end
-end
-end
+# frozen_string_literal: true
+
+module Mongoid
+module Orderable
+module Handlers
+  class Base
+    attr_reader :doc
+
+    def initialize(doc)
+      @doc = doc
+      reset_new_record
+    end
+
+    private
+
+    delegate :orderable_keys,
+             :orderable_field,
+             :orderable_position,
+             :orderable_if,
+             :orderable_unless,
+             :orderable_scope,
+             :orderable_scope_changed?,
+             :orderable_top,
+             :orderable_bottom,
+             :_id,
+             :persisted?,
+             :embedded?,
+             :collection_name,
+             to: :doc
+
+    def new_record?
+      use_transactions ? @new_record : doc.new_record?
+    end
+
+    def use_transactions
+      false
+    end
+
+    def any_field_changed?
+      orderable_keys.any? {|field| changed?(field) }
+    end
+
+    def set_new_record_positions
+      return unless new_record?
+
+      orderable_keys.each do |field|
+        next unless (position = doc.send(field))
+
+        move_all[field] ||= position
+      end
+    end
+
+    def apply_all_positions
+      orderable_keys.each {|field| apply_one_position(field, move_all[field]) }
+    end
+
+    def apply_one_position(field, target_position)
+      return unless allowed?(field) && changed?(field)
+
+      set_lock(field) if use_transactions
+
+      f = orderable_field(field)
+      scope = orderable_scope(field)
+      scope_changed = orderable_scope_changed?(field)
+
+      # Set scope-level lock if scope changed
+      if use_transactions && persisted? && scope_changed
+        set_lock(field, true)
+        scope_changed = orderable_scope_changed?(field)
+      end
+
+      # Get the current position as exists in the database
+      current = if new_record? || scope_changed
+                  nil
+                elsif persisted? && !embedded?
+                  scope.where(_id: _id).pluck(f).first
+                else
+                  orderable_position(field)
+                end
+
+      # If scope changed, remove the position from the old scope
+      if persisted? && !embedded? && scope_changed
+        existing_doc = doc.class.unscoped.find(_id)
+        self.class.new(existing_doc).send(:remove_one_position, field)
+      end
+
+      # Return if there is no instruction to change the position
+      in_list = persisted? && current
+      return if in_list && !target_position
+
+      target = resolve_target_position(field, target_position, in_list)
+
+      # Use $inc operator to shift the position of the other documents
+      if !in_list
+        scope.gte(f => target).inc(f => 1)
+      elsif target < current
+        scope.where(f => { '$gte' => target, '$lt' => current }).inc(f => 1)
+      elsif target > current
+        scope.where(f => { '$gt' => current, '$lte' => target }).inc(f => -1)
+      end
+
+      # If persisted, update the field in the database atomically
+      doc.set({ f => target }.merge(changed_scope_hash(field))) if use_transactions && persisted?
+      doc.send("orderable_#{field}_position=", target)
+    end
+
+    def remove_all_positions
+      orderable_keys.each do |field|
+        remove_one_position(field)
+      end
+    end
+
+    def remove_one_position(field)
+      return unless allowed?(field)
+      f = orderable_field(field)
+      current = orderable_position(field)
+      set_lock(field) if use_transactions
+      orderable_scope(field).gt(f => current).inc(f => -1)
+    end
+
+    def move_all
+      doc.send(:move_all)
+    end
+
+    def reset
+      reset_new_record
+      doc.send(:clear_move_all!)
+    end
+
+    # Required for transactions, which perform some actions
+    # in the after_create callback.
+    def reset_new_record
+      @new_record = doc.new_record?
+    end
+
+    def resolve_target_position(field, target_position, in_list)
+      target_position ||= 'bottom'
+
+      unless target_position.is_a?(Numeric)
+        target_position = case target_position.to_s
+                          when 'top' then (min ||= orderable_top(field))
+                          when 'bottom' then (max ||= orderable_bottom(field, in_list))
+                          when 'higher' then orderable_position(field).pred
+                          when 'lower' then orderable_position(field).next
+                          when /\A\d+\Z/ then target_position.to_i
+                          else raise Mongoid::Orderable::Errors::InvalidTargetPosition.new(target_position)
+                          end
+      end
+
+      if target_position <= (min ||= orderable_top(field))
+        target_position = min
+      elsif target_position > (max ||= orderable_bottom(field, in_list))
+        target_position = max
+      end
+
+      target_position
+    end
+
+    def allowed?(field)
+      cond_if = orderable_if(field)
+      cond_unless = orderable_unless(field)
+
+      (cond_if.nil? || resolve_condition(cond_if)) &&
+        (cond_unless.nil? || !resolve_condition(cond_unless))
+    end
+
+    def resolve_condition(condition)
+      case condition
+      when Proc
+        condition.arity.zero? ? doc.instance_exec(&condition) : condition.call(doc)
+      when Symbol
+        doc.send(condition)
+      else
+        condition || false
+      end
+    end
+
+    def changed?(field)
+      return true if new_record? || !doc.send(orderable_field(field)) || move_all[field]
+      changeable_keys(field).any? {|f| doc.send("#{f}_changed?") }
+    end
+
+    def changeable_keys(field)
+      [orderable_field(field)] | scope_keys(field)
+    end
+
+    def scope_keys(field)
+      orderable_scope(field).selector.keys.map do |f|
+        doc.fields[f]&.options&.[](:as) || f
+      end
+    end
+
+    def changed_scope_hash(field)
+      scope_keys(field).each_with_object({}) do |f, hash|
+        hash[f] = doc.send(f) if doc.send("#{f}_changed?")
+      end
+    end
+
+    def set_lock(field, generic = false)
+      return unless use_transactions
+      model_name = doc.class.orderable_configs[field][:lock_collection].to_s.singularize.classify
+      model = Mongoid::Orderable::Models.const_get(model_name)
+      attrs = lock_scope(field, generic)
+      model.where(attrs).find_one_and_update(attrs.merge(updated_at: Time.now), { upsert: true })
+    end
+
+    def lock_scope(field, generic = false)
+      sel = orderable_scope(field).selector
+      scope = ([collection_name] + (generic ? [field] : sel.to_a.flatten)).map(&:to_s).join('|')
+      { scope: scope }
+    end
+  end
+end
+end
+end