rekiq 0.7.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ab17f1066259e1b4fce0a5391f53892d24623f8
-  data.tar.gz: 8e5c4948b2489f7da947a1b217f795f9fdf350b6
+  metadata.gz: 482599a4667b43c5690d7a4232e0ae3d87f2c4fd
+  data.tar.gz: 9964d52d551ed769dada46c3ab8427f77465c8ff
 SHA512:
-  metadata.gz: 6753e66d5b3e4163949f5f53d2078d6d40c300ae626db977c0a4acc3729114a1726bffbfee2fa7e7806d29cc528e061ed4e0f7354799be1beaf3fa7b7451b276
-  data.tar.gz: 919abea474e6f00c19ac3b78a9c9ba1bc84a8bf05dc7982faa55667a1090fa11cafd9b41b905325971b5880d226da0bda16da62efc3aaf9b7ee083173bff88d5
+  metadata.gz: 34104c582240196d8effd91b0ea5ae48f9d43beb0e7fba9ba5fe8db2e93b17f4269488a947967f5f0f7ebb8d3bf43801e5239db29d8e1ff2ee8033b73e6b0132
+  data.tar.gz: 71f5c7c77a0934bea52bfba4f0913e3ef86260b1ba657e0cf28cce45d29b9e8933ca1803b29768f36422e497436e5b83bd8bb2525fa85438feea242e15c2b3f2

data/README.md

@@ -71,7 +71,7 @@ For our example we'll be using the gem [ice_cube](https://github.com/seejohnrun/
         # now just start your worker
         ExampleWorker.perform_recurringly(schedule, 'argument_1', 'argument_2')
 
-    And that's it! Now the worker will run every friday as 2am.
+And that's it! Now the worker will run every friday as 2am.
 
 You can use your own schedule object, configure worker to schedule before or
 after work is done, set a margin, and much more! So please feel free to check
@@ -79,7 +79,7 @@ after work is done, set a margin, and much more! So please feel free to check
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/rekiq/fork )
+1. Fork it ( https://github.com/junhanamaki/rekiq/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/example/test_app.rb

@@ -9,7 +9,7 @@ require 'rekiq'
 class TestWorker1
   include Sidekiq::Worker
 
-  sidekiq_options queue: "rekiq_test_worker", retry: false
+  sidekiq_options queue: "rekiq_test_worker", retry: 3
 
   def perform(arg1, arg2)
     puts "\n\nhello from TestWorker1, arg1 is #{arg1}, arg2 is #{arg2}" \

data/lib/rekiq/middleware/work_overseer.rb

@@ -9,15 +9,19 @@ module Rekiq
       include ::Sidekiq::Util
 
       def call(worker, msg, queue)
-        return yield unless msg['rq:job'] and msg['retry_count'].nil?
+        return yield unless msg.key?('rq:job')
 
         setup_vars(worker, msg, queue)
 
         if !@canceller_name.nil? and
            worker.send(@canceller_name, *@canceller_args)
-           return logger.info 'worker canceled by rekiq_canceller'
+          return logger.info 'worker canceled by recurrence canceller'
         end
 
+        return yield unless msg.key?('rq:schdlr')
+
+        msg.delete('rq:schdlr')
+
         begin
           reschedule unless @job.schedule_post_work?
           yield
@@ -29,7 +33,7 @@ module Rekiq
     protected
 
       def setup_vars(worker, msg, queue)
-        @canceller_name = worker.rekiq_canceller_name
+        @canceller_name = worker.recurrence_canceller_name
         @canceller_args = msg['rq:ca']
         @worker_name = worker.class.name
         @queue       = queue

data/lib/rekiq/scheduler.rb

@@ -31,9 +31,10 @@ module Rekiq
           'args'   => @args,
           'rq:job' => @job.to_array,
           'rq:at'  => @work_time.to_f,
+          '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']    = @canceller_args unless @canceller_args.nil?
         end
 
       Sidekiq::Client.push(client_args)

data/lib/rekiq/version.rb

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

data/lib/rekiq/worker.rb

@@ -6,20 +6,14 @@ module Rekiq
   module Worker
     class Configuration
       attr_accessor :shift, :schedule_post_work, :schedule_expired,
-                    :expiration_margin, :addon, :canceller_args
+                    :expiration_margin, :addon, :recurrence_canceller_args
 
-      def rekiq_canceller_args(*args)
-        self.canceller_args = args
+      def recurrence_canceller_args(*args)
+        self.recurrence_canceller_args = args
       end
     end
 
     module ClassMethods
-      attr_reader :canceller_name
-
-      def rekiq_canceller(method_name)
-        @canceller_name = method_name
-      end
-
       def perform_recurringly(schedule, *args)
         @config = Configuration.new
         yield @config if block_given?
@@ -40,7 +34,7 @@ module Rekiq
 
         jid, work_time =
           Rekiq::Scheduler
-            .new(name, queue, args, job, @config.addon, @config.canceller_args)
+            .new(name, queue, args, job, @config.addon, @config.recurrence_canceller_args)
             .schedule
 
         if jid.nil?
@@ -52,15 +46,20 @@ module Rekiq
         jid
       end
 
+      def recurrence_canceller_name
+        get_sidekiq_options['recurrence_canceller_name']
+      end
+
     protected
 
       def validate!
-        unless canceller_name.nil? or
-               self.method_defined?(canceller_name)
+        unless recurrence_canceller_name.nil? or
+               self.method_defined?(recurrence_canceller_name)
           raise CancellerMethodMissing,
-                "rekiq_canceller method defined as #{canceller_name} " \
-                'but worker does not have a method with that name, either ' \
-                'remove rekiq_canceller or define missing method'
+                'recurrence canceller method name defined as '                 \
+                "#{recurrence_canceller_name}, but worker does not have "    \
+                'a method with that name, either remove definition or define ' \
+                'missing method'
         end
       end
     end
@@ -78,8 +77,8 @@ module Sidekiq
       base.extend(Rekiq::Worker::ClassMethods)
     end
 
-    def rekiq_canceller_name
-      self.class.canceller_name
+    def recurrence_canceller_name
+      self.class.recurrence_canceller_name
     end
   end
 end

data/rekiq.gemspec

@@ -8,8 +8,10 @@ Gem::Specification.new do |spec|
   spec.version       = Rekiq::VERSION
   spec.authors       = ["junhanamaki"]
   spec.email         = ["jun.hanamaki@gmail.com"]
-  spec.summary       = %q{recurring worker extension for sidekiq}
-  spec.description   = %q{}
+  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.homepage      = "https://github.com/junhanamaki/rekiq"
   spec.license       = "MIT"
 

data/spec/factories/configuration.rb

@@ -1,8 +1,8 @@
 FactoryGirl.define do
   factory :configuration, class: Rekiq::Configuration do
-    shift { [*-100..100].sample }
-    schedule_post_work { [true, false].sample }
-    expiration_margin  { [*0..100].sample }
-    schedule_expired   { [true, false].sample }
+    shift              [*-100..100].sample
+    schedule_post_work [true, false].sample
+    expiration_margin  [*0..100].sample
+    schedule_expired   [true, false].sample
   end
 end

data/spec/factories/job.rb

@@ -3,13 +3,13 @@ require 'ice_cube'
 FactoryGirl.define do
   factory :job, class: Rekiq::Job do
     shift    0
-    schedule { IceCube::Schedule.new(Time.now + 3600) }
+    schedule IceCube::Schedule.new(Time.now + 3600)
 
     trait :randomized_attributes do
-      shift              { [*0..100].sample }
-      schedule_post_work { [nil, false, true].sample }
-      schedule_expired   { [nil, false, true].sample }
-      expiration_margin  { [*0..100].sample }
+      shift              [*0..100].sample
+      schedule_post_work [nil, false, true].sample
+      schedule_expired   [nil, false, true].sample
+      expiration_margin  [*0..100].sample
     end
   end
 end

data/spec/rekiq/middleware/work_overseer_spec.rb

@@ -10,8 +10,8 @@ describe Rekiq::Middleware::WorkOverseer do
   class WorkOverseerCancelTestWorker
     include Sidekiq::Worker
 
-    sidekiq_options queue: 'work_overseer_test_worker'
-    rekiq_canceller :cancel
+    sidekiq_options queue: 'work_overseer_test_worker',
+                    recurrence_canceller_name: :cancel
 
     def cancel(bool)
       bool
@@ -24,12 +24,15 @@ describe Rekiq::Middleware::WorkOverseer do
     let(:job)      { build(:job, schedule: schedule) }
     let(:overseer) { Rekiq::Middleware::WorkOverseer.new }
 
