sidekiq-cron 1.0.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a6e4efebfa16f1bedd09081f160e3db3d778e0b9
-  data.tar.gz: b23fe76d331791eabd457cd85f797181bf086712
+SHA256:
+  metadata.gz: '091abb12b81574bf5fad5130f4e343aaad6adeceb0daae8c46a6d09dbaa7ee58'
+  data.tar.gz: 1ecbf9ba2fd82ff69a423993e7aa3678e7fabc6fb55e2acea74ec1cb83a8af3d
 SHA512:
-  metadata.gz: 3286595909fbc0c05504fb38b12f79544b020a627454701adc8e7b10fd7afc7a27cf27a3edf062b3840eca9e4ebc4964149bc9742e6d1bd85d0177cdea6fe18b
-  data.tar.gz: 337457599316fcdec08c10d29fab8b7d130584c345c97f3e4ad2bc93a2c7f2a240689776be8da24d380057ec23481995f0eff456e3789e68a3cc979012f817bf
+  metadata.gz: 9cfd9a8e2efdcf3ae293533421a1c09b7dcc3154e90d749fd3e3a47ccaff6d673daa68877b2ca3b7939139603ee04e816c8c5ae51ef64d818d8d013eff43d9f0
+  data.tar.gz: 0d86e3bb4b06869889934a37ef30f117a4a28769a07e75b3d7547c49d9d8e5dfe4931f608b8b7b18cdc1b70cfdaf6be55aa043844b047b877ff7dfa21271a9f4

data/Changes.md

@@ -1,3 +1,37 @@
+v 1.3.0
+-------
+
+- add confirmation dialog when enquing jobs from UI
+- start to support Sidekiq `average_scheduled_poll_interval` option (replaced `poll_interval`)
+- enable to use latest fugit to parse cron notation alowing use of natural language (ie `"every 30 minutes"`)
+- fix deprecation warning for redis 4.6.x
+- fix different response from Redis#exists in different redis versions
+- All PRs:
+  - https://github.com/ondrejbartas/sidekiq-cron/pull/275
+  - https://github.com/ondrejbartas/sidekiq-cron/pull/287
+  - https://github.com/ondrejbartas/sidekiq-cron/pull/309
+  - https://github.com/ondrejbartas/sidekiq-cron/pull/299
+  - https://github.com/ondrejbartas/sidekiq-cron/pull/314
+  - https://github.com/ondrejbartas/sidekiq-cron/pull/288
+
+v 1.2.0
+-------
+
+- updated readme
+- fix problem with Sidekiq::Launcher and requiring it when not needed
+- better patching of Sidekiq::Launcher
+- fixed Dockerfile
+
+v 1.1.0
+-------
+
+- updated readme
+- fix unit tests - changed argument error when getting invalid cron format
+- when fallbacking old job enqueued time use `Time.parse` šwithout format (so ruby can decide best method to parse it)
+- add option `date_as_argument` which will add to your job arguments on last place `Time.now.to_f` when it was eneuqued
+- add option `description` which will allow you to add notes to your jobs so in web view you can see it
+- fixed translations
+
 v 1.0.4
 -------
 

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.3.1
+FROM ruby:2.4
 MAINTAINER Joao Serra <joaopfserra@gmail.com>
 
 RUN apt-get update && \

data/Gemfile

@@ -1,32 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'sidekiq', '>= 4.2.1'
-gem 'fugit', '~> 1.1'
-
-group :development do
-  gem 'bundler'
-  gem 'simplecov'
-
-  gem 'redis-namespace', '>= 1.5.2'
-  gem 'shoulda-context'
-
-  gem 'rack'
-  gem 'rack-test'
-
-  gem 'jeweler'
-
-  gem 'minitest'
-  gem 'test-unit'
-  gem 'sdoc' # sdoc -N .
-
-  gem 'slim'
-  gem 'sinatra'
-
-  gem 'mocha'
-  gem 'coveralls'
-
-  gem 'shotgun'
-
-  gem 'guard'
-  gem 'guard-minitest'
-end
+gemspec

