cron-table 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae408479bf5161e8a60f21fd10758b7bc9790f2e47eb13517127f78ec09d9174
+  data.tar.gz: 70787c17ee8e536bb73c8226162765e5c7bc6a3b888cc6c3686df83f676004cc
+SHA512:
+  metadata.gz: 82b82aa4118fefa72c3896bb3850e281b8987205ecee857a5266c6674c81613ada788f3090b696e15a15761641cc2f471e7c96bafe4d9547fe5d722d8d58e497
+  data.tar.gz: fe33d54efd7eb2036125202dada55394624a81c17d461d512cda2693cedd4c9f943228dbae0b783ac959b474fec9bfc0298d449df9d7e2d66d99581ac0c86e86

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 TODO: Write your name
+
+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,15 @@
+# CronTable
+Basic cron-like system to schedule jobs
+
+## Setup
+1. Add `cron-table` gem
+2. Run `rails app:cron_table:install:migrations`
+3. Run `rails db:migrate` to apply migrations
+
+## Usage
+1. Add `include CronTable::Schedule` to the job
+2. Define cron schedule using `crontable(every: <interval>)`
+3. Use block if cron requires params, eg `crontable(every: 1.day) { perform_later(Time.now) }`
+
+## 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,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/cron/table/application_controller.rb

@@ -0,0 +1,6 @@
+module Cron
+  module Table
+    class ApplicationController < ActionController::Base
+    end
+  end
+end

data/app/models/cron_table/application_record.rb

@@ -0,0 +1,5 @@
+module CronTable
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/cron_table/item.rb

@@ -0,0 +1,5 @@
+module CronTable
+  class Item < ApplicationRecord
+    self.table_name = "cron_table"
+  end
+end

data/app/services/cron_table/server.rb

@@ -0,0 +1,67 @@
+class CronTable::Server
+  SLEEP = 1.second..1.day
+  SLEEP_IDLE = 1.hour
+
+  def initialize
+  end
+
+  def sync!
+    crons = CronTable.all.clone
+    deleted = []
+    CronTable::Item.transaction do
+      CronTable::Item.lock.all.each do |cron|
+        if definition = crons.delete(cron.key)
+          cron.update(next_run_at: definition.next_run_at(Time.now)) if cron.next_run_at.nil?
+        elsif cron.next_run_at.present?
+          deleted << cron.key
+        end
+      end
+      CronTable::Item.where(key: deleted).update(next_run_at: nil)
+      crons.each do |key, definition|
+        CronTable::Item.create(key: key, next_run_at: definition.next_run_at(Time.now))
+      end
+    end
+  end
+
+  def run!
+    @exit = false
+    next_run_at = CronTable::Item.minimum(:next_run_at) || SLEEP_IDLE.from_now
+    interruptible_sleep(next_run_at.to_f - Time.now.to_f)
+
+    CronTable::Item.lock.where(next_run_at: ..Time.now).each do |cron|
+      process(cron)
+    end
+  end
+
+  def exit!
+    @exit = true
+    interrupt!
+  end
+
+  def exit?
+    @exit.present?
+  end
+
+  private
+
+  def process(cron)
+    Rails.application.reloader.wrap do
+      definition = CronTable.all.fetch(cron.key)
+      definition.call
+
+      cron.update(last_run_at: Time.now, next_run_at: definition.next_run_at(Time.now))
+    end
+  rescue => e
+    cron.update(next_run_at: nil)
+    Rails.error.report(e, handled: true, severity: :error, context: { cron: cron.id })
+  end
+
+  def interruptible_sleep(seconds)
+    @sleep, @interrupt = IO.pipe
+    IO.select([@sleep], nil, nil, seconds.to_i.clamp(SLEEP))
+  end
+
+  def interrupt!
+    @interrupt&.close
+  end
+end

data/app/views/layouts/cron-table/application.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Cron table</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+CronTable::Engine.routes.draw do
+end

data/db/migrate/20230723000000_create_cron_table.rb

@@ -0,0 +1,11 @@
+class CreateCronTable < ActiveRecord::Migration[7.0]
+  def change
+    create_table :cron_table do |t|
+      t.string :key, null: false, unique: true
+
+      t.datetime :next_run_at, index: true
+      t.datetime :last_run_at
+      t.datetime :created_at, null: false
+    end
+  end
+end

