ruby-clock 2.0.0.beta8 → 2.0.0.beta10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 315bcc30c6fc32c1676e452750d76e839b0123f19fe7512bbe6662ae72ee0ecc
-  data.tar.gz: a5831b721e9d99af3082cb31dd472f4e282d5665616f40694ba41def7250b907
+  metadata.gz: 0f773f1b873c6048b24cb6c78769c809fd3008c0316463071633086aa572f853
+  data.tar.gz: 28de0953617822f2473cecebdac1ab308420231670073db0d4458d89d527e3ee
 SHA512:
-  metadata.gz: '0983e40393e4d273feddbcb53d67c0a8b2ccbb194439a16df9ddb1edaeedcf89f36338bffc80d8ffb44809500b3553cbc601c55275fcd4dba86d18b67ad57bf5'
-  data.tar.gz: 563039f0ea34927b4d6e1abd64db0f2ae086c44f37d03852d8ca510223e1ce0f57ebe275ce7059d704de3e29a1e7f33d1412b92ad4b7a5a7e4e6d5ec661e9605
+  metadata.gz: e4d94f375285033a0ca49ed535b29f0768adac1efa83f4c63a67090f866aa2a1f72b4a0159c746d99bf765c8c5b7f308daff090be0e2b671518d8fe67cf3b63e
+  data.tar.gz: 693519be98311aff6e24aae1c61cf908f710049a6854886264f100dc844f8436b3ba58f0ab1bd9b6d6a5bf3f5916383d744ce9390dbb582bdd70f4c6dab03936

data/CHANGELOG.md

@@ -5,30 +5,33 @@
   is implemented is now compatible with both rails 6 and 7
 * RUBY_CLOCK_SHUTDOWN_WAIT_SECONDS value is logged when starting
 * 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. `def schedule.around_trigger` → `around_action do`
 * Multiple around callbacks can be consecutively assigned - no need to put all behavior into one method
+* Error handler definition is now at the top-level namespace (`def schedule.on_error` → `on_error do`)
 * Errors encountered when loading Clockfile (such as incorrect cron syntax)
   will be reported to the error handler
 * The automatic identifier generator will now ignore `}` and `end` lines
