ruby-clock 0.5.0 → 0.8.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aecbbec2f68af72734fdb4daed9bbe35b47b3b012a2074915241eac7f8b6c40a
-  data.tar.gz: 3bef0b2f87eb30ca32e5cd142249ef7a4ef1c34deb2714dc76cb2ecab3754600
+  metadata.gz: 2ec6ebc2ef5793e7d114920402b20ed5129e1f60a78cb444d208e45def25a36b
+  data.tar.gz: 3935724aaa45567dd2e769274f76fc1b5a3785f155d4885764a25635a8bf6c96
 SHA512:
-  metadata.gz: 9cb10c6514f7e28394632e6fbd76b19e2666ede782cf344918aeea3eaa368e318b7ee3135b7c252208c8f0090657b629cd469eaa704b0b908ce34fa213735213
-  data.tar.gz: 943997440dfb369138ad5084497dbdd76504d030d58c5508eced067930205171089518a752b42a3b7cf398dc5560a9ab8ecb70b0dc01f35188c3380853a23738
+  metadata.gz: cf58749b267218114e3ad235fa64d0c7e21cecc13c75f6a655b63cf16f056dcc174e6cd724be74c3a5c39087eec808e03d72829674cff52d85f0f831340efeb3
+  data.tar.gz: 04eefdc557205145fad64889dec7f7dcf6af4ead08dcc8795af58be4fffc2a54d97bb261048478c98aab58be30124e47f1d35c5115976cdd4119b95903e9b5ce

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+## 0.8.0 RC2
+
+* fix detection of Rails constant, for non-rails apps
+
+## 0.8.0 RC1
+
+* automatically wrap jobs with rails reloader
+* ability to run rake tasks
+* ability to run shell commands
+* 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
+
+* ability to specify the name of the file with job definitions, e.g. `bundle exec clock clocks/MyClockfile`
+* ability to specify the amount of time ruby-clock will wait before forcing threads to shut down
+
+## 0.6.0
+
+* job identifiers

data/Gemfile.lock

@@ -1,22 +1,30 @@
 PATH
   remote: .
   specs:
-    ruby-clock (0.4.0)
-      rufus-scheduler (~> 3.7)
+    ruby-clock (0.8.0.rc2)
+      method_source
+      posix-spawn (~> 0.3.15)
+      rufus-scheduler (~> 3.8)
+      terrapin (~> 0.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    concurrent-ruby (1.1.7)
-    et-orbi (1.2.4)
+    climate_control (0.2.0)
+    concurrent-ruby (1.1.9)
+    et-orbi (1.2.5)
       tzinfo
-    fugit (1.4.1)
+    fugit (1.5.2)
       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.7.0)
+    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)
 
@@ -28,4 +36,4 @@ DEPENDENCIES
   ruby-clock!
 
 BUNDLED WITH
-   2.1.4
+   2.2.23

data/README.md

@@ -16,6 +16,7 @@ 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).
 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.
 
 ## Installation
 
@@ -55,6 +56,11 @@ To start your clock process:
 
     bundle exec clock
 
+To use a file other than Clockfile for job definitions, specify it.
+This will ignore Clockfile and only read jobs from clocks/MyClockfile:
+
+    bundle exec clock clocks/MyClockfile
+
 ### Rails
 
 Install the `clock` binstub and commit to your repo.
@@ -65,6 +71,12 @@ To run your clock process in your app's environment:
 
     bundle exec rails runner bin/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).
+
+
 ### Non-Rails
 
 Require your app's code at the top of Clockfile:
@@ -83,6 +95,28 @@ Add this line to your Procfile
 clock: bundle exec rails runner bin/clock
 ```
 
+You might have a main clock for general scheduled jobs, and then standalone ones
+if your system has something where you want to monitor and adjust resources
+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
+```
+
+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
 
 ### Error Handling
