rekiq 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 482599a4667b43c5690d7a4232e0ae3d87f2c4fd
-  data.tar.gz: 9964d52d551ed769dada46c3ab8427f77465c8ff
+  metadata.gz: 1d548839b06922aae376dd135b36f42129b5e05e
+  data.tar.gz: 878fdd5c73c1943c47727071040194a310c82d83
 SHA512:
-  metadata.gz: 34104c582240196d8effd91b0ea5ae48f9d43beb0e7fba9ba5fe8db2e93b17f4269488a947967f5f0f7ebb8d3bf43801e5239db29d8e1ff2ee8033b73e6b0132
-  data.tar.gz: 71f5c7c77a0934bea52bfba4f0913e3ef86260b1ba657e0cf28cce45d29b9e8933ca1803b29768f36422e497436e5b83bd8bb2525fa85438feea242e15c2b3f2
+  metadata.gz: ae761311a5dc7ce345d52e4c357d8cd0585e555fbb07b927873e8552c1955791ff7df0ed529155024bb1b8f448728bb78b2971d11a745decb00191326c7abef0
+  data.tar.gz: c801e761d166e54589d8a5120850b1ba5ce3479e2e2cda5b75283e73469d27b1ee8c4b2201ae9bdd8b46d1c5410cdaf1c3ec7660f22fbbcc8c3eea668b73b0d7

data/example/test_app.rb

@@ -4,17 +4,24 @@
 require 'ice_cube'
 require 'sidekiq'
 require 'rekiq'
+require 'pry'
 
 # define sidekiq worker as you normally would
 class TestWorker1
   include Sidekiq::Worker
 
-  sidekiq_options queue: "rekiq_test_worker", retry: 3
+  sidekiq_options queue: "rekiq_test_worker",
+                  retry: 3,
+                  rekiq_cancel_method: :cancel
 
   def perform(arg1, arg2)
-    puts "\n\nhello from TestWorker1, arg1 is #{arg1}, arg2 is #{arg2}" \
+    puts "\nhello from TestWorker1, arg1 is #{arg1}, arg2 is #{arg2} " \
          "scheduled work time was #{scheduled_work_time}\n\n"
   end
+
+  def cancel(arg1)
+    puts "\ncancel method invoked with arg #{arg1}\n\n"
+  end
 end
 
 # create ice cube schedule
@@ -24,7 +31,9 @@ schedule = IceCube::Schedule.new(Time.now) do |s|
 
 # invoke method
 TestWorker1.perform_recurringly(
-  schedule,
-  ['Rekiq', 'ola', '!!!'],
-  { 'complex' => { 'hash' => 'woot!' } }
-)
+    schedule,
+    ['Rekiq', 'ola', '!!!'],
+    { 'complex' => { 'hash' => 'woot!' } }
+  ) do |config|
+    config.rekiq_cancel_args 1
+  end

data/lib/rekiq/exceptions.rb

@@ -2,5 +2,6 @@ module Rekiq
   class StandardError < ::StandardError; end
   class SidekiqNotLoaded < StandardError; end
   class InvalidAttributeValue < StandardError; end
-  class CancellerMethodMissing < StandardError; end
+  class CancelMethodMissing < StandardError; end
+  class CancelMethodInvocationError < StandardError; end
 end

data/lib/rekiq/middleware/work_overseer.rb

@@ -13,9 +13,8 @@ module Rekiq
 
         setup_vars(worker, msg, queue)
 
-        if !@canceller_name.nil? and
-           worker.send(@canceller_name, *@canceller_args)
-          return logger.info 'worker canceled by recurrence canceller'
+        if cancel_worker?
+          return logger.info 'worker canceled by rekiq cancel method'
         end
 
         return yield unless msg.key?('rq:schdlr')
@@ -33,8 +32,9 @@ module Rekiq
     protected
 
       def setup_vars(worker, msg, queue)
-        @canceller_name = worker.recurrence_canceller_name
-        @canceller_args = msg['rq:ca']
+        @cancel_method = worker.rekiq_cancel_method
+        @cancel_args   = msg['rq:ca']
+        @worker      = worker
         @worker_name = worker.class.name
         @queue       = queue
         @args        = msg['args']
@@ -43,10 +43,19 @@ module Rekiq
         @scheduled_work_time = Time.at(msg['rq:at'].to_f)
       end
 
+      def cancel_worker?
+        !@cancel_method.nil? and @worker.send(@cancel_method, *@cancel_args)
+      rescue StandardError => s
+        raise CancelMethodInvocationError,
+              "error while invoking rekiq_cancel_method with message " \
+              "#{s.message}",
+              s.backtrace
+      end
+
       def reschedule
         jid, work_time =
           Rekiq::Scheduler
-            .new(@worker_name, @queue, @args, @job, @addon, @canceller_args)
+            .new(@worker_name, @queue, @args, @job, @addon, @cancel_args)
             .schedule_from_work_time(@scheduled_work_time)
 
         unless jid.nil?

data/lib/rekiq/scheduler.rb

@@ -1,12 +1,12 @@
 module Rekiq
   class Scheduler
-    def initialize(worker_name, queue, args, job, addon, canceller_args)
+    def initialize(worker_name, queue, args, job, addon, cancel_args)
       @worker_name = worker_name
       @queue       = queue
       @args        = args
       @job         = job
       @addon       = addon
-      @canceller_args = canceller_args
+      @cancel_args = cancel_args
     end
 
     def schedule(from = Time.now)
@@ -34,7 +34,7 @@ module Rekiq
           'rq:schdlr' => nil
         }.tap do |hash|
           hash['rq:addon'] = @addon unless @addon.nil?
-          hash['rq:ca']    = @canceller_args unless @canceller_args.nil?
+          hash['rq:ca']    = @cancel_args unless @cancel_args.nil?
         end
 
       Sidekiq::Client.push(client_args)

data/lib/rekiq/version.rb

@@ -1,3 +1,3 @@
 module Rekiq
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

data/lib/rekiq/worker.rb

@@ -6,10 +6,10 @@ module Rekiq
   module Worker
     class Configuration
       attr_accessor :shift, :schedule_post_work, :schedule_expired,
-                    :expiration_margin, :addon, :recurrence_canceller_args
+                    :expiration_margin, :addon, :cancel_args
 
-      def recurrence_canceller_args(*args)
-        self.recurrence_canceller_args = args
+      def rekiq_cancel_args(*args)
+        @cancel_args = args
       end
     end
 
@@ -34,7 +34,7 @@ module Rekiq
 
         jid, work_time =
           Rekiq::Scheduler
-            .new(name, queue, args, job, @config.addon, @config.recurrence_canceller_args)
+            .new(name, queue, args, job, @config.addon, @config.cancel_args)
             .schedule
 
         if jid.nil?
@@ -46,18 +46,18 @@ module Rekiq
         jid
       end
 
-      def recurrence_canceller_name
-        get_sidekiq_options['recurrence_canceller_name']
+      def rekiq_cancel_method
+        get_sidekiq_options['rekiq_cancel_method']
       end
 
     protected
 
       def validate!
-        unless recurrence_canceller_name.nil? or
-               self.method_defined?(recurrence_canceller_name)
-          raise CancellerMethodMissing,
-                'recurrence canceller method name defined as '                 \
-                "#{recurrence_canceller_name}, but worker does not have "    \
+        unless rekiq_cancel_method.nil? or
+               self.method_defined?(rekiq_cancel_method)
+          raise CancelMethodMissing,
+                'rekiq cancel method name defined as '                         \
+                "#{rekiq_cancel_method}, but worker does not have "            \
                 'a method with that name, either remove definition or define ' \
                 'missing method'
         end
@@ -77,8 +77,8 @@ module Sidekiq
       base.extend(Rekiq::Worker::ClassMethods)
     end
 
-    def recurrence_canceller_name
-      self.class.recurrence_canceller_name
+    def rekiq_cancel_method
+      self.class.rekiq_cancel_method
     end
   end
 end

data/rekiq.gemspec

@@ -9,9 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["junhanamaki"]
   spec.email         = ["jun.hanamaki@gmail.com"]
   spec.summary       = %q{Recurring worker extension for Sidekiq}
-  spec.description   = %q{Rekiq extends Sidekiq so that we can schedule
-                          recurring workers, check homepage for
-                          more details.}
+  spec.description   = %q{Rekiq extends Sidekiq to allow the scheduling of
+                          recurring workers}
   spec.homepage      = "https://github.com/junhanamaki/rekiq"
   spec.license       = "MIT"
 
@@ -25,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0.9'
-  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.3'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
   spec.add_development_dependency 'factory_girl', '~> 4.4'
   spec.add_development_dependency 'jazz_hands', '~> 0.5'
   spec.add_development_dependency 'ice_cube', '~> 0.12'

data/spec/rekiq/middleware/work_overseer_spec.rb

@@ -11,7 +11,7 @@ describe Rekiq::Middleware::WorkOverseer do
     include Sidekiq::Worker
 
     sidekiq_options queue: 'work_overseer_test_worker',
