mongoid_orderable 6.0.3 → 6.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8882038ec4e57486bd693bc1732f935f2d01f949aeedc7f71b3c54bca5ac0b44
-  data.tar.gz: c0c82c4802280dfe6005e89122e9f7905fabcdf261bc9b3864016d10a70c112c
+  metadata.gz: 130b0033ba55283b4cb619832e51b4b9c42191db02c12e0b9db87e98fb3c6cb8
+  data.tar.gz: 24994768318208173add72989cf364c888137a739390d39f9759d35fbb8a2ce6
 SHA512:
-  metadata.gz: 64332b6ae9d7786864d238accdd3ec81c8defa059ff1d7e1763e487a271c2dffb2f25b3a1a2332947a3b262ecc6cb8da33aae0acdab0cd04bd3ac6e0a2a2ca44
-  data.tar.gz: 918ea29f2b71caf6cfba5cdc7e145bba69d0d90d2561e1983676fa13a3517f87eaabd7f66d628fbae1ec45df56fe82a11a723de632bbd1650697f39939d10534
+  metadata.gz: e401433fc0247621f99cebad69db3034f8b525a3d93035b8ec07c4deeb1116a5a1d568504e0ccfaeb23b8fe9f8fdd56ba5ef41add3526ed4e020b8a8b79f53ec
+  data.tar.gz: 73c6c58d8a9da7e14a2e6f9f0866fbf3a7bedf194f81b44d9156387f57c4032f3fb2a04c8fe94dd49953d259b59c0f9f49c9f37778f3c773a3e61a9705965bbb

data/CHANGELOG.md

@@ -1,11 +1,22 @@
-### 6.0.4 (Next)
+### 6.0.6 (Next)
 
-* Your contribution here.
+* Your change here.
+
+### 6.0.5 (2023/11/08)
+
+* [#75](https://github.com/mongoid/mongoid_orderable/pull/75): Fix: Preserve position when creating new records.
+* [#84](https://github.com/mongoid/mongoid_orderable/pull/84): Feature: Use Mongo::QueryCache if available.
+* [#85](https://github.com/mongoid/mongoid_orderable/pull/85): Refactor: Replace all usages of "protected" with "private".
+
+### 6.0.4 (2023/02/01)
+
+* [#75](https://github.com/mongoid/mongoid_orderable/pull/75): Fix: Setting #move_to should mark an orderable object as changed so that callbacks are triggered.
 
 ### 6.0.3 (2021/06/27)
 
 * [#72](https://github.com/mongoid/mongoid_orderable/pull/72): Feature: Add :if and :unless conditions which disable callbacks.
 * [#71](https://github.com/mongoid/mongoid_orderable/pull/71): Fix: Add TTL index to locks table.
+* [#73](https://github.com/mongoid/mongoid_orderable/pull/73): Refactor: Replace Travis CI with Github Actions.
 
 ### 6.0.2 (2021/01/26)
 

data/lib/mongoid/orderable/configs/field_config.rb

@@ -41,7 +41,7 @@ module Configs
         lock_collection: cfg.lock_collection }
     end
 
-    protected
+    private
 
     def assign_options(options)
       @options = global_config

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

@@ -10,7 +10,7 @@ module Generators
       @klass = klass
     end
 
-    protected
+    private
 
     def generate_method(name, &block)
       klass.send(:define_method, name, &block)

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

@@ -9,7 +9,7 @@ module Generators
       generate_aliased_helpers(field_name)
     end
 
-    protected
+    private
 
     def generate_list_helpers(field_name)
       generate_method("next_#{field_name}_item") do

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

@@ -25,7 +25,7 @@ module Generators
       KLASS
     end
 
-    protected
+    private
 
     def model_exists?(model_name)
       base = ::Mongoid::Orderable::Models

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

@@ -10,7 +10,7 @@ module Generators
       generate_shorthand_helpers(field_name)
     end
 
-    protected
+    private
 
     def generate_move_to_helpers(field_name)
       generate_method("move_#{field_name}_to") do |target_position|

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

@@ -8,16 +8,16 @@ module Generators
       klass.class_eval <<~KLASS, __FILE__, __LINE__ + 1
         def orderable_position(field = nil)
           field ||= default_orderable_field
-          send "orderable_\#{field}_position"
+          send("orderable_\#{field}_position")
         end
       KLASS
 
       generate_method("orderable_#{field_name}_position") do
-        send field_name
+        send(field_name)
       end
 
       generate_method("orderable_#{field_name}_position=") do |value|
-        send "#{field_name}=", value
+        send("#{field_name}=", value)
       end
     end
   end

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

@@ -11,7 +11,7 @@ module Generators
       end
     end
 
-    protected
+    private
 
     def criteria(order_scope)
       case order_scope

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

@@ -8,9 +8,10 @@ module Handlers
 
     def initialize(doc)
       @doc = doc
+      reset_new_record
     end
 
-    protected
+    private
 
     delegate :orderable_keys,
              :orderable_field,
@@ -22,12 +23,15 @@ module Handlers
              :orderable_top,
              :orderable_bottom,
              :_id,
-             :new_record?,
              :persisted?,
              :embedded?,
              :collection_name,
              to: :doc
 
+    def new_record?
+      use_transactions ? @new_record : doc.new_record?
+    end
+
     def use_transactions
       false
     end
@@ -36,8 +40,18 @@ module Handlers
       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.map {|field| apply_one_position(field, move_all[field]) }
+      orderable_keys.each {|field| apply_one_position(field, move_all[field]) }
     end
 
     def apply_one_position(field, target_position)
@@ -56,7 +70,7 @@ module Handlers
       end
 
       # Get the current position as exists in the database
-      current = if !persisted? || scope_changed
+      current = if new_record? || scope_changed
                   nil
                 elsif persisted? && !embedded?
                   scope.where(_id: _id).pluck(f).first
@@ -74,8 +88,9 @@ module Handlers
       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)
+
+      # Use $inc operator to shift the position of the other documents
       if !in_list
         scope.gte(f => target).inc(f => 1)
       elsif target < current
@@ -107,10 +122,21 @@ module Handlers
       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
+      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))

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

@@ -5,18 +5,26 @@ module Orderable
 module Handlers
   class Document < Base
     def before_create
+      set_new_record_positions
       apply_all_positions
     end
 
-    def after_create; end
+    def after_create
+      reset
+    end
 
     def before_update
       return unless any_field_changed?
       apply_all_positions
     end
 
+    def after_update
+      reset
+    end
+
     def after_destroy
       remove_all_positions
+      reset
     end
   end
 end

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

@@ -5,23 +5,20 @@ module Orderable
 module Handlers
   class DocumentTransactional < Document
     def before_create
-      clear_all_positions
+      set_new_record_positions
     end
 
     def after_create
       apply_all_positions
+      super
     end
 
-    protected
+    private
 
     def apply_all_positions
       with_transaction { super }
     end
 
-    def clear_all_positions
-      orderable_keys.each {|field| doc.send("orderable_#{field}_position=", nil) }
-    end
-
     def use_transactions
       true
     end

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

@@ -15,7 +15,7 @@ module Handlers
     end
 
     def with_transaction(&block)
-      Mongoid::QueryCache.uncached do
+      query_cache.uncached do
         if Thread.current[THREAD_KEY]
           yield
         else
@@ -35,7 +35,7 @@ module Handlers
       end
     end
 
-    protected
+    private
 
     def do_transaction(&_block)
       doc.class.with_session(session_opts) do |session|
@@ -65,6 +65,10 @@ module Handlers
     def transaction_max_retries
       doc.orderable_keys.map {|k| doc.class.orderable_configs.dig(k, :transaction_max_retries) }.compact.max
     end
+
+    def query_cache
+      defined?(Mongo::QueryCache) ? Mongo::QueryCache : Mongoid::QueryCache
+    end
   end
 end
 end

data/lib/mongoid/orderable/installer.rb

@@ -18,7 +18,7 @@ module Orderable
       generate_all_helpers
     end
 
-    protected
+    private
 
     def field_name
       config[:field_options][:as] || config[:field]
@@ -48,6 +48,7 @@ module Orderable
       klass.send :include, Mixins::Callbacks
       klass.send :include, Mixins::Movable
       klass.send :include, Mixins::Listable
+      klass.send :prepend, Mixins::Cascadeable if klass.embedded?
     end
 
     def generate_all_helpers

data/lib/mongoid/orderable/mixins/callbacks.rb

@@ -12,16 +12,18 @@ module Mixins
       before_create :orderable_before_create
       after_create :orderable_after_create, prepend: true
       before_update :orderable_before_update
+      after_update :orderable_after_update, prepend: true
       after_destroy :orderable_after_destroy, prepend: true
 
       delegate :before_create,
                :after_create,
                :before_update,
+               :after_update,
                :after_destroy,
                to: :orderable_handler,
                prefix: :orderable
 
-      protected
+      private
 
       def orderable_handler
         @orderable_handler ||= self.class.orderable_handler_class.new(self)

data/lib/mongoid/orderable/mixins/cascadeable.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Mongoid
+module Orderable
+module Mixins
+  # This is required to trigger callbacks on embedded objects.
+  # Otherwise, the #move_to parameter won't work when saving the parent.
+  module Cascadeable
+    def in_callback_state?(kind)
+      super || move_all.present?
+    end
+  end
+end
+end
+end

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

@@ -44,15 +44,19 @@ module Mixins
       KLASS
     end
 
-    protected
+    private
 
     def move_all
-      @move_all || {}
+      @move_all ||= {}
     end
 
     def move_field_to(position, options)
       field = options[:field] || default_orderable_field
-      @move_all = move_all.merge(field => position)
+      move_all[field] = position
+    end
+
+    def clear_move_all!
+      @move_all = {}
     end
   end
 end

data/lib/mongoid/orderable/version.rb

@@ -2,6 +2,6 @@
 
 module Mongoid
   module Orderable
-    VERSION = '6.0.3'
+    VERSION = '6.0.5'
   end
 end

data/lib/mongoid_orderable.rb

@@ -7,9 +7,8 @@ I18n.load_path << File.join(File.dirname(__FILE__), 'config', 'locales', 'en.yml
 
 require 'mongoid'
 
-require 'mongoid/orderable/version'
-
 require 'mongoid/orderable'
+require 'mongoid/orderable/version'
 require 'mongoid/orderable/configs/global_config'
 require 'mongoid/orderable/configs/field_config'
 require 'mongoid/orderable/errors/invalid_target_position'
@@ -18,6 +17,7 @@ require 'mongoid/orderable/mixins/helpers'
 require 'mongoid/orderable/mixins/callbacks'
 require 'mongoid/orderable/mixins/listable'
 require 'mongoid/orderable/mixins/movable'
+require 'mongoid/orderable/mixins/cascadeable'
 require 'mongoid/orderable/generators/base'
 require 'mongoid/orderable/generators/listable'
 require 'mongoid/orderable/generators/lock_collection'

metadata

@@ -1,71 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_orderable
 version: !ruby/object:Gem::Version
-  version: 6.0.3
+  version: 6.0.5
 platform: ruby
 authors:
 - pyromaniac
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2023-11-07 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  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: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: rspec-retry
-  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: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
@@ -111,31 +55,18 @@ files:
 - lib/mongoid/orderable/handlers/transaction.rb
 - lib/mongoid/orderable/installer.rb
 - lib/mongoid/orderable/mixins/callbacks.rb
+- lib/mongoid/orderable/mixins/cascadeable.rb
 - lib/mongoid/orderable/mixins/helpers.rb
 - lib/mongoid/orderable/mixins/listable.rb
 - lib/mongoid/orderable/mixins/movable.rb
 - lib/mongoid/orderable/version.rb
 - lib/mongoid_orderable.rb
-- spec/integration/concurrency_spec.rb
-- spec/integration/conditional_spec.rb
-- spec/integration/customized_spec.rb
-- spec/integration/embedded_spec.rb
-- spec/integration/foreign_key_spec.rb
-- spec/integration/inherited_spec.rb
-- spec/integration/multiple_fields_spec.rb
-- spec/integration/multiple_scoped_spec.rb
-- spec/integration/no_indexed_spec.rb
-- spec/integration/scoped_spec.rb
-- spec/integration/simple_spec.rb
-- spec/integration/string_scoped_spec.rb
-- spec/integration/zero_based_spec.rb
-- spec/spec_helper.rb
-- spec/support/models.rb
 homepage: https://github.com/mongoid/mongoid_orderable
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -150,23 +81,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.9
-signing_key: 
+rubygems_version: 3.4.4
+signing_key:
 specification_version: 4
 summary: Mongoid orderable list implementation
-test_files:
-- spec/integration/concurrency_spec.rb
-- spec/integration/conditional_spec.rb
-- spec/integration/customized_spec.rb
-- spec/integration/embedded_spec.rb
-- spec/integration/foreign_key_spec.rb
-- spec/integration/inherited_spec.rb
-- spec/integration/multiple_fields_spec.rb
-- spec/integration/multiple_scoped_spec.rb
-- spec/integration/no_indexed_spec.rb
-- spec/integration/scoped_spec.rb
-- spec/integration/simple_spec.rb
-- spec/integration/string_scoped_spec.rb
-- spec/integration/zero_based_spec.rb
-- spec/spec_helper.rb
-- spec/support/models.rb
+test_files: []