sidekiq-scheduler 1.0 → 1.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NTgyMGVlOTk3ZGM2ZjQ0ZWI0ZWFkNzViYTU1Mjg2N2ZiZGU4NmI5Mw==
-  data.tar.gz: !binary |-
-    ZDA0ZTJmZGU0ZDdlMDBmOGM0ODUxNWIyNDRkMjRjYmQ2ZTMyYjJmMw==
+SHA1:
+  metadata.gz: fe9ce1e132d1192efa54cb8ca59db66637bead8b
+  data.tar.gz: 067965f503c1a8460b15c46297e991d0476c5a53
 SHA512:
-  metadata.gz: !binary |-
-    ZDYxNjQ1ZGVlNGFlNjJiYWIxODQ0NTdkYTEyNDc2YmE4Zjk5MjUzYjdhOTk0
-    NjY2NDZjOWEyYTAyZTQzYjUyMTE5MmU2MzcxMmFjMzJkZWVkMmZhNzFjOTM4
-    ZDY4MTJhODMxZjE1MjgyZTgxM2NjMTYxNTJkMmFiMjhhMTk5MjQ=
-  data.tar.gz: !binary |-
-    MGU0ZDVmZmE0Yjk3YjRjZTFjOWE1YTA1MmM3M2E1YTI3MDFkODdhZDFlMWUz
-    MzliNWM1MzAyNWM2ZWY5YzUzMzc2NDNlMzA5M2UzYWFiY2ZhNTA3MmYwOTU0
-    M2RiYzU1ZTFlOTFjNDdmMDRkZjBiYTcxNWIzYjU3NTAwOTM5M2I=
+  metadata.gz: 72d123b5fa650afd26e87611411e30a029c4fd9af6e5f3904e1fde525c4793b61924c5e07005f1553b614bb614243c40406639505abe735613c21546e039240a
+  data.tar.gz: a6c10562e33e3c20a865fcbce2ddc280512549482719b2ad0d66750449f3ee9c57bc2c4a604e43055f227dff86f5b3cdeeab042a26d2faccce561daf518b2673

data/README.md

@@ -44,7 +44,7 @@ You can add sidekiq-scheduler configuration options to sidekiq.yml config file.
 Available options are:
 
     :schedule: <the schedule to be run>
-    :dynamic: <if true the schedule can we modified in runtime>
+    :dynamic: <if true the schedule can be modified in runtime>
 
 ## Scheduled Jobs (Recurring Jobs)
 
