sidekiq-scheduler 0.7 → 1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2RhZTgzNTk4MTY0ZGM4NWE5ZmM4OTg5NjUzOTc3YzgxN2NiNDA3MA==
+    NTgyMGVlOTk3ZGM2ZjQ0ZWI0ZWFkNzViYTU1Mjg2N2ZiZGU4NmI5Mw==
   data.tar.gz: !binary |-
-    NDE1MjYwYTg1MDQxNzMxYTM0MTljZjY4YjA1MTlkOGY2YzFlNGJjYQ==
+    ZDA0ZTJmZGU0ZDdlMDBmOGM0ODUxNWIyNDRkMjRjYmQ2ZTMyYjJmMw==
 SHA512:
   metadata.gz: !binary |-
-    N2Q4NzllM2M5NGRjNDI3MWE0YmVkYzYwMTQxYzdkYTRkODE1ZjdkM2QzMzRm
-    NjYyZGQ3MGFjYzQwZGVmM2NkYmRjNDUzYzEyNTlhNGU4ZDlmNmQ2NDg2Mzg1
-    Y2ViMTM0NjY5OTUxZGU0Mjk3ZDdiNDYwMWJkYTE4Nzg4NzZlMTU=
+    ZDYxNjQ1ZGVlNGFlNjJiYWIxODQ0NTdkYTEyNDc2YmE4Zjk5MjUzYjdhOTk0
+    NjY2NDZjOWEyYTAyZTQzYjUyMTE5MmU2MzcxMmFjMzJkZWVkMmZhNzFjOTM4
+    ZDY4MTJhODMxZjE1MjgyZTgxM2NjMTYxNTJkMmFiMjhhMTk5MjQ=
   data.tar.gz: !binary |-
-    MWMzZTY3ZjVhM2MwNjVmMzZmZTZlNDJkNTRhOTgwODRiYjRiOTZiMTVjZTk1
-    MzZkODA0YjI0ODE0MGFmYzg1ODUxYzUyMTMxZDk5MjBjZjg0ZjdiZWQ3ZTg2
-    NzgwMjNmZDZhYWVhZGYyMmRjMWVlMTU5YjIxMWZmOTMwMDIxNTM=
+    MGU0ZDVmZmE0Yjk3YjRjZTFjOWE1YTA1MmM3M2E1YTI3MDFkODdhZDFlMWUz
+    MzliNWM1MzAyNWM2ZWY5YzUzMzc2NDNlMzA5M2UzYWFiY2ZhNTA3MmYwOTU0
+    M2RiYzU1ZTFlOTFjNDdmMDRkZjBiYTcxNWIzYjU3NTAwOTM5M2I=

data/README.md

@@ -1,5 +1,10 @@
 # SidekiqScheduler
 
