sidekiq-scheduler 2.0.5 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c13477c36de16f83f295c07f237a6182a2e8b422
-  data.tar.gz: 00bd5143e5c9a63038f4aa5ec879e9d1cb5d0389
+  metadata.gz: d2b640d812a1bd5a97323ddcc891c3b4322bc5f8
+  data.tar.gz: 8d1d6592c877a503f3167fdb91cecced8bebead1
 SHA512:
-  metadata.gz: dab3552b21945d9fca703a2aa97de4ca0750b15236bffb95b80af82f14c9e10a8d1a5e2e0011105cdf6a47f51e63737cbb5293cfb8689faa16fce2fb4ad41a8f
-  data.tar.gz: 9db739424af1df7bef42f4bb418a2282c6962f0f1392da13dbe8e19a57bbd6587cb73888d714e2950669997a09c944cfb552350f8ca255b2af7a09c9b829e806
+  metadata.gz: 80c12e6687d4251e579d2d7e802e7721f7d9fe6288689f45684448243e2c0091742910a87b57ae306fe4fe0a5a925bbe1fa8b0e7a60c67be62be139e547d2028
+  data.tar.gz: 1d25189e230f7f93bc66fe347326e925c868f8bc967ce5f5211c05aa37ba2f54030732f236e0521621da06af63bd27192ed3beccb6a76baee46c82e4ab8f77e7

data/README.md

@@ -58,6 +58,8 @@ Available options are:
     :schedule: <the schedule to be run>
     :dynamic: <if true the schedule can be modified in runtime>
     :enabled: <enables scheduler if true [true by default]>
+    :scheduler:
+      :listened_queues_only: <push jobs whose queue is being listened by sidekiq [false by default]>
 
 ## Manage tasks from Unicorn/Rails server
 
@@ -138,14 +140,15 @@ for handling the heavy lifting of the actual scheduling engine.
 ### Loading the schedule
 
 Let's assume your scheduled jobs are defined in a file called "config/scheduler.yml" under your Rails project,
-you could create a Rails initializer called "config/initializer/scheduler.rb" which would load the job definitions:
+you could create a Rails initializer called "config/initializers/scheduler.rb" which would load the job definitions:
 
 ```ruby
 require 'sidekiq/scheduler'
 
 Sidekiq.configure_server do |config|
   config.on(:startup) do
-    Sidekiq.schedule =    YAML.load_file(File.expand_path("../../../config/scheduler.yml",__FILE__))
+    Sidekiq.schedule = YAML.load_file(File.expand_path("../../../config/scheduler.yml",__FILE__))
+    Sidekiq::Scheduler.reload_schedule!
   end
 end
 ```
@@ -157,9 +160,9 @@ require 'sidekiq/scheduler'
 Dir[File.expand_path('../lib/workers/*.rb',__FILE__)].each do |file| load file; end
 
 Sidekiq.configure_server do |config|
-
   config.on(:startup) do
     Sidekiq.schedule = YAML.load_file(File.expand_path("../../../config/scheduler.yml",__FILE__))
