ruby-clock 2.0.0.beta2 → 2.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fdfa3656f0ffbdf60b162a594809e29e9f0579cf3f5f52e98ffd857a811c348
-  data.tar.gz: f63dd579f2cd258f89f17666338ec9d433a63e2b93d0a400975ee6c1e61886fa
+  metadata.gz: 17d680fbe8df5efadea1cfa9123682fd2557828515fabfafad6825476669b368
+  data.tar.gz: d68673fdc64e3985a170d129b6642b00f323256904e4e54c07660bf1d73cd4e3
 SHA512:
-  metadata.gz: 938ec658ba3837be8a90c49fdd8d2d6a050b1b6a19486bc2b10479e81370ed3fe5c0e4501293b02a2c8efcfe82d67974e887c2069270986f3398b89762c04707
-  data.tar.gz: c3376b79456a66c2b3c1eb5492b9a0429e69ece7b5207a73d2792c8830c33355c14dc622c2a37e8b6b8e2b9b27cdaaa4d0c83449e6e9c8aca3ae2538e2a90af0
+  metadata.gz: 789d4ba0e97036cf12473ba5d0c6b190ce164e81573738c3f284910fb6de39fb13ae9a1e3342d6c621ede962b105923a05cc7c226c0294aea26dbb3d160c64f8
+  data.tar.gz: 381e0a04c4d0dc0425176d8414939658b669caaa0b1f2c2253c511506800ce01788eac2f4ef8cac9ebbdaac31031171917a8fac1965b4f3098f8f8c7a5b2cc8d

data/CHANGELOG.md

@@ -7,9 +7,13 @@
 * Code reorganization so there are no unnecessary methods in top-level Kernel namespace
 * DSL methods are now at the top-level namespace (`schedule.every` → `every`, `schedule.cron` → `cron`)
 * error handler definition is now at the top-level namespace (`def schedule.on_error` → `on_error do`)
+* around callbacks now have a top-level namespace method, which is different from the above in that...
+* multiple around callbacks can be consecutively assigned
 
 ### Migrating from ruby-clock version 1 to version 2
 
+* if you have and existing `def schedule.around_trigger`, you will need to change it to use the new
+  `around_action` method. see readme.
 * There is no longer a need to have a binstub in rails. You can delete bin/clock from your app.
 * The invocations (in Procfile, or wherever else you start ruby-clock) should change from
 

data/README.md

@@ -1,4 +1,4 @@
-THESE ARE THE DOCS FOR VERSION 2.0.0.beta2
+THESE ARE THE DOCS FOR VERSION 2.0.0.beta
 
 See version 1 docs here: https://github.com/jjb/ruby-clock/tree/v1.0.0
 
@@ -152,7 +152,43 @@ end
 
 ### Callbacks
 
