sidekiq-cron 1.4.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 437dc35edb85224f5e77eaa73be4adac923adb313f755f3029a4037e92a9c523
-  data.tar.gz: 517c8dd23943edb6c1e6e3059b4b6f7044ff85d13594447dbb097ff7438afc63
+  metadata.gz: 7df934577b0740b3e977ffd0e361f6333de6958921659d78bf4c4e4a0015aad9
+  data.tar.gz: 6ae3317c56ff984bf0b651df9117121b4cf67cf36d715eee56a7521f47fe0770
 SHA512:
-  metadata.gz: 8d943877a3c9577b060ccbc86fca6e256ac6e12e7ab4ef5428091960d82d119b8087264b3fd20afcd2a191dc722f42deab5701557aa5d1fd9e0f2cfe10357b26
-  data.tar.gz: 39f3b04c168c250f0273796fb1c6f20947114d92030d60fed74d2c5087ee401b35f0b3e1fdea00a6c7eac9116d76204ce439dae7a5ba965b60978034ae472d38
+  metadata.gz: 8948ce194538c052c1761b921a4df485bc99ab5ce9b2e4c12b576d90e10bb6bb1691d7fe111d8ecc6b54e3324d53b8c5c45c0be561d58c4adb4414f08db576b8
+  data.tar.gz: 2fcccab9c996fe7a6c79c0090875dd81fca30ba6de130af3cf300d1d745e0212e056afe4ea05a8912191703cddf47800f5e3ea6092e1e751091ecf4a3baffc15

data/{Changes.md → CHANGELOG.md}

@@ -2,6 +2,35 @@
 
 All notable changes to this project will be documented in this file.
 
+## 1.8.0
+
+- Fix deprecation warnings with redis-rb v4.8.0 (https://github.com/ondrejbartas/sidekiq-cron/pull/356)
+- Fix poller affecting Sidekiq scheduled set poller (https://github.com/ondrejbartas/sidekiq-cron/pull/359)
+- Fix default polling interval (https://github.com/ondrejbartas/sidekiq-cron/pull/362)
+- Add italian locale (https://github.com/ondrejbartas/sidekiq-cron/pull/367)
+- Allow disabling of cron polling (https://github.com/ondrejbartas/sidekiq-cron/pull/368)
+
+## 1.7.0
+
+- Enable to use cron notation in natural language (ie `every 30 minutes`) (https://github.com/ondrejbartas/sidekiq-cron/pull/312)
+- Fix `date_as_argument` feature to add timestamp argument at every cron job execution (https://github.com/ondrejbartas/sidekiq-cron/pull/329)
+- Introduce `Sidekiq::Options` to centralize reading/writing options from different Sidekiq versions (https://github.com/ondrejbartas/sidekiq-cron/pull/341)
+- Make auto schedule loading compatible with Array format (https://github.com/ondrejbartas/sidekiq-cron/pull/345)
+
+## 1.6.0
+
+- Adds support for auto-loading the `config/schedule.yml` file (https://github.com/ondrejbartas/sidekiq-cron/pull/337)
+- Fix `Sidekiq.options` deprecation warning (https://github.com/ondrejbartas/sidekiq-cron/pull/338)
+
+## 1.5.1
+
+-  Fixes an issue that prevented the gem to work in previous Sidekiq versions (https://github.com/ondrejbartas/sidekiq-cron/pull/335)
+
+## 1.5.0
+
+- Integrate Sidekiq v6.5 breaking changes (https://github.com/ondrejbartas/sidekiq-cron/pull/331)
+- Add portuguese translations (https://github.com/ondrejbartas/sidekiq-cron/pull/332)
+
 ## 1.4.0
 
 - Fix buttons order in job show view (https://github.com/ondrejbartas/sidekiq-cron/pull/302)
@@ -16,7 +45,6 @@ All notable changes to this project will be documented in this file.
 
 - 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:
@@ -38,7 +66,7 @@ All notable changes to this project will be documented in this file.
 
 - 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)
+- 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
@@ -62,8 +90,8 @@ All notable changes to this project will be documented in this file.
 - Fix poller to enqueu all jobs in poll start time
 - Add performance test for enqueue of jobs (10 000 jobs in less than 19s)
 - Fix problem with default queue
-- Remove redis-namespace from dependencies
-- Update ruby versions in travis
+- Remove `redis-namespace` from dependencies
+- Update Ruby versions in Travis
 
 ## 0.5.0
 
@@ -75,7 +103,7 @@ All notable changes to this project will be documented in this file.
 - Add Russian locale
 - User Rack.env in tests
 - Faster enqueue of jobs
-- Permit to use ActiveJob::Base.queue_name_delimiter
+- Permit to use `ActiveJob::Base.queue_name_delimiter`
 - Fix problem with multiple times enqueue #84
 - Fix problem with enqueue of unknown class
 

data/README.md

@@ -27,7 +27,7 @@ Please be aware that Sidekiq-Cron < 1.0 was relying on rufus-scheduler < 3.5. Us
 
 ## Changelog
 
-Before upgrading to a new version, please read our [Changelog](Changes.md).
+Before upgrading to a new version, please read our [Changelog](CHANGELOG.md).
 
 ## Installation
 
@@ -35,6 +35,7 @@ Before upgrading to a new version, please read our [Changelog](Changes.md).
 
 - Redis 2.8 or greater is required (Redis 3.0.3 or greater is recommended for large scale use)
 - Sidekiq 4.2 or greater is required (for Sidekiq < 4 use version sidekiq-cron 0.3.1)
+- Sidekiq 6.5 requires Sidekiq-Cron 1.5+
 
 Install the gem:
 
@@ -45,7 +46,7 @@ $ gem install sidekiq-cron
 Or add to your `Gemfile` and run `bundle install`:
 
 ```ruby
-gem "sidekiq-cron", "~> 1.3"
+gem "sidekiq-cron"
 ```
 
 **NOTE** If you are not using Rails, you need to add `require 'sidekiq-cron'` somewhere after `require 'sidekiq'`.
@@ -63,10 +64,10 @@ gem "sidekiq-cron", "~> 1.3"
   'queue' => 'name of queue',
   '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
-  'description' => 'A sentence describing what work this job performs.'
+  '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
+  'description' => 'A sentence describing what work this job performs'
   'status' => 'disabled' # default: enabled
 }
 ```
@@ -82,6 +83,17 @@ If using Rails, this is evaluated against the timezone configured in Rails, othe
 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'`.
 
+#### Natural-language formats
+
+Since sidekiq-cron `v1.7.0`, you can use the natural-language formats supported by Fugit, such as:
+
+```rb
+"every day at five" # => '0 5 * * *'
+"every 3 hours"     # => '0 */3 * * *'
+```
+
+See [the relevant part of Fugit documentation](https://github.com/floraison/fugit#fugitnat) for details.
+
 #### Second-precision (sub-minute) cronlines
 
 In addition to the standard 5-parameter cronline format, sidekiq-cron supports scheduling jobs with second-precision using a modified 6-parameter cronline format:
@@ -93,7 +105,7 @@ For example: `"*/30 * * * * *"` would schedule a job to run every 30 seconds.
 Note that if you plan to schedule jobs with second precision you may need to override the default schedule poll interval so it is lower than the interval of your jobs:
 
 ```ruby
-Sidekiq.options[:average_scheduled_poll_interval] = 10
+Sidekiq[:cron_poll_interval] = 10
 ```
 
 The default value at time of writing is 30 seconds. See [under the hood](#under-the-hood) for more details.
@@ -226,21 +238,19 @@ second_job:
     hard: "stuff"
 ```
 
-```ruby
-# config/initializers/sidekiq.rb
-schedule_file = "config/schedule.yml"
-
-if File.exist?(schedule_file) && Sidekiq.server?
-  Sidekiq::Cron::Job.load_from_hash YAML.load_file(schedule_file)
-end
-```
+There are multiple ways to load the jobs from a YAML file
 
-From version 3.x it is better not to use separate initializer of schedule instead add `config.on(:startup)` to your Sidekiq configuration:
+1. The gem will automatically load the jobs mentioned in `config/schedule.yml` file.
+2. When you want to load jobs from a different filename, mention the filename in sidekiq configuration,
+i.e. `cron_schedule_file: "config/users_schedule.yml"`
+3. Load the file manually as follows
 
 ```ruby
+# config/initializers/sidekiq.rb
+
 Sidekiq.configure_server do |config|
   config.on(:startup) do
-    schedule_file = "config/schedule.yml"
+    schedule_file = "config/users_schedule.yml"
 
     if File.exist?(schedule_file)
       Sidekiq::Cron::Job.load_from_hash YAML.load_file(schedule_file)
@@ -249,8 +259,6 @@ Sidekiq.configure_server do |config|
 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.
-
 ### Finding jobs
 
 ```ruby
@@ -313,32 +321,7 @@ add `require 'sidekiq/cron/web'` after `require 'sidekiq/web'`.
 
 With this, you will get:
 
-![Web UI](examples/web-cron-ui.png)
-
-### Forking Processes or problem with `NotImplementedError`
-
-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 to occur:
-
-```
-Redis::InheritedError: Tried to use a connection from a child process without reconnecting. You need to reconnect to Redis after forking.
-```
-
-To avoid this, wrap your job creation in the call to `Sidekiq.configure_server`:
-
-```ruby
-Sidekiq.configure_server do |config|
-  config.on(:startup) do
-    schedule_file = "config/schedule.yml"
-
-    if File.exist?(schedule_file)
-      Sidekiq::Cron::Job.load_from_hash YAML.load_file(schedule_file)
-    end
-  end
-end
-```
-
-**NOTE** This API is only available in Sidekiq 3.x.
+![Web UI](examples/web-cron-ui.jpeg)
 
 ## Under the hood
 
@@ -349,11 +332,13 @@ Sidekiq-Cron adds itself into this start procedure and starts another thread wit
 Sidekiq-Cron is checking jobs to be enqueued every 30s by default, you can change it by setting:
 
 ```ruby
-Sidekiq.options[:average_scheduled_poll_interval] = 10
+Sidekiq[:cron_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.
 
+When running with many Sidekiq processes, the polling can add significant load to Redis. You can disable polling on some processes by setting `Sidekiq[:cron_poll_interval] = 0` on these processes.
+
 ## Contributing
 
 **Thanks to all [contributors](https://github.com/ondrejbartas/sidekiq-cron/graphs/contributors), you’re awesome and this wouldn’t be possible without you!**
@@ -364,6 +349,7 @@ Sidekiq-Cron is safe to use with multiple Sidekiq processes or nodes. It uses a
 * Start a feature/bugfix branch.
 * Commit and push until you are happy with your contribution.
 * Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
+* Open a pull request!
 
 ### Testing