data/README.md

@@ -1,64 +1,68 @@
-Sidekiq-Cron [![Gem Version](https://badge.fury.io/rb/sidekiq-cron.svg)](http://badge.fury.io/rb/sidekiq-cron) [![Build Status](https://travis-ci.org/ondrejbartas/sidekiq-cron.svg?branch=master)](https://travis-ci.org/ondrejbartas/sidekiq-cron) [![Coverage Status](https://coveralls.io/repos/github/ondrejbartas/sidekiq-cron/badge.svg?branch=master)](https://coveralls.io/github/ondrejbartas/sidekiq-cron?branch=master)
-================================================================================================================================================================================================================================================================================================================================================================================================================================================
+# Sidekiq-Cron
 
+[![Gem Version](https://badge.fury.io/rb/sidekiq-cron.svg)](http://badge.fury.io/rb/sidekiq-cron)
+[![Build Status](https://github.com/ondrejbartas/sidekiq-cron/workflows/CI/badge.svg?branch=master)](https://github.com/ondrejbartas/sidekiq-cron/actions)
+[![Coverage Status](https://coveralls.io/repos/github/ondrejbartas/sidekiq-cron/badge.svg?branch=master)](https://coveralls.io/github/ondrejbartas/sidekiq-cron?branch=master)
 [![Join the chat at https://gitter.im/ondrejbartas/sidekiq-cron](https://badges.gitter.im/ondrejbartas/sidekiq-cron.svg)](https://gitter.im/ondrejbartas/sidekiq-cron?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-[Introduction video about Sidekiq-Cron by Drifting Ruby](https://www.driftingruby.com/episodes/periodic-tasks-with-sidekiq-cron)
+> A scheduling add-on for [Sidekiq](http://sidekiq.org)
 
-A scheduling add-on for [Sidekiq](http://sidekiq.org).
+🎬 [Introduction video about Sidekiq-Cron by Drifting Ruby](https://www.driftingruby.com/episodes/periodic-tasks-with-sidekiq-cron)
 
-Runs a thread alongside Sidekiq workers to schedule jobs at specified times (using cron notation `* * * * *` parsed by [Fugit](https://github.com/floraison/fugit), more about [cron notation](http://www.nncron.ru/help/EN/working/cron-format.htm).
+Sidekiq-Cron runs a thread alongside Sidekiq workers to schedule jobs at specified times (using cron notation `* * * * *` parsed by [Fugit](https://github.com/floraison/fugit), more about [cron notation](http://www.nncron.ru/help/EN/working/cron-format.htm).
 
 Checks for new jobs to schedule every 30 seconds and doesn't schedule the same job multiple times when more than one Sidekiq worker is running.
 
 Scheduling jobs are added only when at least one Sidekiq process is running, but it is safe to use Sidekiq-Cron in environments where multiple Sidekiq processes or nodes are running.
 
-If you want to know how scheduling work, check out [under the hood](#under-the-hood)
+If you want to know how scheduling work, check out [under the hood](#under-the-hood).
 
-Works with ActiveJob (Rails 4.2+)
+Works with ActiveJob (Rails 4.2+).
 
-You don't need Sidekiq PRO, you can use this gem with plain __Sidekiq__.
+You don't need Sidekiq PRO, you can use this gem with plain Sidekiq.
 
-Requirements
------------------
+## Upgrade from <0.6x to 1.0.x
 
-- Redis 2.8 or greater is required. (Redis 3.0.3 or greater is recommended for large scale use)
-- Sidekiq 5, or 4, or 3 and greater is required (for Sidekiq < 4 use version sidekiq-cron 0.3.1)
+Please be aware that Sidekiq-Cron < 1.0 was relying on rufus-scheduler < 3.5. Using those older sidekiq-cron with rufus-scheduler >= 3.5 ends up with jobs failing on creation. Sidekiq-cron 1.0 includes a patch that switches from rufus-scheduler to rufus-scheduler's core dependency, fugit.
 
-Change Log
-----------
-before upgrading to new version, please read:
-[Change Log](https://github.com/ondrejbartas/sidekiq-cron/blob/master/Changes.md)
+## Changelog
 
-Installation
-------------
+Before upgrading to new version, please read our [ChangeLog](Changes.md).
 
-    $ gem install sidekiq-cron
+## Installation
 
-or add to your `Gemfile`
+### Requirements
 
-    gem "sidekiq-cron", "~> 0.6.3"
+- Redis 2.8 or greater is required. (Redis 3.0.3 or greater is recommended for large scale use)
+- Sidekiq 5, or 4, or 3 and greater is required (for Sidekiq < 4 use version sidekiq-cron 0.3.1)
 
+Install the gem:
 
-Getting Started
------------------
+    $ gem install sidekiq-cron
+
+Or add to your `Gemfile` and run `bundle install`:
 
+    gem "sidekiq-cron", "~> 1.1"
+
+## Getting Started
 
 If you are not using Rails, you need to add `require 'sidekiq-cron'` somewhere after `require 'sidekiq'`.
 
-_Job properties_:
+**Job properties:**
 
 ```ruby
 {
- 'name'  => 'name_of_job', #must be uniq!
- 'cron'  => '1 * * * *',  # execute at 1 minute of every hour, ex: 12:01, 13:01, 14:01, 15:01...etc(HH:MM)
+ 'name' => 'name_of_job', # must be uniq!
+ 'cron' => '1 * * * *',  # execute at 1 minute of every hour, ex: 12:01, 13:01, 14:01, 15:01, ... (HH:MM)
  'class' => 'MyClass',
- #OPTIONAL
+ # OPTIONAL
  'queue' => 'name of queue',
- 'args'  => '[Array or Hash] of arguments which will be passed to perform method',
+ 'args' => '[Array or Hash] of arguments which will be passed to perform method',
+ 'date_as_argument' => true, # add the time of execution as last argument of the perform method
  'active_job' => true,  # enqueue job through rails 4.2+ active job interface
  'queue_name_prefix' => 'prefix', # rails 4.2+ active job queue with prefix
- 'queue_name_delimiter' => '.'  # rails 4.2+ active job queue with custom delimiter
+ 'queue_name_delimiter' => '.',  # rails 4.2+ active job queue with custom delimiter
+ 'description' => 'A sentence describing what work this job performs.'
 }
 ```
 
@@ -66,20 +70,27 @@ _Job properties_:
 
 For testing your cron notation you can use [crontab.guru](https://crontab.guru).
 
-sidekiq-cron uses [Fugit](https://github.com/floraison/fugit) to parse the cronline.
+Sidekiq-Cron uses [Fugit](https://github.com/floraison/fugit) to parse the cronline.
+
 If using Rails, this is evaluated against the timezone configured in Rails, otherwise the default is UTC.
 
 If you want to have your jobs enqueued based on a different time zone you can specify a timezone in the cronline,
 like this `'0 22 * * 1-5 America/Chicago'`.
 
-See [rufus-scheduler documentation](https://github.com/jmettraux/rufus-scheduler#a-note-about-timezones) for more information. (note. Rufus scheduler is using Fugit under the hood, so documentation for Rufus Scheduler can help you also)
+See [rufus-scheduler documentation](https://github.com/jmettraux/rufus-scheduler#a-note-about-timezones) for more information.
+
+**NOTE** Rufus scheduler is using Fugit under the hood, so documentation for Rufus Scheduler can help you also.
 
 ### What objects/classes can be scheduled
+
 #### Sidekiq Worker
+
 In this example, we are using `HardWorker` which looks like:
+
 ```ruby
 class HardWorker
   include Sidekiq::Worker
+
   def perform(*args)
     # do something
   end
@@ -87,7 +98,9 @@ end
 ```
 
 #### Active Job Worker
-You can schedule: `ExampleJob` which looks like:
+
+You can schedule `ExampleJob` which looks like:
+
 ```ruby
 class ExampleJob < ActiveJob::Base
   queue_as :default
@@ -98,11 +111,15 @@ class ExampleJob < ActiveJob::Base
 end
 ```
 
+For Active jobs you can use `symbolize_args: true` in `Sidekiq::Cron::Job.create` or in Hash configuration,
+which will ensure that arguments you are passing to it will be symbolized when passed back to `perform` method in worker.
+
 #### Adding Cron job:
-```ruby
 
+```ruby
 class HardWorker
   include Sidekiq::Worker
+
   def perform(name, count)
     # do something
   end
@@ -123,16 +140,15 @@ else
   puts job.errors
 end
 
-#or simple
-
+# or simple
 unless job.save
-  puts job.errors #will return array of errors
+  puts job.errors # will return array of errors
 end
 ```
 
 Load more jobs from hash:
-```ruby
 
+```ruby
 hash = {
   'name_of_job' => {
     'class' => 'MyClass',
@@ -149,6 +165,7 @@ Sidekiq::Cron::Job.load_from_hash hash
 ```
 
 Load more jobs from array:
+
 ```ruby
 array = [
   {
@@ -167,17 +184,17 @@ array = [
 Sidekiq::Cron::Job.load_from_array array
 ```
 
-Bang-suffixed methods will remove jobs that are not present in the given hash/array,
-update jobs that have the same names, and create new ones when the names are previously unknown.
+Bang-suffixed methods will remove jobs that are not present in the given hash/array, update jobs that have the same names, and create new ones when the names are previously unknown.
 
 ```ruby
 Sidekiq::Cron::Job#load_from_hash! hash
 Sidekiq::Cron::Job#load_from_array! array
 ```
 
-or from YML (same notation as Resque-scheduler)
+Or from YAML (same notation as Resque-scheduler):
+
 ```yaml
-#config/schedule.yml
+# config/schedule.yml
 
 my_first_job:
   cron: "*/5 * * * *"
@@ -193,7 +210,7 @@ second_job:
 ```
 
 ```ruby
-#initializers/sidekiq.rb
+# config/initializers/sidekiq.rb
 schedule_file = "config/schedule.yml"
 
 if File.exist?(schedule_file) && Sidekiq.server?
@@ -201,56 +218,60 @@ if File.exist?(schedule_file) && Sidekiq.server?
 end
 ```
 
-or you can use for loading jobs from yml file [sidekiq-cron-tasks](https://github.com/coverhound/sidekiq-cron-tasks) which will add rake task `bundle exec rake sidekiq_cron:load` to your rails application.
+Or you can use for loading jobs from yml file [sidekiq-cron-tasks](https://github.com/coverhound/sidekiq-cron-tasks) which will add rake task `bundle exec rake sidekiq_cron:load` to your rails application.
+
+### Finding jobs
 
-#### Finding jobs
 ```ruby
-#return array of all jobs
+# return array of all jobs
 Sidekiq::Cron::Job.all
 
-#return one job by its unique name - case sensitive
+# return one job by its unique name - case sensitive
 Sidekiq::Cron::Job.find "Job Name"
 
-#return one job by its unique name - you can use hash with 'name' key
+# return one job by its unique name - you can use hash with 'name' key
 Sidekiq::Cron::Job.find name: "Job Name"
 
-#if job can't be found nil is returned
+# if job can't be found nil is returned
 ```
 
-#### Destroy jobs:
+### Destroy jobs:
+
 ```ruby
-#destroys all jobs
+# destroy all jobs
 Sidekiq::Cron::Job.destroy_all!
 
-#destroy job by its name
+# destroy job by its name
 Sidekiq::Cron::Job.destroy "Job Name"
 
-#destroy found job
+# destroy found job
 Sidekiq::Cron::Job.find('Job name').destroy
 ```
 
-#### Work with job:
+### Work with job:
+
 ```ruby
 job = Sidekiq::Cron::Job.find('Job name')
 
-#disable cron scheduling
+# disable cron scheduling
 job.disable!
 
-#enable cron scheduling
+# enable cron scheduling
 job.enable!
 
-#get status of job:
+# get status of job:
 job.status
 # => enabled/disabled
 
-#enqueue job right now!
+# enqueue job right now!
 job.enque!
 ```
 
-How to start scheduling?
+### How to start scheduling?
+
 Just start Sidekiq workers by running:
 
-    sidekiq
+    $ sidekiq
 
 ### Web UI for Cron Jobs
 
@@ -263,7 +284,7 @@ With this, you will get:
 ### Forking Processes
 
 If you're using a forking web server like Unicorn you may run into an issue where the Redis connection is used
-before the process forks, causing the following exception
+before the process forks, causing the following exception:
 
     Redis::InheritedError: Tried to use a connection from a child process without reconnecting. You need to reconnect to Redis after forking.
 
@@ -279,37 +300,100 @@ Sidekiq.configure_server do |config|
 end
 ```
 
-Note that this API is only available in Sidekiq 3.x.x.
+**NOTE** This API is only available in Sidekiq 3.x.
+
+## Tests in Sidekiq-Cron
+
+If you need to check code of sidekiq-cron run `rake test` in this repository.
 
 ## Under the hood
 
 When you start the Sidekiq process, it starts one thread with `Sidekiq::Poller` instance, which perform the adding of scheduled jobs to queues, retries etc.
 
-Sidekiq-Cron adds itself into this start procedure and starts another thread with `Sidekiq::Cron::Poller` which checks all enabled Sidekiq cron jobs every 10 seconds, if they should be added to queue (their cronline matches time of check).
+Sidekiq-Cron adds itself into this start procedure and starts another thread with `Sidekiq::Cron::Poller` which checks all enabled Sidekiq cron jobs every 30 seconds, if they should be added to queue (their cronline matches time of check).
 
 Sidekiq-Cron is checking jobs to be enqueued every 30s by default, you can change it by setting:
-```
+
+```ruby
+# For Sidekiq >= 3.4
+Sidekiq.options[:average_scheduled_poll_interval] = 10
+
+# For older versions of Sidekiq
 Sidekiq.options[:poll_interval] = 10
 ```
 
 Sidekiq-Cron is safe to use with multiple sidekiq processes or nodes. It uses a Redis sorted set to determine that only the first process who asks can enqueue scheduled jobs into the queue.
 
 ## Thanks to
+* [@284km](https://github.com/284km)
 * [@7korobi](https://github.com/7korobi)
+* [@adrianobarroso](https://github.com/adrianobarroso])
+* [@alexeyramazanov](https://github.com/alexeyramazanov)
 * [@antulik](https://github.com/antulik)
+* [@arthurbryant](https://github.com/arthurbryant)
+* [@cabello](https://github.com/cabello)
+* [@camkidman](https://github.com/camkidman)
+* [@cgunther](https://github.com/cgunther)
+* [@chuchuva](https://github.com/chuchuva)
+* [@corroded](https://github.com/corroded)
+* [@D1ceWard](https://github.com/D1ceWard])
+* [@davidtrogers](https://github.com/davidtrogers)
+* [@denispeplin](https://github.com/denispeplin)
+* [@dwarburt](https://github.com/dwarburt)
+* [@Envek](https://github.com/Envek)
+* [@Eunix](https://github.com/Eunix)
 * [@felixbuenemann](https://github.com/felixbuenemann)
+* [@film42](https://github.com/film42])
+* [@giriss](https://github.com/giriss)
+* [@gitter](https://github.com/gitter)
 * [@gstark](https://github.com/gstark)
+* [@h0jeZvgoxFepBQ2C](https://github.com/h0jeZvgoxFepBQ2C)
+* [@incubus](https://github.com/incubus)
+* [@jack0pan](https://github.com/jack0pan)
+* [@jmettraux](https://github.com/jmettraux)
+* [@johnathanludwig](https://github.com/johnathanludwig)
+* [@joshuacronemeyer](https://github.com/joshuacronemeyer)
+* [@jpserra](https://github.com/jpserra)
+* [@Junyulive](https://github.com/Junyulive)
+* [@le0pard](https://github.com/le0pard)
+* [@lepfhty](https://github.com/lepfhty)
+* [@macool](https://github.com/macool)
+* [@masayukioguni](https://github.com/masayukioguni)
+* [@matsimitsu](https://github.com/matsimitsu)
+* [@merrington](https://github.com/merrington)
+* [@MikeRogers0](https://github.com/MikeRogers0)
+* [@MMartyn](https://github.com/MMartyn)
+* [@mrchucho](https://github.com/mrchucho)
+* [@n00dle](https://github.com/n00dle)
+* [@ngouy](https://github.com/ngouy)
+* [@nhoffmann](https://github.com/nhoffmann)
+* [@nicolasleger](https://github.com/nicolasleger)
+* [@nikolai-b](https://github.com/nikolai-b)
+* [@oivoodoo](https://github.com/oivoodoo)
+* [@paniko0](https://github.com/paniko0)
+* [@petergoldstein](https://github.com/petergoldstein)
 * [@RajRoR](https://github.com/RajRoR)
+* [@rmm5t](https://github.com/rmm5t)
 * [@romeuhcf](https://github.com/romeuhcf)
+* [@rylwin](https://github.com/rylwin)
+* [@ryohashimoto](https://github.com/ryohashimoto)
+* [@safeforge](https://github.com/safeforge)
 * [@siruguri](https://github.com/siruguri)
 * [@Soliah](https://github.com/Soliah)
+* [@spk](https://github.com/spk)
 * [@stephankaag](https://github.com/stephankaag)
+* [@stormsilver](https://github.com/stormsilver)
 * [@sue445](https://github.com/sue445)
 * [@sylg](https://github.com/sylg)
+* [@tai2](https://github.com/tai2)
+* [@tfluehmann](https://github.com/tfluehmann)
+* [@timminkov](https://github.com/timminkov)
+* [@tisba](https://github.com/tisba)
 * [@tmeinlschmidt](https://github.com/tmeinlschmidt)
+* [@tomprats](https://github.com/tomprats)
+* [@zedtux](https://github.com/zedtux)
 * [@zerobearing2](https://github.com/zerobearing2)
 
-
 ## Contributing to sidekiq-cron
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
@@ -322,4 +406,4 @@ Sidekiq-Cron is safe to use with multiple sidekiq processes or nodes. It uses a
 
 ## Copyright
 
-Copyright (c) 2013 Ondrej Bartas. See LICENSE.txt for further details.
+Copyright (c) 2013 Ondrej Bartas. See [LICENSE](LICENSE.txt) for further details.

data/Rakefile

@@ -13,26 +13,8 @@ rescue Bundler::BundlerError => e
 end
 require 'rake'
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "sidekiq-cron"
-  gem.homepage = "http://github.com/ondrejbartas/sidekiq-cron"
-  gem.license = "MIT"
-  gem.summary = %Q{Sidekiq Cron helps to add repeated scheduled jobs}
-  gem.description = %Q{Enables to set jobs to be run in specified time (using CRON notation)}
-  gem.email = "ondrej@bartas.cz"
-  gem.authors = ["Ondrej Bartas"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
 #TESTING
 
-task :doc do
-  system 'sdoc -N .'
-end
-
 require 'rake/testtask'
 task :default => :test
 

data/docker-compose.yml

@@ -18,4 +18,6 @@ services:
     - redis:redis.test
     depends_on:
     - common
-    command: dockerize -wait tcp://redis.test:6379 -timeout 60s rake test
+    command: dockerize -wait tcp://redis.test:6379 -timeout 60s bundle exec rake test
+    volumes:
+    - .:/sidekiq-cron