resque-dedup 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in resque-dedup.gemspec
+gemspec

data/README.md

@@ -0,0 +1,49 @@
+Resque Dedup
+============
+
+A [Resque][rq] plugin. Until [Datagraph's][dg] patched version of Resque
+is merged, you will need to use the `datagraph` branch of our [Resque
+repository][dgrq]
+
+If you want only one instance of a particular job to be enqueued at any
+one time, extend it with this module.
+
+For example:
+
+    require 'resque/plugins/dedup'
+
+    class DoSomeHeavyLifting
+      extend Resque::Plugins::Dedup
+
+      def self.perform(some_id)
+        heavy_lifting
+      end
+    end
+
+Only one instance of this job will be enqueued at any one time. The job is
+identified by a `lock` key which is a combination of its name and the arguments
+supplied to it.
+
+If you want to define this key yourself, you can override the `lock` class method
+in your subclass, e.g.
+
+    class DoSomeHeavyLifting
+      extend Resque::Plugins::Lock
+
+      # Run only one at a time, regardless of some_id.
+      def self.lock(some_id)
+        "DoSomeHeavyLifting"
+      end
+
+      def self.perform(some_id)
+        heavy_lifting
+      end
+    end
+
+The above modification will ensure only one job of class
+DoSomeHeavyLifting is enqueued at a time, regardless of the
+some_id.
+
+[rq]: http://github.com/defunkt/resque
+[dg]: http://datagraph.org
+[dgrq]: http://github.com/datagraph/resque

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+task :default => :test
+
+Rake::TestTask.new do |test|
+  test.libs << "test"
+  test.test_files = FileList['test/**/*_test.rb']
+end

data/lib/resque/plugins/dedup.rb

@@ -0,0 +1,35 @@
+module Resque
+  module Plugins
+    module Dedup
+      VERSION = "0.0.1"
+
+      # 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?(*args)
+        Resque.redis.exists(lock(*args))
+      end
+      
+      def before_enqueue_lock(*args)
+        return false unless Resque.redis.setnx(lock(*args), true)
+        true
+      end
+
+      # Cleanup the key after the job is done.
+      def around_perform_lock(*args)
+        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/resque-dedup.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "resque/plugins/dedup"
+
+Gem::Specification.new do |s|
+  s.name        = "resque-dedup"
+  s.version     = Resque::Plugins::Dedup::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Josh Huckabee"]
+  s.email       = ["joshhuckabee@gmail.com"]
+  s.homepage    = "http://github.com/datagraph/resque-dedup"
+  s.summary     = %q{A Resque plugin for ensuring that the same job does not get enqueued multiple times}
+  s.description = %q{A Resque plugin for ensuring that the same job does not get enqueued multiple times}
+
+  s.rubyforge_project = "resque-dedup"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/dedup_test.rb

@@ -0,0 +1,28 @@
+require 'test/unit'
+require 'resque'
+require 'resque/plugins/dedup'
+
+class Job
+  extend Resque::Plugins::Dedup
+  @queue = :test
+
+  def self.perform
+    sleep 1
+  end
+end
+
+class DedupTest < Test::Unit::TestCase
+  def test_lint
+    assert_nothing_raised do
+      Resque::Plugin.lint(Resque::Plugins::Dedup)
+    end
+  end
+
+  def test_dedup
+    3.times { Resque.enqueue(Job) }
+    assert_equal 1, Resque.size(:test)
+    worker = Resque::Worker.new(:test)
+    worker.process
+    assert_equal 0, Resque.size(:test)
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: resque-dedup
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Josh Huckabee
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-10 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A Resque plugin for ensuring that the same job does not get enqueued multiple times
+email: 
+- joshhuckabee@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- README.md
+- Rakefile
+- lib/resque/plugins/dedup.rb
+- resque-dedup.gemspec
+- test/dedup_test.rb
+has_rdoc: true
+homepage: http://github.com/datagraph/resque-dedup
+licenses: []
+
+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: resque-dedup
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A Resque plugin for ensuring that the same job does not get enqueued multiple times
+test_files: []
+