sidekiq-cron 2.0.0.rc1 → 2.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dce1f7b341e293e80c0b8981c03b24293c2922f4133f62882bcbee62fa3b12d6
-  data.tar.gz: 210bcfa247b4801bdb86a0d1f5c0454721172abebf0c2e5354be24caee1d6628
+  metadata.gz: d2fa6abcb1076d5e510764b33d0cfdd18d18fd1e585d79c63d300e37a1e0e6db
+  data.tar.gz: 4a04a46b7444879c6291a52e783ece82fa3488fe042106eef525ac81cd6a2d72
 SHA512:
-  metadata.gz: cd604c51a98b3b2d1a0af7fdf59afb599f9e9af717043bbbe2816a519be5824694415b59ebd8ec21fa09069798e71bb2d69ae9a62fbf177864f3adcf3c4fc1d3
-  data.tar.gz: '08ebb6f111498fd8f9b377eed43f17be760caace33185fec69b68e7e5f8ef89d5ee0bd34fe91d714d2c4d5af995e7297909a14e827cf4dce43b7974a859ae50f'
+  metadata.gz: bfd60ceaa0999e67bcc3a123ea767c8ed222a70621f688b0456f189386065570160e53cae1810dcc045b33b03101af5d3f9255b3c8afe6d963255ea9004ead06
+  data.tar.gz: b08f12f1ce7ca1495013c9eae44b4469371b2d3aeb6e81675c044133391ce411c6f1f4e71206776632a37b58d7594842ea38a0e2cb94ee18f32a70409b20249a

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file.
 
