que-scheduler 4.2.1 → 4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d92cf3d8ebdf259e1710f12bd18a4c8659487db9a9aef74abc8adc5003d41e3
-  data.tar.gz: 3f0444f62191a9e21d83d2aa3e8d31e2c360d8aa29855cac7c6e3a85a453354f
+  metadata.gz: 10ede03b787b5856626a071b1bc95482444e85426749dbd3e71cd0df4cce2471
+  data.tar.gz: acb2b596d1eb686618e508b25480402686e46c631cfe193ae8c974e49b91090a
 SHA512:
-  metadata.gz: c92abb1259bec07700f14bc38f87513d664dab477a8c1c77112dc3850b807ce7ecc277dbe352bdcb1df1a5098758537a664ded7a59887b4c9e8b9f35c04019d8
-  data.tar.gz: '080de57bec485640cff2f458c4462cd1ff13646851f2212273829195c4da3014df3675197c1d08e11e89bbcbdd68af1a951561837f0c89926a3baf1346b5cddb'
+  metadata.gz: 4a61f0242dde1547c4df76f2626ccab9e4fe2f2046db698ff54699f0b19fe3233a1ba4a586781500a3f9f8519033de3f2ef68cf39f73ba1e7d31fcfb270d0b7e
+  data.tar.gz: 5e8636614bb56e1b38acd50f7b2afdfc2edf9860cc55898b98552537d3aaab543dff7a40396e6aae623fd70f2fe1618f1214faf6589a5c4fb5c2000c8bff7f2e

data/README.md

@@ -27,7 +27,7 @@ resque-scheduler files, but with additional features.
     ```ruby
     class CreateQueSchedulerSchema < ActiveRecord::Migration
       def change
-        Que::Scheduler::Migrations.migrate!(version: 6)
+        Que::Scheduler::Migrations.migrate!(version: 7)
       end
     end
     ```
@@ -211,7 +211,7 @@ performed.
 ```ruby
 class CreateQueSchedulerSchema < ActiveRecord::Migration
   def change
-    Que::Scheduler::Migrations.migrate!(version: 6)
+    Que::Scheduler::Migrations.migrate!(version: 7)
   end
 end
 ```
@@ -310,6 +310,15 @@ 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.5.0.
 
