sidekiq-cron 1.5.1 → 1.12.0

data/lib/sidekiq/cron/launcher.rb

@@ -1,38 +1,41 @@
-# require cron poller
 require 'sidekiq/cron/poller'
 
 # For Cron we need to add some methods to Launcher
 # so look at the code bellow.
 #
-# we are creating new cron poller instance and
-# adding start and stop commands to launcher
+# We are creating new cron poller instance and
+# adding start and stop commands to launcher.
 module Sidekiq
   module Cron
     module Launcher
-      # Add cron poller to 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(options)
-        @cron_poller = Sidekiq::Cron::Poller.new
-        super(options)
+      # 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?
+
+        @cron_poller = Sidekiq::Cron::Poller.new(config) if config[:cron_poll_interval] > 0
+        super
       end
 
-      # execute normal run of launcher and run cron poller
+      # Execute normal run of launcher and run cron poller.
       def run
         super
-        cron_poller.start
+        cron_poller.start if @cron_poller
       end
 
-      # execute normal quiet of launcher and quiet cron poller
+      # Execute normal quiet of launcher and quiet cron poller.
       def quiet
-        cron_poller.terminate
+        cron_poller.terminate if @cron_poller
         super
       end
 
-      # execute normal stop of launcher and stop cron poller
+      # Execute normal stop of launcher and stop cron poller.
       def stop
-        cron_poller.terminate
+        cron_poller.terminate if @cron_poller
         super
       end
     end
@@ -40,7 +43,6 @@ module Sidekiq
 end
 
 Sidekiq.configure_server do
-  # require  Sidekiq original launcher
   require 'sidekiq/launcher'
 
   ::Sidekiq::Launcher.prepend(Sidekiq::Cron::Launcher)

data/lib/sidekiq/cron/locales/it.yml

@@ -0,0 +1,23 @@
+it:
+  Job: Job
+  Cron: Cron
+  CronJobs: Cron job
+  EnqueueNow: Accoda
+  EnableAll: Attiva tutto
+  DisableAll: Disattiva tutto
+  EnqueueAll: Accoda tutto
+  DeleteAll: Cancella tutto
+  "Cron string": Cron
+  AreYouSureEnqueueCronJobs: Vuoi accodare TUTTI i cron job?
+  AreYouSureEnqueueCronJob: "Vuoi accodare il cron job '%{job}'?"
+  AreYouSureDeleteCronJobs: Vuoi cancellare TUTTI i cron job?
+  AreYouSureDeleteCronJob: "Vuoi cancellare il cron job '%{job}'?"
+  NoCronJobsWereFound: Nessun cron job trovato
+  Enable: Attiva
+  Disable: Disattiva
+  "Last enqueued": Ultimo accodamento
+  disabled: disattivato
+  enabled: attivato
+  NoHistoryWereFound: Nessun evento in cronologia
+  Description: Descrizione
+  Message: Payload

data/lib/sidekiq/cron/poller.rb

@@ -1,27 +1,19 @@
 require 'sidekiq'
 require 'sidekiq/cron'
 require 'sidekiq/scheduled'
+require 'sidekiq/options'
 
 module Sidekiq
   module Cron
-    POLL_INTERVAL = 30
-
-    # The Poller checks Redis every N seconds for sheduled cron jobs
+    # The Poller checks Redis every N seconds for sheduled cron jobs.
     class Poller < Sidekiq::Scheduled::Poller
-      def initialize
-        Sidekiq.configure_server do |config|
-          if config.respond_to?(:[])
-            config[:poll_interval_average] = config[:average_scheduled_poll_interval] || POLL_INTERVAL
-          else
-            config.options[:poll_interval_average] = config.options[:average_scheduled_poll_interval] || POLL_INTERVAL
-          end
-        end
-
-        if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("6.5.0")
-          # Sidekiq Poller init requires a config argument
-          super(Sidekiq)
-        else
+      def initialize(config = nil)
+        if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new('6.5.0')
           super
+        else
+          # Old version of Sidekiq does not accept a config argument.
+          @config = config
+          super()
         end
       end
 
@@ -32,7 +24,7 @@ module Sidekiq
         end
       rescue => ex
         # Most likely a problem with redis networking.
-        # Punt and try again at the next interval
+        # Punt and try again at the next interval.
         Sidekiq.logger.error ex.message
         Sidekiq.logger.error ex.backtrace.first
         handle_exception(ex) if respond_to?(:handle_exception)
