ruby-clock 2.0.0.beta9 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc7625ea594c3028d9503ad7c1013b7888c776a51bf5853ada639cef1b9d754c
-  data.tar.gz: 6c3d8841a45cd336a108c334b94e35441200885b2329ac6dbf39751dd32b8451
+  metadata.gz: 20fc4e914b706c818238f8d45a6d81ff650e18ae8fe90b47a9f818e28871bbc6
+  data.tar.gz: b0d23fded8dfd9981bedcfcaf9300376c615f53ce782a6f9e1a807b3e054c324
 SHA512:
-  metadata.gz: f8067434425e00d84371aa7242d78ebf9a24f355e2f13ec1cba79e7140301d2902b4bf2902237023b277ebfd876c88761b4cdc15de33df8225837ab074bb1781
-  data.tar.gz: 93eb07e47f6a8ec2cad4f7916090bb2f310657cca5bae3adef090e7a08f2de7d9b4af62f9e6649e1ab35eb5b2fc81d4a2063971bea6b37e3759473cd722ea47a
+  metadata.gz: 840663b99bf1d803274dc28d7b72882958b1e99fd93b7039fe249192fcb510b07fd894b5e5b404de1153a53095763bd0aaaf1c0a16f20b225187477a3887fab9
+  data.tar.gz: 7ba7a882f7e6cb6ed115d88769d433d835e9b8782c5e9272436ff28956594cd9d8ae995ea54e59e86fbf3daf4848b0eca30a60b20933a16401d0f21cbb6e24a4

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 2.0.0 beta
+## 2.0.0
 
 ### Features
 * The way the [rails app reloader](https://guides.rubyonrails.org/threading_and_code_execution.html)
@@ -20,6 +20,7 @@
 * 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
@@ -29,7 +30,6 @@
 * 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`
@@ -38,8 +38,8 @@
 * Your existing Clockfile with `schedule.foo` invocations will still work, but you now have the option to use
   `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
+* 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

data/README.md

@@ -33,7 +33,7 @@ ruby >= 3.0 is required.
 Add these lines to your application's Gemfile:
 
 ```ruby
-gem 'ruby-clock', '2.0.0.beta9'
+gem 'ruby-clock', '2.0.0.beta10'
 ```
 
 And then execute:
@@ -164,6 +164,26 @@ 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
+## install go
+brew install go # homebrew
+sudo port install go # macports
+
+## install cronv https://github.com/takumakanari/cronv#go-install
+go install -v github.com/takumakanari/cronv/cronv@0.4.5
+
+## generate dummy crontab
+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 | ~/go/bin/cronv --duration=1d --title='Clock Jobs' --width=50 -o ./my_cron_schedule.html
+open my_cron_schedule.html
+```
 
 ## More Config and Capabilities
 

data/exe/clock

@@ -11,12 +11,15 @@ RubyClock.instance.add_rails_executor_to_around_actions
 
 check_syntax = false
 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
@@ -67,6 +70,16 @@ elsif check_slug_uniqueness
   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.beta9"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-clock
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta9
+  version: 2.0.0
 platform: ruby
 authors:
 - John Bachir
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-25 00:00:00.000000000 Z
+date: 2023-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
@@ -272,9 +272,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.7
 signing_key: