resque-better_unique 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49c3786567e5fac7afaf1952494e57dab802498c
+  data.tar.gz: c2c493ae52134c85d258f263f8da2a64e35ab843
+SHA512:
+  metadata.gz: 6718dbab47f5b8f8cd6806981370aba54b36c53369c6126968139f9ea14a1d805e83330cdd646970df77ff096149500728efbf6f902dec2ab6cea16977dd198c
+  data.tar.gz: b433207f6254cb640c3ed511743fddc4b5b2a07786cb73e2ffb2f068160c00a6d711c4db4f0e034ac04551a63278e31d8143e3ea5d71268b0239d061f2674204

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,50 @@
+# Resque::BetterUnique
+
+There are currently a number of resque plugins that provide this functionality in some form or another, but one thing they all lack is the ability to control how the unique constraint is defined. Sometimes, a job should only be unique until a worker begins processing it, in other cases you will want the job to remain unique until the job completes, or maybe even long after the job has completed. This allows you to do all of the above and more with a single gem.
+
+The functionality of this gem is based on the sidekiq equivalent [sidekiq-unique-jobs](https://github.com/mhenrixon/sidekiq-unique-jobs).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resque-better_unique'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-better_unique
+
+## Usage
+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
+end
+```
+
+The unique 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
+  * until_executed: only one job can be queued or processed at a time
+  * until_timeout: only one job can be queued or processed in a given time period
+- options: Hash of options
+  * 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
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/resque-better_unique.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "resque/better_unique"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/resque/plugins/better_unique.rb

@@ -0,0 +1,98 @@
+module Resque
+  module Plugins
+    module BetterUnique
+
+
+      def self.included(base_klass)
+        base_klass.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        # 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_key(*args)
+          unique_args = unique_options[:unique_args]
+          lock_args = case unique_args
+          when Proc
+            unique_args.call(*args)
+          when Symbol
+            self.send(unique_args, *args)
+          else
+            args
+          end
+          "#{lock_key_base}-#{lock_args.to_s}"
+        end
+
+        def lock_key_base
+          "lock:#{name}"
+        end
+
+        def locked?(*args)
+          Resque.redis.exists(lock_key(*args))
+        end
+
+        def unique_options
+          @unique_options || {}
+        end
+
+        def unique_options=(options)
+          @unique_options = options
+        end
+
+        def unique_mode
+          unique_options[:mode].to_sym || :none
+        end
+
+        def unique(mode=:until_executed, options={})
+          self.unique_options = {mode: mode}.merge(options)
+        end
+
+        def before_enqueue_unique_lock(*args)
+          if [:until_executing, :until_executed, :until_timeout].include?(unique_mode)
+            return false if locked?(*args)
+            set_lock(*args)
+          end
+          true
+        end
+
+        def around_perform_unique_lock(*args)
+          case unique_mode
+          when :until_executing
+            release_lock(*args)
+          when :while_executing
+            return if locked?(*args) || !set_lock(*args)
+          end
+          yield
+        ensure
+          if [:until_executed, :while_executing].include?(unique_mode)
+            release_lock(*args)
+          end
+        end
+
+        def release_lock(*args)
+          Resque.redis.del(lock_key(*args))
+        end
+
+        def set_lock(*args)
+          is_now_locked = Resque.redis.setnx(lock_key(*args), true)
+          if is_now_locked && unique_options[:timeout]
+            Resque.redis.expire(lock_key(*args), unique_options[:timeout].to_i)
+          end
+          is_now_locked
+        end
+
+        def release_all_locks(offset=nil)
+          return if offset == '0'
+          new_offset, keys = Resque.redis.scan(offset || 0)
+          keys.each do |key|
+            Resque.redis.del(key) if key.start_with?(lock_key_base)
+          end
+          release_all_locks(new_offset)
+        rescue Redis::CommandError
+          Resque.logger.error 'This command only works with versions of redis-server over 2.8'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Resque
+  module Plugins
+    module BetterUnique
+      VERSION = '1.0.0'
+    end
+  end
+end

data/resque-better_unique.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resque/plugins/better_unique/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'resque-better_unique'
+  spec.version       = Resque::Plugins::BetterUnique::VERSION
+  spec.authors       = ['Will Bryant']
+  spec.email         = ['william@tout.com']
+
+  spec.summary       = %q{A resque plugin for better control over unique jobs}
+  spec.description   = %q{There are a number of plugins which allow you define unique jobs, but each only handle on use-case. This allows you have full control over how uniqueness is defined}
+  spec.homepage      = 'http://github.com/will3216/resque-better_unique'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'resque'
+  spec.add_development_dependency 'redis'
+  spec.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: resque-better_unique
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Will Bryant
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: There are a number of plugins which allow you define unique jobs, but
+  each only handle on use-case. This allows you have full control over how uniqueness
+  is defined
+email:
+- william@tout.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/resque/plugins/better_unique.rb
+- lib/resque/plugins/better_unique/version.rb
+- resque-better_unique.gemspec
+homepage: http://github.com/will3216/resque-better_unique
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: A resque plugin for better control over unique jobs
+test_files: []