mongoid-locker 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+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

data/Gemfile

@@ -0,0 +1,20 @@
+source 'http://rubygems.org'
+# Add dependencies required to use your gem here.
+# Example:
+#   gem 'activesupport', '>= 2.3.5'
+
+gem 'mongoid', '~> 2.4'
+
+# 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'
+  gem 'jeweler', '~> 1.8'
+
+  gem 'guard-rspec'
+end
+
+group :development, :test do
+  gem 'bson_ext', :platforms => :ruby
+end

data/Guardfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Aidan Feldman
+
+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,66 @@
+# mongoid-locker [![Build Status](https://secure.travis-ci.org/afeld/mongoid-locker.png)](http://travis-ci.org/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.
+
+## Usage
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'mongoid-locker', '~> 0.1.0'
+```
+
+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
+end
+```
+
+Then, execute any code you like in a block like so:
+
+```ruby
+queue_item.with_lock do
+
+  # do stuff
+
+  queue_item.completed_at = Time.now
+  queue_item.save!
+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`.
+
+The default timeout can also be set on a per-class basis:
+
+```ruby
+class QueueItem
+  # ...
+  timeout_lock_after 10
+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

@@ -0,0 +1,34 @@
+# 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 'rake'
+
+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"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/mongoid-locker.rb

@@ -0,0 +1,2 @@
+require 'mongoid'
+require File.expand_path(File.join(File.dirname(__FILE__), 'mongoid', 'locker'))

data/lib/mongoid/locker.rb

@@ -0,0 +1,141 @@
+module Mongoid
+  module Locker
+    module ClassMethods
+      # A scope to retrieve all locked documents in the collection.
+      #
+      # @return [Mongoid::Criteria]
+      def locked
+        where :locked_until.gt => Time.now
+      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})
+      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
+        @lock_timeout = new_time
+      end
+
+      # Retrieve the lock timeout default for this class.
+      #
+      # @return [Fixnum] the default number of seconds until a lock is considered "expired", in seconds
+      def lock_timeout
+        @lock_timeout
+      end
+    end
+
+    # @api private
+    def self.included mod
+      mod.extend ClassMethods
+
+      mod.field :locked_at, :type => Time
+      mod.field :locked_until, :type => Time
+
+      # default timeout of five seconds
+      mod.instance_variable_set :@lock_timeout, 5
+    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
+    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
+    # @return [void]
+    def with_lock opts={}, &block
+      self.lock opts
+      begin
+        yield
+      ensure
+        self.unlock
+      end
+    end
+
+
+    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 => {
+          :_id => self.id,
+          '$or' => [
+            # not locked
+            {:locked_until => nil},
+            # expired
+            {:locked_until => {'$lte' => time}}
+          ]
+        },
+        :update => {
+          '$set' => {
+            :locked_at => time,
+            :locked_until => expiration
+          }
+        }
+      )
+
+      if record
+        # lock successful
+        self.locked_at = time
+        self.locked_until = expiration
+      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
+          # doc is locked - wait until it expires
+          wait_time = existing.locked_until - Time.now
+          sleep wait_time if wait_time > 0
+
+          # only wait once
+          opts.dup
+          opts.delete :wait
+
+          # retry lock grab
+          self.lock opts
+        else
+          raise LockError.new("could not get lock")
+        end
+      end
+    end
+
+    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,
+        }
+      }, {:safe => true})
+
+      self.locked_at = nil
+      self.locked_until = nil
+    end
+  end
+
+  # Error thrown if document could not be successfully locked.
+  class LockError < Exception; end
+end

data/mongoid-locker.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "mongoid-locker"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aidan Feldman"]
+  s.date = "2012-07-03"
+  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 = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "Guardfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/mongoid-locker.rb",
+    "lib/mongoid/locker.rb",
+    "mongoid-locker.gemspec",
+    "spec/database.yml",
+    "spec/mongoid-locker_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/afeld/mongoid-locker"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Document-level locking for MongoDB via Mongoid"
+
+  if s.respond_to? :specification_version then
+    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_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"])
+    else
+      s.add_dependency(%q<mongoid>, ["~> 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"])
+    end
+  else
+    s.add_dependency(%q<mongoid>, ["~> 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"])
+  end
+end
+

data/spec/database.yml

@@ -0,0 +1,3 @@
+test:
+  host: localhost
+  database: mongoid_locker_test

data/spec/mongoid-locker_spec.rb

@@ -0,0 +1,159 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Mongoid::Locker do
+  def remove_class klass
+    Object.send :remove_const, klass.to_s.to_sym
+  end
+
+  before do
+    # recreate the class for each spec
+    class User
+      include Mongoid::Document
+      include Mongoid::Locker
+
+      field :account_balance, :type => Integer # easier to test than Float
+    end
+
+    @user = User.create!
+  end
+
+  after do
+    User.delete_all
+    remove_class User
+  end
+
+
+  describe "#locked?" do
+    it "shouldn't be locked when created" do
+      @user.should_not be_locked
+    end
+
+    it "should respect the expiration" do
+      User.timeout_lock_after 1
+
+      @user.with_lock do
+        sleep 2
+        @user.should_not be_locked
+      end
+    end
+  end
+
+  describe "#with_lock" do
+    it "should lock and unlock the user" do
+      @user.with_lock do
+        @user.should be_locked
+        User.first.should be_locked
+      end
+
+      @user.should_not be_locked
+      @user.reload.should_not be_locked
+    end
+
+    it "shouldn't save the full document" do
+      @user.with_lock do
+        @user.account_balance = 10
+      end
+
+      @user.account_balance.should eq(10)
+      User.first.account_balance.should be_nil
+    end
+
+    it "should handle errors gracefully" do
+      expect {
+        @user.with_lock do
+          raise "booyah!"
+        end
+      }.to raise_error
+
+      @user.reload.should_not be_locked
+    end
+
+    it "should complain if trying to lock locked doc" do
+      @user.with_lock do
+        user_dup = User.first
+
+        expect {
+          user_dup.with_lock do
+            fail "shouldn't get the lock"
+          end
+        }.to raise_error(Mongoid::LockError)
+      end
+    end
+
+    it "should wait until the lock times out, if desired" do
+      User.timeout_lock_after 1
+
+      @user.with_lock do
+        user_dup = User.first
+
+        user_dup.with_lock :wait => true do
+          user_dup.account_balance = 10
+          user_dup.save!
+        end
+      end
+
+      @user.reload.account_balance.should eq(10)
+    end
+
+    it "should override the default timeout" do
+      User.timeout_lock_after 1
+
+      expiration = (Time.now + 3).to_i
+      @user.with_lock :timeout => 3 do
+        @user.locked_until.to_i.should eq(expiration)
+      end
+    end
+  end
+
+  describe ".timeout_lock_after" do
+    it "should ignore the lock if it has timed out" do
+      User.timeout_lock_after 1
+
+      @user.with_lock do
+        user_dup = User.first
+        sleep 2
+
+        user_dup.with_lock do
+          user_dup.account_balance = 10
+          user_dup.save!
+        end
+      end
+
+      @user.reload.account_balance.should eq(10)
+    end
+
+    it "should be independent for different classes" do
+      class Account
+        include Mongoid::Document
+        include Mongoid::Locker
+      end
+
+      User.timeout_lock_after 1
+      Account.timeout_lock_after 2
+
+      User.lock_timeout.should eq(1)
+
+      remove_class Account
+    end
+  end
+
+  describe ".locked" do
+    it "should return the locked documents" do
+      user2 = User.create!
+
+      @user.with_lock do
+        User.locked.to_a.should eq([@user])
+      end
+    end
+  end
+
+  describe ".unlocked" do
+    it "should return the unlocked documents" do
+      user2 = User.create!
+
+      @user.with_lock do
+        User.unlocked.to_a.should eq([user2])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'mongoid-locker'
+
+ENV['RACK_ENV'] = 'test'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  Mongoid.load! File.join(File.dirname(__FILE__), 'database.yml')
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-locker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Aidan Feldman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-03 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: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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: bson_ext
+  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
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/mongoid-locker.rb
+- lib/mongoid/locker.rb
+- mongoid-locker.gemspec
+- spec/database.yml
+- spec/mongoid-locker_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/afeld/mongoid-locker
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2896270749272846608
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Document-level locking for MongoDB via Mongoid
+test_files: []