mongoid-locker 0.3.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cf3cf7653f3a1d1719beb2b0a4e355f08ca0c377
-  data.tar.gz: ac2d977fd88b44794f8222b4897b8550de9881db
+SHA256:
+  metadata.gz: 46e4667e791c955ae115a24070ff3b1383c8d272f7263cb9f0199b9b9c82ab46
+  data.tar.gz: ba19a3dc36bdf0522c2cc7d9dca31a8e89f0ac01c3d3073f476a64605db26cc2
 SHA512:
-  metadata.gz: 476b1ff144e25f07ce7f8cd1829b42ff8ab2ad0cb3f2c66fef259a3c2a19b00cfc9cdc11aa5f7988ac3d39ae36b7e29d223ad70bf263e3705114965cd6179baa
-  data.tar.gz: 9849fccf0948617c075368cd7d6514eb91ca9ef677328859381ae606ff1f7b455251ec04f5bbc604e421405aaa1ba14fbcda1c83549f2bcdd977a6d23fb08b05
+  metadata.gz: be8ec0af58ec384c7c1e374fd5ca5bbe133b95fb2be445628f6026a64665a866ebaf4396423f775fc8de51101c6cf920f61669859d32433d7bae2f9353e45a71
+  data.tar.gz: 2148730176e46068be6b9bca45ef9b6f4d83107561e0b60ad8ada1254d40ada77ac69ea64cc792b21f565cde1b4ff338a4d740d11bf90866c9136d4cc831e715

data/.rubocop_todo.yml

@@ -1,58 +1,78 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-10-21 11:03:44 -0400 using RuboCop version 0.29.1.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-09-01 16:46:40 +0300 using RuboCop version 0.58.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
+# Offense count: 6
+# Configuration parameters: Include.
+# Include: **/*.gemfile, **/Gemfile, **/gems.rb
+Bundler/DuplicatedGem:
+  Exclude:
+    - 'Gemfile'
+
+# Offense count: 2
 Metrics/AbcSize:
-  Max: 18
+  Max: 20
 
-# Offense count: 37
-# Configuration parameters: AllowURI, URISchemes.
-Metrics/LineLength:
-  Max: 184
+# Offense count: 5
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 493
 
-# Offense count: 3
+# Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 25
 
-# Offense count: 6
-# Cop supports --auto-correct.
-Style/Blocks:
-  Enabled: false
+# Offense count: 1
+# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist, MethodDefinitionMacros.
+# NamePrefix: is_, has_, have_
+# NamePrefixBlacklist: is_, has_, have_
+# NameWhitelist: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/mongoid/locker.rb'
 
-# Offense count: 3
+# Offense count: 2
 Style/Documentation:
-  Enabled: false
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/mongoid/locker.rb'
 
 # Offense count: 2
 Style/DoubleNegation:
-  Enabled: false
-
-# Offense count: 2
-# Configuration parameters: Exclude.
-Style/FileName:
-  Enabled: false
+  Exclude:
+    - 'lib/mongoid/locker.rb'
 
 # Offense count: 1
-# Configuration parameters: NamePrefix, NamePrefixBlacklist.
-Style/PredicateName:
-  Enabled: false
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/mongoid/locker.rb'
 
 # Offense count: 1
-# Configuration parameters: SupportedStyles.
+# Cop supports --auto-correct.
+# Configuration parameters: .
+# SupportedStyles: compact, exploded
 Style/RaiseArgs:
   EnforcedStyle: compact
 
-# Offense count: 2
-Style/RegexpLiteral:
-  MaxSlashes: 0
-
 # Offense count: 1
 # Cop supports --auto-correct.
-# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, Whitelist.
-Style/TrivialAccessors:
-  Enabled: false
+# Configuration parameters: MinSize.
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# Offense count: 63
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 184

data/CHANGELOG.md

@@ -1,10 +1,15 @@
 ## Changelog
 
-### 0.3.6 (4/18/2018)
+### 1.0.0 (2018-09-02)
+
+* [#57](https://github.com/mongoid/mongoid-locker/pull/57): `Time.now` replaced by `Time.now.utc` - [@dks17](https://github.com/dks17).
+* [#55](https://github.com/mongoid/mongoid-locker/pull/55): Customizable :locked_at and :locked_until fields - [@dks17](https://github.com/dks17).
+
+### 0.3.6 (2018-04-18)
 
 * [#52](https://github.com/mongoid/mongoid-locker/pull/52): Added support for Mongoid 7 - [@wuhuizuo](https://github.com/wuhuizuo).
 
-### 0.3.5 (1/24/2017)
+### 0.3.5 (2017-01-24)
 
 * [#43](https://github.com/mongoid/mongoid-locker/pull/43): Added support for Mongoid 6 - [@sivagollapalli](https://github.com/sivagollapalli).
 * [#38](https://github.com/mongoid/mongoid-locker/issues/38): Fixed unlock already destroyed object - [@sivagollapalli](https://github.com/sivagollapalli).

data/Dangerfile

@@ -1 +1 @@
-danger.import_dangerfile(gem: "mongoid-danger")
+danger.import_dangerfile(gem: 'mongoid-danger')

data/Gemfile

@@ -21,16 +21,15 @@ end
 gemspec
 
 group :development do
-  gem 'bundler', '~> 1.1'
   gem 'guard-rspec'
   gem 'rb-fsevent', '~> 0.9.1'
 end
 
 group :development, :test do
   gem 'mongoid-compatibility'
+  gem 'mongoid-danger', '~> 0.1.1'
   gem 'rack', '~> 1.5'
-  gem 'rspec', '~> 3.0'
   gem 'rake', '11.3.0'
-  gem 'rubocop', '0.29.1'
-  gem 'mongoid-danger', '~> 0.1.1'
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop'
 end

data/Guardfile

@@ -1,10 +1,17 @@
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec' do
-  watch(%r{^spec/.+_spec\.rb$})
+guard :rspec, cmd: 'bundle exec rspec', all_on_start: true do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
 
-  watch('Gemfile')              { 'spec' }
-  watch('Gemfile.lock')         { 'spec' }
-  watch(%r{^lib/(.+)\.rb$})     { 'spec' }
-  watch('spec/spec_helper.rb')  { 'spec' }
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files) { rspec.spec_dir }
+
+  watch('Gemfile.lock') { rspec.spec_dir }
+
+  ruby = dsl.ruby
+  watch(ruby.lib_files) { rspec.spec_dir }
 end

data/README.md

@@ -3,10 +3,10 @@
 [![Build Status](https://secure.travis-ci.org/mongoid/mongoid-locker.svg?branch=master)](http://travis-ci.org/mongoid/mongoid-locker)
 [![Code Climate](https://codeclimate.com/github/mongoid/mongoid-locker.svg)](https://codeclimate.com/github/mongoid/mongoid-locker)
 
-Document-level locking for MongoDB via Mongoid.  The need arose at [Jux](https://jux.com) from multiple processes on multiple servers trying to act upon the same document and stepping on each other's toes.  Mongoid-Locker is an easy way to ensure only one process can perform a certain operation on a document at a time.
+Document-level locking for MongoDB via Mongoid. The need arose at [Jux](https://jux.com) from multiple processes on multiple servers trying to act upon the same document and stepping on each other's toes. Mongoid-Locker is an easy way to ensure only one process can perform a certain operation on a document at a time.
 
 [Tested](http://travis-ci.org/mongoid/mongoid-locker) against:
-- MRI: `2.3.6`, `2.4.3`, `2.5.0` 
+- MRI: `2.3.6`, `2.4.3`, `2.5.0`
 - Mongoid: `2`, `3`, `4`, `5`, `6`, `7`
 
 See [.travis.yml](.travis.yml) for the latest test matrix.
@@ -19,14 +19,17 @@ Add to your `Gemfile`:
 gem 'mongoid-locker'
 ```
 
-and run `bundle install`.  In the model you wish to lock, include `Mongoid::Locker` after `Mongoid::Document`.  For example:
+and run `bundle install`. In the model you wish to lock, include `Mongoid::Locker` after `Mongoid::Document`. For example:
 
 ```ruby
 class QueueItem
   include Mongoid::Document
   include Mongoid::Locker
 
-  field :completed_at, :type => Time
+  field :locked_at, type: Time
+  field :locked_until, type: Time
+
+  field :completed_at, type: Time
 end
 ```
 
@@ -37,7 +40,7 @@ queue_item.with_lock do
 
   # do stuff
 
-  queue_item.completed_at = Time.now
+  queue_item.completed_at = Time.now.utc
   queue_item.save!
 end
 ```
@@ -57,6 +60,48 @@ Note that these locks are only enforced when using `#with_lock`, not at the data
 
 More in-depth method documentation can be found at [rdoc.info](http://rdoc.info/github/mongoid/mongoid-locker/frames).
 
+### Customizable :locked_at and :locked_until field names
+By default, Locker uses fields with `:locked_at` and `:locked_until` names which should be defined in a model.
+```ruby
+class User
+  include Mongoid::Document
+  include Mongoid::Locker
+
+  field :locked_at, type: Time
+  field :locked_until, type: Time
+end
+```
+
+Use `Mongoid::Locker.configure` to setup field names which used by Locker for all models where it's included.
+```ruby
+Mongoid::Locker.configure do |config|
+  config.locked_at_field = :global_locked_at
+  config.locked_until_field = :global_locked_until
+end
+
+class User
+  include Mongoid::Document
+  include Mongoid::Locker
+
+  field :global_locked_at, type: Time
+  field :global_locked_until, type: Time
+end
+```
+
+The `locker` method in your model accepts `:locked_at_field` and `:locked_until_field` options to setup field names which used by Locker for the model. This can be useful when another library uses the same field for different purposes.
+```ruby
+class User
+  include Mongoid::Document
+  include Mongoid::Locker
+
+  field :locker_locked_at, type: Time
+  field :locker_locked_until, type: Time
+
+  locker locked_at_field: :locker_locked_at,
+         locked_until_field: :locker_locked_until
+end
+```
+
 ## Copyright & License
 
 Copyright (c) 2012-2018 Aidan Feldman & Contributors

data/Rakefile

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'rubygems'
 require 'bundler/setup'
 require 'bundler/gem_tasks'

data/UPGRADING.md

@@ -0,0 +1,18 @@
+## Upgrading Mongoid Locker
+
+### Upgrading to 1.0.0
+`Mongoid::Locker` no longer defines `locked_at` and `locked_until` fields when included. You must define these fields manually.
+
+```ruby
+class User
+  include Mongoid::Document
+  include Mongoid::Locker
+
+  field :locked_at, type: Time
+  field :locked_until, type: Time
+end
+```
+
+You can customize the fields used with a `locker` class method or via a global `configure`. See [Customizable :locked_at and :locked_until field names](https://github.com/mongoid/mongoid-locker#customizable-locked_at-and-locked_until-field-names) for more information.
+
+See [#55](https://github.com/mongoid/mongoid-locker/pull/55) for more information.

data/lib/mongoid/locker.rb

@@ -3,22 +3,26 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'locker', 'wrapper'))
 
 module Mongoid
   module Locker
+    # The field names used by default.
+    @locked_at_field     = :locked_at
+    @locked_until_field  = :locked_until
+
     # Error thrown if document could not be successfully locked.
-    class LockError < Exception; end
+    class LockError < RuntimeError; end
 
     module ClassMethods
       # A scope to retrieve all locked documents in the collection.
       #
       # @return [Mongoid::Criteria]
       def locked
-        where :locked_until.gt => Time.now
+        where locked_until_field.gt => Time.now.utc
       end
 
       # A scope to retrieve all unlocked documents in the collection.
       #
       # @return [Mongoid::Criteria]
       def unlocked
-        any_of({ locked_until: nil }, :locked_until.lte => Time.now)
+        any_of({ locked_until_field => nil }, locked_until_field.lte => Time.now.utc)
       end
 
       # Set the default lock timeout for this class.  Note this only applies to new locks.  Defaults to five seconds.
@@ -36,28 +40,68 @@ module Mongoid
         # default timeout of five seconds
         @lock_timeout || 5
       end
+
+      # Set locked_at_field and locked_until_field names for this class
+      def locker(locked_at_field: nil, locked_until_field: nil)
+        class_variable_set(:@@locked_at_field, locked_at_field) if locked_at_field
+        class_variable_set(:@@locked_until_field, locked_until_field) if locked_until_field
+      end
+
+      # Returns field name used to set locked at time for this class.
+      def locked_at_field
+        class_variable_get(:@@locked_at_field)
+      end
+
+      # Returns field name used to set locked until time for this class.
+      def locked_until_field
+        class_variable_get(:@@locked_until_field)
+      end
     end
 
-    # @api private
-    def self.included(mod)
-      mod.extend ClassMethods
+    class << self
+      attr_accessor :locked_at_field, :locked_until_field
+
+      # @api private
+      def included(mod)
+        mod.extend ClassMethods
 
-      mod.field :locked_at, type: Time
-      mod.field :locked_until, type: Time
+        mod.class_variable_set(:@@locked_at_field, locked_at_field)
+        mod.class_variable_set(:@@locked_until_field, locked_until_field)
+
+        mod.send(:define_method, :locked_at_field) { mod.class_variable_get(:@@locked_at_field) }
+        mod.send(:define_method, :locked_until_field) { mod.class_variable_get(:@@locked_until_field) }
+      end
+
+      # Sets configuration using a block
+      #
+      # Mongoid::Locker.configure do |config|
+      #   config.locked_at_field = :mongoid_locker_locked_at
+      #   config.locked_until_field = :mongoid_locker_locked_until
+      # end
+      def configure
+        yield(self) if block_given?
+      end
+
+      # Resets to default configuration.
+      def reset!
+        # The field names used by default.
+        @locked_at_field     = :locked_at
+        @locked_until_field  = :locked_until
+      end
     end
 
     # Returns whether the document is currently locked or not.
     #
     # @return [Boolean] true if locked, false otherwise
     def locked?
-      !!(locked_until && locked_until > Time.now)
+      !!(self[locked_until_field] && self[locked_until_field] > Time.now.utc)
     end
 
     # Returns whether the current instance has the lock or not.
     #
     # @return [Boolean] true if locked, false otherwise
     def has_lock?
-      !!(@has_lock && self.locked?)
+      !!(@has_lock && locked?)
     end
 
     # Primary method of plugin: execute the provided code once the document has been successfully locked.
@@ -70,7 +114,7 @@ module Mongoid
     # @option opts [Boolean] :reload After acquiring the lock, reload the document - defaults to true
     # @return [void]
     def with_lock(opts = {})
-      had_lock = self.has_lock?
+      had_lock = has_lock?
 
       unless had_lock
         opts[:retries] = 1 if opts[:wait]
@@ -87,7 +131,7 @@ module Mongoid
     protected
 
     def acquire_lock(opts = {})
-      time = Time.now
+      time = Time.now.utc
       timeout = opts[:timeout] || self.class.lock_timeout
       expiration = time + timeout
 
@@ -98,23 +142,21 @@ module Mongoid
           :_id => id,
           '$or' => [
             # not locked
-            { locked_until: nil },
+            { locked_until_field => nil },
             # expired
-            { locked_until: { '$lte' => time } }
+            { locked_until_field => { '$lte' => time } }
           ]
         },
-
         '$set' => {
-          locked_at: time,
-          locked_until: expiration
+          locked_at_field => time,
+          locked_until_field => expiration
         }
-
       )
 
       if locked
         # document successfully updated, meaning it was locked
-        self.locked_at = time
-        self.locked_until = expiration
+        self[locked_at_field] = time
+        self[locked_until_field] = expiration
         reload unless opts[:reload] == false
         @has_lock = true
       else
@@ -135,16 +177,16 @@ module Mongoid
 
         if attempts_left > 0
           # if not passed a retry_sleep value, we sleep for the remaining life of the lock
-          unless opts[:retry_sleep]
+          unless retry_sleep
             locked_until = Mongoid::Locker::Wrapper.locked_until(self)
             # the lock might be released since the last check so make another attempt
             next unless locked_until
-            retry_sleep = locked_until - Time.now
+            retry_sleep = locked_until - Time.now.utc
           end
 
           sleep retry_sleep if retry_sleep > 0
         else
-          fail LockError.new('could not get lock')
+          raise LockError.new('could not get lock')
         end
       end
     end
@@ -154,15 +196,13 @@ module Mongoid
       Mongoid::Locker::Wrapper.update(
         self.class,
         { _id: id },
-
         '$set' => {
-          locked_at: nil,
-          locked_until: nil
+          locked_at_field => nil,
+          locked_until_field => nil
         }
-
       )
 
-      self.attributes = { locked_at: nil, locked_until: nil } unless destroyed?
+      self.attributes = { locked_at_field => nil, locked_until_field => nil } unless destroyed?
       @has_lock = false
     end
   end

data/lib/mongoid/locker/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Locker
-    VERSION = '0.3.6'
+    VERSION = '1.0.0'.freeze
   end
 end

data/lib/mongoid/locker/wrapper.rb

@@ -13,5 +13,5 @@ elsif Mongoid::Compatibility::Version.mongoid3?
 elsif Mongoid::Compatibility::Version.mongoid2?
   require 'mongoid/locker/wrapper2'
 else
-  fail 'incompatible Mongoid version'
+  raise 'incompatible Mongoid version'
 end

data/lib/mongoid/locker/wrapper2.rb

@@ -17,9 +17,9 @@ module Mongoid
       # @param [Class] The model instance
       # @return [Time] The timestamp of when the document is locked until, nil if not locked.
       def self.locked_until(doc)
-        existing_query = { _id: doc.id, locked_until: { '$exists' => true } }
-        existing = doc.class.collection.find_one(existing_query, fields: { locked_until: 1 })
-        existing ? existing['locked_until'] : nil
+        existing_query = { _id: doc.id, doc.locked_until_field => { '$exists' => true } }
+        existing = doc.class.collection.find_one(existing_query, fields: { doc.locked_until_field => 1 })
+        existing ? existing[doc.locked_until_field] : nil
       end
     end
   end

data/lib/mongoid/locker/wrapper3.rb

@@ -17,9 +17,9 @@ module Mongoid
       # @param [Class] The model instance
       # @return [Time] The timestamp of when the document is locked until, nil if not locked.
       def self.locked_until(doc)
-        existing_query = { _id: doc.id, locked_until: { '$exists' => true } }
-        existing = doc.class.where(existing_query).limit(1).only(:locked_until).first
-        existing ? existing.locked_until : nil
+        existing_query = { _id: doc.id, doc.locked_until_field => { '$exists' => true } }
+        existing = doc.class.where(existing_query).limit(1).only(doc.locked_until_field).first
+        existing ? existing[doc.locked_until_field] : nil
       end
     end
   end

data/lib/mongoid/locker/wrapper4.rb

@@ -13,9 +13,9 @@ module Mongoid
       end
 
       def self.locked_until(doc)
-        existing_query = { _id: doc.id, locked_until: { '$exists' => true } }
-        existing = doc.class.where(existing_query).limit(1).only(:locked_until).first
-        existing ? existing.locked_until : nil
+        existing_query = { _id: doc.id, doc.locked_until_field => { '$exists' => true } }
+        existing = doc.class.where(existing_query).limit(1).only(doc.locked_until_field).first
+        existing ? existing[doc.locked_until_field] : nil
       end
     end
   end

data/lib/mongoid/locker/wrapper5.rb

@@ -18,9 +18,9 @@ module Mongoid
       # @param [Class] The model instance
       # @return [Time] The timestamp of when the document is locked until, nil if not locked.
       def self.locked_until(doc)
-        existing_query = { _id: doc.id, locked_until: { '$exists' => true } }
-        existing = doc.class.where(existing_query).limit(1).only(:locked_until).first
-        existing ? existing.locked_until : nil
+        existing_query = { _id: doc.id, doc.locked_until_field => { '$exists' => true } }
+        existing = doc.class.where(existing_query).limit(1).only(doc.locked_until_field).first
+        existing ? existing[doc.locked_until_field] : nil
       end
     end
   end

data/lib/mongoid/locker/wrapper6.rb

@@ -20,9 +20,9 @@ module Mongoid
       # @param [Class] The model instance
       # @return [Time] The timestamp of when the document is locked until, nil if not locked.
       def self.locked_until(doc)
-        existing_query = { _id: doc.id, locked_until: { '$exists' => true } }
-        existing = doc.class.where(existing_query).limit(1).only(:locked_until).first
-        existing ? existing.locked_until : nil
+        existing_query = { _id: doc.id, doc.locked_until_field => { '$exists' => true } }
+        existing = doc.class.where(existing_query).limit(1).only(doc.locked_until_field).first
+        existing ? existing[doc.locked_until_field] : nil
       end
     end
   end

data/mongoid-locker.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'mongoid/locker/version'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-locker
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Aidan Feldman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-18 00:00:00.000000000 Z
+date: 2018-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -61,6 +61,7 @@ files:
 - README.md
 - RELEASING.md
 - Rakefile
+- UPGRADING.md
 - demo/README.md
 - demo/config/mongoid.yml
 - demo/instagram.graffle
@@ -98,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Document-level locking for MongoDB via Mongoid.