mm-optimistic_locking 0.0.1 → 0.0.3

data/README.md

@@ -0,0 +1,88 @@
+mm-optimistic_locking
+=====================
+
+[![Build Status](https://secure.travis-ci.org/highgroove/mm-optimistic_locking.png)](http://travis-ci.org/highgroove/mm-optimistic_locking)
+
+mm-optimistic_locking implements optimistic locking in mongo_mapper.
+
+Optimistic Locking?
+-------------------
+
+When attempting to save a record, optimistic locking verifies that the
+record has not been modified by another process since it was earlier loaded
+into memory.  If it has been modified and resaved since that time, an error is
+raised and the record must be reloaded and resaved again.
+
+Optimistic locking is appropriate when the chance of a conflict is low
+and records can easily recover when a conflict does occur (e.g., simply
+by retrying the operations or by asking an end user to manually resolve the
+conflict).
+
+Before using mm-optimistic_locking, you should first consider if your use case
+for locking can be handled by MongoDB's various [atomic operations](http://www.mongodb.org/display/DOCS/Atomic+Operations).
+It is possible that you do not need this type of locking at all.
+
+Quickstart
+----------
+
+If using Bundler (e.g., with Rails 3), add the gem to your project's
+Gemfile:
+
+``` ruby
+gem 'mm-optimistic_locking'
+```
+
+And run `bundle install`.
+
+Next, include `MongoMapper::Plugins::OptimisticLocking` in each model
+that needs optimistic locking functionality.
+
+``` ruby
+class BlogPost
+  include MongoMapper::Document
+
+  # Add the following line to each model that needs optimistic locking
+  plugin MongoMapper::Plugins::OptimisticLocking
+end
+```
+
+Finally, make sure to rescue from `MongoMapper::StaleDocumentError`
+any time you save a model with optimistic locking functionality:
+
+``` ruby
+begin
+  # .. making modifications to blog_post ..
+  blog_post.save
+rescue MongoMapper::StaleDocumentError
+  # Reload, remodify, and resave
+  # e.g.:
+  blog_post.reload
+  retry
+end
+```
+
+Related Projects
+----------------
+
+* [mongo_mapper](http://mongomapper.com/)
+
+Contributing
+------------
+
+* Fork the repository on [GitHub](https://github.com/highgroove/mm-optimistic_locking)
+* Create a [feature branch](http://nvie.com/posts/a-successful-git-branching-model/) (a.k.a., create a branch named my-awesome-feature)
+* Write the new feature (please also add specs)
+* Make sure all specs pass: `rake spec`
+* Submit a pull request that only includes your feature branch
+
+MIT License
+-----------
+Copyright (c) 2011 Highgroove Studios
+
+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.
+
+![Readme.meme](http://i.imgur.com/W3Gob.png)

data/lib/mm-optimistic_locking.rb

@@ -1,17 +1,8 @@
 require 'mongo_mapper'
 
-module MongoMapper
-  autoload :StaleDocumentError, "mongo_mapper/stale_document_error"
+require File.expand_path("mongo_mapper/stale_document_error", File.dirname(__FILE__))
+require File.expand_path("mongo_mapper/plugins/optimistic_locking", File.dirname(__FILE__))
 
-  module Plugins
-    autoload :OptimisticLocking, "mongo_mapper/plugins/optimistic_locking.rb"
-  end
-
-  module Plugins
-    module Querying
-      module InstanceMethods
-        include MongoMapper::Plugins::OptimisticLocking::QueryingInterceptor
-      end
-    end
-  end
+MongoMapper::Plugins::Querying::InstanceMethods.class_eval do
+  include MongoMapper::Plugins::OptimisticLocking::QueryingInterceptor
 end

data/lib/mongo_mapper/plugins/optimistic_locking.rb

@@ -0,0 +1,15 @@
+require 'active_support/concern'
+
+require File.expand_path("optimistic_locking/querying_interceptor", File.dirname(__FILE__))
+
+module MongoMapper
+  module Plugins
+    module OptimisticLocking
+      extend ActiveSupport::Concern
+
+      included do |base|
+        base.key :_lock_version, Integer, :default => 0
+      end
+    end
+  end
+end

data/lib/mongo_mapper/plugins/optimistic_locking/querying_interceptor.rb

@@ -0,0 +1,32 @@
+module MongoMapper
+  module Plugins
+    module OptimisticLocking
+      module QueryingInterceptor
+        def self.included(base)
+          base.class_eval do
+            alias_method_chain :save_to_collection, :optimistic_locking
+          end
+        end
+
+        def save_to_collection_with_optimistic_locking(options = {})
+          if persisted? && keys.keys.include?("_lock_version")
+            current_lock_version = self._lock_version
+            begin
+              self._lock_version += 1
+              result = collection.update({:_id => self._id, :_lock_version => current_lock_version},
+                                          to_mongo,
+                                          :upsert => false, :safe => true)
+
+              raise MongoMapper::StaleDocumentError.new(self) unless result["updatedExisting"]
+            rescue
+              self._lock_version -= 1
+              raise
+            end
+          else
+            save_to_collection_without_optimistic_locking(options)
+          end
+        end
+      end
+    end
+  end
+end

data/mm-optimistic_locking.gemspec

@@ -1,10 +1,8 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "mm-optimistic_locking"
 
 Gem::Specification.new do |s|
   s.name        = "mm-optimistic_locking"
-  s.version     = MongoMapper::Plugins::OptimisticLocking::VERSION
+  s.version     = "0.0.3"
   s.authors     = ["Andy Lindeman"]
   s.email       = ["andy@highgroove.com"]
   s.homepage    = "http://github.com/highgroove/mm-optimistic_locking"
@@ -15,12 +13,17 @@ Gem::Specification.new do |s|
     ".gitignore",
     "Gemfile",
     "Rakefile",
+    "README.md",
     "lib/mm-optimistic_locking.rb",
     "lib/mongo_mapper/stale_document_error.rb",
-    "mm-optimistic_locking.gemspec",
+    "lib/mongo_mapper/plugins/optimistic_locking.rb",
+    "lib/mongo_mapper/plugins/optimistic_locking/querying_interceptor.rb",
+    "mm-optimistic_locking.gemspec"
   ]
 
   s.test_files    = [
+    "spec/spec_helper.rb",
+    "spec/integration/optimistic_locking_spec.rb"
   ]
 
   s.executables   = [
@@ -28,7 +31,7 @@ Gem::Specification.new do |s|
 
   s.require_paths = ["lib"]
 
-  s.add_dependency 'mongo_mapper', '~>0.9.0'
+  s.add_dependency 'mongo_mapper', '>=0.9.0'
   s.add_dependency 'activesupport', '~>3.0'
 
   s.add_development_dependency 'rake', '~>0.8.7'

data/spec/integration/optimistic_locking_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe "optimistic locking plugin" do
+  describe "models with plugin" do
+    subject do
+      Class.new do
+        include MongoMapper::Document
+        plugin MongoMapper::Plugins::OptimisticLocking
+
+        key :foo_text, String
+      end.new
+    end
+
+    context "new records" do
+      it "saves the record normally" do
+        subject.foo_text = "foo bar baz"
+        subject.save
+
+        subject.reload.foo_text.should eql "foo bar baz"
+      end
+    end
+
+    context "previously persisted records" do
+      before do
+        subject.save!
+      end
+
+      it "saves the record normally if no conflicts exist" do
+        subject.foo_text = "foo bar baz"
+        subject.save
+
+        subject.reload.foo_text.should eql "foo bar baz"
+      end
+
+      it "raises a StaleDocumentError if a conflict is detected" do
+        dupped_subject = subject.class.find(subject.id)
+        dupped_subject.foo_text = "baz bar foo"
+        dupped_subject.save
+
+        expect {
+          subject.foo_text = "foo bar baz"
+          subject.save
+        }.to raise_error(MongoMapper::StaleDocumentError)
+      end
+    end
+  end
+
+  describe "models without plugin" do
+    subject do
+      Class.new do
+        include MongoMapper::Document
+
+        key :foo_text, String
+      end.new
+    end
+
+    it "allows records to interfere with one another" do
+      subject.save
+
+      dupped_subject = subject.class.find(subject.id)
+      dupped_subject.foo_text = "baz bar foo"
+      dupped_subject.save
+
+      expect {
+        subject.foo_text = "foo bar baz"
+        subject.save
+      }.to_not raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rspec'
+require 'database_cleaner'
+
+begin
+  require 'ruby-debug'
+rescue LoadError
+end
+
+require File.expand_path("../lib/mm-optimistic_locking", File.dirname(__FILE__))
+
+MongoMapper.connection = Mongo::Connection.new('localhost', 27017)
+MongoMapper.database = "mm-optimistic_locking_test"
+
+RSpec.configure do |c|
+  c.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  c.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  c.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -1,116 +1,121 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mm-optimistic_locking
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.3
   prerelease: 
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Andy Lindeman
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-27 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-13 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: mongo_mapper
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70335886501060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.9.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70335886501060
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70335886500420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70335886500420
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70335886499740 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70335886499740
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70335886498920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.6.0
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: database_cleaner
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70335886498920
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &70335886498220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.6.7
   type: :development
-  version_requirements: *id005
-description: Before a record is saved, mm-optimistic_locking will check if it has been modified by another process. If so, a StaleDocumentError will be raised. The object can be reloaded and resaved after the conflict has been resolved.
-email: 
+  prerelease: false
+  version_requirements: *70335886498220
+description: Before a record is saved, mm-optimistic_locking will check if it has
+  been modified by another process. If so, a StaleDocumentError will be raised. The
+  object can be reloaded and resaved after the conflict has been resolved.
+email:
 - andy@highgroove.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - Rakefile
+- README.md
 - lib/mm-optimistic_locking.rb
 - lib/mongo_mapper/stale_document_error.rb
+- lib/mongo_mapper/plugins/optimistic_locking.rb
+- lib/mongo_mapper/plugins/optimistic_locking/querying_interceptor.rb
 - mm-optimistic_locking.gemspec
-has_rdoc: true
+- spec/spec_helper.rb
+- spec/integration/optimistic_locking_spec.rb
 homepage: http://github.com/highgroove/mm-optimistic_locking
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3576524229858100918
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3576524229858100918
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Implements optimistic locking (similar to ActiveRecord) for MongoMapper
-test_files: []
-
+test_files:
+- spec/spec_helper.rb
+- spec/integration/optimistic_locking_spec.rb