ruby-clock 0.7.0 → 0.8.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2681c0a4279cd09c1c12b8495148b426f3af51ed8620615441ad013f2e21e40a
-  data.tar.gz: db0aea19c254edf9007dd9d1f34a8d1d9616e864972187f1345857ae6ad4f4db
+  metadata.gz: 77de35a13a23a83386d574ebc2ff0e71777f65b3612a9a444afd4f9ea69286bf
+  data.tar.gz: 95cec8207417b487dfb81fb20b9cc8147bd90200efb009cc56a8c023773979bf
 SHA512:
-  metadata.gz: 1461d0c51349a1d635dc85dfc54a691753b48be4fcba2b687257d415d74fb8ced8b9fe15471f7940212bfd1ebf82ed8df2ccb93519f769c5c4034c0cc748a762
-  data.tar.gz: c0120a55ef27d303c66d64f895d664f359cf0edc568fe7ddef6515e62079e99a3767b93ef1f75e83d6ca9971bec08b16fb51f34f8172d67e621045027acd3739
+  metadata.gz: a5585b7af51d706ffcbac3b88881c9b9c189dbc80e08867feea9ecef690dfd04957593504415bffde2c2022f69c1afdb0b30472f2466baa6bfc0dfad1264855d
+  data.tar.gz: b1a9aa07dfcaaf28f8d953c88f9ccc467ac199376dce674bff1b3fac7aef3a01416dd9638a40d5fd28ae23932d56e1f56b74888fdb485c4dce3dd9fa6ed579aa

data/CHANGELOG.md

@@ -1,4 +1,16 @@
+## 0.8.0 RC1
+
+* fixed rare error when calculating job identifier
+* nicer shutdown logging, indicating when shutdown process begins and ends
+* ability to run rake tasks
+* ability to run shell commands
+* automatically wrap jobs with rails reloader
+
 ## 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,24 +1,30 @@
 PATH
   remote: .
   specs:
-    ruby-clock (0.6.0)
+    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.4)
+    et-orbi (1.2.5)
       tzinfo
-    fugit (1.5.0)
+    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.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)
 
@@ -30,4 +36,4 @@ DEPENDENCIES
   ruby-clock!
 
 BUNDLED WITH
-   2.1.4
+   2.2.23

data/README.md

@@ -71,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:
@@ -122,6 +128,46 @@ 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
@@ -133,12 +179,12 @@ 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 |variable|
+schedule.every '1 second', name: 'my job' do
   Foo.bar
 end
 # => my job
 
-schedule.every '1 day' do |variable|
+schedule.every '1 day' do
   daily_things = Foo.setup_daily
   daily_things.process
   # TODO: figure out best time of day
@@ -146,7 +192,7 @@ end
 # => daily_things.process
 
 # n.b. ruby-clock isn't yet smart enough to remove trailing comments
-schedule.every '1 week' do |variable|
+schedule.every '1 week' do
   weekly_things = Foo.setup_weekly
   weekly_things.process # does this work???!1~
 end

data/exe/clock

@@ -8,9 +8,11 @@ class Rufus::Scheduler::Job
     @identifier ||= begin
       name || handler.source.split("\n").reject(&:empty?).grep_v(/#.*/)[-2].strip
     rescue
-      source_location.join('-')
-    rescue
-      'error-calculating-job-identifier'
+      begin
+        source_location.join('-')
+      rescue
+        'error-calculating-job-identifier'
+      end
     end
   end
 end
@@ -18,7 +20,20 @@ end
 include RubyClock
 
 listen_to_signals
+prepare_rake
+schedule.pause
 
 load ARGV[0] || 'Clockfile'
 
+if ::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.7.0"
+  VERSION = "0.8.0.rc1"
 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: ENV['RUBY_CLOCK_SHUTDOWN_WAIT_SECONDS']&.to_i || 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

@@ -31,4 +31,6 @@ 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.7.0
+  version: 0.8.0.rc1
 platform: ruby
 authors:
 - John Bachir
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-08 00:00:00.000000000 Z
+date: 2021-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
@@ -38,7 +38,35 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+- !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
 executables:
@@ -58,6 +86,7 @@ files:
 - exe/clock
 - lib/ruby-clock.rb
 - lib/ruby-clock/version.rb
+- release.md
 - ruby-clock.gemspec
 homepage: https://github.com/jjb/ruby-clock
 licenses:
@@ -65,7 +94,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
@@ -76,12 +105,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: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.23
-signing_key:
+signing_key: 
 specification_version: 4
 summary: A "clock" process for invoking ruby code within a persistent runtime
 test_files: []