ruby-clock 0.8.0.rc3 → 2.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e8d972bb2c2468f53d943f233e4e799df71a449b6f7b8c00a1ddbea33c54c92
-  data.tar.gz: fc97259d0575bd220f79dd25206128001eece56ec51eda06d95f28d718b65080
+  metadata.gz: 567b66555b094f4c722a3340b9cc5ca99abab18918033ed972dc8c65ce242b18
+  data.tar.gz: 2c9a42194dcd969623b04b1bfc21eb327cdd225322703a488f87fa1819a9302c
 SHA512:
-  metadata.gz: 6dcf79cbebb137a9f04e920b8d6ff0f910bd61536e3e666297217aef8d9942c656fca0d67d794c753ab42a9e035be364bcf3d3b6e465058ebfe7e8683fa94fea
-  data.tar.gz: a3ca20e788af53d77d5526aaacb3b7ff4b07e8852e7586fe181e1681985b32b5bce3a9f0a305507be335dfeee7399567a6cd31afe8262b6e0b84db9cd2d9a75a
+  metadata.gz: 0cdd8a85ec8f8de256486f027639c9d4c341131eb7dc88d519baf249733c7c655f72af923b8c8914b51d405f09a24cd9aa17efc4fc96cf807dcacdd74b024878
+  data.tar.gz: e655dce4688f88154bac50957fb321f11e07dc7d40ee5fc679a25d0e0a8feff097016ac7df128e77f4eaccae5e3fa817caa76d5a300bee364e48999bd4c0ea50

data/.gitignore

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

data/CHANGELOG.md

@@ -1,13 +1,21 @@
-## 0.8.0 RC3
+## 2.0.0.beta1
 
-* make terrapin and posix-spawn gems optional
+* 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
 
-## 0.8.0 RC2
+### Migrating from ruby-clock version 1 to version 2
 
-* fix detection of Rails constant, for non-rails apps
+* 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
 
-## 0.8.0 RC1
+## 1.0.0
 
+* 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

data/README.md

@@ -4,6 +4,10 @@ ruby-clock is a [job scheduler](https://en.wikipedia.org/wiki/Job_scheduler),
 known by heroku as a [clock process](https://devcenter.heroku.com/articles/scheduled-jobs-custom-clock-processes).
 In many cases it can replace the use of cron.
 
+Why another ruby scheduler project? See
+[this feature matrix of the space](https://docs.google.com/spreadsheets/d/148VMKY9iyOyUASYytSGiUJKvH0-O5Ri-3Cwr3S6DRPU/edit?usp=sharing).
+Feel free to leave a comment with suggestions for changes or additions.
+
 This gem is very small with very few lines of code. For all its scheduling capabilities,
 it relies on the venerable [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler/).
 rufus-scheduler
@@ -12,8 +16,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.
@@ -63,19 +67,31 @@ This will ignore Clockfile and only read jobs from clocks/MyClockfile:
 
 ### Rails
 
-Install the `clock` binstub and commit to your repo.
-
-    bundle binstubs ruby-clock
-
 To run your clock process in your app's environment:
 
-    bundle exec rails runner bin/clock
+    bundle exec clock
 
 To get smarter database connection management (such as in the case of a database restart or upgrade,
 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
 
@@ -92,7 +108,7 @@ schedule.every('5 minutes') do
 Add this line to your Procfile
 
 ```
-clock: bundle exec rails runner bin/clock
+clock: bundle exec clock
 ```
 
 You might have a main clock for general scheduled jobs, and then standalone ones
@@ -101,9 +117,9 @@ for that work more precisely. Here, maybe the main clock needs a 2GB instance,
 and the others each need 1GB all to themselves:
 
 ```
-clock: bundle exec rails runner bin/clock
-thing_checker: bundle exec rails runner bin/clock clocks/thing_checker.rb
-thing_reporter: bundle exec rails runner bin/clock clocks/thing_reporter.rb
+clock: bundle exec clock
+thing_checker: bundle exec clock clocks/thing_checker.rb
+thing_reporter: bundle exec clock clocks/thing_reporter.rb
 ```
 
 Because of this feature, do I regret using "Clockfile" instead of, say, "clock.rb"? Maybe.
@@ -165,6 +181,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 clock clocks/main_jobs.rb
+bundle exec clock clocks/shell_jobs.rb
+```
+
+
 ### Rake tasks
 
 You can run tasks from within the persistent runtime of ruby-clock, without

data/example-app/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    ruby-clock (0.8.0.rc2)
+    ruby-clock (0.8.0.rc3)
       method_source
       rufus-scheduler (~> 3.8)
 

data/example-app/README.md

@@ -5,5 +5,5 @@ To run:
 
 ```
 bundle
-bundle exe clock
+bundle exec clock
 ```

data/example-rails-app/.gitattributes

@@ -0,0 +1,9 @@
+# See https://git-scm.com/docs/gitattributes for more about git attribute files.
+
+# Mark the database schema as having been generated.
+db/schema.rb linguist-generated
+
+# Mark any vendored files as having been vendored.
+vendor/* linguist-vendored
+
+Clockfile linguist-language=Ruby

data/example-rails-app/.gitignore

@@ -0,0 +1,35 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-*
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore uploaded files in development.
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/
+!/tmp/storage/.keep
+
+/public/assets
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key

data/example-rails-app/.ruby-version

@@ -0,0 +1 @@
+2.7.5

data/example-rails-app/Clockfile

@@ -0,0 +1,19 @@
+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
+
+schedule.every('2 seconds') do
+  shell 'say hello'
+end
+
+schedule.every('2 seconds') do
+  puts Example.count
+end
+
+schedule.every('2 seconds') do
+  raise "An error."
+end

data/example-rails-app/Gemfile

@@ -0,0 +1,74 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby "2.7.5"
+
+gem 'ruby-clock', path: '../'
+
+# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
+gem "rails", "~> 7.0.4"
+
+# The original asset pipeline for Rails [https://github.com/rails/sprockets-rails]
+gem "sprockets-rails"
+
+# Use sqlite3 as the database for Active Record
+gem "sqlite3", "~> 1.4"
+
+# Use the Puma web server [https://github.com/puma/puma]
+gem "puma", "~> 5.0"
+
+# Use JavaScript with ESM import maps [https://github.com/rails/importmap-rails]
+gem "importmap-rails"
+
+# Hotwire's SPA-like page accelerator [https://turbo.hotwired.dev]
+gem "turbo-rails"
+
+# Hotwire's modest JavaScript framework [https://stimulus.hotwired.dev]
+gem "stimulus-rails"
+
+# Build JSON APIs with ease [https://github.com/rails/jbuilder]
+gem "jbuilder"
+
+# Use Redis adapter to run Action Cable in production
+gem "redis", "~> 4.0"
+
+# Use Kredis to get higher-level data types in Redis [https://github.com/rails/kredis]
+# gem "kredis"
+
+# Use Active Model has_secure_password [https://guides.rubyonrails.org/active_model_basics.html#securepassword]
+# gem "bcrypt", "~> 3.1.7"
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: %i[ mingw mswin x64_mingw jruby ]
+
+# Reduces boot times through caching; required in config/boot.rb
+gem "bootsnap", require: false
+
+# Use Sass to process CSS
+# gem "sassc-rails"
+
+# Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images]
+# gem "image_processing", "~> 1.2"
+
+group :development, :test do
+  # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
+  gem "debug", platforms: %i[ mri mingw x64_mingw ]
+end
+
+group :development do
+  # Use console on exceptions pages [https://github.com/rails/web-console]
+  gem "web-console"
+
+  # Add speed badges [https://github.com/MiniProfiler/rack-mini-profiler]
+  # gem "rack-mini-profiler"
+
+  # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
+  # gem "spring"
+end
+
+group :test do
+  # Use system testing [https://guides.rubyonrails.org/testing.html#system-testing]
+  gem "capybara"
+  gem "selenium-webdriver"
+  gem "webdrivers"
+end

data/example-rails-app/README.md

@@ -0,0 +1,12 @@
+This is a bare-bones example rails 7 app to
+help with dev and also as an example for users.
+
+The only interesting thing is in Clockfile
+
+To run:
+
+```
+bundle
+bundle exec rails db:migrate
+bundle exec rails runner bin/clock
+```

data/example-rails-app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/example-rails-app/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css
+//= link_tree ../../javascript .js
+//= link_tree ../../../vendor/javascript .js

data/example-rails-app/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS (and SCSS, if configured) file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/example-rails-app/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/example-rails-app/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/example-rails-app/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/example-rails-app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/example-rails-app/app/javascript/application.js

@@ -0,0 +1,3 @@
+// Configure your import map in config/importmap.rb. Read more: https://github.com/rails/importmap-rails
+import "@hotwired/turbo-rails"
+import "controllers"

data/example-rails-app/app/javascript/controllers/application.js

@@ -0,0 +1,9 @@
+import { Application } from "@hotwired/stimulus"
+
+const application = Application.start()
+
+// Configure Stimulus development experience
+application.debug = false
+window.Stimulus   = application
+
+export { application }

data/example-rails-app/app/javascript/controllers/hello_controller.js

@@ -0,0 +1,7 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  connect() {
+    this.element.textContent = "Hello World!"
+  }
+}

data/example-rails-app/app/javascript/controllers/index.js

@@ -0,0 +1,11 @@
+// Import and register all your controllers from the importmap under controllers/*
+
+import { application } from "controllers/application"
+
+// Eager load all controllers defined in the import map under controllers/**/*_controller
+import { eagerLoadControllersFrom } from "@hotwired/stimulus-loading"
+eagerLoadControllersFrom("controllers", application)
+
+// Lazy load controllers as they appear in the DOM (remember not to preload controllers in import map!)
+// import { lazyLoadControllersFrom } from "@hotwired/stimulus-loading"
+// lazyLoadControllersFrom("controllers", application)

data/example-rails-app/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/example-rails-app/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: "from@example.com"
+  layout "mailer"
+end

data/example-rails-app/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+end

data/example-rails-app/app/models/example.rb

@@ -0,0 +1,2 @@
+class Example < ApplicationRecord
+end

data/example-rails-app/app/views/layouts/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>ExampleRailsApp</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
+    <%= javascript_importmap_tags %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/example-rails-app/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/example-rails-app/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/example-rails-app/bin/bundle

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_requirement
+    @bundler_requirement ||=
+      env_var_version || cli_arg_version ||
+        bundler_requirement_for(lockfile_version)
+  end
+
+  def bundler_requirement_for(version)
+    return "#{Gem::Requirement.default}.a" unless version
+
+    bundler_gem_version = Gem::Version.new(version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem.rubygems_version < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/example-rails-app/bin/importmap

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative "../config/application"
+require "importmap/commands"

data/example-rails-app/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/example-rails-app/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/example-rails-app/bin/setup

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   FileUtils.cp "config/database.yml.sample", "config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system! "bin/rails db:prepare"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  puts "\n== Restarting application server =="
+  system! "bin/rails restart"
+end