resque-lock-timeout 0.4.1 → 0.4.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6fc8ebf154ea6508ebd762f6860002c07f70412d
+  data.tar.gz: 7053ff9081baa02832267aeb5739ec9d46317269
+SHA512:
+  metadata.gz: 590c45f94ec0dc1b40612a94b7545b7c01964eeced9e7ce0d5b0e4f0af4763cdca0223fc991e6c66c03cb462a497a31fb1cb28aa611673153e2cbcd83ed343a0
+  data.tar.gz: c678088940a1857169695fa0907dad6b9cf9839c3f9f571c974128dfcebef92dba36e960a5143452ce515d7542e74eb99004e5590be9f14cc8207e3e23e8e091

data/HISTORY.md

@@ -1,3 +1,8 @@
+## 0.4.4 (2014-02-21)
+
+* Add `enqueued?` and `loner_locked?` helper methods.
+* Bump minimum version of resque to v1.22
+
 ## 0.4.1 (2012-11-19)
 
 * Bug fix, allow `@loner` job to be enqueued if timeout expires.

data/README.md

@@ -1,14 +1,17 @@
 Resque Lock Timeout
 ===================
 
+[![Build Status](https://secure.travis-ci.org/lantins/resque-lock-timeout.png?branch=master)](http://travis-ci.org/lantins/resque-lock-timeout)
+[![Gem Version](https://badge.fury.io/rb/resque-lock-timeout.png)](http://badge.fury.io/rb/resque-lock-timeout)
+
 A [Resque][rq] plugin. Requires Resque >= v1.8.0.
 
 resque-lock-timeout adds locking, with optional timeout/deadlock handling to
 resque jobs.
 
 Using a `lock_timeout` allows you to re-acquire the lock should your worker
-fail, crash, or is otherwise unable to relase the lock. **i.e.** Your server
-unexpectedly looses power. Very handy for jobs that are recurring or may be
+fail, crash, or is otherwise unable to release the lock. **i.e.** Your server
+unexpectedly loses power. Very handy for jobs that are recurring or may be
 retried.
 
 Usage / Examples
@@ -27,15 +30,15 @@ Usage / Examples
       end
     end
 
-Locking is achieved by storing a identifyer/lock key in Redis.
+Locking is achieved by storing a identifier/lock key in Redis.
 
-Default behaviour...
+Default behavior...
 
 * Only one instance of a job may execute at once.
 * The lock is held until the job completes or fails.
 * If another job is executing with the same arguments the job will abort.
 
-Please see below for more information about the identifer/lock key.
+Please see below for more information about the identifier/lock key.
 
 ### Enqueued Exclusivity (Loner Option)
 
@@ -64,7 +67,7 @@ Simply set the lock timeout in seconds, e.g.
       extend Resque::Plugins::LockTimeout
       @queue = :network_graph
 
-      # Lock may be held for upto an hour.
+      # Lock may be held for up to an hour.
       @lock_timeout = 3600
 
       def self.perform(repo_id)
@@ -72,7 +75,7 @@ Simply set the lock timeout in seconds, e.g.
       end
     end
 
-Customise & Extend
+Customize & Extend
 ==================
 
 ### Job Identifier/Lock Key
@@ -160,6 +163,8 @@ using job arguments. e.g.
 ### Helper Methods
 
 * `locked?` - checks if the lock is currently held.
+* `enqueued?` - checks if the loner lock is currently held.
+* `loner_locked?` - checks if the job is either enqueued (if a loner) or locked (any job).
 * `refresh_lock!` - Refresh the lock, useful for jobs that are taking longer
     then usual but your okay with them holding on to the lock a little longer.
 
@@ -171,7 +176,7 @@ Several callbacks are available to override and implement your own logic, e.g.
       extend Resque::Plugins::Lock
       @queue = :network_graph
 
-      # Lock may be held for upto an hour.
+      # Lock may be held for up to an hour.
       @lock_timeout = 3600
 
       # No same job get enqueued if one already running/enqueued
@@ -187,7 +192,7 @@ Several callbacks are available to override and implement your own logic, e.g.
         raise EnqueueFailed
       end
 
-      # Job has complete; but the lock expired before we could relase it.
+      # Job has complete; but the lock expired before we could release it.
       # The lock wasn't released; as its *possible* the lock is now held
       # by another job.
       def self.lock_expired_before_release(repo_id)
@@ -212,6 +217,6 @@ Lock timeout from Ryan Carvar' [resque-lock-retry][resque-lock-retry] plugin.
 And a little tinkering from Luke Antins.
 
 [rq]: http://github.com/defunkt/resque
-[redis-setnx]: http://code.google.com/p/redis/wiki/SetnxCommand
+[redis-setnx]: http://redis.io/commands/setnx
 [resque-lock]: http://github.com/defunkt/resque-lock
-[resque-lock-retry]: http://github.com/rcarver/resque-lock-retry
+[resque-lock-retry]: http://github.com/rcarver/resque-lock-retry

data/lib/resque/plugins/lock_timeout.rb

@@ -110,11 +110,34 @@ module Resque
         @loner ||= false
       end
 
+      # Checks if job is locked or loner locked (if applicable).
+      #
+      # @return [Boolean] true if the job is locked by someone
+      def loner_locked?(*args)
+        locked?(*args) || (loner && enqueued?(*args))
+      end
+
       # Convenience method to check if job is locked and lock did not expire.
       #
       # @return [Boolean] true if the job is locked by someone
       def locked?(*args)
-        lock_until = lock_redis.get(redis_lock_key(*args))
+        inspect_lock(:redis_lock_key, *args)
+      end
+
+      # Convenience method to check if a loner job is queued and lock did not expire.
+      #
+      # @return [Boolean] true if the job is already queued
+      def enqueued?(*args)
+        inspect_lock(:redis_loner_lock_key, *args)
+      end
+
+      # Check for existence of given key.
+      #
+      # @param [Array] args job arguments
+      # @param [Symbol] lock_key_method the method returning redis key to lock
+      # @return [Boolean] true if the lock exists
+      def inspect_lock(lock_key_method, *args)
+        lock_until = lock_redis.get(self.send(lock_key_method, *args))
         return (lock_until.to_i > Time.now.to_i) if lock_timeout(*args) > 0
         !lock_until.nil?
       end

data/test/lock_test.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/test_helper'
 
-class LockTest < MiniTest::Unit::TestCase
+class LockTest < Minitest::Test
   def setup
     $success = $lock_failed = $lock_expired = $enqueue_failed = 0
     Resque.redis.flushall
@@ -157,15 +157,27 @@ class LockTest < MiniTest::Unit::TestCase
   end
 
   def test_cannot_enqueue_two_loner_jobs
-    Resque.enqueue(LonelyJob)
-    Resque.enqueue(LonelyJob)
+    assert Resque.enqueue(LonelyJob)
+    assert !Resque.enqueue(LonelyJob)
     assert_equal 1, Resque.size(:test), '1 job should be enqueued'
 
-    Resque.enqueue(LonelyTimeoutJob)
-    Resque.enqueue(LonelyTimeoutJob)
+    assert Resque.enqueue(LonelyTimeoutJob)
+    assert !Resque.enqueue(LonelyTimeoutJob)
     assert_equal 2, Resque.size(:test), '2 jobs should be enqueued'
   end
 
+  def test_queue_inspection
+    Resque.enqueue(LonelyJob)
+    assert !LonelyJob.locked?, 'job is still in queue'
+    assert LonelyJob.loner_locked?, 'loner key should have been set'
+    assert LonelyJob.enqueued?, 'loner key should have been set'
+
+    Resque.enqueue(SlowJob)
+    assert !SlowJob.locked?, 'job is still in queue'
+    assert !SlowJob.loner_locked?, 'no loner lock key should hae been created'
+    assert !SlowJob.enqueued?, 'no loner lock key should hae been created'
+  end
+
   def test_loner_job_should_not_be_enqued_if_already_running
     Resque.enqueue(LonelyJob)
     thread = Thread.new { @worker.process }
@@ -202,4 +214,15 @@ class LockTest < MiniTest::Unit::TestCase
     assert_equal 1, Resque.size(:test), "Should be able to enqueue a loner job if one previously finished after the timeout"
   end
 
+  def test_loner_job_should_get_enqueued_if_previous_inline_job_finished
+    Resque.inline = true
+    Resque.enqueue(LonelyJob)
+    Resque.inline = false
+
+    sleep 0.5
+
+    assert_equal 0, Resque.size(:test), "Nothing should be in the queue"
+    Resque.enqueue(LonelyJob)
+    assert_equal 1, Resque.size(:test), "Should have enqueued the job"
+  end
 end

data/test/test_helper.rb

@@ -2,10 +2,6 @@ dir = File.dirname(File.expand_path(__FILE__))
 $LOAD_PATH.unshift dir + '/../lib'
 $TESTING = true
 
-require 'rubygems'
-require 'minitest/unit'
-require 'minitest/pride'
-
 # Run code coverage in MRI 1.9 only.
 if RUBY_VERSION >= '1.9' && RUBY_ENGINE == 'ruby'
   require 'simplecov'
@@ -14,6 +10,9 @@ if RUBY_VERSION >= '1.9' && RUBY_ENGINE == 'ruby'
   end
 end
 
+require 'minitest/pride'
+require 'minitest/autorun'
+
 require 'resque-lock-timeout'
 require dir + '/test_jobs'
 
@@ -29,15 +28,13 @@ if !system('which redis-cli')
   abort ''
 end
 
-# This code is run `at_exit` to setup everything before running the tests.
-# Redis server is started before this code block runs.
-at_exit do
-  next if $!
-
-  exit_code = MiniTest::Unit.new.run(ARGV)
-  `redis-cli -p 9737 shutdown nosave`
-end
-
 puts "Starting redis for testing at localhost:9737..."
+
+# Start redis server for testing.
 `redis-server #{dir}/redis-test.conf`
 Resque.redis = '127.0.0.1:9737'
+
+# After tests are complete, make sure we shutdown redis.
+Minitest.after_run {
+  `redis-cli -p 9737 shutdown nosave`
+}

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-lock-timeout
 version: !ruby/object:Gem::Version
-  version: 0.4.1
-  prerelease: 
+  version: 0.4.4
 platform: ruby
 authors:
 - Luke Antins
@@ -11,121 +10,85 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-19 00:00:00.000000000 Z
+date: 2014-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '1.22'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '1.22'
 - !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: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: json
-  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'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: yard
   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: rdiscount
-  requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
-description: ! "  A Resque plugin. Adds locking, with optional timeout/deadlock handling
+        version: 0.7.1
+description: "  A Resque plugin. Adds locking, with optional timeout/deadlock handling
   to\n  resque jobs.\n\n  Using a `lock_timeout` allows you to re-acquire the lock
   should your worker\n  fail, crash, or is otherwise unable to relase the lock.\n
   \ \n  i.e. Your server unexpectedly looses power. Very handy for jobs that are\n
@@ -135,39 +98,39 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- HISTORY.md
+- LICENSE
 - README.md
 - Rakefile
-- LICENSE
-- HISTORY.md
-- lib/resque/plugins/lock_timeout.rb
 - lib/resque-lock-timeout.rb
+- lib/resque/plugins/lock_timeout.rb
 - test/lock_test.rb
 - test/redis-test.conf
 - test/test_helper.rb
 - test/test_jobs.rb
 homepage: http://github.com/lantins/resque-lock-timeout
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Resque plugin adding locking, with optional timeout/deadlock handling to
   resque jobs.
 test_files: []