data/lib/cron-table/definition.rb

@@ -0,0 +1,9 @@
+module CronTable
+  class Definition < Struct.new(:key, :every, :block, keyword_init: true)
+    delegate :call, to: :block
+
+    def next_run_at(now)
+      now + every
+    end
+  end
+end

data/lib/cron-table/engine.rb

@@ -0,0 +1,13 @@
+module CronTable
+  class Engine < ::Rails::Engine
+    isolate_namespace CronTable
+
+    server do
+      Thread.new do
+        cron = CronTable::Server.new
+        cron.sync!
+        cron.run until true
+      end if CronTable.attach_to_server
+    end
+  end
+end

data/lib/cron-table/schedule.rb

@@ -0,0 +1,36 @@
+require "active_support/all"
+
+module CronTable
+  module Schedule
+    class DuplicateKeyError < ArgumentError
+      def initialize(key)
+        @key = key
+      end
+
+      def message = "There can be only one crontable entry with key `#{@key}`. Use `crontable(key: '<other unique name>')` to select a different key"
+    end
+
+    class MissingBlockError < ArgumentError
+      def message = "Provide a block to `crontable(..) { }` with code to execute"
+    end
+
+    extend ActiveSupport::Concern
+
+    included do |_base|
+      singleton_class.prepend(PrependedClassMethods)
+    end
+
+    module PrependedClassMethods
+      def crontable(every:, key: self.name, &block)
+        raise DuplicateKeyError.new(key) if CronTable.all.key? key
+
+        block ||= -> { self.perform_later } if self.respond_to?(:perform_later)
+        raise MissingBlockError if block.nil?
+
+        CronTable.all[key] = Definition.new(key:, every:, block:)
+
+        self
+      end
+    end
+  end
+end

data/lib/cron-table/version.rb

@@ -0,0 +1,3 @@
+module CronTable
+  VERSION = "0.2"
+end

data/lib/cron-table.rb

@@ -0,0 +1,23 @@
+require "cron-table/version"
+require "cron-table/engine"
+require "cron-table/definition"
+require "cron-table/schedule"
+
+module CronTable
+  mattr_accessor :attach_to_server, default: Rails.env.production?
+
+  mattr_accessor :preload_dirs, default: ["app/jobs"]
+
+  @@all = nil
+  def self.all
+    if @@all.nil?
+      @@all = {}
+
+      CronTable.preload_dirs.each do |dir|
+        Rails.autoloaders.main.eager_load_dir(Rails.root.join(dir))
+      end if CronTable.preload_dirs
+    end
+
+    @@all
+  end
+end

data/lib/tasks/cron_table_tasks.rake

@@ -0,0 +1,12 @@
+namespace :cron_table do
+  desc "Run cron_table scheduler"
+  task run: :environment do
+    cron = CronTable::Server.new
+    cron.sync!
+
+    Signal.trap("INT") { cron.exit! }
+    Signal.trap("TERM") { cron.exit! }
+
+    cron.run! until cron.exit?
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: cron-table
+version: !ruby/object:Gem::Version
+  version: '0.2'
+platform: ruby
+authors:
+- twratajczak
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rufo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: Simple system to schedule recurring jobs for Rails
+email:
+- twratajczak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/cron/table/application_controller.rb
+- app/models/cron_table/application_record.rb
+- app/models/cron_table/item.rb
+- app/services/cron_table/server.rb
+- app/views/layouts/cron-table/application.html.erb
+- config/routes.rb
+- db/migrate/20230723000000_create_cron_table.rb
+- lib/cron-table.rb
+- lib/cron-table/definition.rb
+- lib/cron-table/engine.rb
+- lib/cron-table/schedule.rb
+- lib/cron-table/version.rb
+- lib/tasks/cron_table_tasks.rake
+homepage: https://github.com/cron-table/cron-table
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/cron-table/cron-table
+  source_code_uri: https://github.com/cron-table/cron-table
+  changelog_uri: https://github.com/cron-table/cron-table/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Basic cron-like scheduling system for Rails
+test_files: []