mongoid-locker 0.2.0 → 0.2.1

data/demo/showoff.css

@@ -0,0 +1,16 @@
+#preso,
+.slide {
+  position: absolute;
+  top: 0;
+  left: 0;
+  right: 0;
+  bottom: 0;
+  width: auto;
+  height: auto;
+  overflow: auto;
+}
+
+pre.sh_sourceCode {
+  font-size: 2.5em;
+  line-height: 1.2;
+}

data/demo/showoff.md

@@ -0,0 +1,159 @@
+!SLIDE
+
+# Mongoid-Locker
+
+[github.com/afeld/mongoid-locker](https://github.com/afeld/mongoid-locker)
+
+## Aidan Feldman, [Jux.com](https://jux.com)
+
+!SLIDE
+
+![Instagram diagram](instagram.png)
+
+!SLIDE
+
+# Jux needed a queue.
+
+* Distributed, but synchronized
+* No add'l DB
+* No add'l hassle (managing workers, etc.)
+
+!SLIDE
+
+* Thread
+  - \+ Distributed
+  - – Not synchronized
+* Many workers
+  - \+ Distributed
+  - – Not synchronized
+* One worker
+  - \+ Synchronized
+  - – Not distributed
+  - – Single POF
+
+!SLIDE
+
+    @@@ ruby
+    require 'rubygems'
+    require 'mongoid-locker'
+    Mongoid.load!('config/mongoid.yml', :development)
+
+
+    class User
+      include Mongoid::Document
+      # include Mongoid::Locker
+
+      field :balance, type: Float
+    end
+
+    # cleanup
+    User.destroy_all
+
+    bob = User.create!(balance: 100.00)
+
+!SLIDE
+
+# Atomic Operations
+
+    @@@ ruby
+    class User
+      def purchase(amount)
+        if amount > self.balance
+          raise "Can't have negative balance!" 
+        else
+          # deduct *atomically*
+          self.inc(:balance, -1 * amount)
+          # a.k.a.
+          # db.users.update({_id: ...}, {$inc: {balance: ...}})
+
+          puts "cha-ching!"
+        end
+      end
+    end
+
+    bob.purchase(5.10) #=> "cha-ching!"
+    bob.purchase(110.53) #=> "Can't have negative balance!"
+
+!SLIDE
+
+# All fine, right?
+
+!SLIDE
+
+    @@@ ruby
+    class User
+      def purchase(amount)
+        if amount > self.balance
+          raise "Can't have negative balance!" 
+        else
+          # artificial delay
+          print 'has enough money...waiting for ENTER > '
+          gets
+
+          self.inc(:balance, -1 * amount)
+          puts "cha-ching!"
+        end
+      end
+    end
+
+!SLIDE
+
+    @@@ ruby
+    # shell 1
+    bob.purchase(10.00)
+
+    # shell 2
+    also_bob = User.first
+    also_bob.purchase(95.00)
+
+!SLIDE
+
+# oops.
+
+!SLIDE
+
+    @@@ ruby
+    class User
+      # add doc-level locking
+      include Mongoid::Locker
+      timeout_lock_after 20
+
+      def purchase(amount)
+        # only one at a time
+        self.with_lock(wait: true) do
+          # after the `wait`, will have updated `balance`
+
+          if amount > self.balance
+            raise "Can't have negative balance!" 
+          else
+            print 'has enough money...waiting for ENTER > '
+            gets
+
+            self.inc(:balance, -1 * amount)
+            puts "cha-ching!"
+          end
+        end
+      end
+    end
+
+!SLIDE
+
+# Summary
+
+* Easy document-level locking
+* Useful for queueing or pseudo-transactions
+* No additional dependencies
+
+!SLIDE
+
+# Fin.
+
+[afeld/mongoid-locker](https://github.com/afeld/mongoid-locker)
+
+----------------
+
+## Aidan Feldman, [Jux.com](https://jux.com)
+
+[@aidanfeldman](https://twitter.com/aidanfeldman)
+
+[afeld.me](http://afeld.me)

data/lib/mongoid/locker.rb

@@ -120,6 +120,8 @@ module Mongoid
           opts.dup
           opts.delete :wait
 
+          # reload to update with any new values
+          self.reload
           # retry lock grab
           self.lock opts
         else

data/lib/mongoid/locker/wrapper.rb

@@ -2,7 +2,7 @@ module Mongoid
   module Locker
     # Normalizes queries between Mongoid 2 and 3.
     module Wrapper
-      IS_OLD_MONGOID = Mongoid::VERSION.start_with? '2'
+      IS_OLD_MONGOID = Mongoid::VERSION.start_with? '2.'
 
       # Update the document for the provided Class matching the provided query with the provided setter.
       #
@@ -11,12 +11,14 @@ module Mongoid
       # @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
+        error_obj =
+          if IS_OLD_MONGOID
+            klass.collection.update(query, setter, :safe => true)
+          else
+            klass.with(:safe => true).collection.find(query).update(setter)
+          end
+
+        error_obj['n'] == 1
       end
 
       # Determine whether the provided document is locked in the database or not.

data/mongoid-locker.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mongoid-locker"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aidan Feldman"]
-  s.date = "2012-08-27"
+  s.date = "2012-11-28"
   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 = [
@@ -29,6 +29,12 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
+    "demo/README.md",
+    "demo/config/mongoid.yml",
+    "demo/instagram.graffle",
+    "demo/instagram.png",
+    "demo/showoff.css",
+    "demo/showoff.md",
     "gemfiles/mongoid2.gemfile",
     "gemfiles/mongoid3.gemfile",
     "lib/mongoid-locker.rb",

data/spec/database.yml

@@ -1,4 +1,5 @@
 test:
+  # for Mongoid 2
   host: localhost
   database: mongoid_locker_test
 

data/spec/mongoid-locker_spec.rb

@@ -14,7 +14,7 @@ describe Mongoid::Locker do
       field :account_balance, :type => Integer # easier to test than Float
     end
 
-    @user = User.create!
+    @user = User.create! :account_balance => 20
   end
 
   after do
@@ -94,7 +94,7 @@ describe Mongoid::Locker do
       end
 
       @user.account_balance.should eq(10)
-      User.first.account_balance.should be_nil
+      User.first.account_balance.should eq(20)
     end
 
     it "should handle errors gracefully" do
@@ -153,6 +153,22 @@ describe Mongoid::Locker do
       end
     end
 
+    it "should reload the document if it needs to wait for a lock" do
+      User.timeout_lock_after 1
+
+      @user.with_lock do
+        user_dup = User.first
+
+        @user.account_balance = 10
+        @user.save!
+
+        user_dup.account_balance.should eq(20)
+        user_dup.with_lock :wait => true do
+          user_dup.account_balance.should eq(10)
+        end
+      end
+    end
+
     it "should succeed for subclasses" do
       class Admin < User
       end

data/spec/spec_helper.rb

@@ -11,5 +11,10 @@ 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
+
+  # use to check the query conditions
+  if ENV['LOG']
+    Mongoid.logger.level = Logger::DEBUG
+    Moped.logger.level = Logger::DEBUG if defined? Moped
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-locker
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-27 00:00:00.000000000 Z
+date: 2012-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -166,6 +166,12 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- demo/README.md
+- demo/config/mongoid.yml
+- demo/instagram.graffle
+- demo/instagram.png
+- demo/showoff.css
+- demo/showoff.md
 - gemfiles/mongoid2.gemfile
 - gemfiles/mongoid3.gemfile
 - lib/mongoid-locker.rb
@@ -190,7 +196,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2610862896755729046
+      hash: -4115924438345576931
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: