mongoid-locker 0.1.1 → 0.2.0

data/.travis.yml

@@ -7,3 +7,17 @@ rvm:
   - jruby-19mode # JRuby in 1.9 mode
   - rbx-18mode
   - rbx-19mode
+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

data/Appraisals

@@ -0,0 +1,7 @@
+appraise 'mongoid2' do
+  gem 'mongoid', '~> 2.4'
+end
+
+appraise 'mongoid3' do
+  gem 'mongoid', '~> 3.0.0'
+end

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## HEAD ([diff](https://github.com/afeld/mongoid-locker/compare/v0.2.0...master?w=1))
+
+## 0.2.0 ([diff](https://github.com/afeld/mongoid-locker/compare/v0.1.1...v0.2.0?w=1))
+
+* handle recursive calls to `#with_lock` - #7
+* lock optimizations, particularly for large documents
+* add Mongoid 3 support - #3
+
 ## 0.1.1 ([diff](https://github.com/afeld/mongoid-locker/compare/v0.1.0...v0.1.1?w=1))
 
 * fix for subclasses - #5

data/Gemfile

@@ -1,12 +1,10 @@
 source 'http://rubygems.org'
-# Add dependencies required to use your gem here.
-# Example:
-#   gem 'activesupport', '>= 2.3.5'
 
-gem 'mongoid', '~> 2.4'
+gem 'mongoid', '>= 2.4', '<= 3.1'
+
+
+# groups need to be copied to gemfiles/*.gemfile
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development do
   gem 'rspec', '~> 2.8'
   gem 'bundler', '~> 1.1'
@@ -17,4 +15,8 @@ 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'
 end

data/Gemfile.lock

@@ -0,0 +1,80 @@
+GIT
+  remote: git://github.com/thoughtbot/appraisal.git
+  revision: ad2aeb99649f6a78f78be5009fb50306f06eaa9f
+  ref: ad2aeb99649f6a78f78be5009fb50306f06eaa9f
+  specs:
+    appraisal (0.4.1)
+      bundler
+      rake
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    bson (1.6.4)
+    bson_ext (1.6.4)
+      bson (~> 1.6.4)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    ffi (1.1.5)
+    git (1.2.5)
+    guard (1.3.2)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-rspec (1.2.1)
+      guard (>= 1.1)
+    i18n (0.6.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    mongoid (3.0.5)
+      activemodel (~> 3.1)
+      moped (~> 1.1)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.22)
+    moped (1.2.1)
+    multi_json (1.3.6)
+    origin (1.0.7)
+    rake (0.9.2.2)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    thor (0.16.0)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal!
+  bson_ext
+  bundler (~> 1.1)
+  guard-rspec
+  jeweler (~> 1.8)
+  mongoid (>= 2.4, <= 3.1)
+  rake
+  rspec (~> 2.8)

data/README.md

@@ -2,14 +2,14 @@
 
 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.
+[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)).
 
 ## Usage
 
 Add to your `Gemfile`:
 
 ```ruby
-gem 'mongoid-locker', '~> 0.1.0'
+gem 'mongoid-locker', '~> 0.2'
 ```
 
 and run `bundle install`.  In the model you wish to lock, include `Mongoid::Locker` after `Mongoid::Document`.  For example:

data/Rakefile

@@ -1,15 +1,9 @@
 # encoding: utf-8
 
 require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
+require 'bundler/setup'
 require 'rake'
+require 'appraisal'
 
 require 'jeweler'
 Jeweler::Tasks.new do |gem|

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/gemfiles/mongoid2.gemfile

@@ -0,0 +1,24 @@
+# This file *was* generated by Appraisal
+
+source 'http://rubygems.org'
+
+gem 'mongoid', '~> 2.4'
+
+
+###### added manually ######
+
+group :development do
+  gem 'rspec', '~> 2.8'
+  gem 'bundler', '~> 1.1'
+  gem 'jeweler', '~> 1.8'
+
+  gem 'guard-rspec'
+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'
+end

data/gemfiles/mongoid3.gemfile

@@ -0,0 +1,24 @@
+# This file *was* generated by Appraisal
+
+source 'http://rubygems.org'
+
+gem 'mongoid', '~> 3.0.0'
+
+
+###### added manually ######
+
+group :development do
+  gem 'rspec', '~> 2.8'
+  gem 'bundler', '~> 1.1'
+  gem 'jeweler', '~> 1.8'
+
+  gem 'guard-rspec'
+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'
+end

data/lib/mongoid/locker.rb

@@ -1,3 +1,5 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'locker', 'wrapper'))
+
 module Mongoid
   module Locker
     module ClassMethods