-                    recurrence_canceller_name: :cancel
+                    rekiq_cancel_method: :cancel
 
     def cancel(bool)
       bool
@@ -24,7 +24,7 @@ describe Rekiq::Middleware::WorkOverseer do
     let(:job)      { build(:job, schedule: schedule) }
     let(:overseer) { Rekiq::Middleware::WorkOverseer.new }
 
-    context 'worker does not have recurrence_canceller_name set' do
+    context 'worker does not have rekiq_cancel_method set' do
       let(:worker)   { WorkOverseerTestWorker.new }
       let(:queue)    { WorkOverseerTestWorker.get_sidekiq_options['queue'] }
 
@@ -80,7 +80,7 @@ describe Rekiq::Middleware::WorkOverseer do
       end
     end
 
-    context 'worker has recurrence_canceller_name method set' do
+    context 'worker has rekiq_cancel_method method set' do
       let(:worker) { WorkOverseerCancelTestWorker.new }
       let(:queue)  { WorkOverseerCancelTestWorker.get_sidekiq_options['queue'] }
 
@@ -95,7 +95,7 @@ describe Rekiq::Middleware::WorkOverseer do
           end.not_to yield_control
         end
 
-        it 'does not scheduler worker' do
+        it 'does not schedule worker' do
           expect(WorkOverseerCancelTestWorker.jobs.count).to eq(0)
         end
       end
@@ -105,11 +105,27 @@ describe Rekiq::Middleware::WorkOverseer do
           { 'rq:job' => job.to_array, 'args' => args, 'rq:ca' => false }
         end
 
-        it 'does yield' do
+        it 'yields given block' do
           expect do |b|
             overseer.call(worker, msg, queue, &b)
           end.to yield_control.once
         end
+
+        it 'does not schedule worker' do
+          expect(WorkOverseerCancelTestWorker.jobs.count).to eq(0)
+        end
+      end
+
+      context 'msg with rq:ca key with different arity from cancel method' do
+        let(:msg) do
+          { 'rq:job' => job.to_array, 'args' => args, 'rq:ca' => [true, true] }
+        end
+
+        it 'raises error' do
+          expect do |b|
+            overseer.call(worker, msg, queue, &b)
+          end.to raise_error
+        end
       end
     end
   end

data/spec/rekiq/scheduler_spec.rb

@@ -46,7 +46,7 @@ describe Rekiq::Scheduler do
           end
         end
 
-        context 'given nil as canceller_args' do
+        context 'given nil as rekiq_cancel_args' do
           it 'creates sidekiq job' do
             expect(SchedulerTestWorker.jobs.count).to eq(1)
           end
@@ -56,7 +56,7 @@ describe Rekiq::Scheduler do
           end
         end
 
-        context 'given non empty array as canceller_args' do
+        context 'given non empty array as rekiq_cancel_args' do
           let(:c_args) { [1, 2, 3] }
 
           it 'creates sidekiq job' do

data/spec/rekiq/worker_spec.rb

@@ -7,20 +7,20 @@ describe Rekiq::Worker do
     include Sidekiq::Worker
   end
 
-  class CancellerUndefinedExampleWorker
+  class RekiqCancelMethodUndefinedExampleWorker
     include Sidekiq::Worker
-    sidekiq_options recurrence_canceller_name: :cancel
+    sidekiq_options rekiq_cancel_method: :cancel
   end
 
-  class CancellerDefinedExampleWorker
+  class RekiqCancelMethodDefinedExampleWorker
     include Sidekiq::Worker
-    sidekiq_options recurrence_canceller_name: :cancel
+    sidekiq_options rekiq_cancel_method: :cancel
 
     def cancel
     end
   end
 
-  context 'Class includes Sidekiq::Worker module' do
+  context 'class includes Sidekiq::Worker module' do
     it 'responds to perform_recurringly' do
       ExampleWorker.respond_to? :perform_recurringly
     end
@@ -45,36 +45,36 @@ describe Rekiq::Worker do
         let(:time)     { Time.now + 3600 }
         let(:schedule) { IceCube::Schedule.new(time) }
 
-        context 'for worker with recurrence_canceller_name set with ' \
+        context 'for worker with rekiq_cancel_method set with ' \
                 'non defined method' do
           before do
             begin
               @jid =
-                CancellerUndefinedExampleWorker.perform_recurringly(schedule)
+                RekiqCancelMethodUndefinedExampleWorker.perform_recurringly(schedule)
             rescue
             end
           end
 
           it 'raises error' do
             expect do