@@ -43,11 +35,15 @@ module Sidekiq
       def enqueue_job(job, time = Time.now.utc)
         job.test_and_enque_for_time! time if job && job.valid?
       rescue => ex
-        # problem somewhere in one job
+        # Problem somewhere in one job.
         Sidekiq.logger.error "CRON JOB: #{ex.message}"
         Sidekiq.logger.error "CRON JOB: #{ex.backtrace.first}"
         handle_exception(ex) if respond_to?(:handle_exception)
       end
+
+      def poll_interval_average(process_count = 1)
+        @config[:cron_poll_interval]
+      end
     end
   end
 end

data/lib/sidekiq/cron/schedule_loader.rb

@@ -0,0 +1,20 @@
+require 'sidekiq'
+require 'sidekiq/cron/job'
+require 'sidekiq/options'
+
+Sidekiq.configure_server do |config|
+  schedule_file = Sidekiq::Options[:cron_schedule_file] || 'config/schedule.yml'
+
+  if File.exist?(schedule_file)
+    config.on(:startup) do
+      schedule = Sidekiq::Cron::Support.load_yaml(ERB.new(IO.read(schedule_file)).result)
+      if schedule.kind_of?(Hash)
+        Sidekiq::Cron::Job.load_from_hash!(schedule, source: "schedule")
+      elsif schedule.kind_of?(Array)
+        Sidekiq::Cron::Job.load_from_array!(schedule, source: "schedule")
+      else
+        raise "Not supported schedule format. Confirm your #{schedule_file}"
+      end
+    end
+  end
+end

data/lib/sidekiq/cron/support.rb

@@ -28,11 +28,18 @@ module Sidekiq
               const
             end
 
-            # owner is in Object, so raise
             constant.const_get(name, false)
           end
         end
       end
+
+      def self.load_yaml(src)
+        if Psych::VERSION > "4.0"
+          YAML.safe_load(src, permitted_classes: [Symbol], aliases: true)
+        else
+          YAML.load(src)
+        end
+      end
     end
   end
 end

data/lib/sidekiq/cron/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Cron
-    VERSION = "1.5.1"
+    VERSION = "1.12.0"
   end
 end

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

@@ -42,7 +42,7 @@
           <td style="<%= style %>"><%= t job.status %></td>
           <td style="<%= style %>">
             <a href="<%= root_path %>cron/<%= CGI.escape(job.name).gsub('+', '%20') %>">
-              <b><%= job.name %></b>
+              <b style="<%= style %>"><%= job.name %></b>
             </a>
             <hr style="margin:3px;border:0;">
             <small>

data/lib/sidekiq/cron/web_extension.rb

@@ -1,12 +1,10 @@
 module Sidekiq
   module Cron
     module WebExtension
-
       def self.registered(app)
-
         app.settings.locales << File.join(File.expand_path("..", __FILE__), "locales")
 
-        #index page of cron jobs
+        # Index page of cron jobs.
         app.get '/cron' do
           view_path    = File.join(File.expand_path("..", __FILE__), "views")
 
@@ -15,7 +13,7 @@ module Sidekiq
           render(:erb, File.read(File.join(view_path, "cron.erb")))
         end
 
-        # display job detail + jid history
+        # Display job detail + jid history.
         app.get '/cron/:name' do
           view_path = File.join(File.expand_path("..", __FILE__), "views")
 
@@ -27,7 +25,7 @@ module Sidekiq
           end
         end
 
-        #enque cron job
+        # Enqueue cron job.
         app.post '/cron/:name/enque' do
           if route_params[:name] === '__all__'
             Sidekiq::Cron::Job.all.each(&:enque!)
@@ -37,7 +35,7 @@ module Sidekiq
           redirect params['redirect'] || "#{root_path}cron"
         end
 
-        #delete schedule
+        # Delete schedule.
         app.post '/cron/:name/delete' do
           if route_params[:name] === '__all__'
             Sidekiq::Cron::Job.all.each(&:destroy)
@@ -47,7 +45,7 @@ module Sidekiq
           redirect "#{root_path}cron"
         end
 
-        #enable job
+        # Enable job.
         app.post '/cron/:name/enable' do
           if route_params[:name] === '__all__'
             Sidekiq::Cron::Job.all.each(&:enable!)
