resque-lock-timeout 0.3.1 → 0.3.3

data/HISTORY.md

@@ -1,3 +1,8 @@
+## 0.3.3 (2012-03-09)
+## 0.3.2 (2012-03-09)
+
+* Release changes nothing of importance, tested against v1.20.0 of resque.
+
 ## 0.3.1 (2011-07-16)
 
 * Pass job arguments to `lock_timeout`. (Bob Potter)

data/README.md

@@ -1,7 +1,7 @@
 Resque Lock Timeout
 ===================
 
-A [Resque][rq] plugin. Requires Resque >= 01.8.0.
+A [Resque][rq] plugin. Requires Resque >= v1.8.0.
 
 resque-lock-timeout adds locking, with optional timeout/deadlock handling to
 resque jobs.
@@ -61,16 +61,12 @@ Customise & Extend
 
 ### Job Identifier/Lock Key
 
-The key is built using the `identifier`. If you have a lot of arguments or
-really long ones, you should consider overriding `identifier` to define a
-more precise or loose custom identifier.
+By default the key uses this format: `lock:<job class name>:<identifier>`.
 
 The default identifier is just your job arguments joined with a dash `-`.
 
-By default the key uses this format: 
-`resque-lock-timeout:<job class name>:<identifier>`.
-
-Or you can define the entire key by overriding `redis_lock_key`.
+If you have a lot of arguments or really long ones, you should consider
+overriding `identifier` to define a more precise or loose custom identifier:
 
     class UpdateNetworkGraph
       extend Resque::Plugins::LockTimeout
@@ -90,7 +86,24 @@ The above modification will ensure only one job of class
 UpdateNetworkGraph is running at a time, regardless of the
 repo_id.
 
-It's lock key would be: `resque-lock-timeout:UpdateNetworkGraph`.
+Its lock key would be: `lock:UpdateNetworkGraph` (the `:<identifier>` part is left out if the identifier is `nil`).
+
+You can define the entire key by overriding `redis_lock_key`:
+
+    class UpdateNetworkGraph
+      extend Resque::Plugins::LockTimeout
+      @queue = :network_graph
+
+      def self.redis_lock_key(repo_id)
+        "lock:updates"
+      end
+
+      def self.perform(repo_id)
+        heavy_lifting
+      end
+    end
+    
+That would use the key `lock:updates`.
 
 ### Redis Connection Used for Locking
 

data/Rakefile

@@ -4,7 +4,7 @@ require 'yard/rake/yardoc_task'
 
 task :default => :test
 
-desc 'Run tests.'
+desc 'Run unit tests.'
 Rake::TestTask.new(:test) do |task|
   task.test_files = FileList['test/*_test.rb']
   task.verbose = true
@@ -13,7 +13,7 @@ end
 desc 'Build Yardoc documentation.'
 YARD::Rake::YardocTask.new :yardoc do |t|
     t.files   = ['lib/**/*.rb']
-    t.options = ['--output-dir', "doc/",
+    t.options = ['--output-dir', 'doc/',
                  '--files', 'LICENSE,HISTORY.md',
                  '--readme', 'README.md',
                  '--title', 'resque-lock-timeout documentation']

data/lib/resque-lock-timeout.rb

@@ -1 +1,2 @@
+require 'resque'
 require 'resque/plugins/lock_timeout'

data/lib/resque/plugins/lock_timeout.rb

@@ -3,7 +3,7 @@ module Resque
     # If you want only one instance of your job running at a time,
     # extend it with this module:
     #
-    # require 'resque-lock'
+    # require 'resque-lock-timeout'
     #
     # class UpdateNetworkGraph
     #   extend Resque::Plugins::LockTimeout
@@ -62,7 +62,7 @@ module Resque
       # @param [Array] args job arguments
       # @return [String] redis key
       def redis_lock_key(*args)
-        ['lock', name, identifier(*args)].compact.join(":")
+        ['lock', name, identifier(*args)].compact.join(':')
       end
 
       # Number of seconds the lock may be held for.

data/test/lock_test.rb

@@ -1,16 +1,15 @@
 require File.dirname(__FILE__) + '/test_helper'
 
-class LockTest < Test::Unit::TestCase
+class LockTest < MiniTest::Unit::TestCase
   def setup
     $success = $lock_failed = $lock_expired = 0
     Resque.redis.flushall
     @worker = Resque::Worker.new(:test)
   end
 
-  def test_lint
-    assert_nothing_raised do
-      Resque::Plugin.lint(Resque::Plugins::LockTimeout)
-    end
+  def test_resque_plugin_lint
+    # will raise exception if were not a good plugin.
+    assert Resque::Plugin.lint(Resque::Plugins::LockTimeout)
   end
 
   def test_version
@@ -120,7 +119,7 @@ class LockTest < Test::Unit::TestCase
     # this is nil in Resque.redis since we make no attempt to add a resque:
     # prefix to the key
     assert_nil Resque.redis.get('specific_redis')
-    assert_not_nil lock_redis.get('specific_redis')
+    assert lock_redis.get('specific_redis')
 
     thread.join
     assert_nil lock_redis.get('specific_redis')

data/test/test_helper.rb

@@ -2,40 +2,39 @@ dir = File.dirname(File.expand_path(__FILE__))
 $LOAD_PATH.unshift dir + '/../lib'
 $TESTING = true
 
-require 'test/unit'
-require 'resque'
-require 'turn'
+require 'rubygems'
+require 'minitest/unit'
+require 'minitest/pride'
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter '/test/'
+end unless RUBY_PLATFORM == 'java'
 
 require 'resque-lock-timeout'
 require dir + '/test_jobs'
 
-##
 # make sure we can run redis
-if !system("which redis-server")
+if !system('which redis-server')
   puts '', "** can't find `redis-server` in your path"
-  puts "** try running `sudo rake install`"
+  puts '** try running `sudo rake install`'
   abort ''
 end
 
-##
 # start our own redis when the tests start,
 # kill it when they end
 at_exit do
   next if $!
 
-  if defined?(MiniTest)
-    exit_code = MiniTest::Unit.new.run(ARGV)
-  else
-    exit_code = Test::Unit::AutoRunner.run
-  end
+  exit_code = MiniTest::Unit.new.run(ARGV)
 
-  pid = `ps -e -o pid,command | grep [r]edis-test`.split(" ")[0]
-  puts "Killing test redis server..."
+  pid = `ps -e -o pid,command | grep [r]edis-test`.split(' ')[0]
+  puts 'Killing test redis server...'
   `rm -f #{dir}/dump.rdb`
-  Process.kill("KILL", pid.to_i)
-  exit exit_code
+  `kill -9 #{pid}`
+  exit(exit_code)
 end
 
-puts "Starting redis for testing at localhost:9736..."
+puts 'Starting redis for testing at localhost:9736...'
 `redis-server #{dir}/redis-test.conf`
 Resque.redis = '127.0.0.1:9736'

metadata

@@ -1,73 +1,105 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: resque-lock-timeout
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.3.3
   prerelease: 
-  version: 0.3.1
 platform: ruby
-authors: 
+authors:
 - Luke Antins
 - Ryan Carver
 - Chris Wanstrath
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-16 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: resque
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2155990660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.8.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: turn
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2155990660
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2155972620 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2155972620
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &2155947800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2155947800
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2155922920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *2155922920
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2155919780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2155919780
+- !ruby/object:Gem::Dependency
   name: rdiscount
+  requirement: &2155916580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2155916580
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2155910660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
   type: :development
-  version_requirements: *id004
-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-aquire 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  recurring or may be retried.\n"
+  prerelease: false
+  version_requirements: *2155910660
+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-aquire 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
+  \ recurring or may be retried.\n"
 email: luke@lividpenguin.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.md
 - Rakefile
 - LICENSE
@@ -78,33 +110,30 @@ files:
 - test/redis-test.conf
 - test/test_helper.rb
 - test/test_jobs.rb
-has_rdoc: false
 homepage: http://github.com/lantins/resque-lock-timeout
 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'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: A Resque plugin adding locking, with optional timeout/deadlock handling to resque jobs.
+summary: A Resque plugin adding locking, with optional timeout/deadlock handling to
+  resque jobs.
 test_files: []
-
+has_rdoc: false