good_job 3.17.4 → 3.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7b833bb3f1b28dca921562c3110e4147d955a98982f2b9481f9f7f2b41aa648
-  data.tar.gz: 4f230602f1f5a2faf5198035f207e6f206bc614078a8bce8f38f71613250a8bd
+  metadata.gz: cb40c03312f09c2cb91e77bce2ab3aacf87c62a18125d62b50bdc92b312d34f5
+  data.tar.gz: c1c73c9264b8bd6454aad7685d326d082c00d5c3f14667ab89e1f77cce9059ea
 SHA512:
-  metadata.gz: '0990adc9282acc9ad3b387f494b20e716e9f1f6ba37c1ec4da200dd89b53f8dd8d6cac60dc652323127086c837bf08bb02d3c28f1a75d589a1c435a897524b0d'
-  data.tar.gz: 961e5e7e3d522f07572f9031096b940408f3bc7568a46b475d45daeb37ae755e237f497cdbb3221e4419bde4d73a560d743f132359b7ee03ffc8062d24f99b23
+  metadata.gz: 9825b6d3c5a496c7fdee3aec3f0b5653a6c68d40b15487bb43d21b48817ae077052b3c3520b6ac0dd54354cc68b1157800270e95119240260ef68ab55046b293
+  data.tar.gz: a903a5cac7a8b753e457d7e98018ca575825dcb1be515702cd30bd92494f3fc22740e09e48c4b3a8312fae2824021e86d6f6d9e431d0b10f39c05ea97457baca

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [v3.18.0](https://github.com/bensheldon/good_job/tree/v3.18.0) (2023-08-30)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.17.4...v3.18.0)
+
+**Implemented enhancements:**
+
+- Support configuring cron schedule dynamically with a block [\#1051](https://github.com/bensheldon/good_job/pull/1051) ([DanielHeath](https://github.com/DanielHeath))
+
 ## [v3.17.4](https://github.com/bensheldon/good_job/tree/v3.17.4) (2023-08-24)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.17.3...v3.17.4)

data/README.md

@@ -504,6 +504,10 @@ config.good_job.cron = {
     cron: "0 0,12 * * *",
     class: "AnotherJob",
   },
+  complex_schedule: {
+    class: "ComplexScheduleJob",
+    cron: -> (last_ran) { (last_ran.blank? ? Time.now : last_ran + 14.hours).at_beginning_of_minute }
+  }
   # etc.
 }
 ```

data/app/models/good_job/cron_entry.rb

@@ -27,6 +27,7 @@ module GoodJob # :nodoc:
     def initialize(params = {})
       @params = params
 
+      return if cron_proc?
       raise ArgumentError, "Invalid cron format: '#{cron}'" unless fugit.instance_of?(Fugit::Cron)
     end
 
@@ -41,10 +42,6 @@ module GoodJob # :nodoc:
       params.fetch(:class)
     end
 
-    def cron
-      params.fetch(:cron)
-    end
-
     def set
       params[:set]
     end
@@ -61,16 +58,21 @@ module GoodJob # :nodoc:
       params[:description]
     end
 
-    def next_at
+    def next_at(previously_at: nil)
+      if cron_proc?
+        result = Rails.application.executor.wrap { cron.call(previously_at || last_at) }
+        return Fugit.parse(result).next_time.to_t if result.is_a?(String)
+
+        return result
+
+      end
       fugit.next_time.to_t
     end
 
     def schedule
-      fugit.original
-    end
+      return "Custom schedule" if cron_proc?
 
-    def fugit
-      @_fugit ||= Fugit.parse(cron)
+      fugit.original
     end
 
     def jobs
@@ -80,11 +82,7 @@ module GoodJob # :nodoc:
     def last_at
       return if last_job.blank?
 
-      if GoodJob::Job.column_names.include?('cron_at')
-        (last_job.cron_at || last_job.created_at).localtime
-      else
-        last_job.created_at
-      end
+      (last_job.cron_at || last_job.created_at).localtime
     end
 
     def enabled?
@@ -116,11 +114,7 @@ module GoodJob # :nodoc:
     end
 
     def last_job
-      if GoodJob::Job.column_names.include?('cron_at')
-        jobs.order("cron_at DESC NULLS LAST").first
-      else
-        jobs.order(created_at: :asc).last
-      end
+      jobs.order("cron_at DESC NULLS LAST").first
     end
 
     def display_properties
@@ -138,6 +132,18 @@ module GoodJob # :nodoc:
 
     private
 
+    def cron
+      params.fetch(:cron)
+    end
+
+    def cron_proc?
+      cron.respond_to?(:call)
+    end
+
+    def fugit
+      @_fugit ||= Fugit.parse(cron)
+    end
+
     def set_value
       value = set || {}
       value.respond_to?(:call) ? value.call : value

data/lib/good_job/cron_manager.rb

@@ -82,12 +82,13 @@ module GoodJob # :nodoc:
 
     # Enqueues a scheduled task
     # @param cron_entry [CronEntry] the CronEntry object to schedule
-    def create_task(cron_entry)
-      cron_at = cron_entry.next_at
+    # @param previously_at [Date, Time, ActiveSupport::TimeWithZone, nil] the last, +in-memory+, scheduled time the cron task was intended to run
+    def create_task(cron_entry, previously_at: nil)
+      cron_at = cron_entry.next_at(previously_at: previously_at)
       delay = [(cron_at - Time.current).to_f, 0].max
       future = Concurrent::ScheduledTask.new(delay, args: [self, cron_entry, cron_at], executor: @executor) do |thr_scheduler, thr_cron_entry, thr_cron_at|
         # Re-schedule the next cron task before executing the current task
-        thr_scheduler.create_task(thr_cron_entry)
+        thr_scheduler.create_task(thr_cron_entry, previously_at: thr_cron_at)
 
         Rails.application.executor.wrap do
           cron_entry.enqueue(thr_cron_at) if thr_cron_entry.enabled?

data/lib/good_job/version.rb

@@ -2,7 +2,7 @@
 
 module GoodJob
   # GoodJob gem version.
-  VERSION = '3.17.4'
+  VERSION = '3.18.0'
 
   # GoodJob version as Gem::Version object
   GEM_VERSION = Gem::Version.new(VERSION)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.17.4
+  version: 3.18.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-24 00:00:00.000000000 Z
+date: 2023-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob