ruby-clock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ba2d9d1626f38c8027978a5528cfd6697e58d754f68c3d12988e2cb4a0bca5ba
+  data.tar.gz: 07e9f670929519445fb9133af33bdd16e6a1f4188469c6f62a7c7bd8157ecce4
+SHA512:
+  metadata.gz: b684d6ed9b2621e444db1fb9fc66249f31723d972573e7aadde4a38e568c3517dc411b6d07c6c10d4d6bda6580b6cd525870bd157980364d91502bc0601bce2f
+  data.tar.gz: fea438780102ed99f7db1bae99af487435fc0b89e6926a131e65b874a7efdc424bc53024386866612e95faa76f51880dee1582adc5277e8d79fc1eb9f7932b79

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,13 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 John Bachir
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+# ruby-clock
+
+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.
+
+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
+[does not aim to be a standalone process or a cron replacement](https://github.com/jmettraux/rufus-scheduler/issues/307),
+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).
+In both cases, the clock will stop running jobs and give existing jobs 29 seconds
+to stop before killing them.
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+gem 'ruby-clock'
+
+# ruby-clock currently depends on rufus-scheduler master
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+gem 'rufus-scheduler', github: 'jmettraux/rufus-scheduler'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ruby-clock
+
+## Usage
+
+Write a file with your scheduled jobs in it, named Clockfile. The DSL and capabilities
+are the same as those of [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler/).
+Read the rufus-scheduler documentation to see what you can do.
+
+```ruby
+schedule.every('5 minutes') do
+  UserDataReports.generate
+end
+
+# do something every day, five minutes after midnight
+scheduler.cron '5 0 * * *' do
+  DailyActivitySummary.generate_and_send
+end
+```
+
+To start your clock process:
+
+    bundle exec clock
+
+### Rails
+
+To run your clock process in your app's environment:
+
+    bundle exec rails runner clock
+
+### Non-Rails
+
+Require your app's code at the top of Clockfile:
+
+```ruby
+require_relative './lib/app.rb'
+schedule.every('5 minutes') do
+...
+```
+
+### Heroku and other PaaS's
+
+Add this line to your Procfile
+
+```
+clock: bundle exec rails runer clock
+```
+
+## More Config and Capabilities
+
+### Error Handling
+
+todo
+
+### Callbacks
+
+todo
+
+### rufus-scheduler Options
+
+All rufus-scheduler options are set to defaults. The `schedule` variable
+Available in your Clockfile is and instance of `Rufus::Scheduler`,
+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!
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruby_clock"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/clock

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'ruby-clock'
+include RubyClock
+
+listen_to_signals
+
+load 'Clockfile'
+
+run_jobs

data/lib/ruby-clock.rb

@@ -0,0 +1,23 @@
+require "ruby-clock/version"
+require 'rufus-scheduler'
+
+module RubyClock
+  def shutdown
+    puts "Shutting down 🐈️ 👋"
+    puts Rufus::Scheduler.singleton.shutdown(wait: 29)
+    exit
+  end
+
+  def listen_to_signals
+    Signal.trap('INT') { shutdown }
+    Signal.trap('TERM') { shutdown }
+  end
+
+  def schedule
+    Rufus::Scheduler.singleton
+  end
+
+  def run_jobs
+    Rufus::Scheduler.singleton.join
+  end
+end

data/lib/ruby-clock/version.rb

@@ -0,0 +1,3 @@
+module RubyClock
+  VERSION = "0.1.0"
+end

data/ruby-clock.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/ruby-clock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-clock"
+  spec.version       = RubyClock::VERSION
+  spec.authors       = ["John Bachir"]
+  spec.email         = ["j@jjb.cc"]
+
+  spec.summary       = 'A "clock" process for invoking ruby code within a persistent runtime'
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/jjb/ruby-clock"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jjb/ruby-clock"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+
+  # todo: make this not depend on git? which wasted a lot of debugging time
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # spec.add_dependency "rufus-scheduler", '~> 3.7.0'
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: ruby-clock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Bachir
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-30 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- j@jjb.cc
+executables:
+- clock
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/clock
+- lib/ruby-clock.rb
+- lib/ruby-clock/version.rb
+- ruby-clock.gemspec
+homepage: https://github.com/jjb/ruby-clock
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jjb/ruby-clock
+  source_code_uri: https://github.com/jjb/ruby-clock
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A "clock" process for invoking ruby code within a persistent runtime
+test_files: []