+## 2.0.0.rc2
+
+- Remove support for Sidekiq < 6.5 (https://github.com/sidekiq-cron/sidekiq-cron/pull/480)
+- Require at least Fugit >= 1.11.1 (https://github.com/sidekiq-cron/sidekiq-cron/pull/475)
+- Update how Redis values are stored on save (https://github.com/sidekiq-cron/sidekiq-cron/pull/479)
+- Web extension: Add compatibility with Sidekiq 7.3+ and remove inline styles (https://github.com/sidekiq-cron/sidekiq-cron/pull/480)
+- Remove support for old Redis (< 4.2) (https://github.com/sidekiq-cron/sidekiq-cron/pull/490)
+- Ensure date_as_argument option can be set from true to false in Sidekiq Cron jobs (https://github.com/sidekiq-cron/sidekiq-cron/pull/485)
+- Rename `enque!` to `enqueue!` (https://github.com/sidekiq-cron/sidekiq-cron/pull/494)
+- Refactor gem configuration module (https://github.com/sidekiq-cron/sidekiq-cron/pull/495)
+
 ## 2.0.0.rc1
 
 - Introduce `Namespacing` (https://github.com/sidekiq-cron/sidekiq-cron/pull/268)

data/README.md

@@ -8,7 +8,7 @@
 
 🎬 [Introduction video about Sidekiq-Cron by Drifting Ruby](https://www.driftingruby.com/episodes/periodic-tasks-with-sidekiq-cron)
 
-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)).
+Sidekiq-Cron runs a thread alongside Sidekiq workers to schedule jobs at specified times (using cron notation `* * * * *` or natural language, powered by [Fugit](https://github.com/floraison/fugit)).
 
 Checks for new jobs to schedule every 30 seconds and doesn't schedule the same job multiple times when more than one Sidekiq process is running.
 
@@ -16,10 +16,6 @@ Scheduling jobs are added only when at least one Sidekiq process is running, but
 
 If you want to know how scheduling work, check out [under the hood](#under-the-hood).
 
-Works with ActiveJob (Rails 4.2+).
-
-You don't need Sidekiq PRO, you can use this gem with plain Sidekiq.
-
 ## Changelog
 
 Before upgrading to a new version, please read our [Changelog](CHANGELOG.md).
@@ -56,9 +52,9 @@ gem "sidekiq-cron"
   '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 (default: '_')
+  'active_job' => true,  # enqueue job through Active Job interface
+  'queue_name_prefix' => 'prefix', # Active Job queue with prefix
+  'queue_name_delimiter' => '.', # Active Job queue with custom delimiter (default: '_')
   'description' => 'A sentence describing what work this job performs'
   'status' => 'disabled' # default: enabled
 }
@@ -66,6 +62,23 @@ gem "sidekiq-cron"
 
 **NOTE** The `status` of a job does not get changed in Redis when a job gets reloaded unless the `status` property is explicitly set.
 
+### Configuration
+
+All configuration options:
+
+```ruby
+Sidekiq::Cron.configure do |config|
+  config.cron_poll_interval = 10
+  config.cron_schedule_file = 'config/my_schedule.yml'
+  config.default_namespace = 'statistics'
+  config.natural_cron_parsing_mode = :single
+  config.reschedule_grace_period = 100
+  config.cron_history_size = 50
+end
+```
+
+If you are using Rails, add them inside an initializer (`config/initializers/sidekiq-cron.rb`).
+
 ### Time, cron and Sidekiq-Cron
 
 For testing your cron notation you can use [crontab.guru](https://crontab.guru).
@@ -79,9 +92,9 @@ 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:
+Since Sidekiq-Cron `v1.7.0`, you can use the natural-language formats supported by Fugit, such as:
 
-```rb
+```ruby
 "every day at five" # => '0 5 * * *'
 "every 3 hours"     # => '0 */3 * * *'
 ```
@@ -122,7 +135,7 @@ Ex. `every day at 3:15 and 4:30`
 
 #### 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:
+In addition to the standard 5-parameter cronline format, Sidekiq-Cron supports scheduling jobs with second-precision using a modified 6-parameter cronline format:
 
 `Seconds Minutes Hours Days Months DayOfWeek`
 
@@ -131,7 +144,9 @@ 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[:cron_poll_interval] = 10
+Sidekiq::Cron.configure do |config|
+  config.cron_poll_interval = 10
+end
 ```
 
 The default value at time of writing is 30 seconds. See [under the hood](#under-the-hood) for more details.
@@ -142,9 +157,7 @@ The default value at time of writing is 30 seconds. See [under the hood](#under-
 
 When not giving a namespace, the `default` one will be used.
 
-In the case you'd like to change this value, create a new initializer like so:
-
-`config/initializers/sidekiq-cron.rb`:
+In the case you'd like to change this value, you can change it via the following configuration flag:
 
 ```ruby
 Sidekiq::Cron.configure do |config|
@@ -222,7 +235,7 @@ class ExampleJob < ActiveJob::Base
 end
 ```
 
-For Active jobs you can use `symbolize_args: true` in `Sidekiq::Cron::Job.create` or in Hash configuration,
+For Active Job 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 jobs
@@ -261,7 +274,7 @@ end
 
 Use ActiveRecord models as arguments:
 
-```rb
+```ruby
 class Person < ApplicationRecord
 end
 
@@ -325,7 +338,7 @@ Sidekiq::Cron::Job.load_from_array! array
 
 ### Loading jobs from schedule file
 
-You can also load multiple jobs from a YAML (same notation as `Resque-scheduler`) file:
+You can also load multiple jobs from a YAML file:
 
 ```yaml
 # config/schedule.yml
@@ -346,24 +359,31 @@ second_job:
 There are multiple ways to load the jobs from a YAML file
 
 1. The gem will automatically load the jobs mentioned in `config/schedule.yml` file (it supports ERB)
-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"`
+2. When you want to load jobs from a different filename, mention the filename in Sidekiq configuration as follows:
+
+    ```ruby
+    Sidekiq::Cron.configure do |config|
+      config.cron_schedule_file = "config/users_schedule.yml"
+    end
+    ```
+
 3. Load the file manually as follows:
 
-```ruby
-# config/initializers/sidekiq.rb
+    ```ruby
+    # config/initializers/sidekiq.rb
 
-Sidekiq.configure_server do |config|
-  config.on(:startup) do
-    schedule_file = "config/users_schedule.yml"
+    Sidekiq.configure_server do |config|
+      config.on(:startup) do
+        schedule_file = "config/users_schedule.yml"
 
-    if File.exist?(schedule_file)
-      schedule = YAML.load_file(schedule_file)
+        if File.exist?(schedule_file)
+          schedule = YAML.load_file(schedule_file)
 
-      Sidekiq::Cron::Job.load_from_hash!(schedule, source: "schedule")
+          Sidekiq::Cron::Job.load_from_hash!(schedule, source: "schedule")
+        end
+      end
     end
-  end
-end
-```
+    ```
 
 ### Finding jobs
 
@@ -409,7 +429,7 @@ job.status
 # => enabled/disabled
 
 # enqueue job right now!
-job.enque!
+job.enqueue!
 ```
 
 ### Schedule vs Dynamic jobs
@@ -448,14 +468,14 @@ 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[:cron_poll_interval] = 10
+Sidekiq::Cron.configure do |config|
+  config.cron_poll_interval = 10
+end
 ```
 
-When sidekiq (and sidekiq-cron) is not used in zero-downtime deployments, after the deployment is done sidekiq-cron starts to catch up. It will consider older jobs that missed their schedules during that time. By default, only jobs that should have started less than 1 minute ago are considered. This is problematic for some jobs, e.g., jobs that run once a day. If on average sidekiq is shut down for 10 minutes during deployments, you can configure sidekiq-cron to consider jobs that were about to be scheduled during that time:
+When Sidekiq (and Sidekiq-Cron) is not used in zero-downtime deployments, after the deployment is done Sidekiq-Cron starts to catch up. It will consider older jobs that missed their schedules during that time. By default, only jobs that should have started less than 1 minute ago are considered. This is problematic for some jobs, e.g., jobs that run once a day. If on average Sidekiq is shut down for 10 minutes during deployments, you can configure Sidekiq-Cron to consider jobs that were about to be scheduled during that time:
 
 ```ruby
-# config/initializers/sidekiq-cron.rb
-
 Sidekiq::Cron.configure do |config|
   config.reschedule_grace_period = 600 # 10 minutes in seconds
 end
@@ -463,7 +483,13 @@ end
 
 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::Options[:cron_poll_interval] = 0` on these processes.
+When running with many Sidekiq processes, the polling can add significant load to Redis. You can disable polling on some processes by setting:
+
+```ruby
+Sidekiq::Cron.configure do |config|
+  config.cron_poll_interval = 0
+end
+```
 
 ## Contributing
 
@@ -487,21 +513,21 @@ $ bundle exec rake test
 
 ### Using Docker
 
-[Docker](https://www.docker.com) allows you to run things in containers easing the development process.
-
 This project uses [Docker Compose](https://docs.docker.com/compose/) in order to orchestrate containers and get the test suite running on you local machine, and here you find the commands to run in order to get a complete environment to build and test this gem:
 
 1. Build the Docker image (only the first time):
 ```
 docker compose -f docker/docker-compose.yml build
 ```
+
 2. Run the test suite:
 ```
 docker compose -f docker/docker-compose.yml run --rm tests
 ```
+
 _This command will download the first time the project's dependencies (Redis so far), create the containers and run the default command to run the tests._
 
-#### Running other commands
+**Running other commands**
 
 In the case you need to run a command in the gem's container, you would do it like so:
 
@@ -510,7 +536,7 @@ docker compose -f docker/docker-compose.yml run --rm tests <HERE IS YOUR COMMAND
 ```
 _Note that `tests` is the Docker Compose service name defined in the `docker/docker-compose.yml` file._
 
-#### Running a single test file
+**Running a single test file**
 
 Given you only want to run the tests from the `test/unit/web_extension_test.rb` file, you need to pass its path with the `TEST` env variable, so here is the command:
 

data/lib/sidekiq/cron/job.rb

@@ -3,9 +3,7 @@
 require 'fugit'
 require 'cronex'
 require 'globalid'
-require 'sidekiq'
 require 'sidekiq/cron/support'
-require 'sidekiq/options'
 
 module Sidekiq
   module Cron
@@ -16,9 +14,6 @@ module Sidekiq
       # Time format for enqueued jobs.
       LAST_ENQUEUE_TIME_FORMAT = '%Y-%m-%d %H:%M:%S %z'
 
-      # Use the exists? method if we're on a newer version of Redis.
-      REDIS_EXISTS_METHOD = Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("7.0.0") || Gem.loaded_specs['redis'].version < Gem::Version.new('4.2') ? :exists : :exists?
-
       # Use serialize/deserialize key of GlobalID.
       GLOBALID_KEY = "_sc_globalid"
 
@@ -92,7 +87,7 @@ module Sidekiq
       end
 
       # Crucial part of whole enqueuing job.
-      def should_enque? time
+      def should_enqueue? time
         return false unless status == "enabled"
         return false if past_scheduled_time?(time)
         return false if enqueued_after?(time)
@@ -105,23 +100,23 @@ module Sidekiq
 
       # Remove previous information about run times,
       # this will clear Redis and make sure that Redis will not overflow with memory.
-      def remove_previous_enques time
+      def remove_previous_enqueues time
         Sidekiq.redis do |conn|
           conn.zremrangebyscore(job_enqueued_key, 0, "(#{(time.to_f - REMEMBER_THRESHOLD).to_s}")
         end
       end
 
       # Test if job should be enqueued.
-      def test_and_enque_for_time! time
-        if should_enque?(time)
-          enque!
+      def test_and_enqueue_for_time! time
+        if should_enqueue?(time)
+          enqueue!
 
-          remove_previous_enques(time)
+          remove_previous_enqueues(time)
         end
       end
 
       # Enqueue cron job to queue.
-      def enque! time = Time.now.utc
+      def enqueue! time = Time.now.utc
         @last_enqueue_time = time
 
         klass_const =
@@ -413,7 +408,7 @@ module Sidekiq
 
       # Export job data to hash.
       def to_hash
-        hash = {
+        {
           name: @name,
           namespace: @namespace,
           klass: @klass.to_s,
@@ -421,6 +416,7 @@ module Sidekiq
           description: @description,
           source: @source,
           args: @args.is_a?(String) ? @args : Sidekiq.dump_json(@args || []),
+          date_as_argument: date_as_argument? ? "1" : "0",
           message: @message.is_a?(String) ? @message : Sidekiq.dump_json(@message || {}),
           status: @status,
           active_job: @active_job ? "1" : "0",
@@ -429,12 +425,6 @@ module Sidekiq
           last_enqueue_time: serialized_last_enqueue_time,
           symbolize_args: symbolize_args? ? "1" : "0",
         }
-
-        if date_as_argument?
-          hash.merge!(date_as_argument: "1")
-        end
-
-        hash
       end
 
       def errors
@@ -447,6 +437,7 @@ module Sidekiq
 
         errors << "'name' must be set" if @name.nil? || @name.size == 0
         errors << "'namespace' must be set" if @namespace.nil? || @namespace.size == 0
+        errors << "'namespace' cannot be '*'" if @namespace == "*"
 
         if @cron.nil? || @cron.size == 0
           errors << "'cron' must be set"
@@ -482,14 +473,19 @@ module Sidekiq
           conn.sadd self.class.jobs_key(@namespace), [redis_key]
 
           # Add information for this job!
-          conn.hset redis_key, to_hash.transform_values! { |v| v || '' }
+          conn.hset redis_key, to_hash.transform_values! { |v| v || '' }.flatten
 
-          # Add information about last time! - don't enque right after scheduler poller starts!
+          # Add information about last time! - don't enqueue right after scheduler poller starts!
           time = Time.now.utc
-          exists = conn.public_send(REDIS_EXISTS_METHOD, job_enqueued_key)
-          conn.zadd(job_enqueued_key, time.to_f.to_s, formatted_last_time(time).to_s) unless exists == true || exists == 1
+          exists = conn.exists(job_enqueued_key)
+
+          unless exists == true || exists == 1
+            conn.zadd(job_enqueued_key, time.to_f.to_s, formatted_last_time(time).to_s)
+            Sidekiq.logger.info { "Cron Jobs - added job with name #{@name} in the namespace #{@namespace}" }
+          end
         end
-        Sidekiq.logger.info { "Cron Jobs - added job with name #{@name} in the namespace #{@namespace}" }
+
+        true
       end
 
       def save_last_enqueue_time
@@ -505,7 +501,7 @@ module Sidekiq
           enqueued: @last_enqueue_time
         }
 
-        @history_size ||= (Sidekiq::Options[:cron_history_size] || 10).to_i - 1
+        @history_size ||= Sidekiq::Cron.configuration.cron_history_size.to_i - 1
         Sidekiq.redis do |conn|
           conn.lpush jid_history_key,
                      Sidekiq.dump_json(jid_history)
@@ -572,7 +568,7 @@ module Sidekiq
 
       def self.exists?(name, namespace = Sidekiq::Cron.configuration.default_namespace)
         out = Sidekiq.redis do |conn|
-          conn.public_send(REDIS_EXISTS_METHOD, redis_key(name, namespace))
+          conn.exists(redis_key(name, namespace))
         end
 
         [true, 1].include?(out)

data/lib/sidekiq/cron/launcher.rb

@@ -1,5 +1,3 @@
-require 'sidekiq/cron/poller'
-
 # For Cron we need to add some methods to Launcher
 # so look at the code below.
 #
@@ -8,14 +6,13 @@ require 'sidekiq/cron/poller'
 module Sidekiq
   module Cron
     module Launcher
-      DEFAULT_POLL_INTERVAL = 30
 
       # Add cron poller to launcher.
       attr_reader :cron_poller
 
       # Add cron poller and execute normal initialize of Sidekiq launcher.
       def initialize(config, **kwargs)
-        config[:cron_poll_interval] = DEFAULT_POLL_INTERVAL if config[:cron_poll_interval].nil?
+        config[:cron_poll_interval] = Sidekiq::Cron.configuration.cron_poll_interval.to_i
 
         @cron_poller = Sidekiq::Cron::Poller.new(config) if config[:cron_poll_interval] > 0
         super

data/lib/sidekiq/cron/namespace.rb

@@ -1,5 +1,3 @@
-require 'sidekiq'
-
 module Sidekiq
   module Cron
     class Namespace

data/lib/sidekiq/cron/poller.rb

@@ -1,20 +1,12 @@
 # frozen_string_literal: true
 
-require 'sidekiq'
-require 'sidekiq/cron'
 require 'sidekiq/scheduled'
-require 'sidekiq/options'
 
 module Sidekiq
   module Cron
     # The Poller checks Redis every N seconds for scheduled cron jobs.
     class Poller < Sidekiq::Scheduled::Poller
       def initialize(config = nil)
-        if Gem::Version.new(Sidekiq::VERSION) < Gem::Version.new('6.5.0')
-          # Old version of Sidekiq does not accept a config argument.
-          @config = config
-        end
-
         super
       end
 
@@ -40,7 +32,7 @@ module Sidekiq
       private
 
       def enqueue_job(job, time = Time.now.utc)
-        job.test_and_enque_for_time! time if job && job.valid?
+        job.test_and_enqueue_for_time! time if job && job.valid?
       rescue => ex
         # Problem somewhere in one job.
         Sidekiq.logger.error "CRON JOB: #{ex.message}"

data/lib/sidekiq/cron/schedule_loader.rb

@@ -1,9 +1,5 @@
-require 'sidekiq'
-require 'sidekiq/cron/job'
-require 'sidekiq/options'
-
 Sidekiq.configure_server do |config|
-  schedule_file = Sidekiq::Options[:cron_schedule_file] || 'config/schedule.yml'
+  schedule_file = Sidekiq::Cron.configuration.cron_schedule_file
 
   if File.exist?(schedule_file)
     config.on(:startup) do

data/lib/sidekiq/cron/support.rb

@@ -1,8 +1,7 @@
-# https://github.com/rails/rails/blob/352865d0f835c24daa9a2e9863dcc9dde9e5371a/activesupport/lib/active_support/inflector/methods.rb#L270
-
 module Sidekiq
   module Cron
     module Support
+      # Inspired by Active Support Inflector
       def self.constantize(camel_cased_word)
         names = camel_cased_word.split("::".freeze)
 

data/lib/sidekiq/cron/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Cron
-    VERSION = "2.0.0.rc1"
+    VERSION = "2.0.0.rc2"
   end
 end

data/lib/sidekiq/cron/views/cron.erb

@@ -5,7 +5,7 @@
       <small><%= @current_namespace %></small>
     </h3>
   </div>
-  <div class='col-sm-7 pull-right' style="margin-top: 20px; margin-bottom: 10px;">
+  <div class='col-sm-7 pull-right h2'>
     <% if @cron_jobs.size > 0 %>
       <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/all/delete" method="post" class="pull-right">
         <%= csrf_tag if respond_to?(:csrf_tag) %>
@@ -31,7 +31,7 @@
 <div class='row'>
   <div class="col-sm-12 summary_bar">
     <ul class="list-unstyled summary row">
-      <% @namespaces.sort_by { |namespace| namespace[:name] } .each do |namespace| %>
+      <% @namespaces.sort_by { |namespace| namespace[:name] }.each do |namespace| %>
         <li class="col-sm-1">
           <a href="<%= root_path %>cron/namespaces/<%= namespace[:name] %>">
             <span class="count"><%= namespace[:count] %></span>
@@ -47,63 +47,59 @@
 <% if @cron_jobs.size > 0 %>
   <table class="table table-hover table-bordered table-striped table-white">
     <thead>
+    <tr>
       <th><%= t('Status') %></th>
-      <th><%= t('Name') %></th>
+      <th width="50%"><%= t('Name') %></th>
       <th><%= t('Cron string') %></th>
       <th><%= t('Last enqueued') %></th>
-      <th width="180"><%= t('Actions')%></th>
+      <th width="180"><%= t('Actions') %></th>
+    </tr>
     </thead>
 
     <tbody>
-      <% @cron_jobs.sort{|a,b| a.sort_name <=> b.sort_name }.each_with_index do |job, index| %>
-        <% style = "#{job.status == 'disabled' ? "background: #ecc; color: #585454;": ""}" %>
+      <% @cron_jobs.sort{ |a,b| a.sort_name <=> b.sort_name }.each do |job| %>
+        <% klass = (job.status == 'disabled') ? 'bg-danger text-muted' : '' %>
+        <% escaped_job_name = CGI.escape(job.name).gsub('+', '%20') %>
         <tr>
-          <td style="<%= style %>"><%= t job.status %></td>
-          <td style="<%= style %>">
-            <a href="<%= root_path %>cron/namespaces/<%= @current_namespace %>/jobs/<%= CGI.escape(job.name).gsub('+', '%20') %>" title="<%= job.description %>">
-              <b style="<%= style %>"><%= job.name %></b>
+          <td class="<%= klass %>"><%= t job.status %></td>
+          <td class="<%= klass %>">
+            <a href="<%= root_path %>cron/namespaces/<%= job.namespace %>/jobs/<%= escaped_job_name %>" title="<%= job.description %>">
+              <b class="<%= klass %>"><%= job.name %></b>
             </a>
-            <hr style="margin:3px;border:0;">
-            <small>
+            <br/>
             <% if job.message and job.message.to_s.size > 100 %>
-              <% if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("6.3.0") %>
-                <button data-toggle="job_<%= index %>" class="btn btn-warn btn-xs"><%= t('ShowAll')%></button>
-                <div class="toggle" id="job_<%= index %>" style="display: inline;"><%= job.message[0..100] + "... " %></div>
-                <div class="toggle" id="job_<%= index %>_full" style="display: none;"><%= job.message %></div>
-              <% else %>
-                <button data-toggle="collapse" data-target=".worker_<%= index %>" class="btn btn-warn btn-xs"><%= t('ShowAll')%></button>
-                <div class="toggle worker_<%= index %>" style="display: inline;"><%= job.message[0..100] + "... " %></div>
-                <div class="toggle worker_<%= index %>" style="display: none;"><%= job.message %></div>
-              <% end %>
+              <details>
+                <summary class="btn btn-warn btn-xs">Show message</summary>
+                <p><small><%= job.message %></small></p>
+              </details>
             <% else %>
-              <%= job.message %>
+              <small><%= job.message %></small>
             <% end %>
-            </small>
           </td>
-          <td style="<%= style %>"><b><%= job.human_cron %><br/><small><%= job.cron.gsub(" ", "&nbsp;") %></small></b></td>
-          <td style="<%= style %>"><%= job.last_enqueue_time ? relative_time(job.last_enqueue_time) : "-" %></td>
-          <td style="<%= style %>">
+          <td class="<%= klass %>"><b><%= job.human_cron %><br/><small><%= job.cron.gsub(" ", "&nbsp;") %></small></b></td>
+          <td class="<%= klass %>"><%= job.last_enqueue_time ? relative_time(job.last_enqueue_time) : "-" %></td>
+          <td class="<%= klass %>">
             <% if job.status == 'enabled' %>
-              <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/jobs/<%= CGI.escape(job.name).gsub('+', '%20') %>/enque" method="post">
+              <form action="<%= root_path %>cron/namespaces/<%= job.namespace %>/jobs/<%= escaped_job_name %>/enque" method="post">
                 <%= csrf_tag if respond_to?(:csrf_tag) %>
                 <input class='btn btn-warn btn-xs pull-left' type="submit" name="enque" value="<%= t('EnqueueNow') %>" data-confirm="<%= t('AreYouSureEnqueueCronJob', :job => job.name) %>"/>
               </form>
-              <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/jobs/<%= CGI.escape(job.name).gsub('+', '%20') %>/disable" method="post">
+              <form action="<%= root_path %>cron/namespaces/<%= job.namespace %>/jobs/<%= escaped_job_name %>/disable" method="post">
                 <%= csrf_tag if respond_to?(:csrf_tag) %>
                 <input class='btn btn-warn btn-xs pull-left' type="submit" name="disable" value="<%= t('Disable') %>"/>
               </form>
             <% else %>
-              <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/jobs/<%= CGI.escape(job.name).gsub('+', '%20') %>/enque" method="post">
+              <form action="<%= root_path %>cron/namespaces/<%= job.namespace %>/jobs/<%= escaped_job_name %>/enque" method="post">
                 <%= csrf_tag if respond_to?(:csrf_tag) %>
-                <input class='btn btn-warn btn-xs pull-left' type="submit" name="enque" value="<%= t('EnqueueNow') %>"/>
+                <input class='btn btn-warn btn-xs pull-left' type="submit" name="enque" value="<%= t('EnqueueNow') %>" data-confirm="<%= t('AreYouSureEnqueueCronJob', :job => job.name) %>"/>
               </form>
-              <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/jobs/<%= CGI.escape(job.name).gsub('+', '%20') %>/enable" method="post">
+              <form action="<%= root_path %>cron/namespaces/<%= job.namespace %>/jobs/<%= escaped_job_name %>/enable" method="post">
                 <%= csrf_tag if respond_to?(:csrf_tag) %>
                 <input class='btn btn-warn btn-xs pull-left' type="submit" name="enable" value="<%= t('Enable') %>"/>
               </form>
-              <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/jobs/<%= CGI.escape(job.name).gsub('+', '%20') %>/delete" method="post">
+              <form action="<%= root_path %>cron/namespaces/<%= job.namespace %>/jobs/<%= escaped_job_name %>/delete" method="post">
                 <%= csrf_tag if respond_to?(:csrf_tag) %>
-                <input class='btn btn-xs btn-danger pull-left' type="submit" name="delete" value="<%= t('Delete') %>" data-confirm="<%= t('AreYouSureDeleteCronJob', :job => job.name) %>"/>
+                <input class='btn btn-xs btn-danger pull-left help-block' type="submit" name="delete" value="<%= t('Delete') %>" data-confirm="<%= t('AreYouSureDeleteCronJob', :job => job.name) %>"/>
               </form>
             <% end %>
           </td>

data/lib/sidekiq/cron/views/cron_show.erb

@@ -5,25 +5,25 @@
       <small><%= @job.name %></small>
     </h3>
   </div>
-  <div class="span col-sm-7 pull-right" style="margin-top: 20px; margin-bottom: 10px;">
+  <div class="span col-sm-7 pull-right h2">
     <% cron_job_path = "#{root_path}cron/namespaces/#{@current_namespace}/jobs/#{CGI.escape(@job.name).gsub('+', '%20')}" %>
     <form action="<%= cron_job_path %>/enque?redirect=<%= cron_job_path %>" class="pull-right" method="post">
       <%= csrf_tag if respond_to?(:csrf_tag) %>
       <input class="btn btn-warn pull-left" name="enque" type="submit" value="<%= t('EnqueueNow') %>" data-confirm="<%= t('AreYouSureEnqueueCronJob', :job => @job.name) %>" />
     </form>
     <% if @job.status == 'enabled' %>
-      <form action="<%= cron_job_path %>/disable?redirect=<%= cron_job_path %>" method="post">
+      <form action="<%= cron_job_path %>/disable?redirect=<%= cron_job_path %>" class="pull-right" method="post">
         <%= csrf_tag if respond_to?(:csrf_tag) %>
         <input class="btn btn-warn pull-left" name="disable" type="submit" value="<%= t('Disable') %>" />
       </form>
     <% else %>
-      <form action="<%= cron_job_path %>/enable?redirect=<%= cron_job_path %>" method="post">
+      <form action="<%= cron_job_path %>/enable?redirect=<%= cron_job_path %>" class="pull-right" method="post">
         <%= csrf_tag if respond_to?(:csrf_tag) %>
         <input class="btn btn-warn pull-left" name="enable" type="submit" value="<%= t('Enable') %>" />
       </form>
-      <form action="<%= cron_job_path %>/delete" method="post">
+      <form action="<%= cron_job_path %>/delete" class="pull-right" method="post">
         <%= csrf_tag if respond_to?(:csrf_tag) %>
-        <input class="btn btn-danger" data-confirm="<%= t('AreYouSureDeleteCronJob', :job => @job.name) %>" name="delete" type="submit" value="<%= t('Delete') %>" />
+        <input class="btn btn-danger pull-left" data-confirm="<%= t('AreYouSureDeleteCronJob', :job => @job.name) %>" name="delete" type="submit" value="<%= t('Delete') %>" />
       </form>
     <% end %>
   </div>

data/lib/sidekiq/cron/web.rb

@@ -1,7 +1,17 @@
 require "sidekiq/cron/web_extension"
 require "sidekiq/cron/job"
+require "sidekiq/cron/namespace"
 
 if defined?(Sidekiq::Web)
-  Sidekiq::Web.register Sidekiq::Cron::WebExtension
-  Sidekiq::Web.tabs["Cron"] = "cron"
+  if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new('7.3.0')
+    Sidekiq::Web.register(
+      Sidekiq::Cron::WebExtension, # Class which contains the HTTP actions, required
+      name: "cron", # the name of the extension, used to namespace assets
+      tab: "Cron", # labels(s) of the UI tabs
+      index: "cron", # index route(s) for each tab
+    )
+  else
+    Sidekiq::Web.register Sidekiq::Cron::WebExtension
+    Sidekiq::Web.tabs["Cron"] = "cron"
+  end
 end

data/lib/sidekiq/cron/web_extension.rb

@@ -4,6 +4,13 @@ module Sidekiq
       def self.registered(app)
         app.settings.locales << File.join(File.expand_path("..", __FILE__), "locales")
 
+        app.helpers do
+          # This method constructs the URL for the cron jobs page within the specified namespace.
+          def namespace_redirect_path
+            "#{root_path}cron/namespaces/#{route_params[:namespace]}"
+          end
+        end
+
         # Index page of cron jobs.
         app.get '/cron' do
           view_path = File.join(File.expand_path("..", __FILE__), "views")
@@ -44,28 +51,28 @@ module Sidekiq
           if @job
             render(:erb, File.read(File.join(view_path, "cron_show.erb")))
           else
-            redirect "#{root_path}cron/namespaces/#{route_params[:namespace]}"
+            redirect namespace_redirect_path
           end
         end
 
-        # Enque all cron jobs.
+        # Enqueue all cron jobs.
         app.post '/cron/namespaces/:namespace/all/enque' do
-          Sidekiq::Cron::Job.all(route_params[:namespace]).each(&:enque!)
-          redirect params['redirect'] || "#{root_path}cron/namespaces/#{route_params[:namespace]}"
+          Sidekiq::Cron::Job.all(route_params[:namespace]).each(&:enqueue!)
+          redirect params['redirect'] || namespace_redirect_path
         end
 
         # Enqueue cron job.
         app.post '/cron/namespaces/:namespace/jobs/:name/enque' do
           if job = Sidekiq::Cron::Job.find(route_params[:name], route_params[:namespace])
-            job.enque!
+            job.enqueue!
           end
-          redirect params['redirect'] || "#{root_path}cron"
+          redirect params['redirect'] || namespace_redirect_path
         end
 
         # Delete all schedules.
         app.post '/cron/namespaces/:namespace/all/delete' do
           Sidekiq::Cron::Job.all(route_params[:namespace]).each(&:destroy)
-          redirect "#{root_path}cron/namespaces/#{route_params[:namespace]}"
+          redirect params['redirect'] || namespace_redirect_path
         end
 
         # Delete schedule.
@@ -73,13 +80,13 @@ module Sidekiq
           if job = Sidekiq::Cron::Job.find(route_params[:name], route_params[:namespace])
             job.destroy
           end
-          redirect "#{root_path}cron"
+          redirect params['redirect'] || namespace_redirect_path
         end
 
         # Enable all jobs.
         app.post '/cron/namespaces/:namespace/all/enable' do
           Sidekiq::Cron::Job.all(route_params[:namespace]).each(&:enable!)
-          redirect params['redirect'] || "#{root_path}cron/namespaces/#{route_params[:namespace]}"
+          redirect params['redirect'] || namespace_redirect_path
         end
 
         # Enable job.
@@ -87,13 +94,13 @@ module Sidekiq
           if job = Sidekiq::Cron::Job.find(route_params[:name], route_params[:namespace])
             job.enable!
           end
-          redirect params['redirect'] || "#{root_path}cron"
+          redirect params['redirect'] || namespace_redirect_path
         end
 
         # Disable all jobs.
         app.post '/cron/namespaces/:namespace/all/disable' do
           Sidekiq::Cron::Job.all(route_params[:namespace]).each(&:disable!)
-          redirect params['redirect'] || "#{root_path}cron/namespaces/#{route_params[:namespace]}"
+          redirect params['redirect'] || namespace_redirect_path
         end
 
         # Disable job.
@@ -101,7 +108,7 @@ module Sidekiq
           if job = Sidekiq::Cron::Job.find(route_params[:name], route_params[:namespace])
             job.disable!
           end
-          redirect params['redirect'] || "#{root_path}cron"
+          redirect params['redirect'] || namespace_redirect_path
         end
       end
     end

data/lib/sidekiq/cron.rb

@@ -1,9 +1,3 @@
-require "sidekiq/cron/job"
-require "sidekiq/cron/namespace"
-require "sidekiq/cron/poller"
-require "sidekiq/cron/launcher"
-require "sidekiq/cron/schedule_loader"
-
 module Sidekiq
   module Cron
     class << self
@@ -15,6 +9,10 @@ module Sidekiq
       yield(configuration) if block_given?
     end
 
+    def self.reset!
+      self.configuration = Configuration.new
+    end
+
     class Configuration
       # The default namespace is used when no namespace is specified.
       attr_accessor :default_namespace
@@ -33,10 +31,24 @@ module Sidekiq
       # jobs that missed their schedules during the deployment. E.g., jobs that run once a day.
       attr_accessor :reschedule_grace_period
 
+      # The maximum number of recent cron job execution histories to retain.
+      # This value controls how many past job executions are stored.
+      attr_accessor :cron_history_size
+
+      # The interval, in seconds, at which to poll for scheduled cron jobs.
+      # This determines how frequently the scheduler checks for jobs to enqueue.
+      attr_accessor :cron_poll_interval
+
+      # The path to a YAML file containing multiple cron job schedules.
+      attr_accessor :cron_schedule_file
+
       def initialize
         @default_namespace = 'default'
         @natural_cron_parsing_mode = :single
         @reschedule_grace_period = 60
+        @cron_history_size = 10
+        @cron_poll_interval = 30
+        @cron_schedule_file = 'config/schedule.yml'
       end
 
       def natural_cron_parsing_mode=(mode)

data/lib/sidekiq/options.rb

@@ -1,5 +1,4 @@
-require 'sidekiq'
-
+# Module to access Sidekiq config
 module Sidekiq
   module Options
     def self.[](key)
@@ -16,13 +15,12 @@ module Sidekiq
 
     def self.options_field
       return @options_field unless @options_field.nil?
+
       sidekiq_version = Gem::Version.new(Sidekiq::VERSION)
       @options_field = if sidekiq_version >= Gem::Version.new('7.0')
         :default_configuration
-      elsif sidekiq_version >= Gem::Version.new('6.5')
-        false
       else
-        :options
+        false
       end
     end
   end

data/lib/sidekiq-cron.rb

@@ -1,2 +1,8 @@
 require "sidekiq"
 require "sidekiq/cron"
+require "sidekiq/options"
+require "sidekiq/cron/job"
+require "sidekiq/cron/namespace"
+require "sidekiq/cron/poller"
+require "sidekiq/cron/launcher"
+require "sidekiq/cron/schedule_loader"

data/sidekiq-cron.gemspec

@@ -27,9 +27,9 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 2.7"
 
   s.add_dependency("cronex", ">= 0.13.0")
-  s.add_dependency("fugit", "~> 1.8")
+  s.add_dependency("fugit", "~> 1.8", ">= 1.11.1")
   s.add_dependency("globalid", ">= 1.0.1")
-  s.add_dependency("sidekiq", ">= 6")
+  s.add_dependency("sidekiq", ">= 6.5.0")
 
   s.add_development_dependency("minitest", "~> 5.15")
   s.add_development_dependency("mocha", "~> 2.1")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-cron
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0.rc2
 platform: ruby
 authors:
 - Ondrej Bartas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-31 00:00:00.000000000 Z
+date: 2024-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cronex
@@ -31,6 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.1
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +64,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: 6.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: 6.5.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -216,11 +222,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Scheduler/Cron for Sidekiq jobs