-    context 'worker does not have rekiq_canceller set' do
+    context 'worker does not have recurrence_canceller_name set' do
       let(:worker)   { WorkOverseerTestWorker.new }
       let(:queue)    { WorkOverseerTestWorker.get_sidekiq_options['queue'] }
 
-      context 'msg with rq:job key (existing job)' do
-        let(:msg) { { 'rq:job' => job.to_array, 'args' => args } }
+      context 'msg with rq:job key (existing job), ' \
+              'with rq:schdlr key (value is irrelevant)' do
+        let(:msg) do
+          { 'rq:job' => job.to_array, 'args' => args, 'rq:schdlr' => nil }
+        end
 
         it 'yields once' do
           expect do |b|
@@ -42,6 +45,12 @@ describe Rekiq::Middleware::WorkOverseer do
 
           expect(WorkOverseerTestWorker.jobs.count).to eq(1)
         end
+
+        it 'removes key rq:schdlr from message after invocation' do
+          overseer.call(worker, msg, queue) {}
+
+          expect(msg.key?('rq:schdlr')).to eq(false)
+        end
       end
 
       context 'msg without rq:job key' do
@@ -54,9 +63,8 @@ describe Rekiq::Middleware::WorkOverseer do
         end
       end
 
-      context 'msg with job retry info and rq:job (existing job)' do
-        let(:msg) { { 'rq:job' => job.to_array, 'retry_count' => 0,
-                      'args' => args } }
+      context 'msg without rq:schdlr and rq:job (existing job)' do
+        let(:msg) { { 'rq:job' => job.to_array, 'args' => args } }
 
         it 'yields once' do
           expect do |b|
@@ -64,7 +72,7 @@ describe Rekiq::Middleware::WorkOverseer do
           end.to yield_control.once
         end
 
-        it 'does not schedule work' do
+        it 'does not schedule next work' do
           overseer.call(worker, msg, queue) {}
 
           expect(WorkOverseerTestWorker.jobs.count).to eq(0)
@@ -72,7 +80,7 @@ describe Rekiq::Middleware::WorkOverseer do
       end
     end
 
-    context 'worker has rekiq_canceller method set' do
+    context 'worker has recurrence_canceller_name method set' do
       let(:worker) { WorkOverseerCancelTestWorker.new }
       let(:queue)  { WorkOverseerCancelTestWorker.get_sidekiq_options['queue'] }
 

data/spec/rekiq/worker_spec.rb

@@ -9,12 +9,12 @@ describe Rekiq::Worker do
 
   class CancellerUndefinedExampleWorker
     include Sidekiq::Worker
-    rekiq_canceller :cancel
+    sidekiq_options recurrence_canceller_name: :cancel
   end
 
   class CancellerDefinedExampleWorker
     include Sidekiq::Worker
-    rekiq_canceller :cancel
+    sidekiq_options recurrence_canceller_name: :cancel
 
     def cancel
     end
@@ -45,7 +45,8 @@ describe Rekiq::Worker do
         let(:time)     { Time.now + 3600 }
         let(:schedule) { IceCube::Schedule.new(time) }
 
-        context 'for worker with rekiq_canceller set with non defined method' do
+        context 'for worker with recurrence_canceller_name set with ' \
+                'non defined method' do
           before do
             begin
               @jid =
@@ -65,7 +66,8 @@ describe Rekiq::Worker do
           end
         end
 
-        context 'for worker with rekiq_canceller set with defined method' do
+        context 'for worker with recurrence_canceller_name set with ' \
+                'defined method' do
           before do
             @jid = CancellerDefinedExampleWorker.perform_recurringly(schedule)
           end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rekiq
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.1
 platform: ruby
 authors:
 - junhanamaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-21 00:00:00.000000000 Z
+date: 2014-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,7 +122,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-description: ''
+description: |-
+  Rekiq extends Sidekiq so that we can schedule
+                            recurring workers, check homepage for
+                            more details.
 email:
 - jun.hanamaki@gmail.com
 executables: []
@@ -183,7 +186,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: recurring worker extension for sidekiq
+summary: Recurring worker extension for Sidekiq
 test_files:
 - spec/factories/configuration.rb
 - spec/factories/job.rb