zhong 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbe00de7a1e1f5b55ac8a34b0e1d0a13ac372217
-  data.tar.gz: d05ad774898928e6748e59c0d274485414c9f529
+  metadata.gz: 902b025d6f1afe4edfa0f2cb6f6639bc0ff558ff
+  data.tar.gz: 939fedf9667d0dc26f7fb1adcddedd5cbe76deba
 SHA512:
-  metadata.gz: 00ccb9f93043e62773fde4d74f1e9c045a1b18ee18ab7ce1a49137cb64b6b9d8ead36127ef4052d2c3fe5b538680d81000daef5ea44e3be2e8134f4fe5d39f59
-  data.tar.gz: 663b373808754bf6c22c78174aa853bbab0d198068bd6aa1b46f586d53ed00430efb437575d54403540c902e3c391d2f68015f8fc7f6e149a6cfa9cc1347a1af
+  metadata.gz: 16ce76fbea779cffa736f3c48f99bca3fa0ac0ba27e46261f20c41c037143317cb406715e8e866da4495dcf33a20a11830a37b6bd1b41ac9d64c39568c7e1896
+  data.tar.gz: 85abd697abfe5fa1ffd7513ae8e146f34c3360234f2685f9f89aec5224b259d086e25097614836ba90ebe8bc2347b8ea324051d87ea5e6813acc845267de96bf

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.2.0
+
+- Configuring Redis and the heartbeat key now correctly updates even after Zhong is configured initially.
+- Some cleanup in how config is stored in general.
+
 ## 0.1.9
 
 - Much more performant heartbeat checks (thanks, @sherinkurian).

data/README.md

@@ -53,12 +53,42 @@ Zhong.schedule do
     puts "#{job} ran?: #{ran}"
   end
 