+The latest version of que-scheduler supports Ruby 2.7, though this is largely to allow
+the gem to work with que 2.x. Recent que-scheduler versions (up to 4.2.2) work with Ruby 2.5.
+
+Ruby 3.x support (and thus que 2.x support) is currently in beta. 
+
+Using que 0.x with Rails 6 needs a patch to support it. 
+See the patch and how to use it here: https://github.com/que-rb/que/issues/247#issuecomment-595258236
+If that patch is included then que-scheduler will work. This setup is tested, but is not supported.
+
 ## Inspiration
 
 This gem was inspired by the makers of the excellent [Que](https://github.com/chanks/que) job scheduler gem. 
@@ -324,3 +333,5 @@ This gem was inspired by the makers of the excellent [Que](https://github.com/ch
 * @krzyzak
 * @papodaca
 * @ajoneil
+* @ippachi
+* @milgner

data/lib/que/scheduler/defined_job.rb

@@ -86,7 +86,7 @@ module Que
         # queue name is only supported for a subrange of ActiveJob versions. Print this out as a
         # warning.
         if queue &&
-           Que::Scheduler::ToEnqueue.active_job_loaded? &&
+           Que::Scheduler::ToEnqueue.active_job_defined? &&
            job_class < ::ActiveJob::Base &&
            Que::Scheduler::ToEnqueue.active_job_version < Gem::Version.create("6.0.3")
           puts <<~ERR

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

@@ -0,0 +1,13 @@
+CREATE OR REPLACE FUNCTION que_scheduler_prevent_job_deletion() RETURNS TRIGGER AS
+$BODY$
+DECLARE
+BEGIN
+    IF OLD.job_class = 'Que::Scheduler::SchedulerJob' THEN
+        IF NOT que_scheduler_check_job_exists() THEN
+            raise exception 'Deletion of que_scheduler job % prevented. Deleting the que_scheduler job is almost certainly a mistake.', OLD.job_id;
+        END IF;
+    END IF;
+    RETURN OLD;
+END;
+$BODY$
+LANGUAGE 'plpgsql';

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

@@ -0,0 +1,13 @@
+CREATE OR REPLACE FUNCTION que_scheduler_prevent_job_deletion() RETURNS TRIGGER AS
+$BODY$
+DECLARE
+BEGIN
+    IF OLD.job_class = 'Que::Scheduler::SchedulerJob' THEN
+        IF NOT que_scheduler_check_job_exists() THEN
+            raise exception 'Deletion of que_scheduler job prevented. Deleting the que_scheduler job is almost certainly a mistake.';
+        END IF;
+    END IF;
+    RETURN OLD;
+END;
+$BODY$
+LANGUAGE 'plpgsql';

data/lib/que/scheduler/migrations.rb

@@ -43,13 +43,17 @@ module Que
 
         # This method is only intended for use in squashed migrations
         def reenqueue_scheduler_if_missing
-          Que::Scheduler::SchedulerJob.enqueue if Que::Scheduler::Db.count_schedulers.zero?
+          return unless Que::Scheduler::Db.count_schedulers.zero?
+
+          Que::Scheduler::VersionSupport.enqueue_a_job(Que::Scheduler::SchedulerJob)
         end
 
         private
 
         def migrate_up(current, version)
-          Que::Scheduler::SchedulerJob.enqueue if current.zero? # Version 1 does not use SQL
+          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
 

data/lib/que/scheduler/schedule.rb

@@ -36,10 +36,9 @@ module Que
         end
 
         def from_hash(config_hash)
-          config_hash.to_h do |name, defined_job_hash|
-            name_str = name.to_s
-            [name_str, hash_item_to_defined_job(name_str, defined_job_hash)]
-          end
+          config_hash
+            .map { |name, defined_job_hash| hash_item_to_defined_job(name.to_s, defined_job_hash) }
+            .index_by(&:name)
         end
 
         def hash_item_to_defined_job(name, defined_job_hash_in)

data/lib/que/scheduler/scheduler_job.rb

@@ -65,11 +65,16 @@ module Que
 
         # And rerun...
         next_run_at = scheduler_job_args.as_time.beginning_of_minute + SCHEDULER_FREQUENCY
-        enqueued_job = SchedulerJob.enqueue(
-          queue: Que::Scheduler.configuration.que_scheduler_queue,
-          last_run_time: last_full_execution.iso8601,
-          job_dictionary: job_dictionary,
-          run_at: next_run_at
+        enqueued_job = Que::Scheduler::VersionSupport.enqueue_a_job(
+          SchedulerJob,
+          {
+            queue: Que::Scheduler.configuration.que_scheduler_queue,
+            run_at: next_run_at,
+          },
+          {
+            last_run_time: last_full_execution.iso8601,
+            job_dictionary: job_dictionary,
+          }
         )
 
         # rubocop:disable Style/GuardClause This reads better as a conditional

data/lib/que/scheduler/to_enqueue.rb

@@ -22,8 +22,8 @@ module Que
           type_from_job_class(job_class).present?
         end
 
-        def active_job_loaded?
-          !!active_job_version
+        def active_job_defined?
+          Object.const_defined?("ActiveJob")
         end
 
         def active_job_version
@@ -54,7 +54,7 @@ module Que
               hash = {
                 ::Que::Job => QueJobType,
               }
-              hash[::ActiveJob::Base] = ActiveJobType if ToEnqueue.active_job_loaded?
+              hash[::ActiveJob::Base] = ActiveJobType if ToEnqueue.active_job_defined?
               hash
             end
         end
@@ -65,12 +65,11 @@ module Que
     class QueJobType < ToEnqueue
       def enqueue
         job_settings = to_h.slice(:queue, :priority, :run_at).compact
-        job =
-          if args.is_a?(Hash)
-            job_class.enqueue(**args.merge(job_settings))
-          else
-            job_class.enqueue(*args, **job_settings)
-          end
+        job = Que::Scheduler::VersionSupport.enqueue_a_job(
+          job_class,
+          job_settings,
+          args
+        )
 
         return nil if job.nil? || !job # nil in Rails < 6.1, false after.
 

data/lib/que/scheduler/version.rb

@@ -1,5 +1,5 @@
 module Que
   module Scheduler
-    VERSION = "4.2.1".freeze
+    VERSION = "4.3.1".freeze
   end
 end

data/lib/que/scheduler/version_support.rb

@@ -47,6 +47,25 @@ module Que
           normalise_array_of_hashes(Que.execute(str, args))
         end
 
+        # rubocop:disable Style/IfInsideElse
+        def enqueue_a_job(clazz, job_options = {}, job_args = [])
+          if supports_job_options_keyword?
+            # More recent versions have separated the way job arguments and options are passed in
+            if job_args.is_a?(Hash)
+              clazz.enqueue(job_args, job_options: job_options)
+            else
+              clazz.enqueue(*job_args, job_options: job_options)
+            end
+          else
+            if job_args.is_a?(Hash)
+              clazz.enqueue(**job_args.merge(job_options))
+            else
+              clazz.enqueue(*job_args, **job_options)
+            end
+          end
+        end
+
+        # rubocop:enable Style/IfInsideElse
         def default_scheduler_queue
           zero_major? ? "" : Que::DEFAULT_QUEUE
         end
@@ -64,12 +83,25 @@ module Que
           @zero_major ||= que_version.split(".").first.to_i.zero?
         end
 
+        def one_major?
+          # This is the only way to handle beta releases too
+          @one_major ||= que_version.split(".").first.to_i == 1
+        end
+
         def que_version
-          @que_version ||= Gem.loaded_specs["que"].version.to_s
+          @que_version ||= que_version_object.to_s
         end
 
         private
 
+        def supports_job_options_keyword?
+          @supports_job_options_keyword ||= que_version_object >= Gem::Version.new("1.2.0")
+        end
+
+        def que_version_object
+          @que_version_object ||= Gem.loaded_specs["que"].version
+        end
+
         def normalise_array_of_hashes(array)
           array.map { |row| row.to_h.transform_keys(&:to_sym) }
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que-scheduler
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.3.1
 platform: ruby
 authors:
 - Harry Lascelles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-03 00:00:00.000000000 Z
+date: 2022-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,7 +70,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.14'
     - - "<="
       - !ruby/object:Gem::Version
         version: 2.0.0
@@ -80,7 +80,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.14'
     - - "<="
       - !ruby/object:Gem::Version
         version: 2.0.0
@@ -371,6 +371,8 @@ files:
 - lib/que/scheduler/migrations/5/up.sql
 - lib/que/scheduler/migrations/6/down.sql
 - lib/que/scheduler/migrations/6/up.sql
+- lib/que/scheduler/migrations/7/down.sql
+- lib/que/scheduler/migrations/7/up.sql
 - lib/que/scheduler/schedule.rb
 - lib/que/scheduler/scheduler_job.rb
 - lib/que/scheduler/scheduler_job_args.rb
@@ -397,14 +399,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.7
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A cron scheduler for Que