+## Note
+
+The master branch and releases from 1.0 are compatible with sidekiq ~> 3, for sidekiq ~> 2 support
+use versions ~> 0.
+
 ## Description
 
 sidekiq-scheduler is an extension to [Sidekiq](http://github.com/mperham/sidekiq)
@@ -15,37 +20,32 @@ details on individual methods, you might want to try the [rdoc](http://rdoc.info
 
 ## Installation
 
-    # Add this to your Gemfile:
-    gem 'sidekiq-scheduler', '=> 0.6'
+Add this to your Gemfile:
+```ruby
+gem 'sidekiq-scheduler', '~> 1'
+```
+
+If you are using rails you are set
+
+If you are not using rails create a file with this content:
+```ruby
+require 'sidekiq-scheduler'
+```
 
-    # Starting the scheduler
-    bundle exec sidekiq-scheduler
+and the execute:
+```sh
+sidekiq -r created_file_path.rb
+```
 
-The scheduler will perform identically to a normal sidekiq worker with
-an additional scheduler thread being run - in the default configuration
-this will result in 25 worker threads being available on the scheduler
-node but all normal configuration options apply.
+Look at [Loading the schedule][https://github.com/moove-it/sidekiq-scheduler/tree/0.x#loading-the-schedule]
+for information on how to load your schedule.
 
-NOTE: Since it's currently not possible to hook into the default option
-parsing provided by sidekiq you will need to use a configuration file to
-override the scheduler options.
+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>
 
-The scheduling thread will sleep this many seconds between looking for
-jobs that need moving to the worker queue. The default is 5 seconds
-which should be fast enough for almost all uses.
-
-NOTE: You DO NOT want to run more than one instance of the scheduler.  Doing
-so will result in the same job being queued multiple times.  You only need one
-instance of the scheduler running per application, regardless of number of servers.
-
-NOTE: If the scheduler thread goes down for whatever reason, the delayed items
-that should have fired during the outage will fire once the scheduler is
-started back up again (even if it is on a new machine).
-
 ## Scheduled Jobs (Recurring Jobs)
 
 Scheduled (or recurring) jobs are logically no different than a standard cron
@@ -94,20 +94,31 @@ seconds past the minute).
 A big shout out to [rufus-scheduler](http://github.com/jmettraux/rufus-scheduler)
 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:
 
-    require 'sidekiq/scheduler'
-    Sidekiq.schedule = YAML.load_file(File.expand_path("../../../config/scheduler.yml",__FILE__))
+```ruby
+require 'sidekiq/scheduler'
+Sidekiq.schedule = YAML.load_file(File.expand_path("../../../config/scheduler.yml",__FILE__))
+```
 
 If you were running a non Rails project you should add code to load the workers classes before loading the schedule.
 
-    require 'sidekiq/scheduler'
-    Dir[File.expand_path('../lib/workers/*.rb',__FILE__)].each do |file| load file; end
-    Sidekiq.schedule = YAML.load_file(File.expand_path("../../../config/scheduler.yml",__FILE__))
- 
+```ruby
+require 'sidekiq/scheduler'
+Dir[File.expand_path('../lib/workers/*.rb',__FILE__)].each do |file| load file; end
+Sidekiq.schedule = YAML.load_file(File.expand_path("../../../config/scheduler.yml",__FILE__))
+```
+
+You can also put your schedule information inside sidekiq.yml and load it with:
+
+```sh
+sidekiq -C ./config/sidekiq.yml
+```
+
 ### Time zones
 
 Note that if you use the cron syntax, this will be interpreted as in the server time zone
@@ -125,16 +136,6 @@ from the `config.time_zone` value, make sure it's the right format, e.g. with:
 
 A future version of sidekiq-scheduler may do this for you.
 
-## Using with Testing
-
-Sidekiq uses a jobs array on workers for testing, which is supported by sidekiq-scheduler when you require the test code:
-
-    require 'sidekiq/testing'
-    require 'sidekiq-scheduler/testing'
-    
-    MyWorker.perform_in 5, 'arg1'
-    puts MyWorker.jobs.inspect
-
 ## Note on Patches / Pull Requests
 
 * Fork the project.

data/lib/sidekiq-scheduler.rb

@@ -1,2 +1,24 @@
 require 'sidekiq'
-require 'sidekiq-scheduler/version'
+
+require_relative 'sidekiq-scheduler/version'
+require_relative 'sidekiq-scheduler/manager'
+
+Sidekiq.configure_server do |config|
+
+  config.on(:startup) do
+    scheduler_options = {
+      :scheduler => config.options.fetch(:scheduler, true),
+      :dynamic => config.options.fetch(:dynamic, false),
+      :schedule => config.options.fetch(:schedule, nil)
+    }
+
+    schedule_manager = SidekiqScheduler::Manager.new(scheduler_options)
+    config.options[:schedule_manager] = schedule_manager
+    config.options[:schedule_manager].start
+  end
+
+  config.on(:shutdown) do
+    config.options[:schedule_manager].stop
+  end
+
+end

data/lib/sidekiq-scheduler/manager.rb

@@ -28,8 +28,8 @@ module SidekiqScheduler
     end
 
     def start
-      #Load the schedule into rufus
-      #If dynamic is set, load that schedule otherwise use normal load
+      # Load the schedule into rufus
+      # If dynamic is set, load that schedule otherwise use normal load
       if @enabled && Sidekiq::Scheduler.dynamic
         Sidekiq::Scheduler.reload_schedule!
       elsif @enabled

data/lib/sidekiq-scheduler/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-scheduler
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: '1.0'
 platform: ruby
 authors:
 - Morton Jonuschat
@@ -17,7 +17,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.12'
@@ -27,7 +27,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.12'
@@ -161,25 +161,20 @@ description: Light weight job scheduling extension for Sidekiq that adds support
   queueing items in the future.
 email:
 - adrian_g171@hotmail.com
-executables:
-- sidekiq-scheduler
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- bin/sidekiq-scheduler
 - lib/sidekiq-scheduler.rb
 - lib/sidekiq-scheduler/capistrano.rb
-- lib/sidekiq-scheduler/cli.rb
 - lib/sidekiq-scheduler/manager.rb
 - lib/sidekiq-scheduler/schedule.rb
-- lib/sidekiq-scheduler/testing.rb
 - lib/sidekiq-scheduler/version.rb
 - lib/sidekiq/scheduler.rb
 - lib/tasks/sidekiq-scheduler_tasks.rake
-- test/cli_test.rb
 - test/config.yml
 - test/fake_env.rb
 - test/lib/sidekiq/scheduler_test.rb
@@ -219,4 +214,3 @@ test_files:
 - test/lib/sidekiq/scheduler_test.rb
 - test/fake_env.rb
 - test/config.yml
-- test/cli_test.rb

data/bin/sidekiq-scheduler

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'sidekiq/cli'
-
-begin
-  cli = Sidekiq::CLI.instance
-  cli.parse
-
-  require 'sidekiq-scheduler/cli'
-  cli.run
-rescue => e
-  raise e if $DEBUG
-  STDERR.puts e.message
-  STDERR.puts e.backtrace.join("\n")
-  exit 1
-end

data/lib/sidekiq-scheduler/cli.rb

@@ -1,35 +0,0 @@
-require 'sidekiq/cli'
-
-require 'sidekiq-scheduler/manager'
-
-module SidekiqScheduler
-  module CLI
-
-    def self.included(base)
-      base.class_eval do
-        alias_method :run_manager, :run
-        alias_method :run, :run_scheduler
-      end
-    end
-
-    def run_scheduler
-      scheduler_options = { :scheduler => true, :schedule => nil }
-      scheduler_options.merge!(options)
-
-      if options[:config_file]
-        file_options = YAML.load_file(options[:config_file])
-        options.merge!(file_options)
-        options.delete(:config_file)
-        parse_queues(options, options.delete(:queues) || [])
-      end
-
-      scheduler = SidekiqScheduler::Manager.new(scheduler_options)
-      scheduler.start
-      run_manager
-      scheduler.stop
-    end
-
-  end
-end
-
-Sidekiq::CLI.send(:include, SidekiqScheduler::CLI)

data/lib/sidekiq-scheduler/testing.rb

@@ -1,33 +0,0 @@
-require 'sidekiq/testing'
-
-module SidekiqScheduler
-  module Worker
-    module ClassMethods
-      alias_method :perform_at_old, :perform_at
-      def perform_at(timestamp, *args)
-        jobs << { 'class' => self.name, 'timestamp' => timestamp.to_i, 'args' => args }
-        true
-      end
-
-      alias_method :perform_in_old, :perform_in
-      def perform_in(seconds_from_now, *args)
-        timestamp = Time.now + seconds_from_now
-        jobs << { 'class' => self.name, 'timestamp' => timestamp.to_i, 'args' => args }
-      end
-
-      alias_method :remove_delayed_old, :remove_delayed
-      def remove_delayed(*args)
-        old_jobcount = jobs.size
-        jobs.reject! { |job| job["class"] == self.name && job["args"] == args }
-        old_jobcount - jobs.size
-      end
-
-      alias_method :remove_delayed_from_timestamp_old, :remove_delayed_from_timestamp
-      def remove_delayed_from_timestamp(timestamp, *args)
-        old_jobcount = jobs.size
-        jobs.reject! { |job| job["class"] == self.name && job["timestamp"] == timestamp.to_i && job["args"] == args }
-        old_jobcount - jobs.size
-      end
-    end
-  end
-end

data/test/cli_test.rb

@@ -1,26 +0,0 @@
-require 'test_helper'
-require 'sidekiq-scheduler/cli'
-require 'tempfile'
-
-class CliTest < Minitest::Test
-
-  describe 'with cli' do
-
-    before do
-      Celluloid.boot
-      @cli = Sidekiq::CLI.instance
-    end
-
-    describe 'with config file' do
-      before do
-        @cli.parse(['sidekiq', '-C', './test/config.yml'])
-      end
-
-      it 'sets the resolution of the scheduler timer' do
-        assert_equal 30, Sidekiq.options[:resolution]
-      end
-    end
-
-  end
-
-end