resque-uuid 0.1.0 → 0.1.1

data/README.md

@@ -16,3 +16,15 @@ Resque::Plugins::ResqueUUID.enable!
 UUIDs can be returned via:
 * Resque::Job#uuid
 * YourJobPayloadClass.uuid, if your payload class responds to .uuid= and .uuid
+
+Additionally, your payload class can define an after_uuid_generated callback, which will be called with the newly-generated uuid and job args after the job is enqueued
+
+```ruby
+class MyJobClass
+
+   def self.after_uuid_generated(uuid, *args)
+    # do some record keeping or something
+   end
+
+end
+```

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/resque-uuid.rb

@@ -1,3 +1,4 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '/resque/plugins/resque_uuid'))
+require File.expand_path(File.join(File.dirname(__FILE__), '/resque/plugins/resque_uuid/util'))
 require File.expand_path(File.join(File.dirname(__FILE__), '/resque/plugins/resque_uuid/resque_extensions'))
 require File.expand_path(File.join(File.dirname(__FILE__), '/resque/plugins/resque_uuid/job_extensions'))

data/lib/resque/plugins/resque_uuid.rb

@@ -10,7 +10,7 @@ module Resque
         old_after_fork = Resque.after_fork
 
         Resque.after_fork do |job|
-          job.payload_class.uuid = job.payload['uuid'] if job.payload_class.respond_to?(:uuid=)
+          job.payload_class.uuid = job.uuid if job.payload_class.respond_to?(:uuid=)
           old_after_fork.call(job) if old_after_fork
         end
       end

data/lib/resque/plugins/resque_uuid/job_extensions.rb

@@ -4,7 +4,7 @@ module Resque
 
       module JobExtensions
         def uuid
-          self.payload['uuid']
+          self.payload[:uuid] || self.payload['uuid']
         end
       end
 

data/lib/resque/plugins/resque_uuid/resque_extensions.rb

@@ -5,14 +5,32 @@ module Resque
     module ResqueUUID
 
       module ResqueExtensions
+
         def self.extended(extender)
           extender.send(:alias_method, :push_without_uuid, :push)
         end
 
         def push(queue, item)
-          item['uuid'] = UUIDTools::UUID.random_create.to_s if item.respond_to?(:[]=)
+          uuid_generated = false
+
+          old_uuid = (item[:uuid] || item['uuid']).to_s.strip
+
+          # don't overwrite existing uuids
+          if item.respond_to?(:[]=) && (old_uuid.size == 0)
+            item[:uuid] = UUIDTools::UUID.random_create.to_s
+            uuid_generated = true
+          end
+
+
+          ret = push_without_uuid(queue, item)
+
+          # TODO (davebenvenuti 6/17/2012) the resque push method has no knowledge of the payload class, so this seems a bit sloppy.  However, I couldn't think of a better way to do it
+          if uuid_generated
+            payload_class = Util.constantize(item[:class] || item['class']) rescue nil
+            payload_class.after_uuid_generated(item[:uuid], *item[:args]) if payload_class && payload_class.respond_to?(:after_uuid_generated)
+          end
 
-          push_without_uuid(queue, item)
+          ret
         end
 
       end

data/lib/resque/plugins/resque_uuid/util.rb