@@ -48,6 +50,13 @@ module Mongoid
       !!(self.locked_until && self.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?
+    end
+
     # Primary method of plugin: execute the provided code once the document has been successfully locked.
     #
     # @param [Hash] opts for the locking mechanism
@@ -55,11 +64,14 @@ module Mongoid
     # @option opts [Boolean] :wait If the document is currently locked, wait until the lock expires and try again
     # @return [void]
     def with_lock opts={}, &block
-      self.lock opts
+      # don't try to re-lock/unlock on recursive calls
+      had_lock = self.has_lock?
+      self.lock(opts) unless had_lock
+
       begin
         yield
       ensure
-        self.unlock
+        self.unlock unless had_lock
       end
     end
 
@@ -67,14 +79,14 @@ module Mongoid
     protected
 
     def lock opts={}
-      coll = self.class.collection
       time = Time.now
       timeout = opts[:timeout] || self.class.lock_timeout
       expiration = time + timeout
 
       # lock the document atomically in the DB without persisting entire doc
-      record = coll.find_and_modify(
-        :query => {
+      locked = Mongoid::Locker::Wrapper.update(
+        self.class,
+        {
           :_id => self.id,
           '$or' => [
             # not locked
@@ -83,7 +95,7 @@ module Mongoid
             {:locked_until => {'$lte' => time}}
           ]
         },
-        :update => {
+        {
           '$set' => {
             :locked_at => time,
             :locked_until => expiration
@@ -91,21 +103,17 @@ module Mongoid
         }
       )
 
-      if record
-        # lock successful
+      if locked
+        # document successfully updated, meaning it was locked
         self.locked_at = time
         self.locked_until = expiration
+        @has_lock = true
       else
         # couldn't grab lock
 
-        existing_query = {
-          :_id => self.id,
-          :locked_until => {'$exists' => true}
-        }
-
-        if opts[:wait] && existing = coll.find(existing_query, :limit => 1).first
+        if opts[:wait] && locked_until = Mongoid::Locker::Wrapper.locked_until(self)
           # doc is locked - wait until it expires
-          wait_time = existing.locked_until - Time.now
+          wait_time = locked_until - Time.now
           sleep wait_time if wait_time > 0
 
           # only wait once
@@ -122,15 +130,20 @@ module Mongoid
 
     def unlock
       # unlock the document in the DB without persisting entire doc
-      self.class.collection.update({:_id => self.id}, {
-        '$set' => {
-          :locked_at => nil,
-          :locked_until => nil,
+      Mongoid::Locker::Wrapper.update(
+        self.class,
+        {:_id => self.id},
+        {
+          '$set' => {
+            :locked_at => nil,
+            :locked_until => nil,
+          }
         }
-      }, {:safe => true})
+      )
 
       self.locked_at = nil
       self.locked_until = nil
+      @has_lock = false
     end
   end
 

data/lib/mongoid/locker/wrapper.rb

@@ -0,0 +1,42 @@
+module Mongoid
+  module Locker
+    # Normalizes queries between Mongoid 2 and 3.
+    module Wrapper
+      IS_OLD_MONGOID = Mongoid::VERSION.start_with? '2'
+
+      # Update the document for the provided Class matching the provided query with the provided setter.
+      #
+      # @param [Class] The model class
+      # @param [Hash] The Mongoid query
+      # @param [Hash] The Mongoid setter
+      # @return [Boolean] true if the document was successfully updated, false otherwise
+      def self.update klass, query, setter
+        if IS_OLD_MONGOID
+          error_obj = klass.collection.update(query, setter, :safe => true)
+          error_obj['n'] == 1
+        else
+          !!klass.where(query).find_and_modify(setter, :new => false)
+        end
+      end
+
+      # Determine whether the provided document is locked in the database or not.
+      #
+      # @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}
+        }
+
+        if IS_OLD_MONGOID
+          existing = doc.class.collection.find_one(existing_query, :fields => {:locked_until => 1})
+          existing ? existing['locked_until'] : nil
+        else
+          existing = doc.class.where(existing_query).limit(1).only(:locked_until).first
+          existing ? existing.locked_until : nil
+        end
+      end
+    end
+  end
+end

data/mongoid-locker.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mongoid-locker"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aidan Feldman"]
-  s.date = "2012-07-11"
+  s.date = "2012-08-27"
   s.description = "Allows multiple processes to operate on individual documents in MongoDB while ensuring that only one can act at a time."
   s.email = "aidan.feldman@gmail.com"
   s.extra_rdoc_files = [
@@ -20,15 +20,20 @@ Gem::Specification.new do |s|
     ".document",
     ".rspec",
     ".travis.yml",
+    "Appraisals",
     "CHANGELOG.md",
     "Gemfile",
+    "Gemfile.lock",
     "Guardfile",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
     "VERSION",
+    "gemfiles/mongoid2.gemfile",
+    "gemfiles/mongoid3.gemfile",
     "lib/mongoid-locker.rb",
     "lib/mongoid/locker.rb",
+    "lib/mongoid/locker/wrapper.rb",
     "mongoid-locker.gemspec",
     "spec/database.yml",
     "spec/mongoid-locker_spec.rb",
@@ -44,27 +49,33 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<mongoid>, ["~> 2.4"])
+      s.add_runtime_dependency(%q<mongoid>, ["<= 3.1", ">= 2.4"])
       s.add_development_dependency(%q<rspec>, ["~> 2.8"])
       s.add_development_dependency(%q<bundler>, ["~> 1.1"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8"])
       s.add_development_dependency(%q<guard-rspec>, [">= 0"])
       s.add_development_dependency(%q<bson_ext>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<appraisal>, [">= 0"])
     else
-      s.add_dependency(%q<mongoid>, ["~> 2.4"])
+      s.add_dependency(%q<mongoid>, ["<= 3.1", ">= 2.4"])
       s.add_dependency(%q<rspec>, ["~> 2.8"])
       s.add_dependency(%q<bundler>, ["~> 1.1"])
       s.add_dependency(%q<jeweler>, ["~> 1.8"])
       s.add_dependency(%q<guard-rspec>, [">= 0"])
       s.add_dependency(%q<bson_ext>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<appraisal>, [">= 0"])
     end
   else
-    s.add_dependency(%q<mongoid>, ["~> 2.4"])
+    s.add_dependency(%q<mongoid>, ["<= 3.1", ">= 2.4"])
     s.add_dependency(%q<rspec>, ["~> 2.8"])
     s.add_dependency(%q<bundler>, ["~> 1.1"])
     s.add_dependency(%q<jeweler>, ["~> 1.8"])
     s.add_dependency(%q<guard-rspec>, [">= 0"])
     s.add_dependency(%q<bson_ext>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<appraisal>, [">= 0"])
   end
 end
 

data/spec/database.yml

@@ -1,3 +1,10 @@
 test:
   host: localhost
   database: mongoid_locker_test
+
+  # for Mongoid 3
+  sessions:
+    default:
+      database: mongoid_locker_test
+      hosts:
+        - localhost:27017

data/spec/mongoid-locker_spec.rb

@@ -25,7 +25,40 @@ describe Mongoid::Locker do
 
   describe "#locked?" do
     it "shouldn't be locked when created" do
-      @user.should_not be_locked
+      @user.locked?.should be_false
+    end
+
+    it "should be true when locked" do
+      @user.with_lock do
+        @user.locked?.should be_true
+      end
+    end
+
+    it "should respect the expiration" do
+      User.timeout_lock_after 1
+
+      @user.with_lock do
+        sleep 2
+        @user.locked?.should be_false
+      end
+    end
+
+    it "should be true for a different instance" do
+      @user.with_lock do
+        User.first.locked?.should be_true
+      end
+    end
+  end
+
+  describe "#has_lock?" do
+    it "shouldn't be has_lock when created" do
+      @user.has_lock?.should be_false
+    end
+
+    it "should be true when has_lock" do
+      @user.with_lock do
+        @user.has_lock?.should be_true
+      end
     end
 
     it "should respect the expiration" do
@@ -33,7 +66,13 @@ describe Mongoid::Locker do
 
       @user.with_lock do
         sleep 2
-        @user.should_not be_locked
+        @user.has_lock?.should be_false
+      end
+    end
+
+    it "should be false for a different instance" do
+      @user.with_lock do
+        User.first.has_lock?.should be_false
       end
     end
   end
@@ -80,6 +119,16 @@ describe Mongoid::Locker do
       end
     end
 
+    it "should handle recursive calls" do
+      @user.with_lock do
+        @user.with_lock do
+          @user.account_balance = 10
+        end
+      end
+
+      @user.account_balance.should eq(10)
+    end
+
     it "should wait until the lock times out, if desired" do
       User.timeout_lock_after 1
 

data/spec/spec_helper.rb

@@ -11,4 +11,5 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
   Mongoid.load! File.join(File.dirname(__FILE__), 'database.yml')
+  Mongoid.logger.level = Logger::WARN
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-locker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,17 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-11 00:00:00.000000000 Z
+date: 2012-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.4'
   type: :runtime
@@ -24,7 +27,10 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.4'
 - !ruby/object:Gem::Dependency
@@ -107,6 +113,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Allows multiple processes to operate on individual documents in MongoDB
   while ensuring that only one can act at a time.
 email: aidan.feldman@gmail.com
@@ -119,15 +157,20 @@ files:
 - .document
 - .rspec
 - .travis.yml
+- Appraisals
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - VERSION
+- gemfiles/mongoid2.gemfile
+- gemfiles/mongoid3.gemfile
 - lib/mongoid-locker.rb
 - lib/mongoid/locker.rb
+- lib/mongoid/locker/wrapper.rb
 - mongoid-locker.gemspec
 - spec/database.yml
 - spec/mongoid-locker_spec.rb
@@ -147,7 +190,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1869316857969046476
+      hash: 2610862896755729046
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: