zhong 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8e24ce8cbfc3ebd6b0574c791aef211bb0777c1
-  data.tar.gz: cd327270c61bbfb6817096ff5e2f2aee1ade850e
+  metadata.gz: 6786d80a0d2da5fc3d4605ab95a511764b96e2e6
+  data.tar.gz: 2c1f61feff58195e3e8521b7d965f0cb7ed0d616
 SHA512:
-  metadata.gz: b5955bed476e79f2b79520523724320404733986912bda9d3d6fc1396c578a935336fd2927295579f9bfe838baf2ee4d55ff953ab6a0f5f4332d3afb85ad0678
-  data.tar.gz: e8082120c278422e3d1f04660739877d4d7fba6573745c31f63df0df4116d719a424087e1d3b8ac06d863d1dd0c98ebfd3489a7e411dcebe08228a1c6fc07ec4
+  metadata.gz: 3e9b281a5edbd9a6aa9c99ecff01b24f153c886ea2bf91d4659cf92ef858da518e5d96f18ce9b7e253372dc07e8749289fddff77104e72cd61df056fa72d9028
+  data.tar.gz: e0c854e2d554048f88fa4368701c2d59e7e40dccb2d2165f43df3d9ffd679c382c485b1b2f566617a1de0dd17657aef9f2ed07d9f93bb394f6e3abcf9dbdcf85

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.1.8
+
+- Make it very clear when callbacks cause skips of ticks or runs.
+- Add logging when jobs/ticks are skipped.
+- Do not skip when callbacks return nil (only on false explicitly).
+
 ## 0.1.7
 
 - Improve test coverage.

data/README.md

@@ -34,7 +34,7 @@ Zhong.schedule do
     end
   end
 
-  # note: callbacks that return nil or false will cause event to not run
+  # note: callbacks that explicitly false will cause event to not run
   on(:before_tick) do
     puts "ding"
     true
@@ -42,7 +42,6 @@ Zhong.schedule do
 
   on(:after_tick) do
     puts "dong"
-    true
   end
 
   on(:before_run) do |job, time|

data/lib/zhong/scheduler.rb

@@ -1,6 +1,6 @@
 module Zhong
   class Scheduler
-    attr_reader :config, :redis, :jobs
+    attr_reader :config, :redis, :jobs, :logger
 
     DEFAULT_CONFIG = {
       timeout: 0.5,
@@ -61,7 +61,7 @@ module Zhong
     end
 
     def start
-      @logger.info "starting at #{redis_time}"
+      logger.info "starting at #{redis_time}"
 
       @stop = false
 
@@ -87,19 +87,22 @@ module Zhong
           heartbeat(now)
 
           break if @stop
-          sleep_until_next_second
+        else
+          logger.info "skipping tick due to a `:before_tick` callback"
         end
 
+        sleep_until_next_second
+
         break if @stop
       end
 
       @running = false
 
-      Thread.new { @logger.info "stopped" }.join
+      Thread.new { logger.info "stopped" }.join
     end
 
     def stop
-      Thread.new { @logger.error "stopping" } if @running # thread necessary due to trap context
+      Thread.new { logger.error "stopping" } if @running # thread necessary due to trap context
       @stop = true
     end
 
@@ -119,7 +122,9 @@ module Zhong
     private_constant :TRAPPED_SIGNALS
 
     def fire_callbacks(event, *args)
-      @callbacks[event].to_a.all? { |h| h.call(*args) }
+      @callbacks[event].to_a.map do |callback|
+        callback.call(*args)
+      end.compact.all? # do not skip on nils
     end
 
     def jobs_to_run(time = redis_time)
@@ -127,7 +132,10 @@ module Zhong
     end
 
     def run_job(job, time = redis_time)
-      return unless fire_callbacks(:before_run, job, time)
+      unless fire_callbacks(:before_run, job, time)
+        logger.info "skipping #{job} due to a `:before_run` callback"
+        return
+      end
 
       ran = job.run(time, error_handler)
 

data/lib/zhong/version.rb

@@ -1,3 +1,3 @@
 module Zhong
-  VERSION = "0.1.7".freeze
+  VERSION = "0.1.8".freeze
 end

data/lib/zhong/web.rb

@@ -10,19 +10,21 @@ module Zhong
     enable :sessions
     use ::Rack::Protection, use: :authenticity_token unless ENV["RACK_ENV"] == "test"
 
-    # :nocov:
     if ENV["ZHONG_WEB_USERNAME"] && ENV["ZHONG_WEB_PASSWORD"]
+      # :nocov:
       use Rack::Auth::Basic, "Sorry." do |username, password|
         username == ENV["ZHONG_WEB_USERNAME"] and password == ENV["ZHONG_WEB_PASSWORD"]
       end
+      # :nocov:
     end
 
     if ENV["RACK_ENV"] == "development"
+      # :nocov:
       before do
         STDERR.puts "[params] #{params}" unless params.empty?
       end
+      # :nocov:
     end
-    # :nocov:
 
     set :root, File.expand_path(File.dirname(__FILE__) + "/../../web")
     set :public_folder, proc { "#{root}/assets" }
@@ -71,12 +73,12 @@ if defined?(::ActionDispatch::Request::Session) && !::ActionDispatch::Request::S
   # mperham/sidekiq#2460
   # Rack apps can't reuse the Rails session store without
   # this monkeypatch
-  # :nocov:
   class ActionDispatch::Request::Session
+    # :nocov:
     def each(&block)
       hash = self.to_hash
       hash.each(&block)
     end
+    # :nocov:
   end
-  # :nocov:
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zhong
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Nick Elser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-01 00:00:00.000000000 Z
+date: 2016-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: suo