que-scheduler 4.4.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aac67112308ae6e0840d46479cf890eb123f94c51ac9ac9a9a1b51900064cc96
-  data.tar.gz: 1e268c0c918988a05e4bb5912ff47aee45b680ade2c3b422ea9dbf5c1bd0fd18
+  metadata.gz: 97c2b6fc33ff2ee357b0270dae679c66b50064eb8548f0e3be24c07ea504d939
+  data.tar.gz: c1ea678b7540e3f02ac5c7eee3416d20238819eb4050bb2f3d6e7183f342022a
 SHA512:
-  metadata.gz: 7ba7be6ea94dfa50387a329e39753ce1b17df38aa13e8c106c49c4eabaa3a249be8528d8fc6985201736a87a74ef318083f4f9661d6153191f484f06136f3ede
-  data.tar.gz: eba73e89578334e55d4d39a253edf1d2822647eee62d733d52235184c8eaa9b36f64a7027fde5ed3c2a6ea2c73666a9ea6b82ed4ca62edbd5df1ed0bdeee6432
+  metadata.gz: cdb0c8db5b2b9ab99e6a1e8b04a9710a8c19913ebdcc528ed71e0b27f3dad7231887fc8415d85a5aea3bd91304f7682402530a9612ee77037ecf04b2ea050d80
+  data.tar.gz: 4aed1036ef3f2d9937b8928ec0ccb6e6fc14651d8803cbaaddf52b3d0c3da3a7b744a4aa5db5a898440cef9edd45f77325009552fe3b7c5c9bbe9448b701e34f

data/README.md

@@ -1,7 +1,7 @@
 que-scheduler
 ================
 
-[![Gem Version](https://badge.fury.io/rb/que-scheduler.svg)](https://badge.fury.io/rb/que-scheduler)
+[![Gem Version](https://img.shields.io/gem/v/que-scheduler?color=green)](https://img.shields.io/gem/v/que-scheduler?color=green)
 [![Coverage Status](https://coveralls.io/repos/github/hlascelles/que-scheduler/badge.svg?branch=master)](https://coveralls.io/github/hlascelles/que-scheduler?branch=master)
 [![Code Climate Maintainability](https://api.codeclimate.com/v1/badges/710d2fc5202f95d76e8a/maintainability)](https://codeclimate.com/github/hlascelles/que-scheduler/maintainability)
 
@@ -25,9 +25,9 @@ resque-scheduler files, but with additional features.
    will fail if Que is set to execute jobs synchronously, i.e. `Que::Job.run_synchronously = true`.
 
     ```ruby
-    class CreateQueSchedulerSchema < ActiveRecord::Migration
+    class CreateQueSchedulerSchema < ActiveRecord::Migration[6.0]
       def change
-        Que::Scheduler::Migrations.migrate!(version: 7)
+        Que::Scheduler::Migrations.migrate!(version: 8)
       end
     end
     ```
@@ -40,7 +40,8 @@ wish to generate the configuration dynamically, you can set it directly using an
 
 The file is a list of que job classes with arguments and a schedule frequency (in crontab 
 syntax). The format is similar to the resque-scheduler format, though priorities must be supplied as
-integers, and job classes must be migrated from Resque to Que. Cron syntax can be anything
+integers, and job classes must be migrated from Resque to Que.
+ActiveJob classes configured to use `:que` adapter are also supported. Cron syntax can be anything
 understood by [fugit](https://github.com/floraison/fugit#fugitcron).
 
 It has one additional feature, `schedule_type: every_event`. This is set on a job that must be run for every 
@@ -209,23 +210,25 @@ ie, This will perform all migrations necessary up to the latest version, skippin
 performed.
 
 ```ruby
-class CreateQueSchedulerSchema < ActiveRecord::Migration
+class CreateQueSchedulerSchema < ActiveRecord::Migration[6.0]
   def change
-    Que::Scheduler::Migrations.migrate!(version: 7)
+    Que::Scheduler::Migrations.migrate!(version: 8)
   end
 end
 ```
 
 The changes in past migrations were: 
 
-| Version | Changes                                                                         |
-|:-------:|---------------------------------------------------------------------------------|
-|    1    | Enqueued the main Que::Scheduler. This is the job that performs the scheduling. |
-|    2    | Added the audit table `que_scheduler_audit`.                                    |
-|    3    | Added the audit table `que_scheduler_audit_enqueued`.                           |
-|    4    | Updated the the audit tables to use bigints                                     |
-|    5    | Dropped an unnecessary index                                                    |
-|    6    | Enforced single scheduler job at the trigger level                              |
+| Version | Changes                                                                             |
+|:-------:|-------------------------------------------------------------------------------------|
+|    1    | Enqueued the main Que::Scheduler. This is the job that performs the scheduling.     |
+|    2    | Added the audit table `que_scheduler_audit`.                                        |
+|    3    | Added the audit table `que_scheduler_audit_enqueued`.                               |
+|    4    | Updated the the audit tables to use bigints                                         |
+|    5    | Dropped an unnecessary index                                                        |
+|    6    | Enforced single scheduler job at the trigger level                                  |
+|    7    | Prevent accidental deletion of scheduler job                                        |
+|    8    | Add primary key to audit. Note, this can be a slow migration if you have many rows! |
 
 The changes to the DB ([DDL](https://en.wikipedia.org/wiki/Data_definition_language)) are all 
 captured in the structure.sql so will be re-run in correctly if squashed - except for the actual 
@@ -310,7 +313,8 @@ A full changelog can be found here: [CHANGELOG.md](https://github.com/hlascelles
 
 Your [postgres](https://www.postgresql.org/) database must be at least version 9.6.0.
 
-The latest version of que-scheduler supports Ruby 2.7 and above.
+The latest version of que-scheduler supports Ruby 3.0 and above.
+que-scheduler versions below 4.4.0 work with Ruby 2.7.
 que-scheduler versions below 4.2.3 work with Ruby 2.5 and Ruby 2.6.
 
 Using que 0.x with Rails 6 needs a patch to support it. 

data/lib/que/scheduler/audit.rb

@@ -11,7 +11,7 @@ module Que
         INSERT INTO #{TABLE_NAME} (scheduler_job_id, executed_at)
         VALUES ($1::bigint, $2::timestamptz)
         RETURNING *
-      }
+      }.freeze
       INSERT_AUDIT_ENQUEUED = %{
         INSERT INTO #{ENQUEUED_TABLE_NAME}
         (scheduler_job_id, job_class, queue, priority, args, job_id, run_at)
@@ -20,7 +20,7 @@ module Que
           $4::integer, $5::jsonb, $6::bigint, $7::timestamptz
         )
         RETURNING *
-      }
+      }.freeze
 
       class << self
         def append(scheduler_job_id, executed_at, enqueued_jobs)

data/lib/que/scheduler/defined_job.rb

@@ -54,10 +54,8 @@ module Que
         validate_job_class_related(options)
       end
 
-      private
-
       # rubocop:disable Style/GuardClause This reads better as a conditional
-      def validate_fields_types(options)
+      private def validate_fields_types(options)
         unless queue.nil? || queue.is_a?(String)
           err_field(:queue, options, "queue must be a string")
         end
@@ -70,14 +68,14 @@ module Que
       end
       # rubocop:enable Style/GuardClause
 
-      def validate_fields_presence(options)
+      private def validate_fields_presence(options)
         err_field(:name, options, "name must be present") if name.nil?
         err_field(:job_class, options, "job_class must be present") if job_class.nil?
         # An invalid cron is nil
         err_field(:cron, options, "cron must be present") if cron.nil?
       end
 
-      def validate_job_class_related(options)
+      private def validate_job_class_related(options)
         # Only support known job engines
         unless Que::Scheduler::ToEnqueue.valid_job_class?(job_class)
           err_field(:job_class, options, "Job #{job_class} was not a supported job type")
@@ -104,14 +102,14 @@ module Que
         end
       end
 
-      def err_field(field, options, reason = "")
+      private def err_field(field, options, reason = "")
         schedule = Que::Scheduler.configuration.schedule_location
         value = options[field]
         raise "Invalid #{field} '#{value}' for '#{name}' in que-scheduler schedule #{schedule}.\n" \
               "#{reason}"
       end
 
-      def generate_to_enqueue_list(missed_times)
+      private def generate_to_enqueue_list(missed_times)
         return [] if missed_times.empty?
 
         options = to_h.slice(:args, :queue, :priority, :job_class).compact

data/lib/que/scheduler/migrations/8/down.sql

@@ -0,0 +1 @@
+ALTER TABLE que_scheduler_audit_enqueued DROP COLUMN "id";

data/lib/que/scheduler/migrations/8/up.sql

@@ -0,0 +1 @@
+ALTER TABLE que_scheduler_audit_enqueued ADD COLUMN id BIGSERIAL PRIMARY KEY;

data/lib/que/scheduler/migrations.rb

@@ -8,7 +8,7 @@ module Que
         SELECT description FROM pg_class
         LEFT JOIN pg_description ON pg_description.objoid = pg_class.oid
         WHERE relname = '#{AUDIT_TABLE_NAME}'
-      )
+      ).freeze
       MAX_VERSION = Dir.glob("#{__dir__}/migrations/*").map { |d| File.basename(d) }.map(&:to_i).max
 
       class << self
@@ -48,21 +48,19 @@ module Que
           Que::Scheduler::VersionSupport.enqueue_a_job(Que::Scheduler::SchedulerJob)
         end
 
-        private
-
-        def migrate_up(current, version)
+        private def migrate_up(current, version)
           if current.zero? # Version 1 does not use SQL
             Que::Scheduler::VersionSupport.enqueue_a_job(Que::Scheduler::SchedulerJob)
           end
           execute_step((current += 1), :up) until current == version
         end
 
-        def migrate_down(current, version)
+        private def migrate_down(current, version)
           current += 1
           execute_step((current -= 1), :down) until current == version + 1
         end
 
-        def execute_step(number, direction)
+        private def execute_step(number, direction)
           sql = File.read("#{__dir__}/migrations/#{number}/#{direction}.sql")
           Que::Scheduler::VersionSupport.execute(sql)
           return unless audit_table_exists?

data/lib/que/scheduler/scheduler_job.rb

@@ -38,16 +38,14 @@ module Que
       end
 
       def enqueue_required_jobs(calculator_result, logs)
-        calculator_result.missed_jobs.map do |to_enqueue|
+        calculator_result.missed_jobs.filter_map do |to_enqueue|
           to_enqueue.enqueue.tap do |enqueued_job|
             check_enqueued_job(to_enqueue, enqueued_job, logs)
           end
-        end.compact
+        end
       end
 
-      private
-
-      def check_enqueued_job(to_enqueue, enqueued_job, logs)
+      private def check_enqueued_job(to_enqueue, enqueued_job, logs)
         logs << if enqueued_job.present?
                   "que-scheduler enqueueing #{enqueued_job.job_class} " \
                     "#{enqueued_job.job_id} with args: #{enqueued_job.args}"
@@ -58,7 +56,8 @@ module Que
                 end
       end
 
-      def enqueue_self_again(scheduler_job_args, last_full_execution, job_dictionary, enqueued_jobs)
+      private def enqueue_self_again(scheduler_job_args, last_full_execution, job_dictionary,
+                                     enqueued_jobs)
         # Log last run...
         job_id = VersionSupport.job_attributes(self).fetch(:job_id)
         Audit.append(job_id, scheduler_job_args.as_time, enqueued_jobs)

data/lib/que/scheduler/state_checks.rb

@@ -10,9 +10,7 @@ module Que
           assert_db_migrated
         end
 
-        private
-
-        def assert_db_migrated
+        private def assert_db_migrated
           db_version = Que::Scheduler::Migrations.db_version
           return if db_version == Que::Scheduler::Migrations::MAX_VERSION
 
@@ -49,7 +47,7 @@ module Que
             To bring the db version up to the current one required, add a migration like this. It
             is cumulative, so one line is sufficient to perform all necessary steps.
 
-            class UpdateQueSchedulerSchema < ActiveRecord::Migration
+            class UpdateQueSchedulerSchema < ActiveRecord::Migration[6.0]
               def change
                 Que::Scheduler::Migrations.migrate!(version: #{Que::Scheduler::Migrations::MAX_VERSION})
               end

data/lib/que/scheduler/to_enqueue.rb

@@ -23,7 +23,7 @@ module Que
         end
 
         def active_job_defined?
-          Object.const_defined?("ActiveJob")
+          Object.const_defined?(:ActiveJob)
         end
 
         def active_job_version
@@ -39,16 +39,14 @@ module Que
             Gem::Version.create("6.0.3")
         end
 
-        private
-
-        def type_from_job_class(job_class)
+        private def type_from_job_class(job_class)
           types.each do |type, implementation|
             return implementation if job_class < type
           end
           nil
         end
 
-        def types
+        private def types
           @types ||=
             begin
               hash = {

data/lib/que/scheduler/version.rb

@@ -1,5 +1,5 @@
 module Que
   module Scheduler
-    VERSION = "4.4.0".freeze
+    VERSION = "5.0.0".freeze
   end
 end

data/lib/que/scheduler/version_support.rb

@@ -15,7 +15,7 @@ module Que
         # the top of all jobs it enqueues.
         def set_priority(context, priority)
           if zero_major?
-            context.instance_variable_set("@priority", priority)
+            context.instance_variable_set(:@priority, priority)
           else
             context.priority = priority
           end
@@ -24,7 +24,7 @@ module Que
         # Ensure the job runs at least once an hour when it is backing off due to errors
         def apply_retry_semantics(context)
           if zero_major?
-            context.instance_variable_set("@retry_interval", RETRY_PROC)
+            context.instance_variable_set(:@retry_interval, RETRY_PROC)
           else
             context.maximum_retry_count = 1 << 128 # Heat death of universe
             context.retry_interval = RETRY_PROC
@@ -92,17 +92,15 @@ module Que
           @que_version ||= que_version_object.to_s
         end
 
-        private
-
-        def supports_job_options_keyword?
+        private def supports_job_options_keyword?
           @supports_job_options_keyword ||= que_version_object >= Gem::Version.new("1.2.0")
         end
 
-        def que_version_object
+        private def que_version_object
           @que_version_object ||= Gem.loaded_specs["que"].version
         end
 
-        def normalise_array_of_hashes(array)
+        private def normalise_array_of_hashes(array)
           array.map { |row| row.to_h.transform_keys(&:to_sym) }
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que-scheduler
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Harry Lascelles
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-24 00:00:00.000000000 Z
+date: 2024-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: fugit
   requirement: !ruby/object:Gem::Requirement
@@ -175,7 +175,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fasterer
+  name: dememoize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -189,7 +189,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: fasterer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -202,6 +202,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -286,6 +300,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -373,6 +401,8 @@ files:
 - lib/que/scheduler/migrations/6/up.sql
 - lib/que/scheduler/migrations/7/down.sql
 - lib/que/scheduler/migrations/7/up.sql
+- lib/que/scheduler/migrations/8/down.sql
+- lib/que/scheduler/migrations/8/up.sql
 - lib/que/scheduler/schedule.rb
 - lib/que/scheduler/scheduler_job.rb
 - lib/que/scheduler/scheduler_job_args.rb
@@ -391,7 +421,7 @@ metadata:
   source_code_uri: https://github.com/hlascelles/que-scheduler/
   bug_tracker_uri: https://github.com/hlascelles/que-scheduler/issues
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -399,15 +429,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 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.3.26
+signing_key:
 specification_version: 4
 summary: A cron scheduler for Que
 test_files: []