@@ -102,6 +136,103 @@ You can define before, after, and around callbacks which will run for all jobs.
 Read [the rufus-scheduler documentation](https://github.com/jmettraux/rufus-scheduler/#callbacks)
 to learn how to do this. Where the documentation references `s`, you should use `schedule`.
 
+### 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.
+
+```ruby
+schedule.every '1 day' do
+  shell('sh scripts/process_stuff.sh')
+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:
+
+```ruby
+schedule.every '1 day' do
+  line = Terrapin::CommandLine.new('optimize_png', ":file")
+  Organization.with_new_logos.find_each do |o|
+    line.run(file: o.logo_file_path)
+    o.update!(logo_optimized: true)
+  end
+end
+```
+
+### Rake tasks
+
+You can run tasks from within the persistent runtime of ruby-clock, without
+needing to shell out and start another process.
+
+```ruby
+schedule.every '1 day' do
+  rake('reports:daily')
+end
+```
+
+There is also `rake_execute` and `rake_async`. See [the code](https://github.com/jjb/ruby-clock/blob/main/lib/ruby-clock.rb)
+and [this article](https://code.jjb.cc/running-rake-tasks-from-within-ruby-on-rails-code) for more info.
+
+### Job Identifier
+
+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.
+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:
+
+```ruby
+schedule.every '1 second', name: 'my job' do
+  Foo.bar
+end
+# => my job
+
+schedule.every '1 day' do
+  daily_things = Foo.setup_daily
+  daily_things.process
+  # TODO: figure out best time of day
+end
+# => daily_things.process
+
+# n.b. ruby-clock isn't yet smart enough to remove trailing comments
+schedule.every '1 week' do
+  weekly_things = Foo.setup_weekly
+  weekly_things.process # does this work???!1~
+end
+# => weekly_things.process # does this work???!1~
+```
+
+This can be used for keeping track of job behavior in logs or a
+stats tracker. For example:
+
+```ruby
+def schedule.on_post_trigger(job, trigger_time)
+  duration = Time.now-trigger_time.to_t
+  StatsTracker.value('Clock: Job Execution Time', duration.round(2))
+  StatsTracker.value("Clock: Job #{job.identifier} Execution Time", duration.round(2))
+  StatsTracker.increment('Clock: Job Executions')
+end
+
+schedule.every '10 seconds', name: 'thread stats' do
+  thread_usage = Hash.new(0)
+  schedule.work_threads(:active).each do |t|
+    thread_usage[t[:rufus_scheduler_job].identifier] += 1
+  end
+  thread_usage.each do |job, count|
+    StatsTracker.value("Clock: Job #{job} Active Threads", count)
+  end
+
+  StatsTracker.value("Clock: Active Threads", schedule.work_threads(:active).size)
+  StatsTracker.value("Clock: Vacant Threads", schedule.work_threads(:vacant).size)
+  StatsTracker.value("Clock: DB Pool Size", ActiveRecord::Base.connection_pool.connections.size)
+end
+```
+
 ### other rufus-scheduler Options
 
 All rufus-scheduler options are set to defaults. The `schedule` variable
@@ -111,6 +242,14 @@ so anything you can do on this instance, you can do in your Clockfile.
 Perhaps in the future ruby-clock will add some easier specific configuration
 capabilities for some things. Let me know if you have a request!
 
+## Syntax highlighting for Clockfile
+
+To tell github and maybe other systems to syntax highlight Clockfile, put this in a .gitattributes file:
+
+```gitattributes
+Clockfile linguist-language=Ruby
+```
+
 
 ## License
 

data/example-app/.gitattributes

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

data/example-app/Clockfile

@@ -0,0 +1,3 @@
+schedule.every('2 seconds') do
+  puts "hello from a ruby-clock job"
+end

data/example-app/Gemfile

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

data/example-app/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: ..
+  specs:
+    ruby-clock (0.8.0.rc1)
+      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
+    fugit (1.5.2)
+      et-orbi (~> 1.1, >= 1.1.8)
+      raabro (~> 1.4)
+    method_source (1.0.0)
+    posix-spawn (0.3.15)
+    raabro (1.4.0)
+    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
+  arm64-darwin-20
+
+DEPENDENCIES
+  ruby-clock!
+
+BUNDLED WITH
+   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 exe clock
+```

data/exe/clock

@@ -1,10 +1,39 @@
 #!/usr/bin/env ruby
 
 require 'ruby-clock'
+require 'method_source'
+
+class Rufus::Scheduler::Job
+  def identifier
+    @identifier ||= begin
+      name || handler.source.split("\n").reject(&:empty?).grep_v(/#.*/)[-2].strip
+    rescue
+      begin
+        source_location.join('-')
+      rescue
+        'error-calculating-job-identifier'
+      end
+    end
+  end
+end
+
 include RubyClock
 
 listen_to_signals
+prepare_rake
+schedule.pause
+
+load ARGV[0] || 'Clockfile'
 
-load 'Clockfile'
+if defined?(::Rails)
+  schedule.instance_eval do
+    @old_around_trigger = method :around_trigger
+    def around_trigger(job)
+      ::Rails.application.reloader.wrap do
+        @old_around_trigger.call(job){ yield }
+      end
+    end
+  end
+end
 
 run_jobs

data/lib/ruby-clock/version.rb

@@ -1,3 +1,3 @@
 module RubyClock
-  VERSION = "0.5.0"
+  VERSION = "0.8.0.rc2"
 end

data/lib/ruby-clock.rb

@@ -3,8 +3,10 @@ require 'rufus-scheduler'
 
 module RubyClock
   def shutdown
-    puts "Shutting down ruby-clock 🐈️ 👋"
-    Rufus::Scheduler.singleton.shutdown(wait: 29)
+    wait_seconds = ENV['RUBY_CLOCK_SHUTDOWN_WAIT_SECONDS']&.to_i || 29
+    puts "Shutting down ruby-clock. Waiting #{wait_seconds} seconds for jobs to finish..."
+    schedule.shutdown(wait: wait_seconds)
+    puts "...done 🐈️ 👋"
   end
 
   def listen_to_signals
@@ -27,6 +29,48 @@ module RubyClock
 
   def run_jobs
     puts "Starting ruby-clock with #{schedule.jobs.size} jobs"
-    Rufus::Scheduler.singleton.join
+    schedule.resume
+    schedule.join
   end
+
+  def prepare_rake
+    if defined?(::Rails) && Rails.application
+      Rails.application.load_tasks
+      Rake::Task.tasks.each{|t| t.prerequisites.delete 'environment' }
+      @rake_mutex = Mutex.new
+    else
+      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.
+      MESSAGE
+    end
+  end
+
+  # See https://code.jjb.cc/running-rake-tasks-from-within-ruby-on-rails-code
+
+  # for tasks that don't have dependencies
+  def rake_execute(task)
+    Rake::Task[task].execute
+  end
+
+  # If the task doesn't share dependencies with another task,
+  # or if it does and you know you'll never run tasks such that any overlap
+  def rake_async(task)
+    Rake::Task[task].invoke
+  ensure
+    Rake::Task[task].reenable
+    Rake::Task[task].all_prerequisite_tasks.each(&:reenable)
+  end
+
+  # If the task has shared dependencies and you might run more than one at the same time
+  # This is the safest option and hence the default.
+  def rake(task)
+    @rake_mutex.synchronize { rake_async(task) }
+  end
+
+  def shell(command)
+    Terrapin::CommandLine.new(command).run
+  end
+
 end

data/release.md

@@ -0,0 +1,3 @@
+1. update lib/ruby-clock/version.rb
+2. update CHANGELOG.md
+3. `rake release`

data/ruby-clock.gemspec

@@ -29,5 +29,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rufus-scheduler", '~> 3.7'
+  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.5.0
+  version: 0.8.0.rc2
 platform: ruby
 authors:
 - John Bachir
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-04 00:00:00.000000000 Z
+date: 2021-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
@@ -16,14 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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:
 email:
 - j@jjb.cc
@@ -33,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -40,9 +83,15 @@ files:
 - 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
+- release.md
 - ruby-clock.gemspec
 homepage: https://github.com/jjb/ruby-clock
 licenses:
@@ -61,11 +110,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: A "clock" process for invoking ruby code within a persistent runtime