mongoid_orderable 6.0.2 → 6.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3a80c8eb058adeffe1ead4c0fa20ce10660ea49a2df1405d46048419f2af965
-  data.tar.gz: d68f6f64f52f132295e588dfcd59ad27d22a68237e5b29ab7682a37e3c940ca5
+  metadata.gz: 8882038ec4e57486bd693bc1732f935f2d01f949aeedc7f71b3c54bca5ac0b44
+  data.tar.gz: c0c82c4802280dfe6005e89122e9f7905fabcdf261bc9b3864016d10a70c112c
 SHA512:
-  metadata.gz: 6c2d9da294dda836b17047aaf3ebc6329b3c382fb793c83fe57dd63a07512d2e1da65af3559b12e75ce3924b1edfaaefad8317f4acaa488cb94ad2392d84b474
-  data.tar.gz: 58e8c15554183674cef20639c2cb888cb6e793471ecf7f55ea76360f2ca7de351d218f417e34db220d2daa32c6ab5dc11da23bce7acec0f77a1f99718e713705
+  metadata.gz: 64332b6ae9d7786864d238accdd3ec81c8defa059ff1d7e1763e487a271c2dffb2f25b3a1a2332947a3b262ecc6cb8da33aae0acdab0cd04bd3ac6e0a2a2ca44
+  data.tar.gz: 918ea29f2b71caf6cfba5cdc7e145bba69d0d90d2561e1983676fa13a3517f87eaabd7f66d628fbae1ec45df56fe82a11a723de632bbd1650697f39939d10534

data/CHANGELOG.md

@@ -1,7 +1,12 @@
-### 6.0.3 (Next)
+### 6.0.4 (Next)
 
 * Your contribution here.
 
+### 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.
+
 ### 6.0.2 (2021/01/26)
 
 * [#70](https://github.com/mongoid/mongoid_orderable/pull/70): Fix: Transactions should not use around callbacks - [@johnnyshields](https://github.com/johnnyshields).

data/README.md

@@ -138,7 +138,8 @@ book.previous_#{field}_item
 
 where `#{field}` is either `position` or `serial_no`.
 
-When a model defines multiple orderable fields, the original helpers are also available and work on the first orderable field.
+When a model defines multiple orderable fields, the original helpers are also available and work
+on the first orderable field.
 
 ```ruby
   @book1 = Book.create!
@@ -181,6 +182,24 @@ end
 To ensure the position is written correctly, you will need to set
 `cascade_callbacks: true` on the relation.
 
+### Disable Ordering
+
+You can disable position tracking for specific documents using the `:if` and `:unless` options.
+This is in advanced scenarios where you want to control position manually for certain documents.
+In general, the disable condition should match a specific scope.
+**Warning:** If used improperly, this will cause your documents to become out-of-order.
+
+```ruby
+class Book
+  include Mongoid::Document
+  include Mongoid::Orderable
+
+  field :track_position, type: Boolean
+  
+  orderable if: :track_position, unless: -> { created_at < Date.parse('2020-01-01') }
+end
+```
+
 ## Transaction Support
 
 By default, Mongoid Orderable does not guarantee ordering consistency
@@ -219,7 +238,7 @@ After `transaction_max_retries` has been exceeded, a
 
 When using transactions, Mongoid Orderable creates a collection
 `mongoid_orderable_locks` which is used to store temporary lock objects.
-This collection accumulate documents overtime; it is safe to delete it periodically.
+Lock collections use a TTL index which auto-deletes objects older than 1 day.
 
 You can change the lock collection name globally or per model:
 

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

@@ -11,6 +11,8 @@ module Configs
                         base
                         index
                         default
+                        if
+                        unless
                         use_transactions
                         transaction_max_retries
                         lock_collection].freeze

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

@@ -17,6 +17,14 @@ module Generators
           field ||= default_orderable_field
           #{self_class}.orderable_configs[field][:field]
         end
+
+        def orderable_if(field)
+          #{self_class}.orderable_configs[field][:if]
+        end
+
+        def orderable_unless(field)
+          #{self_class}.orderable_configs[field][:unless]
+        end
       KLASS
 
       generate_method(:orderable_inherited_class) do

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

@@ -12,12 +12,14 @@ module Generators
         module Models
           class #{model_name}
             include Mongoid::Document
+            include Mongoid::Timestamps::Updated::Short
 
             store_in collection: :#{collection_name}
 
             field :scope, type: String
 
             index({ scope: 1 }, { unique: 1 })
+            index({ updated_at: 1 }, { expire_after_seconds: 86400 })
           end
         end
       KLASS

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

@@ -15,6 +15,8 @@ module Handlers
     delegate :orderable_keys,
              :orderable_field,
              :orderable_position,
+             :orderable_if,
+             :orderable_unless,
              :orderable_scope,
              :orderable_scope_changed?,
              :orderable_top,
@@ -39,7 +41,7 @@ module Handlers
     end
 
     def apply_one_position(field, target_position)
-      return unless changed?(field)
+      return unless allowed?(field) && changed?(field)
 
       set_lock(field) if use_transactions
 
@@ -94,6 +96,7 @@ module Handlers
     end
 
     def remove_one_position(field)
+      return unless allowed?(field)
       f = orderable_field(field)
       current = orderable_position(field)
       set_lock(field) if use_transactions
@@ -127,6 +130,25 @@ module Handlers
       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?") }
@@ -153,7 +175,7 @@ module Handlers
       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, { upsert: true })
+      model.where(attrs).find_one_and_update(attrs.merge(updated_at: Time.now), { upsert: true })
     end
 
     def lock_scope(field, generic = false)

data/lib/mongoid/orderable/installer.rb

@@ -35,7 +35,7 @@ module Orderable
     def add_db_index
       spec = [[config[:field], 1]]
       config[:scope].each {|field| spec.unshift([field, 1]) } if config[:scope].is_a?(Array)
-      klass.index(Hash[spec])
+      klass.index(spec.to_h)
     end
 
     def save_config

data/lib/mongoid/orderable/version.rb

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

data/spec/integration/conditional_spec.rb

@@ -0,0 +1,36 @@
+require_relative '../spec_helper'
+
+describe ConditionalOrderable do
+
+  shared_examples_for 'conditional_orderable' do
+
+    before :each do
+      ConditionalOrderable.create!(cond_a: false, cond_b: nil)
+      ConditionalOrderable.create!(cond_a: false, cond_b: 1)
+      ConditionalOrderable.create!(cond_a: true, cond_b: 2)
+      ConditionalOrderable.create!(cond_a: false, cond_b: 3)
+      ConditionalOrderable.create!(cond_a: true, cond_b: 4)
+      ConditionalOrderable.create!(cond_a: true, cond_b: 5)
+    end
+
+    it 'should have proper position field' do
+      orderables = ConditionalOrderable.all.sort_by {|x| x.cond_b || 0 }
+
+      expect(orderables.map(&:pos_a)).to eq [nil, nil, 1, nil, 2, 3]
+      expect(orderables.map(&:pos_b)).to eq [nil, 1, 2, 3, 4, nil]
+      expect(orderables.map(&:pos_c)).to eq [1, 2, 3, 4, 5, 6]
+    end
+  end
+
+  context 'with transactions' do
+    enable_transactions!
+
+    it_behaves_like 'conditional_orderable'
+  end
+
+  context 'without transactions' do
+    disable_transactions!
+
+    it_behaves_like 'conditional_orderable'
+  end
+end

data/spec/support/models.rb

@@ -13,6 +13,18 @@ class SimpleOrderable
   orderable
 end
 
+class ConditionalOrderable
+  include Mongoid::Document
+  include Mongoid::Orderable
+
+  field :cond_a, type: Boolean
+  field :cond_b, type: Integer
+
+  orderable field: :pos_a, if: :cond_a, unless: ->(obj) { obj.cond_b&.<(2) }
+  orderable field: :pos_b, if: -> { cond_b&.<=(4) }
+  orderable field: :pos_c, unless: false
+end
+
 class ScopedGroup
   include Mongoid::Document
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_orderable
 version: !ruby/object:Gem::Version
-  version: 6.0.2
+  version: 6.0.3
 platform: ruby
 authors:
 - pyromaniac
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-27 00:00:00.000000000 Z
+date: 2021-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -117,6 +117,7 @@ files:
 - 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
@@ -131,7 +132,8 @@ files:
 - spec/spec_helper.rb
 - spec/support/models.rb
 homepage: https://github.com/mongoid/mongoid_orderable
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -148,12 +150,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.9
 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