+    Sidekiq::Scheduler.reload_schedule!
   end
 end
 ```
@@ -247,7 +250,7 @@ require 'sidekiq-scheduler/web'
 
 ## Credits
 
-This work is a partial port of [resque-scheduler](https://github.com/bvandenbos/resque-scheduler) by Ben VandenBos.  
+This work is a partial port of [resque-scheduler](https://github.com/bvandenbos/resque-scheduler) by Ben VandenBos.
 Modified to work with the Sidekiq queueing library by Morton Jonuschat.
 Scheduling of recurring jobs has been added to v0.4.0, thanks to [Adrian Gomez](https://github.com/adrian-gomez).
 

data/lib/sidekiq-scheduler.rb

@@ -13,11 +13,16 @@ Sidekiq.configure_server do |config|
     enabled = Sidekiq::Scheduler.enabled
     enabled = enabled.nil? ? config.options.fetch(:enabled, true) : enabled
 
+    scheduler = config.options.fetch(:scheduler, {})
+
+    listened_queues_only = Sidekiq::Scheduler.listened_queues_only
+    listened_queues_only = listened_queues_only.nil? ? scheduler[:listened_queues_only] : listened_queues_only
+
     scheduler_options = {
-      scheduler: config.options.fetch(:scheduler, true),
       dynamic:   dynamic,
       enabled:   enabled,
-      schedule:  config.options.fetch(:schedule, nil)
+      schedule:  config.options.fetch(:schedule, nil),
+      listened_queues_only: listened_queues_only
     }
 
     schedule_manager = SidekiqScheduler::Manager.new(scheduler_options)

data/lib/sidekiq-scheduler/manager.rb

@@ -17,6 +17,7 @@ module SidekiqScheduler
     def initialize(options)
       Sidekiq::Scheduler.enabled = options[:enabled]
       Sidekiq::Scheduler.dynamic = options[:dynamic]
+      Sidekiq::Scheduler.listened_queues_only = options[:listened_queues_only]
       Sidekiq.schedule = options[:schedule] if options[:schedule]
     end
 

data/lib/sidekiq-scheduler/version.rb

@@ -1,5 +1,5 @@
 module SidekiqScheduler
 
-  VERSION = '2.0.5'
+  VERSION = '2.0.6'
 
 end

data/lib/sidekiq/scheduler.rb

@@ -22,6 +22,8 @@ module Sidekiq
       # Set to update the schedule in runtime in a given time period.
       attr_accessor :dynamic
 
+      # Set to schedule jobs only when will be pushed to queues listened by sidekiq
+      attr_accessor :listened_queues_only
     end
 
     # the Rufus::Scheduler jobs that are scheduled
@@ -55,10 +57,15 @@ module Sidekiq
 
         logger.info 'Schedule empty! Set Sidekiq.schedule' if Sidekiq.schedule.empty?
 
+
         @@scheduled_jobs = {}
 
         Sidekiq.schedule.each do |name, config|
-          self.load_schedule_job(name, config)
+          if !listened_queues_only || enabled_queue?(config['queue'])
+            self.load_schedule_job(name, config)
+          else
+            logger.info { "Ignoring #{name}, job's queue is not enabled." }
+          end
         end
 
         Sidekiq.redis { |r| r.del(:schedules_changed) }
@@ -245,5 +252,16 @@ module Sidekiq
       config
     end
 
+    # Returns true if a job's queue is being listened on by sidekiq
+    #
+    # @param [String] job_queue Job's queue name
+    #
+    # @return [Boolean]
+    def self.enabled_queue?(job_queue)
+      queues = Sidekiq.options[:queues]
+
+      queues.empty? || queues.include?(job_queue)
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-scheduler
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.6
 platform: ruby
 authors:
 - Morton Jonuschat
@@ -9,216 +9,216 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-09 00:00:00.000000000 Z
+date: 2016-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
   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: 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: 3.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.8
 - !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: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.4.0
 - !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: 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: 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'
 - !ruby/object:Gem::Dependency
   name: activejob
   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: coveralls
   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: rack-test
   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: sinatra
   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
@@ -229,18 +229,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/sidekiq/scheduler.rb
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/sidekiq-scheduler.rb
 - lib/sidekiq-scheduler/manager.rb
 - lib/sidekiq-scheduler/schedule.rb
 - lib/sidekiq-scheduler/version.rb
 - lib/sidekiq-scheduler/web.rb
-- lib/sidekiq-scheduler.rb
+- lib/sidekiq/scheduler.rb
 - web/locales/cs.yml
 - web/locales/en.yml
 - web/views/recurring_jobs.erb
-- MIT-LICENSE
-- Rakefile
-- README.md
 homepage: https://github.com/moove-it/sidekiq-scheduler
 licenses:
 - MIT
@@ -251,17 +251,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.0.14
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Light weight job scheduling extension for Sidekiq