ruby-clock 2.0.0.beta6 → 2.0.0.beta8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 748f887bbd3b6076b86585e8734f2fc131ec3312bd10c330e5adc867643d7776
-  data.tar.gz: 8c449e3389930814e009ad6850e1a5e4a049ffe0e50364f834dc0b1e1cef1def
+  metadata.gz: 315bcc30c6fc32c1676e452750d76e839b0123f19fe7512bbe6662ae72ee0ecc
+  data.tar.gz: a5831b721e9d99af3082cb31dd472f4e282d5665616f40694ba41def7250b907
 SHA512:
-  metadata.gz: 85af8021686f2148b0f295fdd4b0c0e3eba7457a3a060f34d1f9fed67ff17ab6ba2f62983912ee481dea45db14a547ffe6b496a6fea59986e271e66f768a0212
-  data.tar.gz: da361427d50908de9c9a4a949a284831536fbf2e0f1980a9906f23d19e80150d3f1f4085031df06850a63529a23eddb7d48956de7352ff2679d6c026eced8e2e
+  metadata.gz: '0983e40393e4d273feddbcb53d67c0a8b2ccbb194439a16df9ddb1edaeedcf89f36338bffc80d8ffb44809500b3553cbc601c55275fcd4dba86d18b67ad57bf5'
+  data.tar.gz: 563039f0ea34927b4d6e1abd64db0f2ae086c44f37d03852d8ca510223e1ce0f57ebe275ce7059d704de3e29a1e7f33d1412b92ad4b7a5a7e4e6d5ec661e9605

data/CHANGELOG.md

@@ -6,10 +6,17 @@
 * 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` - see readme
-* Multiple around callbacks can be consecutively assigned - no need to put all behavior into one action
-* Errors encountered when loading Clockfile (such as incorrect cron syntaxt)
+* 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
+* 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#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
 
 ### Anti-Features
 * ruby 3.0 is now the minimum version
@@ -26,11 +33,9 @@
 * 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
   `around_action` method.
-* Your existing Clockfile will still work, but you now have the option to use
+* 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`.
-  See the readme for examples.
 * You now have the option of catching and reporting errors encountered when parsing the Clockfile.
-  See the 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

@@ -28,7 +28,7 @@ You can change this number with `RUBY_CLOCK_SHUTDOWN_WAIT_SECONDS` in the enviro
 
 ## Installation
 
-ruby >= 2.7 is required.
+ruby >= 3.0 is required.
 
 Add these lines to your application's Gemfile:
 
@@ -139,6 +139,17 @@ to another process or file. To change this behavior and have logs flush immediat
 add `$stdout.sync = true` to the top of your Clockfile.
 
 
+#### Testing
+
+You can use the `--environment-and-syntax-check` flag to load the app environment and check
+Clockfile syntax without actually running jobs. This can be used to check if cron syntax
+is valid during dev, or in automate tests.
+
+```ruby
+# system returns true/false depending on 0/1 exit status of process
+assert(system("bundle exec --environment-and-syntax-check clock/my_clockfile.rb"))
+```
+
 ## More Config and Capabilities
 
 ### Error Handling
@@ -151,7 +162,7 @@ error reports about problems while loading the Clockfile:
 on_error do |job, error|
   case job
   when String # this means there was a problem parsing the Clockfile while starting
-    ErrorReporter.track_exception(error, tag: 'clock', severity: 'high')
+    ErrorReporter.track_exception(StandardError.new(error), tag: 'clock', severity: 'high')
   else
     ErrorReporter.track_exception(error, tag: 'clock', custom_attribute: {job_name: job.identifier})
   end
@@ -239,7 +250,7 @@ end
 By default they will be run with
 [ruby backticks](https://livebook.manning.com/concept/ruby/backtick).
 For better performance, install the [terrapin](https://github.com/thoughtbot/terrapin)
-and [posix-spawn](https://github.com/rtomayko/posix-spawn) gems.
+gem.
 
 `shell` is a convenience method which just passes the string on.
 If you want to use other terrapin features, you can skip the `shell` command
@@ -283,7 +294,7 @@ end
 ```
 
 There are also `rake_execute` and `rake_async`.
-See [the code](https://github.com/jjb/ruby-clock/blob/main/lib/rake.rb)
+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

data/example-app/Clockfile

@@ -14,7 +14,7 @@ end
 # end
 
 around_action do |job_proc, job_info|
-  puts "before1 #{job_info.class}"
+  puts "before1 #{job_info.class} #{job_info.identifier}"
   job_proc.call
   puts "after1"
 end
@@ -60,3 +60,19 @@ end
 # def schedule.around_trigger(job_info, &job_proc)
 #   puts "ruby-clock 1-style around trigger!"
 # end
+
+every('2 seconds', blocking: true) do
+  begin
+
+    1.times {
+      begin
+        puts "hello from a stress test for the autonamer"
+      end
+
+    }
+    # this is a comment!
+
+  end
+  # another comment
+
+end

data/example-app/Gemfile

@@ -6,4 +6,3 @@ ruby '>= 3.0'
 
 gem 'ruby-clock', path: '../'
 # gem 'terrapin'
-# gem 'posix-spawn'

data/exe/clock

@@ -9,8 +9,21 @@ 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]
+  end
+when String
+  clockfile = ARGV[0]
+end
+
 begin
-  load ARGV[0] || 'Clockfile'
+  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)
@@ -21,4 +34,9 @@ end
 
 RubyClock.instance.ensure_around_trigger_has_not_been_redefined
 RubyClock.instance.freeze_around_actions
-RubyClock.instance.run_jobs
+
+if check_syntax
+  puts "✨ Environment & Syntax OK ✨"
+else
+  RubyClock.instance.run_jobs
+end

data/lib/ruby-clock/shell.rb

@@ -2,13 +2,11 @@ module RubyClock::Shell
   def shell_runner
     @shell_runner ||= begin
       require 'terrapin'
-      require 'posix-spawn'
-
-      unless Terrapin::CommandLine.runner.class == Terrapin::CommandLine::PosixRunner
+      unless Terrapin::CommandLine.runner.class == Terrapin::CommandLine::ProcessRunner
         puts <<~MESSAGE
 
-          🤷 terrapin and posix-spawn are installed, but for some reason terrapin is
-             not using posix-spawn as its runner.
+          🤷 terrapin is installed, but for some reason terrapin is
+            using backticks as its runner.
 
         MESSAGE
       end
@@ -19,7 +17,7 @@ module RubyClock::Shell
       puts <<~MESSAGE
 
         🦥 Using ruby backticks for shell commands.
-           For better performance, install the terrapin and posix-spawn gems.
+           For better performance, install the terrapin gem.
            See README.md for more info.
 
       MESSAGE

data/lib/ruby-clock/version.rb

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

data/lib/rufus_monkeypatch.rb

@@ -1,8 +1,15 @@
 require 'method_source'
 class Rufus::Scheduler::Job
+  UNDESIRED_ELEMENTS = ['', '}', 'end']
   def identifier
     @identifier ||= begin
-      name || handler.source.split("\n").reject(&:empty?).grep_v(/#.*/)[-2].strip
+      return name if name
+
+      lines = handler.source.split("\n")
+      whitespace_removed = lines.map(&:strip)
+      undesired_removed = whitespace_removed - UNDESIRED_ELEMENTS
+      comment_only_lines_removed = undesired_removed.grep_v(/#.*/)
+      comment_only_lines_removed[-1] # final line
     rescue
       begin
         source_location.join('-')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-clock
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta6
+  version: 2.0.0.beta8
 platform: ruby
 authors:
 - John Bachir
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-19 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
@@ -276,7 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A job scheduler which runs jobs each in their own thread in a persistent