resque-better_unique 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e474de20786fbba4361851c129a2644738ca9bda
-  data.tar.gz: b887e51072a2ce8756536f1b7aed2fef67cbfc02
+  metadata.gz: 926c1f77a991608f8cb0d9ccd69fb90fa467962b
+  data.tar.gz: b485017b4d607b88aad87861278df221f77a63ca
 SHA512:
-  metadata.gz: d04eeee9e17cf85359eb1b8865c635ae1f92b050a92d589161cb1f9daaef75d86cb3c7a6562ae9ec2ae7aa261d33dc0ea797899569cccf9fe09083d8236cb77e
-  data.tar.gz: 0cf12c119b33e5dff88e3036a5ba622e3cef1b446bda3ef57f3c57b64daa588ff00ade9f7e28ed8fcf18ebe7b9678ebc74148bfcc4280116d343f66693709cbd
+  metadata.gz: 67b86180d9dda8dcb39bb5d3b86f6ad9050da7bc1d8885132bec37489103c213fe7978f5384ee2551e398d94ac271a85c856f48f5e50ebfaf062469b538f7164
+  data.tar.gz: 2d006f9a4ab41ba6910e003eef4d5a20398a62f0ba07ff7394e20734c2ba139bb8eff4be890d1d6f9464efa96bc1f7255bbf8ef6dd0bb9450eecd49339d23fec

data/README.md

@@ -25,11 +25,11 @@ Include this plugin into your job class and call the `unique` method
 ```ruby
 class MyWorker
   include Resque::Plugins::BetterUnique
-  unique :while_executing, timeout: 5.minutes
+  unique_job :while_executing, timeout: 5.minutes
 end
 ```
 
-The unique method takes up to two arguments:
+The unique_job method takes up to two arguments:
 - mode: (default=:until_executed)
   * while_executing: only one distinct job can be processed at a time
   * until_executing: only one job can be queued at a time
@@ -39,6 +39,61 @@ The unique method takes up to two arguments:
   * timeout - integer or object that responds to to_i - How long should a lock live
   * unique_args - a proc or a symbol which takes the arguments of perform and returns the arguments that should be used to determine uniqueness
 
+### Examples:
+Specify method to define unique args:
+```ruby
+class MyWorker
+  include Resque::Plugins::BetterUnique
+  unique_job :while_executing, timeout: 5.minutes, unique_args: unique_job_arguments
+
+  def self.unique_job_arguments(*args)
+    [args[0], args[3]]
+  end
+end
+```
+
+Specify Proc to define unique args:
+```ruby
+class MyWorker
+  include Resque::Plugins::BetterUnique
+  unique_job :while_executing, timeout: 5.minutes, unique_args: ->(*args) { [args[0], args[3]] }
+end
+```
+
+Override lock_key method:
+```ruby
+class MyWorker
+  include Resque::Plugins::BetterUnique
+  unique_job :while_executing, timeout: 5.minutes
+
+  def self.lock_key(*args)
+    "lock:my_lock:#{args.to_s}"
+  end
+end
+```
+
+Clear lock for a single job:
+```ruby
+class MyWorker
+  include Resque::Plugins::BetterUnique
+  unique_job :until_executed, timeout: 5.minutes
+end
+
+Resque.enqueue(MyWorker, {some: :args})
+MyWorker.release_lock({some: :args})
+```
+
+Clear all locks for a worker class:
+```ruby
+class MyWorker
+  include Resque::Plugins::BetterUnique
+  unique_job :while_executing, timeout: 5.minutes
+end
+100.times { Resque.enqueue(MyWorker, rand(1000))}
+MyWorker.release_all_locks
+```
+NOTE: `release_all_locks` requires redis-server >= 2.8. Only removes locks for the class on which it was called.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/resque/plugins/better_unique.rb

@@ -41,7 +41,7 @@ module Resque
         end
 
         def unique_job_mode
-          unique_job_options[:mode].to_sym || :none
+          unique_job_options[:mode].try(:to_sym) || :none
         end
 
         def unique_job(mode=:until_executed, options={})

data/lib/resque/plugins/better_unique/version.rb

@@ -1,7 +1,7 @@
 module Resque
   module Plugins
     module BetterUnique
-      VERSION = '1.0.1'
+      VERSION = '1.0.2'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resque-better_unique
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Will Bryant
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-18 00:00:00.000000000 Z
+date: 2018-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A resque plugin for better control over unique jobs