mongoid-locking 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c503286097299824c534beaed6886b61ee0b314dae7a362a2b556d142074dd54
+  data.tar.gz: 80ef23fc4832dc9610f4c1723deea805904d0085961caf6b08eb8f0b721a0d28
+SHA512:
+  metadata.gz: cf84bddf69cfa2d9ba33c6b1ca2bc71360da3e91b7f8fd4c80878477eafa93153081f63ba523f93d1e7981eb96d54a083262b2bb3bf2a842a31f38a8308e94a1
+  data.tar.gz: ca61600a4d453867b75829b4b7a72d6cd9c8f952ab26ead8a386459b7e3eda20bd31bd01b9c7b0c5595b3d30ed293b7c9ee50e76cf8963d5065d21880b7a9278

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,29 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: disable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Enabled: False
+
+RSpec/DescribeClass:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.7

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-08-03
+
+- Initial release
+
+Supports Mongoid 6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at rodrigo.aquino@fullhealthmedical.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mongoid-locking.gemspec
+gemspec
+
+gem "mongoid", "~> 6.0"

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    mongoid-locking (0.1.0)
+      mongoid (> 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.8.1)
+      activesupport (= 5.2.8.1)
+    activesupport (5.2.8.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.2)
+    bson (4.15.0)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    minitest (5.16.3)
+    mongo (2.18.1)
+      bson (>= 4.14.1, < 5.0.0)
+    mongoid (6.4.8)
+      activemodel (>= 5.1, < 6.0.0)
+      mongo (>= 2.5.1, < 3.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
+    ruby-progressbar (1.11.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.10)
+      thread_safe (~> 0.1)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  byebug
+  mongoid (~> 6.0)
+  mongoid-locking!
+  rake (~> 13.0)
+  rspec
+  rubocop
+  rubocop-rspec
+
+BUNDLED WITH
+   2.3.14

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Rodrigo RA
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# Mongoid::Locking
+
+It adds Optimistic Locking to `Mongoid::Document` objects.
+
+This gem is inspired in the [ActiveRecord::Locking](https://api.rubyonrails.org/v7.0.3.1/classes/ActiveRecord/Locking/Optimistic.html)
+module.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add mongoid-locking
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install mongoid-locking
+
+## Usage
+
+- Include `Mongoid::Locking` module
+
+```
+  class Order
+    include Mongoid::Document
+    include Mongoid::Locking
+  end
+```
+
+- Handle `Mongoid::StaleObjectError` when performing updates
+
+```
+  # ...
+  def update_order
+    order.update(attributes)
+  rescue Mongoid::StaleObjectError => e
+    add_error("This order has been changed ...")
+  end
+end
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fullhealthmedical/fhweb/mongoid-locking. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/fullhealthmedical/fhweb/mongoid-locking/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mongoid::Locking project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fullhealthmedical/fhweb/mongoid-locking/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/gemfiles/mongoid6.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mongoid-locking.gemspec
+gemspec path: ".."
+
+gem "mongoid", "~> 6.0"

data/gemfiles/mongoid7.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mongoid-locking.gemspec
+gemspec path: ".."
+
+gem "mongoid", "~> 7.0"

data/lib/mongoid/locking/contextual/atomic.rb

@@ -0,0 +1,183 @@
+module Mongoid
+  module Locking
+    module Contextual
+      # :nodoc:
+      module Atomic
+        # Execute an atomic $addToSet on the matching documents.
+        #
+        # @example Add the value to the set.
+        #   context.add_to_set(members: "Dave", genres: "Electro")
+        #
+        # @param [ Hash ] adds The operations.
+        #
+        # @return [ nil ] Nil.
+        def add_to_set(adds)
+          _update_many_with_locking("$addToSet" => collect_operations(adds))
+        end
+
+        # Perform an atomic $addToSet/$each on the matching documents.
+        #
+        # @example Add the value to the set.
+        #   context.add_each_to_set(members: ["Dave", "Bill"], genres: ["Electro", "Disco"])
+        #
+        # @param [ Hash ] adds The operations.
+        #
+        # @return [ nil ] Nil.
+        def add_each_to_set(adds)
+          _update_many_with_locking("$addToSet" => collect_each_operations(adds))
+        end
+
+        # Perform an atomic $bit operation on the matching documents.
+        #
+        # @example Perform the bitwise op.
+        #   context.bit(likes: { and: 14, or: 4 })
+        #
+        # @param [ Hash ] bits The operations.
+        #
+        # @return [ nil ] Nil.
+        def bit(bits)
+          _update_many_with_locking("$bit" => collect_operations(bits))
+        end
+
+        # Perform an atomic $inc operation on the matching documents.
+        #
+        # @example Perform the atomic increment.
+        #   context.inc(likes: 10)
+        #
+        # @param [ Hash ] incs The operations.
+        #
+        # @return [ nil ] Nil.
+        def inc(incs)
+          _update_many_with_locking("$inc" => collect_operations(incs))
+        end
+
+        # Perform an atomic $pop operation on the matching documents.
+        #
+        # @example Pop the first value on the matches.
+        #   context.pop(members: -1)
+        #
+        # @example Pop the last value on the matches.
+        #   context.pop(members: 1)
+        #
+        # @param [ Hash ] pops The operations.
+        #
+        # @return [ nil ] Nil.
+        def pop(pops)
+          _update_many_with_locking("$pop" => collect_operations(pops))
+        end
+
+        # Perform an atomic $pull operation on the matching documents.
+        #
+        # @example Pull the value from the matches.
+        #   context.pull(members: "Dave")
+        #
+        # @note Expression pulling is not yet supported.
+        #
+        # @param [ Hash ] pulls The operations.
+        #
+        # @return [ nil ] Nil.
+        def pull(pulls)
+          _update_many_with_locking("$pull" => collect_operations(pulls))
+        end
+
+        # Perform an atomic $pullAll operation on the matching documents.
+        #
+        # @example Pull all the matching values from the matches.
+        #   context.pull_all(:members, [ "Alan", "Vince" ])
+        #
+        # @param [ Hash ] pulls The operations.
+        #
+        # @return [ nil ] Nil.
+        def pull_all(pulls)
+          _update_many_with_locking("$pullAll" => collect_operations(pulls))
+        end
+
+        # Perform an atomic $push operation on the matching documents.
+        #
+        # @example Push the value to the matching docs.
+        #   context.push(members: "Alan")
+        #
+        # @param [ Hash ] pushes The operations.
+        #
+        # @return [ nil ] Nil.
+        def push(pushes)
+          _update_many_with_locking("$push" => collect_operations(pushes))
+        end
+
+        # Perform an atomic $push/$each operation on the matching documents.
+        #
+        # @example Push the values to the matching docs.
+        #   context.push_all(members: [ "Alan", "Fletch" ])
+        #
+        # @param [ Hash ] pushes The operations.
+        #
+        # @return [ nil ] Nil.
+        def push_all(pushes)
+          _update_many_with_locking("$push" => collect_each_operations(pushes))
+        end
+
+        # Perform an atomic $rename of fields on the matching documents.
+        #
+        # @example Rename the fields on the matching documents.
+        #   context.rename(members: :artists)
+        #
+        # @param [ Hash ] renames The operations.
+        #
+        # @return [ nil ] Nil.
+        def rename(renames)
+          operations = renames.inject({}) do |ops, (old_name, new_name)|
+            ops[old_name] = new_name.to_s
+            ops
+          end
+          _update_many_with_locking("$rename" => collect_operations(operations))
+        end
+
+        # Perform an atomic $set of fields on the matching documents.
+        #
+        # @example Set the field value on the matches.
+        #   context.set(name: "Depeche Mode")
+        #
+        # @param [ Hash ] sets The operations.
+        #
+        # @return [ nil ] Nil.
+        #
+        # @since 3.0.0
+        def set(sets)
+          _update_many_with_locking("$set" => collect_operations(sets))
+        end
+
+        # Perform an atomic $unset of a field on the matching documents.
+        #
+        # @example Unset the field on the matches.
+        #   context.unset(:name)
+        #
+        # @param [ String | Symbol | Array<String|Symbol> | Hash ] args
+        #   The name(s) of the field(s) to unset.
+        #   If a Hash is specified, its keys will be used irrespective of what
+        #   each key's value is, even if the value is nil or false.
+        #
+        # @return [ nil ] Nil.
+        def unset(*args)
+          fields = args.map { |a| a.is_a?(Hash) ? a.keys : a }
+                       .__find_args__
+                       .map { |f| [database_field_name(f), true] }
+          view.update_many("$unset" => Hash[fields])
+        end
+
+        private
+
+        def _update_many_with_locking(operations)
+          if _locking?
+            view.update_many(operations.merge("$inc" => { "lock_version" => 1 }))
+          else
+            view.update_many(operations)
+          end
+        end
+
+        def _locking?
+          @klass.included_modules.include?(Mongoid::Locking)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/locking/contextual/mongo.rb

@@ -0,0 +1,31 @@
+module Mongoid
+  module Locking
+    module Contextual
+      # :nodoc:
+      module Mongo
+        # Update the documents for the provided method.
+        #
+        # @api private
+        #
+        # @example Update the documents.
+        #   context.update_documents(attrs)
+        #
+        # @param [ Hash ] attributes The updates.
+        # @param [ Symbol ] method The method to use.
+        #
+        # @return [ true, false ] If the update succeeded.
+        def update_documents(attributes, method = :update_one, opts = {})
+          return false unless attributes
+
+          attributes = Hash[attributes.transform_keys { |k| klass.database_field_name(k.to_s) }]
+          updates = attributes.__consolidate__(klass)
+          if _locking?
+            updates["$inc"] ||= {}
+            updates["$inc"]["lock_version"] = 1
+          end
+          view.send(method, updates, opts)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/locking/persistable/creatable.rb

@@ -0,0 +1,18 @@
+module Mongoid
+  module Locking
+    module Persistable
+      module Creatable # :nodoc:
+        def insert_as_embedded
+          raise Errors::NoParent, self.class.name unless _parent
+
+          if _parent.new_record?
+            _parent.insert
+          else
+            selector = _parent.atomic_selector
+            _update_one_locked(_root.collection, selector, positionally(selector, atomic_inserts))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/locking/persistable/updatable.rb

@@ -0,0 +1,27 @@
+module Mongoid
+  module Locking
+    module Persistable
+      module Updatable # :nodoc:
+        # Overrides the default Mongoid::Persistable::Updatable#update_document
+        # to:
+        # - include the lock_version in the atomic selector
+        # - increment the lock_version in the atomic updates
+        def update_document(options = {})
+          prepare_update(options) do
+            updates, conflicts = init_atomic_updates
+            return if updates.empty?
+
+            coll = collection(_root)
+            selector = atomic_selector
+
+            _update_one_locked(coll, selector, updates)
+
+            conflicts.each_pair do |key, value|
+              coll.find(selector).update_one(positionally(selector, { key => value }), session: _session)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/locking/persistable.rb

@@ -0,0 +1,53 @@
+module Mongoid
+  module Locking
+    module Persistable # :nodoc:
+      include ::Mongoid::Locking::Persistable::Creatable
+      include ::Mongoid::Locking::Persistable::Updatable
+
+      # Overrides the default Mongoid::Persistable#persist_atomic_operations
+      # to:
+      # - include the lock_version in the atomic selector
+      # - increment the lock_version in the atomic updates
+      def persist_atomic_operations(operations)
+        return unless persisted? && operations.present?
+
+        selector = atomic_selector
+        _update_one_locked(_root.collection, selector, operations)
+      end
+
+      private
+
+      def _update_one_locked(collection, selector, updates)
+        if _locking?
+          updates["$inc"] ||= {}
+          updates["$inc"]["lock_version"] = 1
+        end
+
+        result = collection.find(selector).update_one(positionally(selector, updates), session: _session)
+
+        if _locking?
+          _assert_updated(result)
+          _increase_lock_version
+        end
+
+        result
+      end
+
+      def _assert_updated(result)
+        raise Mongoid::StaleObjectError, self.class.name.try(:downcase) if result.n < 1
+      end
+
+      def _increase_lock_version
+        doc = embedded? ? _root : self
+
+        doc.lock_version = (doc.lock_version || 0) + 1
+      end
+
+      def _locking?
+        klass = embedded? ? _root.class : self.class
+
+        klass.included_modules.include?(::Mongoid::Locking)
+      end
+    end
+  end
+end

data/lib/mongoid/locking/selectable.rb

@@ -0,0 +1,18 @@
+module Mongoid
+  module Locking
+    module Selectable # :nodoc:
+      # Overrides the default Mongoid::Selectable#atomic_selector to not memoize
+      # its result.
+      #
+      # It is required when saving the same object multiple times in a row.
+      def atomic_selector
+        embedded? ? embedded_atomic_selector : root_atomic_selector
+      end
+
+      # https://github.com/mongodb/mongoid/blob/e03120a56894bc773dcf1e51209eb2f3e6f2b61f/lib/mongoid/selectable.rb#L55
+      def root_atomic_selector
+        { "_id" => id, "lock_version" => lock_version }
+      end
+    end
+  end
+end

data/lib/mongoid/locking/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Locking
+    VERSION = "0.1.0"
+  end
+end

data/lib/mongoid/locking.rb

@@ -0,0 +1,32 @@
+require "mongoid"
+require_relative "locking/version"
+require_relative "stale_object_error"
+require_relative "locking/contextual/atomic"
+require_relative "locking/contextual/mongo"
+require_relative "locking/selectable"
+require_relative "locking/persistable/creatable"
+require_relative "locking/persistable/updatable"
+require_relative "locking/persistable"
+
+module Mongoid
+  ##
+  # Adds optimistic locking to a Mongoid::Document class.
+  #
+  # @since 0.1.0
+  module Locking
+    def self.included(base)
+      base.field :lock_version, type: Integer
+      base.before_create { self.lock_version = 0 }
+
+      base.include Mongoid::Locking::Selectable
+      # base.include Mongoid::Locking::Reloadable if Mongoid::VERSION >= "7"
+    end
+  end
+end
+
+# monkey patching for collection updates
+Mongoid::Contextual::Mongo.prepend Mongoid::Locking::Contextual::Mongo
+Mongoid::Contextual::Mongo.prepend Mongoid::Locking::Contextual::Atomic
+
+# monkey patching for document updates
+Mongoid::Persistable.prepend Mongoid::Locking::Persistable

data/lib/mongoid/stale_object_error.rb

@@ -0,0 +1,4 @@
+module Mongoid
+  class StaleObjectError < Mongoid::Errors::MongoidError
+  end
+end

data/sig/mongoid/locking.rbs

@@ -0,0 +1,6 @@
+module Mongoid
+  module Locking
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-locking
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rodrigo RA
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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'
+description: Implements optimistic locking for Mongoid objects.
+email:
+- rodrigorcomp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/mongoid6.gemfile
+- gemfiles/mongoid7.gemfile
+- lib/mongoid/locking.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/selectable.rb
+- lib/mongoid/locking/version.rb
+- lib/mongoid/stale_object_error.rb
+- sig/mongoid/locking.rbs
+homepage: https://github.com/fullhealthmedical/mongoid-locking
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/fullhealthmedical/mongoid-locking
+  source_code_uri: https://github.com/fullhealthmedical/mongoid-locking
+  changelog_uri: https://github.com/fullhealthmedical/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Implements optimistic locking for Mongoid objects.
+test_files: []