resque-lonely_job 1.0.0 → 1.0.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDFmMjdkMzRmNmVhNWM4YTg1Y2JlNDkzNmViZjdlNjk3MTA2MWQ5Ng==
-  data.tar.gz: !binary |-
-    ODJhOTg3YWYyZjRiZTcyMmZlMmNhZjA4NjRjNzc4YmY5ZGNhNWI0ZQ==
+SHA1:
+  metadata.gz: 77d6fb9e55406f71e625a51f3aed732858c53c30
+  data.tar.gz: 5428f1070c91a492eefd4b13eaf9ba9bb4d404fa
 SHA512:
-  metadata.gz: !binary |-
-    YWE2NzdlOTkwYTI1YTlkZmU0ZjhhNGM0M2EyMDdkZjM4ZmM5MTJlOWY5OWY3
-    N2RkODI1YjQzMDg0MjA0YTQ4ZDRiNTVkNWQ3YTk2YTk4MGU3Y2ZkNmYwMWI3
-    YjE2Yzc2NjBkMzFmZmI2MjUwNjBmY2MzZWIyNmM0YjVmZjQ0N2I=
-  data.tar.gz: !binary |-
-    MTBhZjY2MmZjNGE5MGZhNjYwYWFmNDViZWIzMzVmNzg0Y2I3OTUxMjA5YTcy
-    ZTc1YjE5MGI5ZmVjN2ZlNTM4YjBkOWRlZDYzMDQxN2E1NDFjZWM0NDc5OGY1
-    NDJiZmExNjM0MTAxMmM3OGQwZjgwNmQ4NWRkMWFiZTgxM2Q0N2Q=
+  metadata.gz: 5014e12936d857fec3009b2c8b017689a4c3e25765f3122a196d984d3fbc9fa07c1cf4591de26d5801716104b67b6948d08fdc59e52a8fb5aff73e91970b24b0
+  data.tar.gz: 57fbd6bcb2a2189bc382814751f29efd4b14071e059a4e50087a0c5e6e8ad8f7109d640ce0755bfd48566d7df40646430c2fdfc2415f83378d4615e7a2309ef1

data/.travis.yml

@@ -1,3 +1,5 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/README.md

@@ -2,8 +2,12 @@
 
 [![Build Status](https://travis-ci.org/wallace/resque-lonely_job.png)](https://travis-ci.org/wallace/resque-lonely\_job)
 
-A [Resque](https://github.com/resque/resque) plugin. Version 1.x Requires Resque >= 1.20.0 and < 1.25.0.
-Requires ruby 1.9.3.
+A [Resque](https://github.com/resque/resque) plugin that implements [Semantic
+Versioning](http://semver.org/).
+
+Version 1.x Requires Resque >= 1.20.0 and < 1.25.0.
+
+Requires a version of MRI Ruby >= 1.9.3.
 
 Ensures that for a given queue, only one worker is working on a job at any given
 time.
@@ -35,7 +39,7 @@ Or install it yourself as:
 
 #### Example #1 -- One job running per queue
 
-    require 'resque/plugins/lonely_job'
+    require 'resque-lonely_job'
 
     class StrictlySerialJob
       extend Resque::Plugins::LonelyJob
@@ -54,7 +58,7 @@ Let's say you want the serial constraint to apply at a more granular
 level.  Instead of applying at the queue level, you can overwrite the .redis\_key
 method.
 
-    require 'resque/plugins/lonely_job'
+    require 'resque-lonely_job'
 
     class StrictlySerialJob
       extend Resque::Plugins::LonelyJob
@@ -112,7 +116,38 @@ where you have three jobs in the queue with two resque workers:
 
 #### Example #3 -- One job running per user-defined attribute with job ordering preserved
 
-TODO
+The secret to preserving job order semantics is to remove critical data from the
+resque job and store data in a separate redis list. Part of a running job's
+responsibility will be to grab data off of the separate redis list needed for it
+to complete its job.
+
+    +---------------------------------------------------+
+    | :serial_work for jobs associated with key A       |
+    |---------------------------------------------------|
+    |   data x    |   data y    |   data z    | ...     |
+    +---------------------------------------------------+
+
+    +---------------------------------------------------+
+    | :serial_work for jobs associated with key B       |
+    |---------------------------------------------------|
+    |   data m    |   data n    |   data o    | ...     |
+    +---------------------------------------------------+
+
+    +---------------------------------------------------+
+    | :serial_work                                      |
+    |---------------------------------------------------|
+    |             |             |             |         |
+    | redis_key:  | redis_key:  | redis_key:  | ...     |
+    |    A        |    A        |    B        |         |
+    |             |             |             |         |
+    | job 1       | job 2       | job 3       |         |
+    +---------------------------------------------------+
+
+It now doesn't matter whether job 1 and job 2 are re-ordered as whichever goes
+first will perform an atomic pop on the redis list that contains the data needed
+for its job (data x, data y, data z).
+
+*NOTE*: Worker starvation and fairness is still possible as in Example 2.
 
 ## Contributing
 

data/lib/resque-lonely_job/version.rb

@@ -1,7 +1,7 @@
 module Resque
   module Plugins
     module LonelyJob
-      VERSION = "1.0.0"
+      VERSION = "1.0.1"
     end
   end
 end

data/resque-lonely_job.gemspec

@@ -14,11 +14,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Resque::Plugins::LonelyJob::VERSION
 
-  gem.add_dependency 'resque', '>= 1.20.0', '< 1.25.0'
-  gem.add_development_dependency 'mock_redis', '~> 0.4.1'
+  gem.add_dependency 'resque', '>= 1.2'
+  gem.add_development_dependency 'mock_redis'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'debugger'
   gem.add_development_dependency 'timecop'
 
   gem.description   = <<desc

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-lonely_job
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jonathan R. Wallace
@@ -14,97 +14,89 @@ dependencies:
   name: resque
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.20.0
-    - - <
-      - !ruby/object:Gem::Version
-        version: 1.25.0
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.20.0
-    - - <
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.25.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: mock_redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.4.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.4.1
-- !ruby/object:Gem::Dependency
-  name: rake
-  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: rspec
+  name: rake
   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: debugger
+  name: rspec
   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: timecop
   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: ! "Ensures that for a given queue, only one worker is working on a job
-  at any given time.\n\nExample:\n\n  require 'resque/plugins/lonely_job'\n\n  class
-  StrictlySerialJob\n    extend Resque::Plugins::LonelyJob\n\n    @queue = :serial_work\n\n
-  \   def self.perform\n      # only one at a time in this block, no parallelism allowed
-  for this\n      # particular queue\n    end\n  end\n"
+description: |
+  Ensures that for a given queue, only one worker is working on a job at any given time.
+
+  Example:
+
+    require 'resque/plugins/lonely_job'
+
+    class StrictlySerialJob
+      extend Resque::Plugins::LonelyJob
+
+      @queue = :serial_work
+
+      def self.perform
+        # only one at a time in this block, no parallelism allowed for this
+        # particular queue
+      end
+    end
 email:
 - jonathan.wallace@gmail.com
 executables: []
@@ -131,17 +123,17 @@ 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.1.11
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A resque plugin that ensures that only one job for a given queue will be