-You can define before, after, and around callbacks which will run for all jobs.
+You can define around callbacks which will run for all jobs, like shown below.
+This somewhat awkward syntax is necessary in order to enable the ability to define multiple callbacks.
+(perhaps in different files, shared by multiple Clockfiles, etc.).
+
+```ruby
+around_action do |job_proc, job_info|
+  puts "before1 #{job_info.class}"
+  job_proc.call
+  puts "after1"
+end
+
+around_action do |job_proc|
+  puts "before2"
+  job_proc.call
+  puts "after2"
+end
+
+every('2 seconds') do
+  puts "hello from a ruby-clock job"
+end
+```
+
+
+```
+before1 Rufus::Scheduler::EveryJob
+before2
+hello from a ruby-clock job
+after2
+after1
+```
+
+The around callbacks code will be run in the individual job thread.
+
+rufus-scheduler also provides before and after hooks. ruby-clock does not provide convenience methods for these
+but you can easily use them via the `schedule` object. These will run in the outer scheduling thread and not in
+the job thread, so they may have slightly different behavior in some cases. There is likely no reason to use them
+instead of `around_action`.
 Read [the rufus-scheduler documentation](https://github.com/jmettraux/rufus-scheduler/#callbacks)
 to learn how to do this. Where the documentation references `s`, you should use `schedule`.
 

data/example-app/Clockfile

@@ -1,5 +1,26 @@
 on_error do |job, error|
-  raise error
+  puts "An error has occurred with job #{job.identifier}: #{error.class}: #{error.message}"
+end
+# on_error do |job, error|
+#   raise error
+# end
+
+around_action do |job_proc, job_info|
+  puts "before1 #{job_info.class}"
+  job_proc.call
+  puts "after1"
+end
+
+around_action do |job_proc|
+  puts "before2"
+  job_proc.call
+  puts "after2"
+end
+
+around_action do |job_proc, job_info|
+  puts "before3 #{job_info.class}"
+  job_proc.call
+  puts "after3"
 end
 
 every('2 seconds') do
@@ -10,6 +31,10 @@ every('2 seconds') do
   shell 'say hello'
 end
 
+every('2 seconds') do
+  raise "An error."
+end
+
 cron('*/10 * * * * *') do
   puts "cron running on every 10th second #{Time.now}"
 end

data/example-app/Gemfile.lock

@@ -1,31 +1,32 @@
 PATH
   remote: ..
   specs:
-    ruby-clock (0.8.0.rc3)
+    ruby-clock (2.0.0.beta2)
       method_source
       rufus-scheduler (~> 3.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    concurrent-ruby (1.1.9)
-    et-orbi (1.2.5)
+    concurrent-ruby (1.1.10)
+    et-orbi (1.2.7)
       tzinfo
-    fugit (1.5.2)
-      et-orbi (~> 1.1, >= 1.1.8)
+    fugit (1.7.1)
+      et-orbi (~> 1, >= 1.2.7)
       raabro (~> 1.4)
     method_source (1.0.0)
     raabro (1.4.0)
-    rufus-scheduler (3.8.0)
+    rufus-scheduler (3.8.2)
       fugit (~> 1.1, >= 1.1.6)
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
 
 PLATFORMS
   arm64-darwin-20
+  arm64-darwin-21
 
 DEPENDENCIES
   ruby-clock!
 
 BUNDLED WITH
-   2.2.28
+   2.3.8

data/example-rails-app/Clockfile

@@ -1,23 +1,5 @@
-on_error do |job, error|
-  puts "An error has occurred: #{error.class}: #{error.message}"
-end
-
-every('2 seconds') do
-  puts "hello from a ruby-clock job"
-end
-
-every('2 seconds') do
-  shell 'say hello'
-end
+load '../example-app/Clockfile'
 
 every('2 seconds') do
   puts Example.count
 end
-
-every('2 seconds') do
-  raise "An error."
-end
-
-cron('*/10 * * * * *') do
-  puts "cron running on every 10th second #{Time.now}"
-end

data/exe/clock

@@ -41,6 +41,10 @@ def on_error(&on_error_block)
   end
 end
 
+def around_action(&b)
+  RubyClock.instance.around_actions << b
+end
+
 def cron(...)
   RubyClock.instance.schedule.cron(...)
 end
@@ -58,12 +62,9 @@ end
 load ARGV[0] || 'Clockfile'
 
 if defined?(::Rails)
-  schedule.instance_eval do
-    @old_around_trigger = method :around_trigger
-    def around_trigger(job)
-      ::Rails.application.reloader.wrap do
-        @old_around_trigger.call(job){ yield }
-      end
+  around_action do |job_proc|
+    ::Rails.application.reloader.wrap do
+      job_proc.call
     end
   end
 end

data/lib/ruby-clock/version.rb

@@ -1,3 +1,3 @@
 class RubyClock
-  VERSION = "2.0.0.beta2"
+  VERSION = "2.0.0.beta3"
 end

data/lib/ruby-clock.rb

@@ -6,7 +6,19 @@ class RubyClock
 
   include Singleton
 
-  attr_accessor :on_error
+  attr_accessor :on_error, :around_actions
+
+  def initialize
+    @around_actions = []
+
+    def schedule.around_trigger(job_info, &job_proc)
+      RubyClock.instance.call_with_around_action_stack(
+        RubyClock.instance.around_actions.reverse,
+        job_proc,
+        job_info
+      )
+    end
+  end
 
   def wait_seconds
     ENV['RUBY_CLOCK_SHUTDOWN_WAIT_SECONDS']&.to_i || 29
@@ -116,4 +128,17 @@ class RubyClock
     end
   end
 
+  def call_with_around_action_stack(wrappers, job_proc, job_info)
+    case wrappers.count
+    when 0
+      job_proc.call(job_info)
+    else
+      call_with_around_action_stack(
+        wrappers[1..],
+        Proc.new{ wrappers.first.call(job_proc, job_info) },
+        job_info
+      )
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-clock
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta2
+  version: 2.0.0.beta3
 platform: ruby
 authors:
 - John Bachir
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-15 00:00:00.000000000 Z
+date: 2022-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler