mongo-lock 1.1.4 → 1.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTU0ZTFjYWZhMDUwMGMwNzYzMzE3ZWU1NTk0OWVjZTNlYjQ5Njk0MQ==
+    YjQzMDE4M2FmOTA3ZWM0NTc2ZjcwYzk0OTFjOGE5NzRlMDllNDMyZA==
   data.tar.gz: !binary |-
-    OGMzZDlkNmVmZjRiNDIyZGZjMjIyNzk1OWJiYzYxMDIyZjY5OTFlMA==
+    NmMxZDYzMDQ4ODRkOWE4ZWUyMjE1OGY0OTc1ZTkwNTZmMDc5MTc1YQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NjcxMWU0NGM3YmRlYWYyZTczNzI1MGY2YTgxMTliOTYxYmM1NWQ5Njk5YmU2
-    YzA4OGEzODk3Nzk0MzM1YmMzN2U2YzA5NmYzYzZmNTNlMDg4ODhiNWQ5ZDk1
-    YzUzODg5ZjlhNGNlOTEyNDFkYTgzZGM2MDEwMzg1YWQwYjg5OWM=
+    YTk0MDJlMmYwYTRiNzI4ZTdhMjRhZWVkYWViYTYxNzM2NGZiZTEyNjA4NzRi
+    MmE5MWI1OWE0NGE2OTA1ZjA2Yjg5YzNhMTNmOTJjYzFiZDBmYjJhMWNiNzky
+    YzI1ODFkZTAzNzA3ODllNGVhNWFmZjVjMjI3MGM2MGVlNmQyMmE=
   data.tar.gz: !binary |-
-    ZWIwNWZjMTJiOGZkZDQ3NWI4ZGEzMTA0OTE0YzliOWJmMDdhNjcwNjY2NDUw
-    NDhhNTg1ZDVlMjMwYzRjNTBkNjQ0ZjA1MzIxMjlhMzY0ZmY4OTk0Yjk3ZmNi
-    Zjg4NmU0MTA1OTNmYzMzMTM0ZjdlYTI0ZDQ5M2MwZDdlMzY5ODc=
+    ODU1MDU2NWVkYTVkZGVhMDgzZWYzZWExNDgxYmUxYWNjNzIwOTRjMTVlMDc5
+    MTBhNzU4MDRhMTQ5MzYzOWEwM2U4ZDE2NjhiNGE1YWMwYzZiNGEwMjFlZjhk
+    NzA3MDUyMTc1YjZhMWMzZjBlODY1NGExMTgwYWEyNzljYTQ5NjU=

data/Gemfile.lock

@@ -1,38 +1,39 @@
 PATH
   remote: .
   specs:
-    mongo-lock (1.1.3)
+    mongo-lock (1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (4.0.3)
-      actionpack (= 4.0.3)
+    actionmailer (4.0.4)
+      actionpack (= 4.0.4)
       mail (~> 2.5.4)
-    actionpack (4.0.3)
-      activesupport (= 4.0.3)
+    actionpack (4.0.4)
+      activesupport (= 4.0.4)
       builder (~> 3.1.0)
       erubis (~> 2.7.0)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    activemodel (4.0.3)
-      activesupport (= 4.0.3)
+    activemodel (4.0.4)
+      activesupport (= 4.0.4)
       builder (~> 3.1.0)
-    activerecord (4.0.3)
-      activemodel (= 4.0.3)
+    activerecord (4.0.4)
+      activemodel (= 4.0.4)
       activerecord-deprecated_finders (~> 1.0.2)
-      activesupport (= 4.0.3)
+      activesupport (= 4.0.4)
       arel (~> 4.0.0)
     activerecord-deprecated_finders (1.0.3)
-    activesupport (4.0.3)
-      i18n (~> 0.6, >= 0.6.4)
+    activesupport (4.0.4)
+      i18n (~> 0.6, >= 0.6.9)
       minitest (~> 4.2)
       multi_json (~> 1.3)
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
     arel (4.0.2)
-    atomic (1.1.14)
-    bson (1.9.2)
+    bson (1.10.0)
+    bson_ext (1.10.0)
+      bson (~> 1.10.0)
     builder (3.1.4)
     coderay (1.1.0)
     coveralls (0.7.0)
@@ -55,9 +56,10 @@ GEM
     method_source (0.8.2)
     mime-types (1.25.1)
     minitest (4.7.5)
-    mongo (1.9.2)
-      bson (~> 1.9.2)
-    multi_json (1.8.4)
+    mongo (1.10.0)
+      bson (~> 1.10.0)
+    moped (1.5.2)
+    multi_json (1.9.2)
     polyglot (0.3.4)
     pry (0.9.12.6)
       coderay (~> 1.0)
@@ -66,38 +68,38 @@ GEM
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
-    rails (4.0.3)
-      actionmailer (= 4.0.3)
-      actionpack (= 4.0.3)
-      activerecord (= 4.0.3)
-      activesupport (= 4.0.3)
+    rails (4.0.4)
+      actionmailer (= 4.0.4)
+      actionpack (= 4.0.4)
+      activerecord (= 4.0.4)
+      activesupport (= 4.0.4)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 4.0.3)
+      railties (= 4.0.4)
       sprockets-rails (~> 2.0.0)
-    railties (4.0.3)
-      actionpack (= 4.0.3)
-      activesupport (= 4.0.3)
+    railties (4.0.4)
+      actionpack (= 4.0.4)
+      activesupport (= 4.0.4)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (10.1.1)
+    rake (10.3.1)
     rest-client (1.6.7)
       mime-types (>= 1.16)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
+    rspec-core (2.14.8)
     rspec-expectations (2.14.5)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.5)
-    ruby-progressbar (1.4.1)
+    rspec-mocks (2.14.6)
+    ruby-progressbar (1.4.2)
     simplecov (0.8.2)
       docile (~> 1.1.0)
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
-    slop (3.4.7)
-    sprockets (2.10.1)
+    slop (3.5.0)
+    sprockets (2.12.1)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
@@ -108,25 +110,26 @@ GEM
       sprockets (~> 2.8)
     term-ansicolor (1.3.0)
       tins (~> 1.0)
-    thor (0.18.1)
-    thread_safe (0.1.3)
-      atomic
+    thor (0.19.1)
+    thread_safe (0.3.3)
     tilt (1.4.1)
-    tins (1.0.0)
+    tins (1.1.0)
     treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.38)
+    tzinfo (0.3.39)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   activesupport
+  bson_ext
   coveralls
   fuubar
   mongo
   mongo-lock!
+  moped
   pry
-  rails
+  rails (~> 4.0.0)
   rspec

data/README.md

@@ -55,7 +55,10 @@ A lock has an owner. Mongo::Lock defaults to using an owner id of HOSTNAME:PID:T
 ## Configuration
 
 Mongo::Lock makes no effort to help configure the MongoDB connection - that's
-what the Mongo Ruby Driver is for.
+what the Mongo driver is for, you can use either Moped or the Mongo Ruby Driver.
+If you are using Mongoid you want to be using the Moped driver. Mongo::Lock will
+automatically choose the right driver for the collection you provide and raise an
+error if you try and mix them.
 
 ```ruby
 Mongo::Lock.configure collection: Mongo::Connection.new("localhost").db("somedb").collection("locks")
@@ -119,7 +122,7 @@ If a lock cannot be acquired, released or extended it will return false, you can
 
 ```ruby
 Mongo::Lock.configure do |config|
-  config.raise = true # Whether to raise an error when acquire, release or extend fail.
+  config.should_raise = true # Whether to raise an error when acquire, release or extend fail.
 end
 ```
 
@@ -293,7 +296,7 @@ unless lock.extend_by 10
 end
 ```
 
