ruby-clock 2.0.0.beta1 → 2.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 567b66555b094f4c722a3340b9cc5ca99abab18918033ed972dc8c65ce242b18
-  data.tar.gz: 2c9a42194dcd969623b04b1bfc21eb327cdd225322703a488f87fa1819a9302c
+  metadata.gz: 17d680fbe8df5efadea1cfa9123682fd2557828515fabfafad6825476669b368
+  data.tar.gz: d68673fdc64e3985a170d129b6642b00f323256904e4e54c07660bf1d73cd4e3
 SHA512:
-  metadata.gz: 0cdd8a85ec8f8de256486f027639c9d4c341131eb7dc88d519baf249733c7c655f72af923b8c8914b51d405f09a24cd9aa17efc4fc96cf807dcacdd74b024878
-  data.tar.gz: e655dce4688f88154bac50957fb321f11e07dc7d40ee5fc679a25d0e0a8feff097016ac7df128e77f4eaccae5e3fa817caa76d5a300bee364e48999bd4c0ea50
+  metadata.gz: 789d4ba0e97036cf12473ba5d0c6b190ce164e81573738c3f284910fb6de39fb13ae9a1e3342d6c621ede962b105923a05cc7c226c0294aea26dbb3d160c64f8
+  data.tar.gz: 381e0a04c4d0dc0425176d8414939658b669caaa0b1f2c2253c511506800ce01788eac2f4ef8cac9ebbdaac31031171917a8fac1965b4f3098f8f8c7a5b2cc8d

data/CHANGELOG.md