@@ -57,7 +55,7 @@ module Sidekiq
           redirect params['redirect'] || "#{root_path}cron"
         end
 
-        #disable job
+        # Disable job.
         app.post '/cron/:name/disable' do
           if route_params[:name] === '__all__'
             Sidekiq::Cron::Job.all.each(&:disable!)
@@ -66,7 +64,6 @@ module Sidekiq
           end
           redirect params['redirect'] || "#{root_path}cron"
         end
-
       end
     end
   end

data/lib/sidekiq/cron.rb

@@ -1,6 +1,7 @@
 require "sidekiq/cron/job"
 require "sidekiq/cron/poller"
 require "sidekiq/cron/launcher"
+require "sidekiq/cron/schedule_loader"
 
 module Sidekiq
   module Cron

data/lib/sidekiq/options.rb

@@ -0,0 +1,29 @@
+require 'sidekiq'
+
+module Sidekiq
+  module Options
+    def self.[](key)
+      self.config[key]
+    end
+
+    def self.[]=(key, value)
+      self.config[key] = value
+    end
+
+    def self.config
+      options_field ? Sidekiq.public_send(options_field) : Sidekiq
+    end
+
+    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
+      end
+    end
+  end
+end

data/sidekiq-cron.gemspec

@@ -5,18 +5,18 @@ require './lib/sidekiq/cron/version'
 Gem::Specification.new do |s|
   s.name = "sidekiq-cron"
   s.version = Sidekiq::Cron::VERSION
-
-  s.required_ruby_version = ">= 2.6"
-  s.require_paths = ["lib"]
+  s.summary = "Scheduler/Cron for Sidekiq jobs"
+  s.description = "Enables to set jobs to be run in specified time (using CRON notation or natural language)"
+  s.homepage = "https://github.com/sidekiq-cron/sidekiq-cron"
   s.authors = ["Ondrej Bartas"]
-  s.description = "Enables to set jobs to be run in specified time (using CRON notation)"
   s.email = "ondrej@bartas.cz"
+  s.licenses = ["MIT"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
   ]
