zhong 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdb0c3e763f67f1b0a6401a13cd9090fa3a7a45a
-  data.tar.gz: 77c008fecedfabc3994d95a621a0c2dd7e0fa786
+  metadata.gz: 2cf0507becd43b3bd5e220ca807c539eccdc955d
+  data.tar.gz: 46ae372e6e8b04b970e19ce1d4768552b4dfe044
 SHA512:
-  metadata.gz: fccf0555dc69c9ef3cfffa60050e0af92fada4d294047bcdac7d36e95e1a98528f4a1f7533da179c4203e5db39db623df72f5be9459c61fb9cb9f84288ec6d7a
-  data.tar.gz: d9063ca1237fd65f9abbabe979788483174bda374670da24050b4bed064d90ab2cbbe6882ca89590c9e2b3690ccc69c50eb933ab34a239cdd326ae718f31172f
+  metadata.gz: 8c6c347eef8f5520a0119a676a1fb11f322e6a5e947cada7606d50f38030a1d9728bdedb609d95020be7fe3543008ab6986096691c3f8d364a5d080977a5e203
+  data.tar.gz: 428004dbde08236b4b4018e00b15dadd955e9463b54c3ce735a00b59d74c5b5789072da7e385f3767dc086d024f44fdcc891e5a42e963e412df737c1e68f32ca

data/.gitignore

@@ -13,6 +13,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+zhong.rb
 test/tmp
 test/version_tmp
 tmp

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.1
+
+- Handle multiple ats (at: ["mon 8:00, tues 9:30"]).
+- Job callbacks (:before_tick, :after_tick, etc).
+
 ## 0.1.0
 
 - First release.

data/README.md

@@ -1,6 +1,8 @@
 # Zhong
 
-Useful, reliable distributed cron.
+Useful, reliable distributed cron. Tired of your cron-like scheduler running key jobs twice? Would you like to be able to run your cron server on multiple machines and have it "just work"? Have we got the gem for you.
+
+Zhong uses Redis to acquire exclusive locks on jobs, as well as recording when they last ran. This means that you can rest easy at night, knowing that your customers are getting their monthly Goat Fancy magazine subscriptions and you are rolling around in your piles of money without a care in the world.
 
 # Installation
 
@@ -15,16 +17,28 @@ gem 'zhong'
 ```ruby
 r = Redis.new
 
-Zhong.schedule(redis: r) do
-  category "stuff" do
-    every(5.seconds, "foo") { puts "foo" }
-    every(1.week, "baz", at: "mon 22:45") { puts "baz" }
+Zhong.schedule(redis: r) do |s|
+  s.category "stuff" do
+    s.every(5.seconds, "foo") { puts "foo" }
+    s.every(1.week, "baz", at: ["mon 22:45", "wed 23:13"]) { puts "baz" }
+  end
+
+  s.category "clutter" do
+    s.every(1.second, "compute", if: -> (t) { t.wday == 3 && rand < 0.5 }) { puts "something happened on wednesday" }
   end
 
-  category "clutter" do
-    every(1.second, "compute", if: -> (t) { rand < 0.5 }) { puts "something happened" }
+  # note: callbacks that return nil or false will cause event to not run
+  s.on(:before_tick) do
+    puts "ding"
+    true
+  end
+
+  s.on(:after_tick) do
+    puts "dong"
+    true
   end
 end
+
 ```
 
 ## TODO

data/bin/zhong

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+STDERR.sync = STDOUT.sync = true
+
+require "bundler/setup"
+require "zhong"
+
+usage = "zhong <zhong.rb>"
+file = ARGV.shift || abort(usage)
+
+file = "./#{file}" unless file.match(/^[\/.]/)
+
+require file
+
+Zhong.start

data/lib/zhong.rb

@@ -5,6 +5,8 @@ require "active_support/time"
 
 require "zhong/version"
 
+require "zhong/util"
+
 require "zhong/at"
 require "zhong/every"
 
@@ -13,10 +15,19 @@ require "zhong/scheduler"
 
 module Zhong
   class << self
-    def schedule(**opts, &block)
-      @scheduler = Scheduler.new(opts)
-      @scheduler.instance_eval(&block)
-      @scheduler.start
+    def schedule(**opts)
+      @scheduler = Scheduler.new(opts).tap do |s|
+        yield(s)
+      end
+    end
+
+    def start
+      fail "You must run `Zhong.schedule` first" unless scheduler
+      scheduler.start
+    end
+
+    def scheduler
+      @scheduler
     end
   end
 end

data/lib/zhong/at.rb

@@ -43,6 +43,11 @@ module Zhong
     def self.parse(at, grace: 0)
       return unless at
 
+      # TODO: refactor this mess
+      if at.respond_to?(:each)
+        return MultiAt.new(at.map { |a| parse(a, grace: grace) })
+      end
+
       case at
       when /\A([[:alpha:]]+)\s+(.*)\z/
         wday = WDAYS[$1]
@@ -67,4 +72,16 @@ module Zhong
       throw FailedToParse, at
     end
   end
+
+  class MultiAt
+    attr_accessor :ats
+
+    def initialize(ats = [])
+      @ats = ats
+    end
+
+    def next_at(time = Time.now)
+      ats.map { |at| at.next_at(time) }.min
+    end
+  end
 end

data/lib/zhong/job.rb

@@ -2,23 +2,26 @@ module Zhong
   class Job
     attr_reader :name, :category
 
-    def initialize(scheduler:, name:, every: nil, at: nil, only_if: nil, category: nil, &block)
+    def initialize(name, config = {}, &block)
       @name = name
-      @category = category
+      @category = config[:category]
 
-      @at = At.parse(at, grace: scheduler.config[:grace])
-      @every = Every.parse(every)
+      @at = At.parse(config[:at], grace: config.fetch(:grace, 15.minutes))
+      @every = Every.parse(config[:every])
 
       if @at && !@every
         @logger.error "warning: #{self} has `at` but no `every`; could run far more often than expected!"
       end
 
+      fail "must specific either `at` or `every` for a job" unless @at || @every
+
       @block = block
-      @redis = scheduler.config[:redis]
-      @logger = scheduler.config[:logger]
-      @tz = scheduler.config[:tz]
-      @if = only_if
-      @lock = Suo::Client::Redis.new(lock_key, client: @redis, stale_lock_expiration: scheduler.config[:long_running_timeout])
+
+      @redis = config[:redis]
+      @logger = config[:logger]
+      @tz = config[:tz]
+      @if = config[:if]
+      @lock = Suo::Client::Redis.new(lock_key, client: @redis, stale_lock_expiration: config[:long_running_timeout])
       @timeout = 5
 
       refresh_last_ran
@@ -36,6 +39,8 @@ module Zhong
         return
       end
 
+      @thread = nil
+
       ran_set = @lock.lock do
         refresh_last_ran
 
@@ -85,7 +90,13 @@ module Zhong
     end
 
     def to_s
-      [@category, @name].compact.join(".")
+      [@category, @name].compact.join(".").freeze
+    end
+
+    def next_at
+      every_time = @every.next_at(@last_ran) if @last_ran && @every
+      at_time = @at.next_at(Time.now) if @at
+      [every_time, at_time, Time.now].compact.max || "now"
     end
 
     private

data/lib/zhong/scheduler.rb

@@ -2,38 +2,69 @@ module Zhong
   class Scheduler
     attr_reader :config, :redis, :jobs
 
+    DEFAULT_CONFIG = {
+      timeout: 0.5,
+      grace: 15.minutes,
+      long_running_timeout: 5.minutes
+    }.freeze
+
+    TRAPPED_SIGNALS = %w(QUIT INT TERM).freeze
+
     def initialize(config = {})
       @jobs = {}
-      @config = {timeout: 0.5, grace: 15.minutes, long_running_timeout: 5.minutes}.merge(config)
-      @logger = @config[:logger] ||= self.class.default_logger
-      @redis = @config[:redis] ||= Redis.new
+      @callbacks = {}
+      @config = DEFAULT_CONFIG.merge(config)
+      @logger = @config[:logger] ||= Util.default_logger
+      @redis = @config[:redis] ||= Redis.new(ENV["REDIS_URL"])
     end
 
     def category(name)
-      @category = name
+      fail "cannot nest categories: #{name} would be nested in #{@category}" if @category
 
-      yield
+      @category = name.to_s
+
+      yield(self)
 
       @category = nil
     end
 
     def every(period, name, opts = {}, &block)
-      add(Job.new(scheduler: self, name: name, every: period, at: opts[:at], only_if: opts[:if], category: @category, &block))
+      job = Job.new(name, opts.merge(@config).merge(every: period, category: @category), &block)
+      add(job)
+    end
+
+    def error_handler(&block)
+      @error_handler = block if block_given?
+      @error_handler
+    end
+
+    def on(event, &block)
+      fail "Unsupported callback #{event}" unless [:before_tick, :after_tick, :before_run, :after_run].include?(event.to_sym)
+      (@callbacks[event.to_sym] ||= []) << block
     end
 
     def start
-      %w(QUIT INT TERM).each do |sig|
+      TRAPPED_SIGNALS.each do |sig|
         Signal.trap(sig) { stop }
       end
 
       @logger.info "starting at #{redis_time}"
 
       loop do
-        now = redis_time
+        if fire_callbacks(:before_tick)
+          now = redis_time
 
-        jobs.each { |_, job| job.run(now) }
+          jobs.each do |_, job|
+            if fire_callbacks(:before_run, job, now)
+              job.run(now)
+              fire_callbacks(:after_run, job, now)
+            end
+          end
 
-        sleep(interval)
+          fire_callbacks(:after_tick)
+
+          sleep(interval)
+        end
 
         break if @stop
       end
@@ -46,6 +77,10 @@ module Zhong
       Thread.new { @logger.info "stopped" }
     end
 
+    def fire_callbacks(event, *args)
+      @callbacks[event].to_a.all? { |h| h.call(*args) }
+    end
+
     private
 
     def add(job)
@@ -66,11 +101,5 @@ module Zhong
       now = Time.at(s + ms / (10**6))
       config[:tz] ? now.in_time_zone(config[:tz]) : now
     end
-
-    def self.default_logger
-      Logger.new(STDOUT).tap do |logger|
-        logger.formatter = -> (_, datetime, _, msg) { "#{datetime}: #{msg}\n" }
-      end
-    end
   end
 end

data/lib/zhong/util.rb

@@ -0,0 +1,11 @@
+module Zhong
+  module Util
+    class << self
+      def default_logger
+        Logger.new(STDOUT).tap do |logger|
+          logger.formatter = -> (_, datetime, _, msg) { "#{datetime}: #{msg}\n" }
+        end
+      end
+    end
+  end
+end

data/lib/zhong/version.rb

@@ -1,3 +1,3 @@
 module Zhong
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zhong
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nick Elser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-05 00:00:00.000000000 Z
+date: 2015-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: suo
@@ -128,6 +128,7 @@ email:
 executables:
 - console
 - setup
+- zhong
 extensions: []
 extra_rdoc_files: []
 files:
@@ -141,11 +142,13 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bin/zhong
 - lib/zhong.rb
 - lib/zhong/at.rb
 - lib/zhong/every.rb
 - lib/zhong/job.rb
 - lib/zhong/scheduler.rb
+- lib/zhong/util.rb
 - lib/zhong/version.rb
 - test/minitest_helper.rb
 - test/zhong_test.rb