@@ -0,0 +1,67 @@
+module Resque
+  module Plugins
+    module ResqueUUID
+
+      module Util
+        extend self
+
+        # Ruby 1.9 introduces an inherit argument for Module#const_get and
+        # #const_defined? and changes their default behavior.
+        if Module.method(:const_get).arity == 1
+          # Tries to find a constant with the name specified in the argument string:
+          #
+          #   "Module".constantize     # => Module
+          #   "Test::Unit".constantize # => Test::Unit
+          #
+          # The name is assumed to be the one of a top-level constant, no matter whether
+          # it starts with "::" or not. No lexical context is taken into account:
+          #
+          #   C = 'outside'
+          #   module M
+          #     C = 'inside'
+          #     C               # => 'inside'
+          #     "C".constantize # => 'outside', same as ::C
+          #   end
+          #
+          # NameError is raised when the name is not in CamelCase or the constant is
+          # unknown.
+          def constantize(camel_cased_word)
+            camel_cased_word = camel_cased_word.to_s
+
+            if camel_cased_word.include?('-')
+              camel_cased_word = classify(camel_cased_word)
+            end
+
+            names = camel_cased_word.split('::')
+            names.shift if names.empty? || names.first.empty?
+
+            constant = Object
+            names.each do |name|
+              constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+            end
+            constant
+          end
+        else
+          def constantize(camel_cased_word) #:nodoc:
+            camel_cased_word = camel_cased_word.to_s
+
+            if camel_cased_word.include?('-')
+              camel_cased_word = classify(camel_cased_word)
+            end
+
+            names = camel_cased_word.split('::')
+            names.shift if names.empty? || names.first.empty?
+
+            constant = Object
+            names.each do |name|
+              constant = constant.const_defined?(name, false) ? constant.const_get(name) : constant.const_missing(name)
+            end
+            constant
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/resque-uuid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "resque-uuid"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["davebenvenuti"]
-  s.date = "2012-06-17"
+  s.date = "2012-06-18"
   s.email = "davebenvenuti@gmail.com"
   s.extra_rdoc_files = [
     "README.md"
@@ -24,10 +24,12 @@ Gem::Specification.new do |s|
     "lib/resque/plugins/resque_uuid.rb",
     "lib/resque/plugins/resque_uuid/job_extensions.rb",
     "lib/resque/plugins/resque_uuid/resque_extensions.rb",
+    "lib/resque/plugins/resque_uuid/util.rb",
     "resque-uuid.gemspec",
     "test/redis-test.conf",
     "test/resque/plugins/resque_uuid/job_extensions_test.rb",
     "test/resque/plugins/resque_uuid/resque_extensions_test.rb",
+    "test/resque/plugins/resque_uuid/util_test.rb",
     "test/resque/plugins/resque_uuid_test.rb",
     "test/test_helper.rb"
   ]

data/test/resque/plugins/resque_uuid/resque_extensions_test.rb

@@ -1,5 +1,24 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "../../../test_helper"))
 
+class FakeJobClass
+
+  def self.after_uuid_generated(uuid, *args)
+    @passed_uuid = uuid
+    @passed_args = args
+  end
+
+  def self.passed_uuid
+    @passed_uuid
+  end
+
+  def self.passed_args
+    @passed_args
+  end
+end
+
+class FakeJobClassNoUUIDCallback
+end
+
 class ResqueExtensionsTest < Test::Unit::TestCase
   class << self
     # we need to startup and shutdown a redis server for this test case so we can enqueue resque push/pop still work properly
@@ -12,17 +31,55 @@ class ResqueExtensionsTest < Test::Unit::TestCase
     end
   end
 
+  setup do
+    # clear out resque queues each run
+    Resque.redis.flushall
+  end
+
   should "add a uuid to job payload when pushed" do
     test_uuid = UUIDTools::UUID.random_create
-    UUIDTools::UUID.expects(:random_create).returns(test_uuid)
+    UUIDTools::UUID.stubs(:random_create).returns(test_uuid)
 
-    fake_payload = { 'payload' => 'blah' }
+    Resque.push :my_queue, { :payload => 'blah' }
 
-    Resque.push :my_queue, fake_payload
+    assert_equal({ 'payload' => 'blah', 'uuid' => test_uuid.to_s }, Resque.pop(:my_queue))
+  end
+
+  should "call after_uuid_generated method defined on payload class" do
+    test_uuid = UUIDTools::UUID.random_create
+    UUIDTools::UUID.stubs(:random_create).returns(test_uuid)
 