-  s.files = Dir.glob('lib/**/*') + Dir.glob('test/**/*') + [
-    "Changes.md",
+  s.files = Dir.glob('lib/**/*') + [
+    "CHANGELOG.md",
     "Gemfile",
     "LICENSE.txt",
     "Rakefile",
@@ -24,18 +24,17 @@ Gem::Specification.new do |s|
     "sidekiq-cron.gemspec",
   ]
 
-  s.homepage = "https://github.com/ondrejbartas/sidekiq-cron"
-  s.licenses = ["MIT"]
-  s.summary = "Sidekiq-Cron helps to add repeated scheduled jobs"
+  s.required_ruby_version = ">= 2.7"
 
-  s.add_dependency("fugit", "~> 1")
-  s.add_dependency("sidekiq", ">= 4.2.1")
+  s.add_dependency("fugit", "~> 1.8")
+  s.add_dependency("sidekiq", ">= 6")
+  s.add_dependency("globalid", ">= 1.0.1")
 
   s.add_development_dependency("minitest", "~> 5.15")
-  s.add_development_dependency("mocha", "~> 1.14")
-  s.add_development_dependency("redis-namespace", "~> 1.8")
+  s.add_development_dependency("mocha", "~> 2.1")
   s.add_development_dependency("rack", "~> 2.2")
   s.add_development_dependency("rack-test", "~> 1.1")
   s.add_development_dependency("rake", "~> 13.0")
   s.add_development_dependency("simplecov", "~> 0.21")
+  s.add_development_dependency("simplecov-cobertura", "~> 2.1")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-cron
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.12.0
 platform: ruby
 authors:
 - Ondrej Bartas
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-10 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fugit
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: '6'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: globalid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.15'
-  type: :development
+        version: 1.0.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.15'
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '5.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '5.15'
 - !ruby/object:Gem::Dependency
-  name: redis-namespace
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +136,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.21'
-description: Enables to set jobs to be run in specified time (using CRON notation)
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Enables to set jobs to be run in specified time (using CRON notation
+  or natural language)
 email: ondrej@bartas.cz
 executables: []
 extensions: []
@@ -144,7 +159,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- Changes.md
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -155,28 +170,26 @@ files:
 - lib/sidekiq/cron/launcher.rb
 - lib/sidekiq/cron/locales/de.yml
 - lib/sidekiq/cron/locales/en.yml
+- lib/sidekiq/cron/locales/it.yml
 - lib/sidekiq/cron/locales/ja.yml
 - lib/sidekiq/cron/locales/pt.yml
 - lib/sidekiq/cron/locales/ru.yml
 - lib/sidekiq/cron/locales/zh-CN.yml
 - lib/sidekiq/cron/poller.rb
+- lib/sidekiq/cron/schedule_loader.rb
 - lib/sidekiq/cron/support.rb
 - lib/sidekiq/cron/version.rb
 - lib/sidekiq/cron/views/cron.erb
 - lib/sidekiq/cron/views/cron_show.erb
 - lib/sidekiq/cron/web.rb
 - lib/sidekiq/cron/web_extension.rb
+- lib/sidekiq/options.rb
 - sidekiq-cron.gemspec
-- test/integration/performance_test.rb
-- test/test_helper.rb
-- test/unit/job_test.rb
-- test/unit/poller_test.rb
-- test/unit/web_extension_test.rb
-homepage: https://github.com/ondrejbartas/sidekiq-cron
+homepage: https://github.com/sidekiq-cron/sidekiq-cron
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -184,15 +197,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
-summary: Sidekiq-Cron helps to add repeated scheduled jobs
+summary: Scheduler/Cron for Sidekiq jobs
 test_files: []

data/Changes.md

@@ -1,111 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-## 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)
-- Dark Mode support in UI (https://github.com/ondrejbartas/sidekiq-cron/pull/317/282)
-- Remove invocation of deprecated Redis functionality (https://github.com/ondrejbartas/sidekiq-cron/pull/318)
-- Internal code cleanup (https://github.com/ondrejbartas/sidekiq-cron/pull/317)
-- Optimize gem size (https://github.com/ondrejbartas/sidekiq-cron/pull/322)
-- Fix "Show All" button on cron jobs view with Sidekiq 6.3.0+ (https://github.com/ondrejbartas/sidekiq-cron/pull/321)
-- Documentation updates
-
-## 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
-
-## 1.2.0
-
-- Updated readme
-- Fix problem with Sidekiq::Launcher and requiring it when not needed
-- Better patching of Sidekiq::Launcher
-- Fixed Dockerfile
-
-## 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
-
-## 1.0.4
-
-- Fix problem with upgrading to 1.0.x - parsing last enqued time didn't count with old time format stored in Redis
-
-## 1.0.0
-
-- Use [fugit](https://github.com/floraison/fugit) instead of [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler) - API of cron didn't change (rufus scheduler is using fugit)
-- Better working with Timezones
-- Translations for JA, zh-CN
-- Cron without timezone are considered as UTC, to add Timezone to cron use format `* * * * * Europe/Berlin`
-- Be aware that this release can change when your jobs are enqueued (for me it didn't change but it is in one project, in other it can shift by different timezone setup)
-
-## 0.6.0
-
-- Set poller to check jobs every 30s by default (possible to override by `Sidekiq.options[:poll_interval] = 10`)
-- Add group actions (enqueue, enable, disable, delete) all in web view
-- 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
-
-## 0.5.0
-
-- Add Docker support
-- All crons are now evaluated in UTC
-- Fix rufus scheduler & timezones problems
-- Add support for Sidekiq 4.2.1
-- Fix readme
-- Add Russian locale
-- User Rack.env in tests
-- Faster enqueue of jobs
-- Permit to use ActiveJob::Base.queue_name_delimiter
-- Fix problem with multiple times enqueue #84
-- Fix problem with enqueue of unknown class
-
-## 0.4.0
-
-- Enable to work with Sidekiq >= 4.0.0
-- Fix readme
-
-## 0.3.1
-
-- Add CSRF tags to forms so it will work with Sidekiq >= 3.4.2
-- Remove Tilt dependency
-
-## 0.3.0
-
-- Suport for Active Job
-- Sidekiq cron web ui needs to be loaded by: require 'sidekiq/cron/web'
-- Add load_from_hash! and load_from_array! which cleanup jobs before adding new ones
-
-## 0.1.1
-
-- Add Web front-end with enabled/disable job, enqueue now, delete job
-- Add cron poller - enqueue cron jobs
-- Add cron job - save all needed data to Redis