@@ -1,16 +1,29 @@
-## 2.0.0.beta1
+## 2.0.0 beta
 
 * The way the [rails app reloader](https://guides.rubyonrails.org/threading_and_code_execution.html)
   is implemented is now compatible with both rails 6 and 7
 * The setup for rails is now less complicated
+* RUBY_CLOCK_SHUTDOWN_WAIT_SECONDS value is logged when starting
+* 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
+
       bundle exec rails runner bin/clock
   to
+
       bundle exec clock
+* Your existing Clockfile will still work, but you now have the option to use
+  `every`, `cron`, and `on_error` at the top-level, without referencing `schedule`.
+  See the readme for examples.
 
 ## 1.0.0
 

data/README.md

@@ -1,3 +1,7 @@
+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
+
 # ruby-clock
 
 ruby-clock is a [job scheduler](https://en.wikipedia.org/wiki/Job_scheduler),
@@ -24,6 +28,8 @@ You can change this number with `RUBY_CLOCK_SHUTDOWN_WAIT_SECONDS` in the enviro
 
 ## Installation
 
+ruby >= 2.7 is required.
+
 Add these lines to your application's Gemfile:
 
 ```ruby
@@ -41,17 +47,15 @@ Or install it yourself as:
 ## Usage
 
 Create a file named Clockfile. This will hold your job definitions.
-The DSL and capabilities
-are the same as those of [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler/).
-Read the rufus-scheduler documentation to see what you can do.
+Define jobs like this:
 
 ```ruby
-schedule.every('5 minutes') do
+every('5 minutes') do
   UserDataReports.generate
 end
 
 # do something every day, five minutes after midnight
-schedule.cron '5 0 * * *' do
+cron '5 0 * * *' do
   DailyActivitySummary.generate_and_send
 end
 ```
@@ -99,7 +103,7 @@ Require your app's code at the top of Clockfile:
 
 ```ruby
 require_relative './lib/app.rb'
-schedule.every('5 minutes') do
+every('5 minutes') do
 ...
 ```
 
@@ -141,14 +145,50 @@ You can catch and report errors raised in your jobs by defining an error catcher
 the top of your Clockfile like this:
 
 ```ruby
-def schedule.on_error(job, error)
+on_error do |job, error|
   ErrorReporter.track_exception(error)
 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`.
 
@@ -157,7 +197,7 @@ to learn how to do this. Where the documentation references `s`, you should use
 You can run shell commands in your jobs.
 
 ```ruby
-schedule.every '1 day' do
+every '1 day' do
   shell('sh scripts/process_stuff.sh')
 end
 ```
@@ -172,7 +212,7 @@ If you want to use other terrapin features, you can skip the `shell` command
 and use terrapin directly:
 
 ```ruby
-schedule.every '1 day' do
+every '1 day' do
   line = Terrapin::CommandLine.new('optimize_png', ":file")
   Organization.with_new_logos.find_each do |o|
     line.run(file: o.logo_file_path)
@@ -203,7 +243,7 @@ You can run tasks from within the persistent runtime of ruby-clock, without
 needing to shell out and start another process.
 
 ```ruby
-schedule.every '1 day' do
+every '1 day' do
   rake('reports:daily')
 end
 ```
@@ -222,12 +262,12 @@ fallback is the line number of the job in Clockfile.
 Some examples of jobs and their identifiers:
 
 ```ruby
-schedule.every '1 second', name: 'my job' do
+every '1 second', name: 'my job' do
   Foo.bar
 end
 # => my job
 
-schedule.every '1 day' do
+every '1 day' do
   daily_things = Foo.setup_daily
   daily_things.process
   # TODO: figure out best time of day
@@ -235,7 +275,7 @@ end
 # => daily_things.process
 
 # n.b. ruby-clock isn't yet smart enough to remove trailing comments
-schedule.every '1 week' do
+every '1 week' do
   weekly_things = Foo.setup_weekly
   weekly_things.process # does this work???!1~
 end
@@ -253,7 +293,7 @@ def schedule.on_post_trigger(job, trigger_time)
   StatsTracker.increment('Clock: Job Executions')
 end
 
-schedule.every '10 seconds', name: 'thread stats' do
+every '10 seconds', name: 'thread stats' do
   thread_usage = Hash.new(0)
   schedule.work_threads(:active).each do |t|
     thread_usage[t[:rufus_scheduler_job].identifier] += 1
@@ -268,14 +308,17 @@ schedule.every '10 seconds', name: 'thread stats' do
 end
 ```
 
-### other rufus-scheduler Options
+### Other rufus-scheduler Options
 
-All rufus-scheduler options are set to defaults. The `schedule` variable
-available in your Clockfile is an instance of `Rufus::Scheduler`,
-so anything you can do on this instance, you can do in your Clockfile.
+All [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler/) options are set to defaults.
+There is a `schedule` variable available in your Clockfile, which is the singleton instance of `Rufus::Scheduler`.
+ruby-clock methods such as `every` and `cron` are convenience methods which invoke `schedule.every`
+and `schedule.cron`.
+Anything you can do on this instance, you can do in your Clockfile.
+See the rufus-scheduler documentation to see what you can do.
 
-Perhaps in the future ruby-clock will add some easier specific configuration
-capabilities for some things. Let me know if you have a request!
+If you have ideas for rufus-scheduler features that can be brought in as
+more abstract or default ruby-clock behavior, let me know!
 
 ## Syntax highlighting for Clockfile
 

data/example-app/Clockfile

@@ -1,11 +1,40 @@
-def schedule.on_error(job, error)
-  raise error
+on_error do |job, error|
+  puts "An error has occurred with job #{job.identifier}: #{error.class}: #{error.message}"
 end
+# on_error do |job, error|
+#   raise error
+# end
 
-schedule.every('2 seconds') do
+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
   puts "hello from a ruby-clock job"
 end
 
-schedule.every('2 seconds') do
+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,19 +1,5 @@
-def schedule.on_error(job, error)
-  puts "An error has occurred: #{error.class}: #{error.message}"
-end
-
-schedule.every('2 seconds') do
-  puts "hello from a ruby-clock job"
-end
+load '../example-app/Clockfile'
 
-schedule.every('2 seconds') do
-  shell 'say hello'
-end
-
-schedule.every('2 seconds') do
+every('2 seconds') do
   puts Example.count
 end
-
-schedule.every('2 seconds') do
-  raise "An error."
-end

data/exe/clock

@@ -23,23 +23,50 @@ class Rufus::Scheduler::Job
   end
 end
 
-include RubyClock
+RubyClock.instance.listen_to_signals
+RubyClock.instance.prepare_rake
+RubyClock.instance.schedule.pause
+
+
+
+## Add methods to top-level namespace
+def schedule
+  RubyClock.instance.schedule
+end
+
+def on_error(&on_error_block)
+  RubyClock.instance.on_error = on_error_block
+  def schedule.on_error(job, error)
+    RubyClock.instance.on_error.call(job, error)
+  end
+end
+
+def around_action(&b)
+  RubyClock.instance.around_actions << b
+end
+
+def cron(...)
+  RubyClock.instance.schedule.cron(...)
+end
+
+def every(...)
+  RubyClock.instance.schedule.every(...)
+end
+
+def shell(string)
+  RubyClock.instance.shell(string)
+end
+#####################################
 
-listen_to_signals
-prepare_rake
-schedule.pause
 
 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
 
-run_jobs
+RubyClock.instance.run_jobs

data/lib/ruby-clock/version.rb

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

data/lib/ruby-clock.rb

@@ -1,9 +1,30 @@
 require "ruby-clock/version"
 require 'rufus-scheduler'
+require 'singleton'
+
+class RubyClock
+
+  include Singleton
+
+  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
+  end
 
-module RubyClock
   def shutdown
-    wait_seconds = ENV['RUBY_CLOCK_SHUTDOWN_WAIT_SECONDS']&.to_i || 29
     puts "Shutting down ruby-clock. Waiting #{wait_seconds} seconds for jobs to finish..."
     schedule.shutdown(wait: wait_seconds)
     puts "...done 🐈️ 👋"
@@ -21,6 +42,7 @@ module RubyClock
         end
       end
     end
+    puts "RUBY_CLOCK_SHUTDOWN_WAIT_SECONDS is set to #{wait_seconds}"
   end
 
   def schedule
@@ -106,4 +128,17 @@ module 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

data/ruby-clock.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   # spec.description   = %q{TODO: Write a longer description or delete this line.}
   spec.homepage      = "https://github.com/jjb/ruby-clock"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-clock
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta1
+  version: 2.0.0.beta3
 platform: ruby
 authors:
 - John Bachir
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-01 00:00:00.000000000 Z
+date: 2022-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
@@ -159,7 +159,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"