resque-loner 0.1.3 → 1.0.1

data/README.markdown

@@ -10,13 +10,18 @@ Installation
 
 First install the gem:
 
-    $ gem install resque-loner -v=0.1.2
+    $ gem install resque-loner 
 
 Then include it in your app:
 
     require 'resque-loner'
 
-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).r
+
+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.
 
 Example
 --------
@@ -90,7 +95,7 @@ The last part of this key is the job's ID, which is pretty much your queue item'
 
     { 'class': 'CacheSweeper', 'args': [1] }`
 
-The default method to create a job ID from these parameters  is to do some normalization on the payload and then md5'ing it (defined in `Resque::Plugins::Loner::UniqueJob#redis_key`).
+The default method to create a job ID from these parameters  is to do some normalization on the payload and then md5'ing it (defined in `Resque::Plugins::UniqueJob#redis_key`).
 
 You could also use the whole payload or anything else as a redis key, as long as you make sure these requirements are met:
 

data/lib/resque-ext/job.rb

@@ -5,8 +5,8 @@
 # 
 module Resque
   class Job
-    
-    
+
+
     #
     #  Overwriting original create method to mark an item as queued
     #  after Resque::Job.create has called Resque.push
@@ -18,7 +18,7 @@ module Resque
       Resque::Plugins::Loner::Helpers.mark_loner_as_queued(queue, item)
       job
     end
-    
+
     #
     #  Overwriting original reserve method to mark an item as unqueued
     #
@@ -27,7 +27,7 @@ module Resque
       Resque::Plugins::Loner::Helpers.mark_loner_as_unqueued( queue, item ) if item
       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 
@@ -38,7 +38,7 @@ module Resque
       Resque::Plugins::Loner::Helpers.job_destroy(queue, klass, *args)
       destroy_without_loner(queue, klass, *args)
     end
-    
+
     #
     # Chain..
     #
@@ -51,4 +51,4 @@ module Resque
       alias_method :destroy, :destroy_with_loner
     end
   end
-end
+end

data/lib/resque-ext/resque.rb

@@ -1,37 +1,37 @@
 module Resque
-  
+
   #
   #  Why force one job type into one queue?
   #
   def self.enqueue_to( queue, klass, *args )
     Job.create(queue, klass, *args)
   end
-  
+
   def self.dequeue_from( queue, klass, *args)
     Job.destroy(queue, klass, *args)
   end
-  
+
   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 }
     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)
     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
+
+end

data/lib/resque-loner/helpers.rb

@@ -8,7 +8,7 @@ module Resque
           return false unless item_is_a_unique_job?(item)
           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)
           redis.set(unique_job_queue_key(queue, item), 1)
@@ -24,16 +24,16 @@ module Resque
           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.ancestors.include?(::Resque::Plugins::Loner::UniqueJob)
+            klass.included_modules.include?(::Resque::Plugins::UniqueJob)
           rescue
             false # Resque testsuite also submits strings as job classes while Resque.enqueue'ing,
           end     # so resque-loner should not start throwing up when that happens.
         end
-        
+
         def self.job_destroy(queue, klass, *args)
           klass = klass.to_s
           redis_queue = "queue:#{queue}"
@@ -49,12 +49,13 @@ module Resque
             end
           end
         end
-        
+
         def self.cleanup_loners(queue)
-          redis.del(*redis.keys("loners:queue:#{queue}:job:*"))
+          keys = redis.keys("loners:queue:#{queue}:job:*")
+          redis.del(*keys) unless keys.empty?
         end
-        
+
       end
     end
   end
-end
+end

data/lib/resque-loner/unique_job.rb

@@ -1,27 +1,59 @@
 require 'digest/md5'
 
 #
-#  If you want your job to be unique, subclass it from this class. If you wish,
+#  If you want your job to be unique, include this module in it. If you wish,
 #  you can overwrite this implementation of redis_key to fit your needs
 #
 module Resque
   module Plugins
-    module Loner
-      class UniqueJob
-        extend Resque::Helpers
+    module UniqueJob
+
+      def self.included(base)
+        base.extend         ClassMethods
+        base.class_eval do
+          base.send(:extend, Resque::Helpers)
+        end
+      end # self.included
+
+      module ClassMethods
+
 
         #
         #  Payload is what Resque stored for this job along with the job's class name.
         #  On a Resque with no plugins installed, this is a hash containing :class and :args
         #
-        def self.redis_key(payload)
+        def redis_key(payload)
           payload = decode(encode(payload)) # This is the cycle the data goes when being enqueued/dequeued
           job  = payload[:class] || payload["class"]
-          args = payload[:args]  || payload["args"]
+          args = (payload[:args]  || payload["args"])
+          args.map! do |arg|
+            arg.is_a?(Hash) ? arg.sort : arg
+          end
+
           digest = Digest::MD5.hexdigest encode(:class => job, :args => args)
           digest
         end
+      end # ClassMethods
+
+
+    end
+  end
+end
+
+module Resque
+  module Plugins
+    module Loner
+      class UniqueJob
+
+        include Resque::Plugins::UniqueJob
+
+        def self.inherited(host)
+          super(host)
+          return  if @__unique_job_warned
+          warn "Inherit Resque::Plugins::Loner::UniqueJob is deprecated. Include Resque::Plugins::UniqueJob module instead."
+          @__unique_job_warned = true
+        end
       end
     end
   end
-end
+end

data/lib/resque-loner/version.rb

@@ -1,7 +1,7 @@
 module Resque
   module Plugins
     module Loner
-      VERSION = "0.1.3"
+      VERSION = "1.0.1"
     end
   end
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: resque-loner
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 3
-  version: 0.1.3
+  prerelease: 
+  version: 1.0.1
 platform: ruby
 authors: 
 - Jannis Hermanns
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-19 00:00:00 +01:00
+date: 2011-07-15 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,34 +21,63 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
         version: "1.0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: bundler
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+        version: 1.0.0
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.5.7
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+  type: :development
+  version_requirements: *id005
 description: |
   Makes sure that for special jobs, there can be only one job with the same workload in one queue.
   
   Example:
-      class CacheSweeper < Resque::Plugins::Loner::UniqueJob
+      class CacheSweeper 
+  
+         include Resque::Plugins::UniqueJob
+  
          @queue = :cache_sweeps
-      
+  
          def self.perform(article_id)
            # Cache Me If You Can...
          end
@@ -89,23 +113,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: resque-loner
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Adds unique jobs to resque