mongoid-locking 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6150316b83b781d4f26eff62a82a593aff8f7a7a81791ae7b003801e9cc2f44
-  data.tar.gz: 57a84b81757d94e4d4bfaceaea0f98f8437bd61bf7832be9e030fcb37fd5146c
+  metadata.gz: 59b03918904c46ce2770150d4b8d20d2b25ab735e6409982e804a9dbab8c4231
+  data.tar.gz: 316a1a9851bccd6580aedd95a9e5089a7b5a2ce4f9f2bc2b07a1af4f9ff4a263
 SHA512:
-  metadata.gz: 743b07e99b92af64d0d209580f2a5851c44800a51c7c33e794cc655661abfeb86c65e1f8df66cd7eb42197466020cae038c85dd9dfd2656b7e187204cddcd3a1
-  data.tar.gz: c14fb5d640c3bf4b6a4edfab3929aae1244a13f62ebe40641bd5a7a354357203f8f7e8add1e396ca07917d57cc3f4fd9af3ea3f3b5d589c3ceef17fa595de043
+  metadata.gz: dc860e6b8d43e812c6b7df124f72e1319041e795006f9dfd2c845cf0ee53d474c20d3d2c50b7d12e10e9b0b4f2eeb4180be38e6baa304b4bef132c14fcd89c9a
+  data.tar.gz: d545996296a982692f906ed2aa9ccd490855c153c6b949186552814250454168c0c8d8147efc8d5f094fb2f617a0ebc8c30ff02d8f93600143f227972a9fc83b

data/.rubocop.yml

@@ -30,3 +30,6 @@ RSpec/DescribeClass:
 
 RSpec/MultipleExpectations:
   Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10

data/CHANGELOG.md