+  on(:before_disable) do |job|
+    puts "#{job} is going to be disabled"
+  end
+
+  on(:after_disable) do |job|
+    puts "#{job} disabled"
+  end
+
+  on(:before_enable) do |job|
+    puts "#{job} is going to be enabled"
+  end
+
+  on(:after_enable) do |job|
+    puts "#{job} enabled"
+  end
+
   error_handler do |e, job|
     puts "dang, #{job} messed up: #{e}"
   end
 end
 ```
 
+## Web UI
+
+Zhong comes with a web application that can display jobs, their last run and
+enable/disable them.
+
+### Rails
+
+Add the following to your config/routes.rb:
+
+```ruby
+require 'zhong/web'
+mount Zhong::Web, at: "zhong"
+```
+
 ## History
 
 View the [changelog](https://github.com/nickelser/zhong/blob/master/CHANGELOG.md).

data/lib/zhong/job.rb

@@ -1,12 +1,16 @@
 module Zhong
   class Job
-    attr_reader :name, :category, :last_ran, :logger, :at, :every, :id
+    extend Forwardable
+    def_delegators Zhong, :redis, :tz, :logger, :heartbeat_key
 
-    def initialize(job_name, config = {}, &block)
+    attr_reader :name, :category, :last_ran, :at, :every, :id
+
+    def initialize(job_name, config = {}, callbacks = {}, &block)
       @name = job_name
       @category = config[:category]
       @logger = config[:logger]
       @config = config
+      @callbacks = callbacks
 
       @at = config[:at] ? At.parse(config[:at], grace: config.fetch(:grace, 15.minutes)) : nil
       @every = config[:every] ? Every.parse(config[:every]) : nil
@@ -15,8 +19,6 @@ module Zhong
 
       @block = block
 
-      @redis = config[:redis]
-      @tz = config[:tz]
       @if = config[:if]
       @long_running_timeout = config[:long_running_timeout]
       @running = false
@@ -88,20 +90,24 @@ module Zhong
     end
 
     def refresh_last_ran
-      last_ran_val = @redis.get(last_ran_key)
+      last_ran_val = redis.get(last_ran_key)
       @last_ran = last_ran_val ? Time.at(last_ran_val.to_i) : nil
     end
 
     def disable
-      @redis.set(disabled_key, "true")
+      fire_callbacks(:before_disable, self)
+      redis.set(disabled_key, "true")
+      fire_callbacks(:after_disable, self)
     end
 
     def enable
-      @redis.del(disabled_key)
+      fire_callbacks(:before_enable, self)
+      redis.del(disabled_key)
+      fire_callbacks(:after_enable, self)
     end
 
     def disabled?
-      !@redis.get(disabled_key).nil?
+      !redis.get(disabled_key).nil?
     end
 
     def to_s
@@ -115,7 +121,7 @@ module Zhong
     end
 
     def clear
-      @redis.del(last_ran_key)
+      redis.del(last_ran_key)
     end
 
     def last_ran_key
@@ -136,10 +142,16 @@ module Zhong
 
     private
 
+    def fire_callbacks(event, *args)
+      @callbacks[event].to_a.map do |callback|
+        callback.call(*args)
+      end.compact.all? # do not skip on nils
+    end
+
     # if the @at value is changed across runs, the last_run becomes invalid
     # so clear it
     def clear_last_ran_if_at_changed
-      previous_at_msgpack = @redis.get(desired_at_key)
+      previous_at_msgpack = redis.get(desired_at_key)
 
       if previous_at_msgpack
         previous_at = At.deserialize(previous_at_msgpack)
@@ -150,7 +162,7 @@ module Zhong
         end
       end
 
-      @redis.set(desired_at_key, @at.serialize)
+      redis.set(desired_at_key, @at.serialize)
     end
 
     def run_every?(time)
@@ -167,7 +179,7 @@ module Zhong
 
     def ran!(time)
       @last_ran = time
-      @redis.set(last_ran_key, @last_ran.to_i)
+      redis.set(last_ran_key, @last_ran.to_i)
     end
 
     def redis_lock

data/lib/zhong/scheduler.rb

@@ -1,13 +1,14 @@
 module Zhong
   class Scheduler
-    attr_reader :config, :redis, :jobs, :logger
+    extend Forwardable
+
+    def_delegators Zhong, :redis, :tz, :logger, :heartbeat_key
+    attr_reader :jobs
 
     DEFAULT_CONFIG = {
       timeout: 0.5,
       grace: 15.minutes,
-      long_running_timeout: 5.minutes,
-      tz: nil,
-      heartbeat_key: "zhong:heartbeat",
+      long_running_timeout: 5.minutes
     }.freeze
 
     def initialize(config = {})
@@ -15,9 +16,6 @@ module Zhong
       @callbacks = {}
       @config = DEFAULT_CONFIG.merge(config)
 
-      @logger = @config[:logger]
-      @redis = @config[:redis]
-      @tz = @config[:tz]
       @category = nil
       @error_handler = nil
       @running = false
@@ -44,7 +42,7 @@ module Zhong
     def every(period, name, opts = {}, &block)
       raise "must specify a period for #{name} (#{caller.first})" unless period
 
-      job = Job.new(name, opts.merge(@config).merge(every: period, category: @category), &block)
+      job = Job.new(name, opts.merge(@config).merge(every: period, category: @category), @callbacks, &block)
 
       raise "duplicate job #{job}" if jobs.key?(job.id)
 
@@ -57,7 +55,10 @@ module Zhong
     end
 
     def on(event, &block)
-      raise "unknown callback #{event}" unless [:before_tick, :after_tick, :before_run, :after_run].include?(event.to_sym)
+      unless [:before_tick, :after_tick, :before_run, :after_run, :before_disable,
+              :after_disable, :before_enable, :after_enable].include?(event.to_sym)
+        raise "unknown callback #{event}"
+      end
       (@callbacks[event.to_sym] ||= []) << block
     end
 
@@ -112,9 +113,9 @@ module Zhong
     end
 
     def redis_time
-      s, ms = @redis.time # returns [seconds since epoch, microseconds]
+      s, ms = redis.time # returns [seconds since epoch, microseconds]
       now = Time.at(s + ms / (10**6))
-      @tz ? now.in_time_zone(@tz) : now
+      tz ? now.in_time_zone(tz) : now
     end
 
     private
@@ -144,7 +145,7 @@ module Zhong
     end
 
     def heartbeat(time)
-      @redis.hset(config[:heartbeat_key], heartbeat_field, time.to_i)
+      redis.hset(heartbeat_key, heartbeat_field, time.to_i)
     end
 
     def heartbeat_field

data/lib/zhong/version.rb

@@ -1,3 +1,3 @@
 module Zhong
-  VERSION = "0.1.9".freeze
+  VERSION = "0.2.0".freeze
 end

data/test/test_library.rb

@@ -24,7 +24,27 @@ class TestLibrary < Minitest::Test
     assert_equal true, Zhong.any_running?
     assert_in_delta Zhong.redis_time.to_f, Time.now.to_f, 1
     assert_in_delta Zhong.redis_time.to_f, Zhong.latest_heartbeat.to_f, 1
+    refute_empty Zhong.all_heartbeats
     Zhong.stop
     t.join
   end
+
+  def test_redis_change
+    Zhong.schedule { nil }
+    t = Thread.new { Zhong.start }
+    sleep(1)
+    assert_equal true, Zhong.any_running?
+    test_redis = Zhong.redis
+    Zhong.stop
+    t.join
+    Zhong.redis = Redis.new(url: "redis://localhost/15")
+    refute Zhong.any_running?(5.seconds)
+    t = Thread.new { Zhong.start }
+    sleep(1)
+    assert_equal true, Zhong.any_running?
+    assert_in_delta Zhong.redis_time.to_f, Time.now.to_f, 1
+    Zhong.stop
+    Zhong.redis = test_redis
+    t.join
+  end
 end

data/test/test_web.rb

@@ -32,8 +32,13 @@ class TestWeb < Minitest::Test
   end
 
   def test_disable_job
+    test_before_disable = 0
+    test_after_disable = 0
+
     Zhong.schedule do
       every(30.seconds, "test_disable_web_job") { nil }
+      on(:before_disable) { test_before_disable += 1 }
+      on(:after_disable) { test_after_disable += 1 }
     end
 
     job = Zhong.scheduler.find_by_name("test_disable_web_job")
@@ -48,11 +53,18 @@ class TestWeb < Minitest::Test
     assert_contains "every 30 seconds", last_response.body
     assert_contains 'name="enable"', last_response.body
     assert_equal true, job.disabled?
+    assert_equal 1, test_before_disable
+    assert_equal 1, test_after_disable
   end
 
   def test_enable_job
+    test_before_enable = 0
+    test_after_enable = 0
+
     Zhong.schedule do
       every(12.hours, "test_enable_web_job") { nil }
+      on(:before_enable) { test_before_enable += 1 }
+      on(:after_enable) { test_after_enable += 1 }
     end
 
     job = Zhong.scheduler.find_by_name("test_enable_web_job")
@@ -67,6 +79,8 @@ class TestWeb < Minitest::Test
     assert_contains "every 12 hours", last_response.body
     assert_contains 'name="disable"', last_response.body
     assert_equal false, job.disabled?
+    assert_equal 1, test_before_enable
+    assert_equal 1, test_after_enable
   end
 
   def test_heartbeat

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zhong
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Nick Elser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-08 00:00:00.000000000 Z
+date: 2016-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: suo
@@ -288,4 +288,3 @@ test_files:
 - test/test_library.rb
 - test/test_scheduler.rb
 - test/test_web.rb
-has_rdoc: