resque-loner 1.2.1 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de3cf9ac86e6b7d373f9f281805f3a0fe4da5548
+  data.tar.gz: daf48d9aa6bc0a2f9a0afdeac093ab55fc04f1b1
+SHA512:
+  metadata.gz: f25db5e2368a0b32d8cc5aaf363ee5b63eaa68dd78ef204b705434df500b376bf7c3cfe50f8819df1d99fdecdf685e42b540fed5e9c8f193a02978a4c587275b
+  data.tar.gz: d6be67b0d07ae6c98d167edca1cf6537d84458137f89c968af4db5f9b8e445974cfd2bf87bb3ea36d5fde29e81143792843cbbc80845e77e0a70b4a2944e6e63

data/.gitignore

@@ -3,3 +3,7 @@
 **.swp
 Gemfile.lock
 .rvmrc
+spec/stdout
+coverage/
+.ruby-version
+.ruby-gemset

data/.rubocop.yml

@@ -0,0 +1,92 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-03-20 16:42:32 -0400 using RuboCop version 0.19.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+AmbiguousOperator:
+  Enabled: false
+
+# Offense count: 1
+AmbiguousRegexpLiteral:
+  Enabled: false
+
+# Offense count: 36
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+ClassAndModuleChildren:
+  Enabled: false
+
+# Offense count: 5
+ClassVars:
+  Enabled: false
+
+# Offense count: 75
+Documentation:
+  Enabled: false
+
+# Offense count: 20
+Encoding:
+  Enabled: false
+
+# Offense count: 1
+Eval:
+  Enabled: false
+
+# Offense count: 1
+FavorUnlessOverNegatedIf:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: Exclude.
+FileName:
+  Enabled: false
+
+# Offense count: 27
+# Configuration parameters: AllowedVariables.
+GlobalVars:
+  Enabled: false
+
+# Offense count: 1
+HandleExceptions:
+  Enabled: false
+
+# Offense count: 75
+LineLength:
+  Max: 161
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+MethodLength:
+  Max: 17
+
+# Offense count: 1
+ModuleFunction:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+RaiseArgs:
+  Enabled: false
+
+# Offense count: 3
+RedundantBegin:
+  Enabled: false
+
+# Offense count: 1
+UnlessElse:
+  Enabled: false
+
+# Offense count: 1
+UnreachableCode:
+  Enabled: false
+
+# Offense count: 5
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+VariableName:
+  Enabled: false
+
+# Offense count: 11
+Void:
+  Enabled: false

data/.simplecov

@@ -0,0 +1 @@
+SimpleCov.start { add_filter '/spec/' } if ENV['COVERAGE']

data/.travis.yml

@@ -0,0 +1,12 @@
+---
+language: ruby
+rvm:
+- 1.9.3
+- 2.1.1
+env:
+  global:
+  - RESQUE_LONER_DISABLE_TEST_REDIS_SERVER=1
+  - COVERAGE=1
+  - secure: c9PvRm9w0ewSsS1QDogwPCvSXO+xgHm0mcVA+iiUknezitNjDwaTuBqGtLJ/PjMnQ16QfG0ApDvSqqOw9rSjwM7meCqiQZlJRqqyd547PNhbP6J56mtuXvxMM7wvulK/aLeIYwDeON0Do52FSY4l2/oN2QvA2hIvX8RTDyrfdaA=
+services:
+- redis-server

data/CHANGELOG.markdown

@@ -1,3 +1,14 @@
+1.3.0
+--------------------------------
+Enhancements and bug fixes from @mateusdelbianco.  Not allowing a job to
+be executed immediately after execution, another from @mateusdelbianco!
+Merged @andrejj's fix which removes an unused `#first` from a redis
+multi call.  @kforsman created an internal helpers module to remove the
+dependency on the deprecated `Resque::Helpers` module.  Added RuboCop,
+SimpleCov, and CodeClimate, plus tweaked some stuff in Travis
+configuration.
+
+
 1.2.1
 --------------------------------
 Merged @aerodynamik's pull request. Enqueuing and marking as

data/Gemfile

@@ -1,8 +1,7 @@
+# -*- encoding: utf-8 -*-
 source 'http://rubygems.org'
+
 gemspec
 
-group :development do
-  gem 'gemcutter'
-  gem 'ruby-debug', :platform => :mri_18
-  gem 'ruby-debug19', :platform => :mri_19
-end
+gem 'debugger', group: :development, platform: :mri_19
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/README.markdown

@@ -1,6 +1,9 @@
 Resque-Loner
 ======
 
+[![Build Status](https://secure.travis-ci.org/resque/resque-loner.png?branch=master)](https://travis-ci.org/resque/resque-loner)
+[![Code Climate](https://codeclimate.com/github/resque/resque-loner.png)](https://codeclimate.com/github/resque/resque-loner)
+
 Resque-Loner is a plugin for defunkt/resque which adds unique jobs to resque: Only one job with the same payload per queue.
 
 
@@ -20,7 +23,7 @@ Tests
 -----------
 To make sure this plugin works on your installation, you should run the tests. resque-loner is tested in RSpec, but it also includes resque's original testsuite. You can run all tests specific to resque-loner with `rake spec`.
 
-To make sure the plugin did not break resque, you can run `rake test` (the standard resque test suite). This runs all tests from the 1.10.0 version of resque, so make sure you have that version of resque installed, when you run the resque-tests.
+To make sure the plugin did not break resque, you can run `rake test` (the standard resque test suite). This runs all tests from the 1.22.0 version of resque, so make sure you have that version of resque installed, when you run the resque-tests.
 
 Example
 --------

data/Rakefile

@@ -1,49 +1,32 @@
-#
-# Setup
-#
-
 $LOAD_PATH.unshift 'lib'
 
-require "rubygems"
-require "bundler"
+require 'rubygems'
+require 'bundler'
 Bundler.setup
 
 require 'rspec/core/rake_task'
-
 load 'tasks/redis.rake'
 require 'rake/testtask'
-
 require 'resque/tasks'
-
 require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
 
 def command?(command)
   system("type #{command} > /dev/null 2>&1")
 end
 
+task default: [:rubocop, :spec]
 
-#
-# Tests
-#
-
-task :default => :spec
+Rubocop::RakeTask.new
 
-desc "Run specs for resque-loner"
+desc 'Run specs for resque-loner'
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = "spec/**/*_spec.rb"
+  t.pattern = 'spec/**/*_spec.rb'
   t.rspec_opts = %w(-fd -c)
 end
 
-# desc "Run resque's test suite to make sure we did not break anything"
-# task :test do
-#   rg = command?(:rg)
-#   Dir['test/**/*_test.rb'].each do |f|
-#     rg ? sh("rg #{f}") : ruby(f)
-#   end
-# end
-
 if command?(:rg)
-  desc "Run the test suite with rg"
+  desc 'Run the test suite with rg'
   task :test do
     Dir['test/**/*_test.rb'].each do |f|
       sh("rg #{f}")
@@ -51,33 +34,22 @@ if command?(:rg)
   end
 else
   Rake::TestTask.new do |test|
-    test.libs << "test"
+    test.libs << 'test'
     test.test_files = FileList['test/**/*_test.rb']
   end
 end
 
 if command? :kicker
-  desc "Launch Kicker (like autotest)"
+  desc 'Launch Kicker (like autotest)'
   task :kicker do
-    puts "Kicking... (ctrl+c to cancel)"
-    exec "kicker -e rake test lib examples"
+    puts 'Kicking... (ctrl+c to cancel)'
+    exec 'kicker -e rake test lib examples'
   end
 end
 
-
-#
-# Install
-#
-
-task :install => [ 'redis:install', 'dtach:install' ]
-
-
-#
-# Documentation
-#
+task :install => ['redis:install', 'dtach:install']
 
 begin
   require 'sdoc_helpers'
 rescue LoadError
 end
-

data/lib/resque-ext/job.rb

@@ -2,24 +2,24 @@
 #  Since there were not enough hooks to hook into, I have to overwrite
 #  3 methods of Resque::Job - the rest of the implementation is in the
 #  proper Plugin namespace.
-# 
+#
 module Resque
   class Job
-
-
     #
     #  Overwriting original create method to mark an item as queued
     #  after Resque::Job.create has called Resque.push
     #
     def self.create_with_loner(queue, klass, *args)
       return create_without_loner(queue, klass, *args) if Resque.inline?
-      item = { :class => klass.to_s, :args => args }
-      return "EXISTED" if Resque::Plugins::Loner::Helpers.loner_queued?(queue, item)
+      item = { class: klass.to_s, args: args }
+      return 'EXISTED' if Resque::Plugins::Loner::Helpers.loner_queued?(queue, item)
       # multi block returns array of keys
+      create_return_value = false
       Resque.redis.multi do
-        create_without_loner(queue, klass, *args)
+        create_return_value = create_without_loner(queue, klass, *args)
         Resque::Plugins::Loner::Helpers.mark_loner_as_queued(queue, item)
-      end.first
+      end
+      create_return_value
     end
 
     #
@@ -27,13 +27,13 @@ module Resque
     #
     def self.reserve_with_loner(queue)
       item = reserve_without_loner(queue)
-      Resque::Plugins::Loner::Helpers.mark_loner_as_unqueued( queue, item ) if item && !Resque.inline?
+      Resque::Plugins::Loner::Helpers.mark_loner_as_unqueued(queue, item) if item && !Resque.inline?
       item
     end
 
     #
     #  Overwriting original destroy method to mark all destroyed jobs as unqueued.
-    #  Because the original method only returns the amount of jobs destroyed, but not 
+    #  Because the original method only returns the amount of jobs destroyed, but not
     #  the jobs themselves. Hence Resque::Plugins::Loner::Helpers.job_destroy looks almost
     #  as the original method Resque::Job.destroy. Couldn't make it any dry'er.
     #

data/lib/resque-ext/resque.rb

@@ -1,26 +1,21 @@
 module Resque
-
-  def self.enqueued?( klass, *args)
-    enqueued_in?(queue_from_class(klass), klass, *args )
+  def self.enqueued?(klass, *args)
+    enqueued_in?(queue_from_class(klass), klass, *args)
   end
 
   def self.enqueued_in?(queue, klass, *args)
-    item = { :class => klass.to_s, :args => args }
+    item = { class: klass.to_s, args: args }
     return nil unless Resque::Plugins::Loner::Helpers.item_is_a_unique_job?(item)
     Resque::Plugins::Loner::Helpers.loner_queued?(queue, item)
   end
 
   def self.remove_queue_with_loner_cleanup(queue)
-    self.remove_queue_without_loner_cleanup(queue)
+    remove_queue_without_loner_cleanup(queue)
     Resque::Plugins::Loner::Helpers.cleanup_loners(queue)
   end
 
-
   class << self
-
     alias_method :remove_queue_without_loner_cleanup, :remove_queue
     alias_method :remove_queue, :remove_queue_with_loner_cleanup
-
   end
-
 end

data/lib/resque-loner.rb

@@ -2,5 +2,6 @@ require 'rubygems'
 require 'resque'
 require 'resque-loner/unique_job'
 require 'resque-loner/helpers'
+require 'resque-loner/legacy_helpers'
 require 'resque-ext/job'
-require 'resque-ext/resque'
+require 'resque-ext/resque'

data/lib/resque-loner/helpers.rb

@@ -1,19 +1,21 @@
+require 'resque-loner/legacy_helpers'
+
 module Resque
   module Plugins
     module Loner
       class Helpers
-        extend Resque::Helpers
+        extend Resque::Plugins::Loner::LegacyHelpers
 
         def self.loner_queued?(queue, item)
           return false unless item_is_a_unique_job?(item)
-          redis.get(unique_job_queue_key(queue, item)) == "1"
+          redis.get(unique_job_queue_key(queue, item)) == '1'
         end
 
         def self.mark_loner_as_queued(queue, item)
           return unless item_is_a_unique_job?(item)
           key = unique_job_queue_key(queue, item)
           redis.set(key, 1)
-          unless(ttl=item_ttl(item)) == -1 # no need to incur overhead for default value 
+          unless (ttl = item_ttl(item)) == -1 # no need to incur overhead for default value
             redis.expire(key, ttl)
           end
         end
@@ -21,17 +23,21 @@ module Resque
         def self.mark_loner_as_unqueued(queue, job)
           item = job.is_a?(Resque::Job) ? job.payload : job
           return unless item_is_a_unique_job?(item)
-          redis.del(unique_job_queue_key(queue, item))
+          unless (ttl = loner_lock_after_execution_period(item)) == 0
+            redis.expire(unique_job_queue_key(queue, item), ttl)
+          else
+            redis.del(unique_job_queue_key(queue, item))
+          end
         end
 
         def self.unique_job_queue_key(queue, item)
-          job_key = constantize(item[:class] || item["class"]).redis_key(item)
+          job_key = constantize(item[:class] || item['class']).redis_key(item)
           "loners:queue:#{queue}:job:#{job_key}"
         end
 
         def self.item_is_a_unique_job?(item)
           begin
-            klass = constantize(item[:class] || item["class"])
+            klass = constantize(item[:class] || item['class'])
             klass.included_modules.include?(::Resque::Plugins::UniqueJob)
           rescue
             false # Resque testsuite also submits strings as job classes while Resque.enqueue'ing,
@@ -40,12 +46,20 @@ module Resque
 
         def self.item_ttl(item)
           begin
-            constantize(item[:class] || item["class"]).loner_ttl
+            constantize(item[:class] || item['class']).loner_ttl
           rescue
             -1
           end
         end
 
+        def self.loner_lock_after_execution_period(item)
+          begin
+            constantize(item[:class] || item['class']).loner_lock_after_execution_period
+          rescue
+            0
+          end
+        end
+
         def self.job_destroy(queue, klass, *args)
           klass = klass.to_s
           redis_queue = "queue:#{queue}"
@@ -57,7 +71,7 @@ module Resque
             match &= json['args'] == args unless args.empty?
 
             if match
-             Resque::Plugins::Loner::Helpers.mark_loner_as_unqueued( queue, json )
+              Resque::Plugins::Loner::Helpers.mark_loner_as_unqueued(queue, json)
             end
           end
         end
@@ -66,7 +80,6 @@ module Resque
           keys = redis.keys("loners:queue:#{queue}:job:*")
           redis.del(*keys) unless keys.empty?
         end
-
       end
     end
   end