@@ -1,4 +1,14 @@
-## [Unreleased]
+## [1.2.0]
+
+- Add: with_locking method [#6](https://github.com/fullhealthmedical/mongoid-locking/pull/6)
+
+## [1.1.1]
+
+- Fix: Fix update embedded association [#5](https://github.com/fullhealthmedical/mongoid-locking/pull/5)
+
+## [1.1.0]
+
+- Add: Support for Mongoid 7.3 [#3](https://github.com/fullhealthmedical/mongoid-locking/pull/3)
 
 ## [0.1.0] - 2022-08-03
 

data/Gemfile.lock

@@ -1,20 +1,19 @@
 PATH
   remote: .
   specs:
-    mongoid-locking (1.0.0)
-      mongoid (~> 7.2.0)
+    mongoid-locking (1.2.0)
+      mongoid (~> 7.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.7.6)
-      activesupport (= 6.1.7.6)
-    activesupport (6.1.7.6)
+    activemodel (7.0.8)
+      activesupport (= 7.0.8)
+    activesupport (7.0.8)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     ast (2.4.2)
     bson (4.15.0)
     byebug (11.1.3)
@@ -24,10 +23,10 @@ GEM
       concurrent-ruby (~> 1.0)
     json (2.6.2)
     minitest (5.20.0)
-    mongo (2.19.2)
+    mongo (2.19.3)
       bson (>= 4.14.1, < 5.0.0)
-    mongoid (7.2.6)
-      activemodel (>= 5.1, < 6.2)
+    mongoid (7.5.4)
+      activemodel (>= 5.1, < 7.1, != 7.0.0)
       mongo (>= 2.10.5, < 3.0.0)
       ruby2_keywords (~> 0.0.5)
     parallel (1.22.1)
@@ -69,7 +68,6 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.2.0)
-    zeitwerk (2.6.12)
 
 PLATFORMS
   arm64-darwin-21
@@ -77,7 +75,7 @@ PLATFORMS
 
 DEPENDENCIES
   byebug
-  mongoid (~> 7.2.0)
+  mongoid (~> 7.2)
   mongoid-locking!
   rake (~> 13.0)
   rspec

data/README.md

@@ -19,7 +19,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 - Include `Mongoid::Locking` module
 
-```
+```ruby
   class Order
     include Mongoid::Document
     include Mongoid::Locking
@@ -28,16 +28,64 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 - Handle `Mongoid::StaleObjectError` when performing updates
 
-```
+```ruby
   # ...
   def update_order
-    order.update(attributes)
+    Order.update(attributes)
   rescue Mongoid::StaleObjectError => e
     add_error("This order has been changed ...")
   end
 end
 ```
 
+- Use `with_locking` to automatically handle `Mongoid::StaleObjectError`
+
+By default, `with_locking` will retry the update 3 times in case of a
+`Mongoid::StaleObjectError`.
+
+```ruby
+  def process_with_locking
+    Order.with_locking do
+      # Ensure the block is idempotent
+      # Reload object(s) within the block to get the latest changes
+      order.reload
+      # Your code here
+      # ...
+    end
+  end
+```
+
+Adjust the `max_retries` parameter to control the number of retry attempts in
+case of a `Mongoid::StaleObjectError`.
+
+```ruby
+  # ...
+  def update_order
+    order.with_locking(max_retries: 2) do
+      order.update(attributes)
+    end
+  end
+end
+```
+
+- Use `with_locking` at the instance level to automatically reload the instance
+  on each retry
+
+```ruby
+def process_with_locking
+  order.with_locking do
+    # The instance is automatically reloaded for each retry
+    # Your code here
+    # ...
+  end
+end
+````
+
+
+The with_locking method at the instance level combines class-level locking with
+automatic reloading on each retry. This ensures that the instance reflects the
+latest changes, providing seamless control over optimistic locking.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -62,4 +110,4 @@ Everyone interacting in the Mongoid::Locking project's codebases, issue trackers
 | -------- | ------- |
 | 0.1.2 | >= 6.0, < 7.2 |
 | 1.0.0 | ~> 7.2.0 |
-| 1.1.0 | ~> 7.2 |
+| ~> 1.1.0 | ~> 7.2 |

data/lib/mongoid/locking/association/embedded/batchable.rb

@@ -0,0 +1,29 @@
+module Mongoid
+  module Locking
+    module Association
+      module Embedded
+        module Batchable # :nodoc:
+          # Get the selector for executing atomic operations on the collection.
+          #
+          # @api private
+          #
+          # @example Get the selector.
+          #   batchable.selector
+          #
+          # @return [ Hash ] The atomic selector.
+          #
+          # @since 3.0.0
+          #
+          # ---
+          #
+          # Mongoid memoizes the atomic selector, which is not compatible with
+          # Mongoid::Locking. For subsequent saves, the lock_version needs to be
+          # updated, so the atomic selector needs to be regenerated.
+          def selector
+            _base.atomic_selector
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/locking/retry.rb

@@ -0,0 +1,62 @@
+module Mongoid
+  module Locking
+    ##
+    # Gives the ability to retry a block of code a specified number of times
+    # when a Mongoid::StaleObjectError is raised.
+    module Retry
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      ##
+      # Retries the block of code a specified number of times when a
+      # Mongoid::StaleObjectError is raised.
+      #
+      # This method will reload the document before each block execution.
+      #
+      # @example
+      #   person = Person.find(existing.id)
+      #   person.with_locking do
+      #     person.update!(name: "Person 1 updated")
+      #   end
+      #
+      # @param [ Integer ] max_retries The maximum number of times to retry
+      #
+      # @return [ Object ] The result of the block
+      def with_locking(max_retries: 3)
+        self.class.with_locking(max_retries: max_retries) do
+          reload
+          yield
+        end
+      end
+
+      module ClassMethods # :nodoc:
+        ##
+        # Retries the block of code a specified number of times when a
+        # Mongoid::StaleObjectError is raised.
+        #
+        # @example
+        #   Person.with_locking do
+        #     person = Person.find(existing.id)
+        #     Person.update!(name: "Person 1 updated")
+        #   end
+        #
+        # @param [ Integer ] max_retries The maximum number of times to retry
+        #
+        # @return [ Object ] The result of the block
+        def with_locking(max_retries: 3)
+          retries = 0
+
+          begin
+            yield
+          rescue Mongoid::StaleObjectError
+            raise if retries >= max_retries
+
+            retries += 1
+            retry
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/locking/version.rb

@@ -2,6 +2,6 @@
 
 module Mongoid
   module Locking
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/lib/mongoid/locking.rb

@@ -1,6 +1,7 @@
 require "mongoid"
 require_relative "locking/version"
 require_relative "stale_object_error"
+require_relative "locking/association/embedded/batchable"
 require_relative "locking/contextual/atomic"
 require_relative "locking/contextual/mongo"
 require_relative "locking/selectable"
@@ -8,6 +9,7 @@ require_relative "locking/reloadable"
 require_relative "locking/persistable/creatable"
 require_relative "locking/persistable/updatable"
 require_relative "locking/persistable"
+require_relative "locking/retry"
 
 module Mongoid
   ##
@@ -21,7 +23,7 @@ module Mongoid
 
       base.include Mongoid::Locking::Selectable
       base.include Mongoid::Locking::Reloadable
-      # base.include Mongoid::Locking::Reloadable if Mongoid::VERSION >= "7"
+      base.include Mongoid::Locking::Retry
     end
   end
 end
@@ -30,5 +32,8 @@ end
 Mongoid::Contextual::Mongo.prepend Mongoid::Locking::Contextual::Mongo
 Mongoid::Contextual::Mongo.prepend Mongoid::Locking::Contextual::Atomic
 
+# monkey patching for embedded documents
+Mongoid::Association::Embedded::Batchable.prepend Mongoid::Locking::Association::Embedded::Batchable
+
 # monkey patching for document updates
 Mongoid::Persistable.prepend Mongoid::Locking::Persistable

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-locking
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Rodrigo RA
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-17 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -114,12 +114,14 @@ files:
 - gemfiles/mongoid7_2.gemfile
 - gemfiles/mongoid7_3.gemfile
 - lib/mongoid/locking.rb
+- lib/mongoid/locking/association/embedded/batchable.rb
 - lib/mongoid/locking/contextual/atomic.rb
 - lib/mongoid/locking/contextual/mongo.rb
 - lib/mongoid/locking/persistable.rb
 - lib/mongoid/locking/persistable/creatable.rb
 - lib/mongoid/locking/persistable/updatable.rb
 - lib/mongoid/locking/reloadable.rb
+- lib/mongoid/locking/retry.rb
 - lib/mongoid/locking/selectable.rb
 - lib/mongoid/locking/version.rb
 - lib/mongoid/stale_object_error.rb