ruby-clock 0.8.0.rc1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77de35a13a23a83386d574ebc2ff0e71777f65b3612a9a444afd4f9ea69286bf
-  data.tar.gz: 95cec8207417b487dfb81fb20b9cc8147bd90200efb009cc56a8c023773979bf
+  metadata.gz: bb7709e5cb45330de5b30adb906cc15e847207894a2ad71b3afd706ea0235f09
+  data.tar.gz: 9ab66e406ada9646d83f28806c07018641953b7b56f8824b49e14b3bd2ad2b7c
 SHA512:
-  metadata.gz: a5585b7af51d706ffcbac3b88881c9b9c189dbc80e08867feea9ecef690dfd04957593504415bffde2c2022f69c1afdb0b30472f2466baa6bfc0dfad1264855d
-  data.tar.gz: b1a9aa07dfcaaf28f8d953c88f9ccc467ac199376dce674bff1b3fac7aef3a01416dd9638a40d5fd28ae23932d56e1f56b74888fdb485c4dce3dd9fa6ed579aa
+  metadata.gz: d14858bb6c936e07e66527c9f670d68e236d56ccce407da9c5472334748a3b3f07012f82ff827fb314557b318a555a0e50ff9914b36330fe9cbd7c271da76532
+  data.tar.gz: '033369b93174cdba782d21fa150f63f521bf058d9ef6a654fbb54fd53e2b529f753350b5e086aa2b7e5df2cd0647cf9f932aceb6aaeabba892727dfb978ed1a8'

data/.gitignore

@@ -1,3 +1,4 @@
+Gemfile.lock
 /.bundle/
 /.yardoc
 /_yardoc/

data/CHANGELOG.md

@@ -1,10 +1,12 @@
-## 0.8.0 RC1
+## 1.0.0
 
-* fixed rare error when calculating job identifier
-* nicer shutdown logging, indicating when shutdown process begins and ends
+* make terrapin and posix-spawn gems optional
+* fix detection of Rails constant, for non-rails apps
+* automatically wrap jobs with rails reloader
 * ability to run rake tasks
 * ability to run shell commands
-* automatically wrap jobs with rails reloader
+* nicer shutdown logging, indicating when shutdown process begins and ends
+* fix approach for error fallbacks when when calculating job identifier (probably never encountered)
 
 ## 0.7.0
 

data/README.md

@@ -12,8 +12,8 @@ ruby-clock does.
 
 Jobs are all run in their own parallel threads within the same process.
 
-The clock process will respond to signals INT (^c at the command line) and
-TERM (signal sent by environments such as Heroku and other PaaS's when shutting down).
+The clock process will respond to signals `INT` (<kbd>^c</kbd> at the command line) and
+`TERM` (signal sent by environments such as Heroku and other PaaS's when shutting down).
 In both cases, the clock will stop running jobs and give existing jobs 29 seconds
 to stop before killing them.
 You can change this number with `RUBY_CLOCK_SHUTDOWN_WAIT_SECONDS` in the environment.
@@ -75,7 +75,22 @@ To get smarter database connection management (such as in the case of a database
 and maybe other benefits) and code reloading in dev (app code, not the code in Clockfile itself),
 jobs are automatically wrapped in the
 [rails app reloader](https://guides.rubyonrails.org/threading_and_code_execution.html).
+This [may incur a performance impact for certain jobs](https://github.com/rails/rails/issues/43504),
+I'm still exploring this.
 
+#### ActiveRecord Query Cache
+
+You may wish to
+[turn off the ActiveRecord Query Cache](https://code.jjb.cc/turning-off-activerecord-query-cache-to-improve-memory-consumption-in-background-jobs)
+for your jobs. You can do so with the around trigger:
+
+```ruby
+def schedule.around_trigger(job)
+  ActiveRecord::Base.uncached do
+    yield
+  end
+end
+```
 
 ### Non-Rails
 
@@ -108,6 +123,14 @@ thing_reporter: bundle exec rails runner bin/clock clocks/thing_reporter.rb
 
 Because of this feature, do I regret using "Clockfile" instead of, say, "clock.rb"? Maybe.
 
+#### Observing logs
+
+Because STDOUT does not flush until a certain amount of data has gone into it,
+you might not immediately see the ruby-clock startup message or job output if
+viewing logs in a deployed environment such as Heroku where the logs are redirected
+to another process or file. To change this behavior and have logs flush immediately,
+add `$stdout.sync = true` to the top of your Clockfile.
+
 
 ## More Config and Capabilities
 
@@ -130,9 +153,7 @@ to learn how to do this. Where the documentation references `s`, you should use
 
 ### Shell commands
 
-You can run shell commands in your jobs. They are invoked using
-[posix-spawn](https://github.com/rtomayko/posix-spawn), which means
-the ruby process is not forked.
+You can run shell commands in your jobs.
 
 ```ruby
 schedule.every '1 day' do
@@ -140,9 +161,14 @@ schedule.every '1 day' do
 end
 ```
 
-`shell` is a very simple convenience method which is implemented with
-[terrapin](https://github.com/thoughtbot/terrapin). If you want to use other terrapin
-features you can do so:
+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.
+
+`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
+and use terrapin directly:
 
 ```ruby
 schedule.every '1 day' do
@@ -154,6 +180,22 @@ schedule.every '1 day' do
 end
 ```
 
+#### shutdown behavior
+
+Because of [this](https://stackoverflow.com/questions/69653842/),
+if a shell job is running during shutdown, shutdown behavior seems to be changed
+for _all_ running jobs - they no longer are allowed to finish within the timeout period.
+Everything exits immediately.
+
+Until this is figured out, if you are concerned about jobs exiting inelegantly,
+you may want to run your shell jobs in their own separate clock process.
+
+```
+bundle exec rails runner bin/clock clocks/main_jobs.rb
+bundle exec rails runner bin/clock clocks/shell_jobs.rb
+```
+
+
 ### Rake tasks
 
 You can run tasks from within the persistent runtime of ruby-clock, without

data/example-app/.gitattributes

@@ -0,0 +1 @@
+Clockfile linguist-language=Ruby

data/example-app/Clockfile

@@ -0,0 +1,11 @@
+def schedule.on_error(job, error)
+  raise error
+end
+
+schedule.every('2 seconds') do
+  puts "hello from a ruby-clock job"
+end
+
+schedule.every('2 seconds') do
+  shell 'say hello'
+end

data/example-app/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem 'ruby-clock', path: '../'
+# gem 'terrapin'
+# gem 'posix-spawn'

data/{Gemfile.lock → example-app/Gemfile.lock}

@@ -1,16 +1,13 @@
 PATH
-  remote: .
+  remote: ..
   specs:
-    ruby-clock (0.8.0.rc1)
+    ruby-clock (0.8.0.rc3)
       method_source
-      posix-spawn (~> 0.3.15)
       rufus-scheduler (~> 3.8)
-      terrapin (~> 0.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    climate_control (0.2.0)
     concurrent-ruby (1.1.9)
     et-orbi (1.2.5)
       tzinfo
@@ -18,22 +15,17 @@ GEM
       et-orbi (~> 1.1, >= 1.1.8)
       raabro (~> 1.4)
     method_source (1.0.0)
-    posix-spawn (0.3.15)
     raabro (1.4.0)
-    rake (12.3.3)
     rufus-scheduler (3.8.0)
       fugit (~> 1.1, >= 1.1.6)
-    terrapin (0.6.0)
-      climate_control (>= 0.0.3, < 1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
 
 PLATFORMS
-  ruby
+  arm64-darwin-20
 
 DEPENDENCIES
-  rake (~> 12.0)
   ruby-clock!
 
 BUNDLED WITH
-   2.2.23
+   2.2.28

data/example-app/README.md

@@ -0,0 +1,9 @@
+This is a bare-bones example non-rails app to
+help with dev and also as an example for users.
+
+To run:
+
+```
+bundle
+bundle exec clock
+```

data/exe/clock

@@ -25,7 +25,7 @@ schedule.pause
 
 load ARGV[0] || 'Clockfile'
 
-if ::Rails
+if defined?(::Rails)
   schedule.instance_eval do
     @old_around_trigger = method :around_trigger
     def around_trigger(job)

data/lib/ruby-clock/version.rb

@@ -1,3 +1,3 @@
 module RubyClock
-  VERSION = "0.8.0.rc1"
+  VERSION = "1.0.0"
 end

data/lib/ruby-clock.rb

@@ -42,7 +42,7 @@ module RubyClock
       puts <<~MESSAGE
         Because this is not a rails application, we do not know how to load your
         rake tasks. You can do this yourself at the top of your Clockfile if you want
-        to run rake tasks from ruby-cron.
+        to run rake tasks from ruby-clock.
       MESSAGE
     end
   end
@@ -69,8 +69,41 @@ module RubyClock
     @rake_mutex.synchronize { rake_async(task) }
   end
 
+  def shell_runner
+    @shell_runner ||= begin
+      require 'terrapin'
+      require 'posix-spawn'
+
+      unless Terrapin::CommandLine.runner.class == Terrapin::CommandLine::PosixRunner
+        puts <<~MESSAGE
+
+          🤷 terrapin and posix-spawn are installed, but for some reason terrapin is
+             not using posix-spawn as its runner.
+
+        MESSAGE
+      end
+
+      puts '🐆 Using terrapin for shell commands.'
+      :terrapin
+    rescue LoadError
+      puts <<~MESSAGE
+
+        🦥 Using ruby backticks for shell commands.
+           For better performance, install the terrapin and posix-spawn gems.
+           See README.md for more info.
+
+      MESSAGE
+      :backticks
+    end
+  end
+
   def shell(command)
-    Terrapin::CommandLine.new(command).run
+    case shell_runner
+    when :terrapin
+      Terrapin::CommandLine.new(command).run
+    when :backticks
+      `#{command}`
+    end
   end
 
 end

data/release.md

@@ -1,3 +1,4 @@
 1. update lib/ruby-clock/version.rb
 2. update CHANGELOG.md
+3. commit and push to github
 3. `rake release`

data/ruby-clock.gemspec

@@ -31,6 +31,4 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rufus-scheduler", '~> 3.8'
   spec.add_dependency "method_source"
-  spec.add_dependency "terrapin", '~> 0.6'
-  spec.add_dependency "posix-spawn", '~> 0.3.15'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-clock
 version: !ruby/object:Gem::Version
-  version: 0.8.0.rc1
+  version: 1.0.0
 platform: ruby
 authors:
 - John Bachir
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-18 00:00:00.000000000 Z
+date: 2022-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
@@ -38,35 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: terrapin
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: posix-spawn
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.15
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.15
-description: 
+description:
 email:
 - j@jjb.cc
 executables:
@@ -77,12 +49,16 @@ files:
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- example-app/.gitattributes
+- example-app/Clockfile
+- example-app/Gemfile
+- example-app/Gemfile.lock
+- example-app/README.md
 - exe/clock
 - lib/ruby-clock.rb
 - lib/ruby-clock/version.rb
@@ -94,7 +70,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/jjb/ruby-clock
   source_code_uri: https://github.com/jjb/ruby-clock
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,12 +81,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.23
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: A "clock" process for invoking ruby code within a persistent runtime
 test_files: []