resque-lock 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Chris Wanstrath
+
+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.

data/README.md

@@ -0,0 +1,51 @@
+Resque Lock
+===========
+
+A [Resque][rq] plugin. If you want only one instance of your job
+running at a time, extend it with this module.
+
+For example:
+
+    require 'resque/plugins/lock'
+
+    class UpdateNetworkGraph
+      extend Resque::Plugins::Lock
+
+      def self.perform(repo_id)
+        heavy_lifting
+      end
+    end
+
+While other UpdateNetworkGraph jobs will be placed on the queue,
+the Locked class will check Redis to see if any others are
+executing with the same arguments before beginning. If another
+is executing the job will be aborted.
+
+If you want to define the key yourself you can override the
+`lock` class method in your subclass, e.g.
+
+    class UpdateNetworkGraph
+      extend Resque::Plugins::Lock
+
+      Run only one at a time, regardless of repo_id.
+      def self.lock(repo_id)
+        "network-graph"
+      end
+
+      def self.perform(repo_id)
+        heavy_lifting
+      end
+    end
+
+The above modification will ensure only one job of class
+UpdateNetworkGraph is running at a time, regardless of the
+repo_id. Normally a job is locked using a combination of its
+class name and arguments.
+
+
+Dependencies
+------------
+
+* Resque 1.7.0
+
+[rq]: http://github.com/defunkt/resque

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+def command?(command)
+  system("type #{command} > /dev/null")
+end
+
+#
+# Tests
+#
+
+task :default => :test
+
+if command? :turn
+  desc "Run tests"
+  task :test do
+    suffix = "-n #{ENV['TEST']}" if ENV['TEST']
+    sh "turn test/*.rb #{suffix}"
+  end
+else
+  Rake::TestTask.new do |t|
+    t.libs << 'lib'
+    t.pattern = 'test/**/*_test.rb'
+    t.verbose = false
+  end
+end
+
+#
+# Gems
+#
+
+begin
+  require 'mg'
+  MG.new("resque-lock.gemspec")
+
+  desc "Build a gem."
+  task :gem => :package
+
+  # Ensure tests pass before pushing a gem.
+  task :gemcutter => :test
+
+  desc "Push a new version to Gemcutter and publish docs."
+  task :publish => :gemcutter do
+    sh "git push origin master --tags"
+  end
+rescue LoadError
+  warn "mg not available."
+  warn "Install it with: gem i mg"
+end

data/lib/resque/plugins/lock.rb

@@ -0,0 +1,71 @@
+module Resque
+  module Plugins
+    # If you want only one instance of your job running at a time,
+    # extend it with this module.
+    #
+    # For example:
+    #
+    # require 'resque/plugins/lock'
+    #
+    # class UpdateNetworkGraph
+    #   extend Resque::Plugins::Lock
+    #
+    #   def self.perform(repo_id)
+    #     heavy_lifting
+    #   end
+    # end
+    #
+    # While other UpdateNetworkGraph jobs will be placed on the queue,
+    # the Lock class will check Redis to see if any others are
+    # executing with the same arguments before beginning. If another
+    # is executing the job will be aborted.
+    #
+    # If you want to define the key yourself you can override the
+    # `lock` class method in your subclass, e.g.
+    #
+    # class UpdateNetworkGraph
+    #   extend Resque::Plugins::Lock
+    #
+    #   # Run only one at a time, regardless of repo_id.
+    #   def self.lock(repo_id)
+    #     "network-graph"
+    #   end
+    #
+    #   def self.perform(repo_id)
+    #     heavy_lifting
+    #   end
+    # end
+    #
+    # The above modification will ensure only one job of class
+    # UpdateNetworkGraph is running at a time, regardless of the
+    # repo_id. Normally a job is locked using a combination of its
+    # class name and arguments.
+    module Lock
+      # Override in your job to control the lock key. It is
+      # passed the same arguments as `perform`, that is, your job's
+      # payload.
+      def lock(*args)
+        "lock:#{name}-#{args.to_s}"
+      end
+
+      # Convenience method, not used internally.
+      def locked?
+        Resque.redis.exist(lock)
+      end
+
+      # Where the magic happens.
+      def around_perform_lock(*args)
+        # Abort if another job has created a lock.
+        return unless Resque.redis.setnx(lock(*args), true)
+
+        begin
+          yield
+        ensure
+          # Always clear the lock when we're done, even if there is an
+          # error.
+          Resque.redis.del(lock(*args))
+        end
+      end
+    end
+  end
+end

data/test/lock_test.rb

@@ -0,0 +1,34 @@
+require 'test/unit'
+require 'resque'
+require 'resque/plugins/lock'
+
+$counter = 0
+
+class Job
+  extend Resque::Plugins::Lock
+  @queue = :test
+
+  def self.perform
+    $counter += 1
+    sleep 1
+  end
+end
+
+class LockTest < Test::Unit::TestCase
+  def test_version
+    assert_equal '1.7.0', Resque::Version
+  end
+
+  def test_lock
+    3.times { Resque.enqueue(Job) }
+    worker = Resque::Worker.new(:test)
+
+    workers = []
+    3.times do
+      workers << Thread.new { worker.process }
+    end
+    workers.each { |t| t.join }
+
+    assert_equal 1, $counter
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: resque-lock
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Wanstrath
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-01 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: |
+  A Resque plugin. If you want only one instance of your job
+  running at a time, extend it with this module.
+  
+  For example:
+  
+      class UpdateNetworkGraph
+        extend Resque::Jobs::Locked
+  
+        def self.perform(repo_id)
+          heavy_lifting
+        end
+      end
+
+email: chris@ozmm.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- LICENSE
+- lib/resque/plugins/lock.rb
+- test/lock_test.rb
+has_rdoc: true
+homepage: http://github.com/defunkt/resque-lock
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Resque plugin for ensuring only one instance of your job is running at a time.
+test_files: []
+