@@ -119,6 +119,18 @@ You can also put your schedule information inside sidekiq.yml and load it with:
 sidekiq -C ./config/sidekiq.yml
 ```
 
+#### The Spring preloader and Testing your initializer via Rails console
+
+If you're pulling in your schedule from a YML file via an initializer as shown, be aware that the Spring application preloader included with Rails will interefere with testing via the Rails console.
+
+**Spring will not reload initializers** unless the initializer is changed.  Therefore, if you're making a change to your YML schedule file and reloading Rails console to see the change, Spring will make it seem like your modified schedule is not being reloaded.
+
+To see your updated schedule, be sure to reload Spring by stopping it prior to booting the Rails console.
+
+Run `spring stop` to stop Spring.
+
+For more information, see [this issue](https://github.com/Moove-it/sidekiq-scheduler/issues/35#issuecomment-48067183) and [Spring's README](https://github.com/rails/spring/blob/master/README.md).
+
 ### Time zones
 
 Note that if you use the cron syntax, this will be interpreted as in the server time zone
@@ -164,4 +176,4 @@ MIT License
 
 Copyright 2013 Moove-IT
 Copyright 2012 Morton Jonuschat
-Some parts copyright 2010 Ben VandenBos
+Some parts copyright 2010 Ben VandenBos

data/lib/sidekiq-scheduler/version.rb

@@ -1,3 +1,3 @@
 module SidekiqScheduler
-  VERSION = '1.0'
-end
+  VERSION = '1.1'
+end

data/lib/sidekiq/scheduler.rb

@@ -7,8 +7,13 @@ module Sidekiq
   class Scheduler
     extend Sidekiq::Util
 
+    # We expect rufus jobs to have #params
+    Rufus::Scheduler::Job.module_eval do
+      alias_method :params, :opts
+    end
+
     class << self
-      # If set, will try to update the schulde in the loop
+      # If set, will try to update the schedule in the loop
       attr_accessor :dynamic
     end
 
@@ -77,7 +82,10 @@ module Sidekiq
           if !config[interval_type].nil? && config[interval_type].length > 0
             args = self.optionizate_interval_value(config[interval_type])
 
-            @@scheduled_jobs[name] = self.rufus_scheduler.send(interval_type, *args) do
+            # We want rufus_scheduler to return a job object, not a job id
+            opts = { :job => true }
+
+            @@scheduled_jobs[name] = self.rufus_scheduler.send(interval_type, *args, opts) do
               logger.info "queueing #{config['class']} (#{name})"
               config.delete(interval_type)
               self.handle_errors { self.enqueue_from_config(config) }
@@ -123,8 +131,16 @@ module Sidekiq
        Sidekiq::Client.push(config)
     end
 
+    def self.rufus_scheduler_options
+      @rufus_scheduler_options ||= {}
+    end
+
+    def self.rufus_scheduler_options=(options)
+      @rufus_scheduler_options = options
+    end
+
     def self.rufus_scheduler
-      @rufus_scheduler ||= Rufus::Scheduler.start_new
+      @rufus_scheduler ||= Rufus::Scheduler.new rufus_scheduler_options
     end
 
     # Stops old rufus scheduler and creates a new one.  Returns the new
@@ -167,4 +183,4 @@ module Sidekiq
     end
 
   end
-end
+end

data/test/lib/sidekiq/scheduler_test.rb

@@ -52,7 +52,7 @@ class ManagerTest < Minitest::Test
     end
 
     it 'config makes it into the rufus_scheduler' do
-      assert_equal(0, Sidekiq::Scheduler.rufus_scheduler.all_jobs.size)
+      assert_equal(0, Sidekiq::Scheduler.rufus_scheduler.jobs.size)
       Sidekiq.schedule = {
         :some_ivar_job => {
           'cron' => '* * * * *',
@@ -63,11 +63,19 @@ class ManagerTest < Minitest::Test
 
       Sidekiq::Scheduler.load_schedule!
 
-      assert_equal(1, Sidekiq::Scheduler.rufus_scheduler.all_jobs.size)
+      assert_equal(1, Sidekiq::Scheduler.rufus_scheduler.jobs.size)
       assert Sidekiq::Scheduler.scheduled_jobs.include?(:some_ivar_job)
     end
 
-    # THIS
+    it 'can pass options to the Rufus scheduler instance' do
+      options = { :lockfile => '/tmp/rufus_lock' }
+
+      Sidekiq::Scheduler.rufus_scheduler_options = options
+      Rufus::Scheduler.expects(:new).with(options)
+
+      Sidekiq::Scheduler.clear_schedule!
+    end
+
     it 'can reload schedule' do
       Sidekiq::Scheduler.dynamic = true
       Sidekiq.schedule = {
@@ -99,7 +107,7 @@ class ManagerTest < Minitest::Test
 
       Sidekiq::Scheduler.reload_schedule!
 
-      assert Sidekiq::Scheduler.scheduled_jobs.include?('some_ivar_job')
+      refute  Sidekiq::Scheduler.scheduled_jobs.include?('some_ivar_job')
       assert Sidekiq::Scheduler.scheduled_jobs.include?('some_ivar_job2')
 
       assert_equal '/tmp/2', Sidekiq.schedule['some_ivar_job2']['args']
@@ -115,7 +123,7 @@ class ManagerTest < Minitest::Test
         }
       )
 
-      assert_equal(1, Sidekiq::Scheduler.rufus_scheduler.all_jobs.size)
+      assert_equal(1, Sidekiq::Scheduler.rufus_scheduler.jobs.size)
       assert_equal(1, Sidekiq::Scheduler.scheduled_jobs.size)
       assert Sidekiq::Scheduler.scheduled_jobs.keys.include?('some_ivar_job')
     end
@@ -130,7 +138,7 @@ class ManagerTest < Minitest::Test
         }
       )
 
-      assert_equal(1, Sidekiq::Scheduler.rufus_scheduler.all_jobs.size)
+      assert_equal(1, Sidekiq::Scheduler.rufus_scheduler.jobs.size)
       assert_equal(1, Sidekiq::Scheduler.scheduled_jobs.size)
       assert Sidekiq::Scheduler.scheduled_jobs.keys.include?('some_ivar_job')
       assert Sidekiq::Scheduler.scheduled_jobs['some_ivar_job'].params.keys.include?(:first_in)
@@ -146,7 +154,7 @@ class ManagerTest < Minitest::Test
         }
       )
 
-      assert_equal(1, Sidekiq::Scheduler.rufus_scheduler.all_jobs.size)
+      assert_equal(1, Sidekiq::Scheduler.rufus_scheduler.jobs.size)
       assert_equal(1, Sidekiq::Scheduler.scheduled_jobs.size)
       assert Sidekiq::Scheduler.scheduled_jobs.keys.include?('some_ivar_job')
       assert Sidekiq::Scheduler.scheduled_jobs['some_ivar_job'].params.keys.include?(:allow_overlapping)
@@ -161,7 +169,7 @@ class ManagerTest < Minitest::Test
         }
       )
 
-      assert_equal(0, Sidekiq::Scheduler.rufus_scheduler.all_jobs.size)
+      assert_equal(0, Sidekiq::Scheduler.rufus_scheduler.jobs.size)
       assert_equal(0, Sidekiq::Scheduler.scheduled_jobs.size)
       assert !Sidekiq::Scheduler.scheduled_jobs.keys.include?('some_ivar_job')
     end
@@ -176,7 +184,7 @@ class ManagerTest < Minitest::Test
         }
       )
 
-      assert_equal(0, Sidekiq::Scheduler.rufus_scheduler.all_jobs.size)
+      assert_equal(0, Sidekiq::Scheduler.rufus_scheduler.jobs.size)
       assert_equal(0, Sidekiq::Scheduler.scheduled_jobs.size)
       assert !Sidekiq::Scheduler.scheduled_jobs.keys.include?('some_ivar_job')
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-scheduler
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
 platform: ruby
 authors:
 - Morton Jonuschat
@@ -9,152 +9,152 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-19 00:00:00.000000000 Z
+date: 2015-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.12'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.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'
 - !ruby/object:Gem::Dependency
   name: mocha
   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: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: mock_redis
   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: simplecov
   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: Light weight job scheduling extension for Sidekiq that adds support for
@@ -192,25 +192,25 @@ 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.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Light weight job scheduling extension for Sidekiq
 test_files:
+- test/config.yml
+- test/fake_env.rb
+- test/lib/sidekiq/scheduler_test.rb
 - test/schedule_test.rb
-- test/support/my_worker.rb
 - test/support/direct_worker.rb
+- test/support/my_worker.rb
 - test/test_helper.rb
-- test/lib/sidekiq/scheduler_test.rb
-- test/fake_env.rb
-- test/config.yml