-If the raise error option is set to true or you append ! to the end of the method name and you call any of the acquire, release, extend_by or extend methods they will raise a Mongo::Lock::NotAcquiredError, Mongo::Lock::NotReleasedError or Mongo::Lock::NotExtendedError instead of returning false.
+If the should\_raise error option is set to true or you append ! to the end of the method name and you call any of the acquire, release, extend_by or extend methods they will raise a Mongo::Lock::NotAcquiredError, Mongo::Lock::NotReleasedError or Mongo::Lock::NotExtendedError instead of returning false.
 
 ```ruby
 begin
@@ -305,7 +308,7 @@ end
 # Or
 
 begin
-  Mongo::Lock.acquire 'my_key', raise: true
+  Mongo::Lock.acquire 'my_key', should\_raise: true
 rescue Mongo::Lock::LockNotAcquiredError => e
   # Maybe try again tomorrow
 end

data/lib/mongo-lock.rb

@@ -1,6 +1,7 @@
 require 'mongo-lock/configuration'
-require 'mongo-lock/mongo_queries'
+require 'mongo-lock/drivers/base'
 require 'mongo-lock/class_convenience_methods'
+require 'mongo-lock/send_with_raise_methods'
 
 # If we are using Rails then we will include the Mongo::Lock railtie.
 if defined?(Rails)
@@ -11,17 +12,19 @@ module Mongo
   class Lock
 
     extend Mongo::Lock::ClassConvenienceMethods
+    include Mongo::Lock::SendWithRaiseMethods
 
     class NotAcquiredError < StandardError ; end
     class NotReleasedError < StandardError ; end
     class NotExtendedError < StandardError ; end
+    class InvalidCollectionError < StandardError ; end
+    class MixedCollectionsError < StandardError ; end
 
     attr_accessor :configuration
     attr_accessor :key
     attr_accessor :acquired
     attr_accessor :expires_at
     attr_accessor :released
-    attr_accessor :query
 
     def self.configure options = {}, &block
       defaults = {
@@ -29,7 +32,8 @@ module Mongo
         limit: 100,
         frequency: 1,
         expire_in: 10,
-        raise: false,
+        should_raise: false,
+        driver: options[:driver] || (require('mongo-lock/drivers/mongo') && ::Mongo::Lock::Drivers::Mongo),
         owner: Proc.new { "#{`hostname`.strip}:#{Process.pid}:#{Thread.object_id}" }
       }
       defaults = defaults.merge(@@default_configuration) if defined?(@@default_configuration) && @@default_configuration
@@ -46,7 +50,7 @@ module Mongo
 
     def self.ensure_indexes
       configuration.collections.each_pair do |key, collection|
-        Mongo::Lock::MongoQueries.ensure_indexes collection
+        configuration.driver.ensure_indexes collection
       end
     end
 
@@ -54,7 +58,7 @@ module Mongo
       options = configuration.process_collection_options options
 
       options[:collections].each do |collection|
-        Mongo::Lock::MongoQueries.clear_expired collection
+        configuration.driver.clear_expired collection
       end
     end
 
@@ -62,14 +66,13 @@ module Mongo
       options = configuration.process_collection_options options
 
       options[:collections].each do |collection|
-        Mongo::Lock::MongoQueries.release_collection collection, options[:owner]
+        configuration.driver.release_collection collection, options[:owner]
       end
     end
 
     def initialize key, options = {}
       self.configuration = Configuration.new self.class.configuration.to_hash, options
       self.key = retrieve_lock_key key
-      self.query = Mongo::Lock::MongoQueries.new self
       acquire_if_acquired
     end
 
@@ -97,6 +100,7 @@ module Mongo
     end
 
     def try_acquire options, i, time_spent, &block
+
       # If timeout has expired
       if options[:timeout_in] && options[:timeout_in] < time_spent
         return raise_or_false options
@@ -106,7 +110,7 @@ module Mongo
         return raise_or_false options
 
       # If there is an existing lock
-      elsif existing_lock = query.find_or_insert(options)
+      elsif existing_lock = driver.find_or_insert(options)
         # If the lock is owned by me
         if existing_lock['owner'] == options[:owner]
           self.acquired = true
@@ -144,7 +148,7 @@ module Mongo
 
       # We must have acquired the lock to release it
       elsif !acquired?
-        if acquire options.merge(raise: false)
+        if acquire options.merge(should_raise: false)
           return release options
         else
           return raise_or_false options, NotReleasedError
@@ -153,7 +157,7 @@ module Mongo
       else
         self.released = true
         self.acquired = false
-        query.remove options
+        driver.remove options
         return true
       end
     end
@@ -166,7 +170,7 @@ module Mongo
         return raise_or_false options, NotExtendedError
 
       else
-        query.find_and_update time, options
+        driver.find_and_update time, options
         true
       end
     end
@@ -178,28 +182,10 @@ module Mongo
 
     def available? options = {}
       options = inherit_options options
-      existing_lock = query.find_existing
+      existing_lock = driver.find_existing
       !existing_lock || existing_lock['owner'] == options[:owner]
     end
 
-    # Raise methods
-
-    def acquire! options = {}
-      send_with_raise :acquire, options
-    end
-
-    def release! options = {}
-      send_with_raise :release, options
-    end
-
-    def extend_by! time, options = {}
-      send_with_raise :extend_by, time, options
-    end
-
-    def extend! options = {}
-      send_with_raise :extend, options
-    end
-
     # Current state
 
     def acquired?
@@ -216,6 +202,10 @@ module Mongo
 
     # Utils
 
+    def driver
+      @driver ||= configuration.driver.new self
+    end
+
     def retrieve_lock_key key
       case
       when key.respond_to?(:lock_key)  then key.lock_key
@@ -225,16 +215,11 @@ module Mongo
     end
 
     def acquire_if_acquired
-      self.acquired = true if query.is_acquired?
-    end
-
-    def send_with_raise method, *args
-      args.last[:raise] = true
-      self.send(method, *args)
+      self.acquired = true if driver.is_acquired?
     end
 
     def raise_or_false options, error = NotAcquiredError
-      raise error if options[:raise]
+      raise error if options[:should_raise]
       false
     end
 

data/lib/mongo-lock/configuration.rb

@@ -8,7 +8,8 @@ module Mongo
       attr_accessor :frequency
       attr_accessor :expire_in
       attr_accessor :owner
-      attr_accessor :raise
+      attr_accessor :should_raise
+      attr_accessor :driver
 
       def initialize defaults, options, &block
         options = defaults.merge(options)
@@ -23,7 +24,7 @@ module Mongo
       end
 
       def collection= collection
-        collections[:default] = collection
+        collections[:default] = choose_driver collection
       end
 
       def collection collection = :default
@@ -36,7 +37,7 @@ module Mongo
       end
 
       def collections= collections
-        @collections = collections
+        @collections = choose_driver collections
       end
 
       def set_collections_keep_default collections
@@ -48,6 +49,38 @@ module Mongo
         @collections ||= {}
       end
 
+      def choose_driver provided_collections
+        collections = provided_collections.clone
+        collections = collections.values if collections.is_a? Hash
+
+        if collections.is_a? Array
+          collection = collections.first
+          collection_class = collections.map{ |x| x.class }.uniq
+          raise MixedCollectionsError.new "Collections must be of the same class" if collection_class.size > 1
+        else
+          collection = collections
+        end
+
+        if collection.is_a? Moped::Collection
+          require 'mongo-lock/drivers/moped'
+          self.driver = Mongo::Lock::Drivers::Moped
+        elsif collection.is_a?(Mongo::Collection) or collection.nil? or collection.is_a?(String) or collection.is_a?(Symbol)
+          require 'mongo-lock/drivers/mongo'
+          self.driver = Mongo::Lock::Drivers::Mongo
+        else
+          raise InvalidCollectionError.new "#{collection.class.name} is not a valid collection class"
+        end
+
+        provided_collections
+      end
+
+      def driver= driver
+        if driver.is_a? String
+          driver = "::Mongo::Lock::Drivers::#{driver.camelize}".constantize
+        end
+        @driver = driver
+      end
+
       def to_hash
         {
           collections: collections,
@@ -56,7 +89,8 @@ module Mongo
           frequency: frequency,
           expire_in: expire_in,
           owner: owner,
-          raise: raise
+          driver: driver,
+          should_raise: should_raise
         }
       end