mongoid-locker 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a80f5cc223862e305b57a190f0713f9b40d98aa2
+  data.tar.gz: 5e7b035e9de4e47acb180f8737aad225fef38170
+SHA512:
+  metadata.gz: 21b22b0c0e1902582d62565efa1ab8d38571960ab915756de31bd2ff9f021c5cab4e9e5bd49bffee967d392a0ef457e572c0a398db88560155124d9df29ffc62
+  data.tar.gz: 582144c90fde1230f723f610f76153ffd475c1005fc5162891c88cd1ed38651e45f42432679a8b46b4682b9c08fe82f950a606128fadd03e7666efb51b4f03f0

data/.rubocop.yml

@@ -0,0 +1,38 @@
+AllCops:
+  Excludes:
+    - vendor/**
+    - bin/**
+    - mongoid-locker.gemspec
+
+LineLength:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+Blocks:
+  Enabled: false
+
+FileName:
+  Enabled: false
+
+RaiseArgs:
+  Enabled: false
+
+PredicateName:
+  Enabled: false
+
+DoubleNegation:
+  Enabled: false
+
+TrivialAccessors:
+  Enabled: false

data/.travis.yml

@@ -1,24 +1,16 @@
 language: ruby
+
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
-  - jruby-18mode # JRuby in 1.8 mode
-  - jruby-19mode # JRuby in 1.9 mode
-  - rbx-18mode
-  - rbx-19mode
+  - 2.1.2
+  - jruby-19mode
+  - rbx-2
+
 services: mongodb
-gemfile:
-  - gemfiles/mongoid2.gemfile
-  - gemfiles/mongoid3.gemfile
-matrix:
-  exclude:
-    # not supported by Mongoid 3
-    - rvm: 1.8.7
-      gemfile: gemfiles/mongoid3.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/mongoid3.gemfile
-    - rvm: jruby-18mode
-      gemfile: gemfiles/mongoid3.gemfile
-    - rvm: rbx-18mode
-      gemfile: gemfiles/mongoid3.gemfile
+
+env:
+  - MONGOID_VERSION=2
+  - MONGOID_VERSION=3
+  - MONGOID_VERSION=4
+
+cache: bundler

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 # Changelog
 
-## HEAD ([diff](https://github.com/afeld/mongoid-locker/compare/v0.2.1...master?w=1))
+## 0.3.0 ([diff](https://github.com/afeld/mongoid-locker/compare/v0.2.1...v0.3.0?w=1))
+
+* change exception class to be `Mongoid::Locker::LockError` - #8
+* drop support for Rubinius 1.8-mode, since it seems to be [broken w/ Mongoid 2.6](https://travis-ci.org/mongoid/mongoid/jobs/4594000)
+* relax dependency on Mongoid - #12
+* add Mongoid 4 support
+* drop support for Ruby 1.8.x
+* got rid of appraisal for testing multiple Mongoid versions
+* added Rubocop, Ruby style linter
+* fixed `:has_lock?` to always return a boolean
+* upgraded RSpec to 3.x
+
+Thanks to @mooremo, @yanowitz and @nchainani (#9):
+
+* add `:retries` option to attempt to grab a lock multiple times - #2
+* add `:retry_sleep` to override duration between lock attempts
+* reload document after acquiring a lock by default, which can be disabled with `:reload => false`
 
 ## 0.2.1 ([diff](https://github.com/afeld/mongoid-locker/compare/v0.2.0...v0.2.1?w=1))
 

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing
+
+Pull requests are welcome.  To set up:
+
+    $ bundle install
+
+To run tests:
+
+    $ rake
+
+To run tests for Mongoid 3:
+
+    $ rm Gemfile.lock
+    $ MONGOID_VERSION=3 bundle install
+    $ MONGOID_VERSION=3 rake
+
+To auto-run tests as you code:
+
+    $ bundle exec guard

data/Gemfile

@@ -1,22 +1,27 @@
 source 'http://rubygems.org'
 
-gem 'mongoid', '>= 2.4', '<= 3.1'
-
-
-# groups need to be copied to gemfiles/*.gemfile
+case version = ENV['MONGOID_VERSION'] || '~> 4.0'
+when /4/
+  gem 'mongoid', '~> 4.0'
+when /3/
+  gem 'mongoid', '~> 3.1'
+when /2/
+  gem 'bson_ext', :platforms => :ruby
+  gem 'mongoid', '~> 2.4'
+else
+  gem 'mongoid', version
+end
 
 group :development do
-  gem 'rspec', '~> 2.8'
+  gem 'rspec', '~> 3.0'
   gem 'bundler', '~> 1.1'
   gem 'jeweler', '~> 1.8'
 
   gem 'guard-rspec'
+  gem 'rb-fsevent', '~> 0.9.1'
 end
 
 group :development, :test do
-  gem 'bson_ext', :platforms => :ruby
-
   gem 'rake'
-  # v0.4.1 doesn't support multiple group names
-  gem 'appraisal', :git => 'git://github.com/thoughtbot/appraisal.git', :ref => 'ad2aeb99649f6a78f78be5009fb50306f06eaa9f'
+  gem 'rubocop', '0.24.0'
 end

data/Guardfile

@@ -1,6 +1,6 @@
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec', :version => 2 do
+guard 'rspec' do
   watch(%r{^spec/.+_spec\.rb$})
 
   watch('Gemfile')              { "spec" }

data/README.md

@@ -1,8 +1,8 @@
-# mongoid-locker [![Build Status](https://secure.travis-ci.org/afeld/mongoid-locker.png?branch=master)](http://travis-ci.org/afeld/mongoid-locker)
+# mongoid-locker [![Build Status](https://secure.travis-ci.org/afeld/mongoid-locker.png?branch=master)](http://travis-ci.org/afeld/mongoid-locker) [![Code Climate](https://codeclimate.com/github/afeld/mongoid-locker.png)](https://codeclimate.com/github/afeld/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.
 
-[Tested](http://travis-ci.org/afeld/mongoid-locker) against MRI 1.8.7, 1.9.2 and 1.9.3, Rubinius 1.8 and 1.9, and JRuby 1.8 and 1.9 with Mongoid 2 and 3 ([where supported](http://travis-ci.org/#!/afeld/mongoid-locker)).
+[Tested](http://travis-ci.org/afeld/mongoid-locker) against MRI 1.9.3, 2.0.0 and 2.1.2, Rubinius 2.x, and JRuby 1.9 with Mongoid 2, 3 and 4 ([where supported](http://travis-ci.org/#!/afeld/mongoid-locker)).
 
 ## Usage
 
@@ -35,10 +35,7 @@ queue_item.with_lock do
 end
 ```
 
-`#with_lock` takes a couple options as a hash:
-
-* `timeout`: The amount of time until a lock expires, in seconds.  Defaults to `5`.
-* `wait`: If a lock exists on the document, wait until that lock expires and try again.  Defaults to `false`.
+`#with_lock` takes an optional [handful of options around retrying](http://rdoc.info/github/afeld/mongoid-locker/Mongoid/Locker:with_lock), so make sure to take a look.
 
 The default timeout can also be set on a per-class basis:
 
@@ -52,15 +49,3 @@ end
 Note that these locks are only enforced when using `#with_lock`, not at the database level.  It is useful for transactional operations, where you can make atomic modification of the document with checks.  For exmple, you could deduct a purchase from a user's balance... _unless_ they are broke.
 
 More in-depth method documentation can be found at [rdoc.info](http://rdoc.info/github/afeld/mongoid-locker/frames).  Enjoy!
-
-## Contributing
-
-Pull requests are welcome.  To run tests:
-
-    $ bundle install
-    $ rake
-
-To auto-run tests as you code:
-
-    $ bundle install
-    $ guard

data/Rakefile

@@ -3,18 +3,17 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'rake'
-require 'appraisal'
 
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "mongoid-locker"
-  gem.homepage = "http://github.com/afeld/mongoid-locker"
-  gem.license = "MIT"
-  gem.summary = "Document-level locking for MongoDB via Mongoid"
-  gem.description = %Q{Allows multiple processes to operate on individual documents in MongoDB while ensuring that only one can act at a time.}
-  gem.email = "aidan.feldman@gmail.com"
-  gem.authors = ["Aidan Feldman"]
+  gem.name = 'mongoid-locker'
+  gem.homepage = 'http://github.com/afeld/mongoid-locker'
+  gem.license = 'MIT'
+  gem.summary = 'Document-level locking for MongoDB via Mongoid'
+  gem.description = 'Allows multiple processes to operate on individual documents in MongoDB while ensuring that only one can act at a time.'
+  gem.email = 'aidan.feldman@gmail.com'
+  gem.authors = ['Aidan Feldman']
   gem.files.exclude 'demo'
   # dependencies defined in Gemfile
 end
@@ -26,4 +25,7 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-task :default => :spec
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/lib/mongoid/locker.rb

@@ -2,6 +2,9 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'locker', 'wrapper'))
 
 module Mongoid
   module Locker
+    # Error thrown if document could not be successfully locked.
+    class LockError < Exception; end
+
     module ClassMethods
       # A scope to retrieve all locked documents in the collection.
       #
@@ -14,14 +17,14 @@ module Mongoid
       #
       # @return [Mongoid::Criteria]
       def unlocked
-        any_of({:locked_until => nil}, {:locked_until.lte => Time.now})
+        any_of({ locked_until: nil }, { :locked_until.lte => Time.now })
       end
 
       # Set the default lock timeout for this class.  Note this only applies to new locks.  Defaults to five seconds.
       #
       # @param [Fixnum] new_time the default number of seconds until a lock is considered "expired", in seconds
       # @return [void]
-      def timeout_lock_after new_time
+      def timeout_lock_after(new_time)
         @lock_timeout = new_time
       end
 
@@ -35,50 +38,54 @@ module Mongoid
     end
 
     # @api private
-    def self.included mod
+    def self.included(mod)
       mod.extend ClassMethods
 
-      mod.field :locked_at, :type => Time
-      mod.field :locked_until, :type => Time
+      mod.field :locked_at, type: Time
+      mod.field :locked_until, type: Time
     end
 
-
     # Returns whether the document is currently locked or not.
     #
     # @return [Boolean] true if locked, false otherwise
     def locked?
-      !!(self.locked_until && self.locked_until > Time.now)
+      !!(locked_until && locked_until > Time.now)
     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 && self.locked?)
     end
 
     # Primary method of plugin: execute the provided code once the document has been successfully locked.
     #
     # @param [Hash] opts for the locking mechanism
     # @option opts [Fixnum] :timeout The number of seconds until the lock is considered "expired" - defaults to the {ClassMethods#lock_timeout}
-    # @option opts [Boolean] :wait If the document is currently locked, wait until the lock expires and try again
+    # @option opts [Fixnum] :retries If the document is currently locked, the number of times to retry. Defaults to 0 (note: setting this to 1 is the equivalent of using :wait => true)
+    # @option opts [Float] :retry_sleep How long to sleep between attempts to acquire lock - defaults to time left until lock is available
+    # @option opts [Boolean] :wait If the document is currently locked, wait until the lock expires and try again - defaults to false. If set, :retries will be ignored
+    # @option opts [Boolean] :reload After acquiring the lock, reload the document - defaults to true
     # @return [void]
-    def with_lock opts={}, &block
-      # don't try to re-lock/unlock on recursive calls
-      had_lock = self.has_lock?
-      self.lock(opts) unless had_lock
+    def with_lock(opts = {})
+      have_lock = self.has_lock?
+
+      unless have_lock
+        opts[:retries] = 1 if opts[:wait]
+        lock(opts)
+      end
 
       begin
         yield
       ensure
-        self.unlock unless had_lock
+        unlock unless have_lock
       end
     end
 
-
     protected
 
-    def lock opts={}
+    def acquire_lock(opts = {})
       time = Time.now
       timeout = opts[:timeout] || self.class.lock_timeout
       expiration = time + timeout
@@ -87,45 +94,54 @@ module Mongoid
       locked = Mongoid::Locker::Wrapper.update(
         self.class,
         {
-          :_id => self.id,
+          :_id => id,
           '$or' => [
             # not locked
-            {:locked_until => nil},
+            { locked_until: nil },
             # expired
-            {:locked_until => {'$lte' => time}}
+            { locked_until: { '$lte' => time } }
           ]
         },
-        {
-          '$set' => {
-            :locked_at => time,
-            :locked_until => expiration
-          }
+
+        '$set' => {
+          locked_at: time,
+          locked_until: expiration
         }
+
       )
 
       if locked
         # document successfully updated, meaning it was locked
         self.locked_at = time
         self.locked_until = expiration
+        reload unless opts[:reload] == false
         @has_lock = true
       else
-        # couldn't grab lock
+        @has_lock = false
+      end
+    end
+
+    def lock(opts = {})
+      opts = { retries: 0 }.merge(opts)
+
+      attempts_left = opts[:retries] + 1
+      retry_sleep = opts[:retry_sleep]
+
+      loop do
+        return if acquire_lock(opts)
 
-        if opts[:wait] && locked_until = Mongoid::Locker::Wrapper.locked_until(self)
-          # doc is locked - wait until it expires
-          wait_time = locked_until - Time.now
-          sleep wait_time if wait_time > 0
+        attempts_left -= 1
 
-          # only wait once
-          opts.dup
-          opts.delete :wait
+        if attempts_left > 0
+          # if not passed a retry_sleep value, we sleep for the remaining life of the lock
+          unless opts[:retry_sleep]
+            locked_until = Mongoid::Locker::Wrapper.locked_until(self)
+            retry_sleep = locked_until - Time.now
+          end
 
-          # reload to update with any new values
-          self.reload
-          # retry lock grab
-          self.lock opts
+          sleep retry_sleep if retry_sleep > 0
         else
-          raise LockError.new("could not get lock")
+          fail LockError.new('could not get lock')
         end
       end
     end
@@ -134,13 +150,13 @@ module Mongoid
       # unlock the document in the DB without persisting entire doc
       Mongoid::Locker::Wrapper.update(
         self.class,
-        {:_id => self.id},
-        {
-          '$set' => {
-            :locked_at => nil,
-            :locked_until => nil,
-          }
+        { _id: id },
+
+        '$set' => {
+          locked_at: nil,
+          locked_until: nil
         }
+
       )
 
       self.locked_at = nil
@@ -148,7 +164,4 @@ module Mongoid
       @has_lock = false
     end
   end
-
-  # Error thrown if document could not be successfully locked.
-  class LockError < Exception; end
 end