-              CancellerUndefinedExampleWorker.perform_recurringly(schedule)
+              RekiqCancelMethodUndefinedExampleWorker.perform_recurringly(schedule)
             end.to raise_error
           end
 
           it 'does not schedule worker' do
-            expect(CancellerUndefinedExampleWorker.jobs.count).to eq(0)
+            expect(RekiqCancelMethodUndefinedExampleWorker.jobs.count).to eq(0)
           end
         end
 
-        context 'for worker with recurrence_canceller_name set with ' \
+        context 'for worker with rekiq_cancel_method set with ' \
                 'defined method' do
           before do
-            @jid = CancellerDefinedExampleWorker.perform_recurringly(schedule)
+            @jid = RekiqCancelMethodDefinedExampleWorker.perform_recurringly(schedule)
           end
 
           it 'does not raise error' do
             expect do
-              CancellerDefinedExampleWorker.perform_recurringly(schedule)
+              RekiqCancelMethodDefinedExampleWorker.perform_recurringly(schedule)
             end.not_to raise_error
           end
 
@@ -83,11 +83,11 @@ describe Rekiq::Worker do
           end
 
           it 'schedules worker' do
-            expect(CancellerDefinedExampleWorker.jobs.count).to eq(1)
+            expect(RekiqCancelMethodDefinedExampleWorker.jobs.count).to eq(1)
           end
 
           it 'schedules worker for one hour from now' do
-            expect(CancellerDefinedExampleWorker.jobs[0]['at']).to eq(time.to_f)
+            expect(RekiqCancelMethodDefinedExampleWorker.jobs[0]['at']).to eq(time.to_f)
           end
         end
 
@@ -109,8 +109,55 @@ describe Rekiq::Worker do
           end
         end
 
+        context 'rekiq_cancel_args with 2 arguments' do
+          let(:rekiq_cancel_args) { ['args1', 'args2'] }
+          before do
+            @jid = ExampleWorker.perform_recurringly(schedule) do |config|
+                config.rekiq_cancel_args *rekiq_cancel_args
+              end
+          end
+
+          it 'returns created job id' do
+            expect(@jid).not_to be_nil
+          end
+
+          it 'schedules worker' do
+            expect(ExampleWorker.jobs.count).to eq(1)
+          end
+
+          it 'yields once if block given' do
+            expect do |b|
+              ExampleWorker.perform_recurringly(schedule, &b)
+            end.to yield_control.once
+          end
+
+          it 'creates key rq:ca in job hash' do
+            expect(ExampleWorker.jobs[0].key?('rq:ca')).to eq(true)
+          end
+
+          describe 'value under rq:ca key in job hash' do
+            let(:value) { ExampleWorker.jobs[0]['rq:ca'] }
+
+            it 'is an array' do
+              expect(value.class).to eq(Array)
+            end
+
+            it 'has count equal to number of rekiq_cancel_args' do
+              expect(value.count).to eq(rekiq_cancel_args.count)
+            end
+
+            it 'has first element equal to first arg in rekiq_cancel_args' do
+              expect(value[0]).to eq(rekiq_cancel_args[0])
+            end
+
+            it 'has second element equal to second arg in rekiq_cancel_args' do
+              expect(value[1]).to eq(rekiq_cancel_args[1])
+            end
+          end
+        end
+
         context 'shift set to minus 5 minutes' do
-          let(:shift)    { -5 * 60 }
+          let(:shift) { -5 * 60 }
           before do
             @jid = ExampleWorker.perform_recurringly(schedule) do |config|
                 config.shift = shift
@@ -125,13 +172,13 @@ describe Rekiq::Worker do
             expect(ExampleWorker.jobs.count).to eq(1)
           end
 
-          it 'yields once' do
+          it 'yields once if block given' do
             expect do |b|
               ExampleWorker.perform_recurringly(schedule, &b)
             end.to yield_control.once
           end
 
-          it 'sets shift in rq:job' do
+          it 'sets shift in position 1 of array under key rq:job' do
             array = ExampleWorker.jobs[0]['rq:job']
 
             expect(array[1]).to eq(shift)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rekiq
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - junhanamaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-01 00:00:00.000000000 Z
+date: 2014-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
@@ -123,9 +123,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 description: |-
-  Rekiq extends Sidekiq so that we can schedule
-                            recurring workers, check homepage for
-                            more details.
+  Rekiq extends Sidekiq to allow the scheduling of
+                            recurring workers
 email:
 - jun.hanamaki@gmail.com
 executables: []