-    popped = Resque.pop :my_queue
+    Resque.push :my_queue, { :class => FakeJobClass.to_s, :args => [1,2,3] }
+
+    assert_equal({ 'class' => FakeJobClass.to_s, 'args' => [1,2,3], 'uuid' => test_uuid.to_s }, Resque.pop(:my_queue))
+    assert_equal test_uuid.to_s, FakeJobClass.passed_uuid
+    assert_equal [1,2,3], FakeJobClass.passed_args
+  end
+
+  should "not call after_uuid_generated if payload class doesn't define one" do
+    test_uuid = UUIDTools::UUID.random_create
+    UUIDTools::UUID.stubs(:random_create).returns(test_uuid)
+
+    assert_nothing_raised do
+      Resque.push :my_queue, { :class => FakeJobClassNoUUIDCallback.to_s }
+    end
+
+    assert_equal({ 'class' => FakeJobClassNoUUIDCallback.to_s, 'uuid' => test_uuid.to_s }, Resque.pop(:my_queue))
+  end
+
+  should "not overwrite an existing uuid" do
+    UUIDTools::UUID.expects(:random_create).never
+
+    Resque.push :my_queue, { :class => FakeJobClassNoUUIDCallback.to_s, :uuid => 'my_unique_id' }
+
+    assert_equal({ 'class' => FakeJobClassNoUUIDCallback.to_s, 'uuid' => 'my_unique_id' }, Resque.pop(:my_queue))
+  end
+
+  should "not call after_uuid_generated if a new uuid wasn't generated" do
+    test_uuid = UUIDTools::UUID.random_create
+    FakeJobClass.expects(:after_uuid_generated).never
 
-    assert_equal fake_payload.merge('uuid' => test_uuid.to_s), popped
+    Resque.push :my_queue, { :class => FakeJobClassNoUUIDCallback.to_s, 'uuid' => 'my_unique_id' }
   end
 
 end

data/test/resque/plugins/resque_uuid/util_test.rb

@@ -0,0 +1,9 @@
+class UtilTest < Test::Unit::TestCase
+
+  should "constantize" do
+
+    assert_equal Resque::Plugins::ResqueUUID::JobExtensions, Resque::Plugins::ResqueUUID::Util.constantize('Resque::Plugins::ResqueUUID::JobExtensions')
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-uuid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-17 00:00:00.000000000 Z
+date: 2012-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &25018580 !ruby/object:Gem::Requirement
+  requirement: &33074480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *25018580
+  version_requirements: *33074480
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &25017980 !ruby/object:Gem::Requirement
+  requirement: &33073860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *25017980
+  version_requirements: *33073860
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &25017360 !ruby/object:Gem::Requirement
+  requirement: &33072900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *25017360
+  version_requirements: *33072900
 - !ruby/object:Gem::Dependency
   name: uuidtools
-  requirement: &25016680 !ruby/object:Gem::Requirement
+  requirement: &33072260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *25016680
+  version_requirements: *33072260
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &25015720 !ruby/object:Gem::Requirement
+  requirement: &33071780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -65,7 +65,7 @@ dependencies:
         version: 1.13.0
   type: :runtime
   prerelease: false
-  version_requirements: *25015720
+  version_requirements: *33071780
 description: 
 email: davebenvenuti@gmail.com
 executables: []
@@ -82,10 +82,12 @@ files:
 - lib/resque/plugins/resque_uuid.rb
 - lib/resque/plugins/resque_uuid/job_extensions.rb
 - lib/resque/plugins/resque_uuid/resque_extensions.rb
+- lib/resque/plugins/resque_uuid/util.rb
 - resque-uuid.gemspec
 - test/redis-test.conf
 - test/resque/plugins/resque_uuid/job_extensions_test.rb
 - test/resque/plugins/resque_uuid/resque_extensions_test.rb
+- test/resque/plugins/resque_uuid/util_test.rb
 - test/resque/plugins/resque_uuid_test.rb
 - test/test_helper.rb
 homepage: http://github.com/davebenvenuti/resque-uuid