-* posix-spawn is no longer used. In ruby 3, native `Process.spawn` is more performant. See
+* posix-spawn is no longer used. In ruby ~3~ 2.2, native `Process.spawn` is more performant. See
   [posix-spawn#90](https://github.com/rtomayko/posix-spawn/issues/90)
   and
   [terrapin#19](https://github.com/thoughtbot/terrapin/pull/19)
   for more info.
-* `--environment-and-syntax-check` capability
+* ability to load multiple clockfiles with one invocation
+* job slugs based on job identifier, e.g. "Widget Co. Weekly Reports" -> "widget-co-weekly-reports"
+* `--check-slug-uniqueness`
+* `--environment-and-syntax-check`
+* `--generate-dummy-crontab` to facilitate visualization with cronv
 
 ### Anti-Features
 * ruby 3.0 is now the minimum version
 
 ### Code Improvements
 * The code which implements the rails reloader/executor is now less complicated
-* Code reorganization so there are no unnecessary methods in top-level Kernel namespace
+* Code reorganization so there are no unnecessary methods in top-level `Kernel` namespace
 * top-level DSL methods are now implemented with refinements, so they don't polute other code
 
 
 ### Migrating from ruby-clock version 1 to version 2
-
 * The minimum ruby version is 3.0
 * The top of every Clockfile must begin with `using RubyClock::DSL`
 * If you have an existing `def schedule.around_trigger`, you will need to change it to use the new
@@ -37,6 +40,7 @@
   `every`, `cron`, and `on_error` at the top-level, without referencing `schedule`.
 * You now have the option of catching and reporting errors encountered when parsing the Clockfile.
 * There is no longer a need to have a binstub in rails. You can delete bin/clock from your app.
+* remove the `posix-spawn` gem from your project
 * The invocations (in Procfile, or wherever else you start ruby-clock) should change from
 
       bundle exec rails runner bin/clock

data/README.md

@@ -33,7 +33,7 @@ ruby >= 3.0 is required.
 Add these lines to your application's Gemfile:
 
 ```ruby
-gem 'ruby-clock'
+gem 'ruby-clock', '2.0.0.beta10'
 ```
 
 And then execute:
@@ -71,6 +71,11 @@ This will ignore Clockfile and only read jobs from clocks/MyClockfile:
 
     bundle exec clock clocks/MyClockfile
 
+You can also load multiple files with one invocation
+(although a better approach might be to load your subfiles within a top-level Clockfile):
+
+    bundle exec clock clocks/daily.rb clocks/weekly.rb
+
 ### Rails
 
 To run your clock process in your app's environment:
@@ -150,6 +155,28 @@ is valid during dev, or in automate tests.
 assert(system("bundle exec --environment-and-syntax-check clock/my_clockfile.rb"))
 ```
 
+You can use `--check-slug-uniqueness` to check if all the auto-generated slugs are unique. If you have
+multiple files with jobs, you need to pass them all in with one invocation in order to check global uniqueness.
+
+```ruby
+# system returns true/false depending on 0/1 exit status of process
+assert(system("bundle exec --check-slug-uniqueness")) # loads Clockfile
+assert(system("bundle exec --check-slug-uniqueness clock/weekly.rb clock/daily.rb")) # load specific files
+```
+
+#### Visualization with cronv
+
+Using the `--generate-dummy-crontab` flag you can visualize your schedule with [cronv](https://github.com/takumakanari/cronv).
+For your jobs with cron-style schedules, it will generate a dummy crontab file that can be ingested by cronv.
+For your jobs with "Every X seconds" schedules, a comment will be made in the file and they will not be vizualized.
+
+```console
+bundle exec clock --generate-dummy-crontab Clockfile ../clock/daily.rb ../clock/weekly.rb > dummycron.txt
+## IMPORTANT: open dummycron.txt in an editor and remove the boot startup message cruft from the top
+cat dummycron.txt | /Users/your-username/go/bin/cronv -d 1d -o ./my_cron_schedule.html
+open dummycron
+```
+
 ## More Config and Capabilities
 
 ### Error Handling
@@ -297,7 +324,7 @@ There are also `rake_execute` and `rake_async`.
 See [the code](https://github.com/jjb/ruby-clock/blob/main/lib/ruby-clock/rake.rb)
 and [this article](https://code.jjb.cc/running-rake-tasks-from-within-ruby-on-rails-code) for more info.
 
-### Job Identifier
+### Job Identifier & Slug
 
 ruby-clock adds the `identifier` method to `Rufus::Scheduler::Job`. This method will return the job's
 [name](https://github.com/jmettraux/rufus-scheduler/#name--string) if one was given.
@@ -305,30 +332,35 @@ If a name is not given, the last non-comment code line in the job's block
 will be used instead. If for some reason an error is encountered while calculating this, the next
 fallback is the line number of the job in Clockfile.
 
-Some examples of jobs and their identifiers:
+There is also the `slug` method, which produces a slug using
+[ActiveSupport parameterize](https://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-parameterize),
+and with underscores changed to hyphens.
+If the `activesupport` gem is not in your Gemfile and you attempt to use `slug`, it will fail.
+
+Some examples of identifiers and slugs:
 
 ```ruby
 every '1 second', name: 'my job' do
   Foo.bar
 end
-# => my job
+# my job, my-job
 
 every '1 day' do
   daily_things = Foo.setup_daily
   daily_things.process
   # TODO: figure out best time of day
 end
-# => daily_things.process
+# daily_things.process, daily-things-process
 
 # n.b. ruby-clock isn't yet smart enough to remove trailing comments
 every '1 week' do
   weekly_things = Foo.setup_weekly
   weekly_things.process # does this work???!1~
 end
-# => weekly_things.process # does this work???!1~
+# weekly_things.process # does this work???!1~, weekly-things-process-does-this-work-1
 ```
 
-This can be used for keeping track of job behavior in logs or a
+The identifier can be used for keeping track of job behavior in logs or a
 stats tracker. For example:
 
 ```ruby
@@ -356,6 +388,18 @@ every '10 seconds', name: 'thread stats' do
 end
 ```
 
+The slug can be used for similar purposes where a slug-style string is needed. Here you can report
+your job to a scheduled job monitor:
+
+```ruby
+# TODO proper example for healthcheks
+around_action do |job_proc, job_info|
+  Net::HTTP.get("https://mymonitor.example.com/APIKEY/start/#{job_info.slug}")
+  job_proc.call
+  Net::HTTP.get("https://mymonitor.example.com/APIKEY/stop/#{job_info.slug}")
+end
+```
+
 ### Other rufus-scheduler Options
 
 All [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler/) options are set to defaults.

data/example-app/Clockfile

@@ -14,7 +14,7 @@ end
 # end
 
 around_action do |job_proc, job_info|
-  puts "before1 #{job_info.class} #{job_info.identifier}"
+  puts "before1 #{job_info.class} #{job_info.identifier} #{job_info.slug}"
   job_proc.call
   puts "after1"
 end

data/example-app/Gemfile

@@ -5,4 +5,5 @@ source "https://rubygems.org"
 ruby '>= 3.0'
 
 gem 'ruby-clock', path: '../'
+gem 'activesupport'
 # gem 'terrapin'

data/exe/clock

@@ -9,27 +9,43 @@ RubyClock.instance.prepare_rake
 RubyClock.instance.schedule.pause
 RubyClock.instance.add_rails_executor_to_around_actions
 
-clockfile = 'Clockfile'
 check_syntax = false
-case ARGV[0]
-when '--environment-and-syntax-check'
-  check_syntax = true
-  case ARGV[1]
-  when String
-    clockfile = ARGV[1]
+check_slug_uniqueness = false
+generate_dummy_crontab = false
+if '--' == ARGV[0][0..1]
+  case ARGV[0]
+  when '--environment-and-syntax-check'
+    check_syntax = true
+  when '--check-slug-uniqueness'
+    check_slug_uniqueness = true
+  when '--generate-dummy-crontab'
+    generate_dummy_crontab = true
+  else
+    raise 'unknown option'
+  end
+  if ARGV[1]
+    clockfiles = ARGV[1..]
+  else
+    clockfiles = ['Clockfile']
+  end
+else
+  if ARGV[0]
+    clockfiles = ARGV[0..]
+  else
+    clockfiles = ['Clockfile']
   end
-when String
-  clockfile = ARGV[0]
 end
 
-begin
-  load clockfile
-rescue => clockfile_error
-  if RubyClock.instance.on_error
-    RubyClock.instance.on_error.call("An error has occured while parsing the clockfile", clockfile_error)
-  end
+clockfiles.each do |clockfile|
+  begin
+    load clockfile
+  rescue => clockfile_error
+    if RubyClock.instance.on_error
+      RubyClock.instance.on_error.call("An error has occured while parsing the clockfile #{clockfile}", clockfile_error)
+    end
 
-  raise
+    raise
+  end
 end
 
 RubyClock.instance.ensure_around_trigger_has_not_been_redefined
@@ -37,6 +53,33 @@ RubyClock.instance.freeze_around_actions
 
 if check_syntax
   puts "✨ Environment & Syntax OK ✨"
+elsif check_slug_uniqueness
+  slugs = {}
+  RubyClock.instance.schedule.jobs.each do |j|
+    if slugs[j.slug]
+      slugs[j.slug] +=1
+    else
+      slugs[j.slug] = 1
+    end
+  end
+  slugs_with_duplicates = []
+  slugs.each{|s,count| slugs_with_duplicates << s if count > 1 }
+  if slugs_with_duplicates.any?
+    puts "The following slugs have duplicates: #{slugs_with_duplicates}"
+    exit(false)
+  else
+    puts "✨ All Slugs Are Unique ✨"
+  end
+elsif generate_dummy_crontab
+  text = ''
+  RubyClock.instance.schedule.jobs.each do |j|
+    if j.respond_to?(:cron_line)
+      text << "#{j.cron_line.original} #{j.slug}\n"
+    else
+      text << "# every-#{j.frequency}-seconds #{j.slug}\n"
+    end
+  end
+  puts text
 else
   RubyClock.instance.run_jobs
 end

data/lib/ruby-clock/version.rb

@@ -1,3 +1,3 @@
 class RubyClock
-  VERSION = "2.0.0.beta8"
+  VERSION = "2.0.0.beta10"
 end

data/lib/rufus_monkeypatch.rb

@@ -1,6 +1,8 @@
 require 'method_source'
+
 class Rufus::Scheduler::Job
   UNDESIRED_ELEMENTS = ['', '}', 'end']
+
   def identifier
     @identifier ||= begin
       return name if name
@@ -18,4 +20,9 @@ class Rufus::Scheduler::Job
       end
     end
   end
+
+  def slug
+    require 'active_support/inflector'
+    identifier.gsub('_', '-').parameterize
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-clock
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta8
+  version: 2.0.0.beta10
 platform: ruby
 authors:
 - John Bachir
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2023-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler