clockwork 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e720594452bfaa38dfa5531dd7b8de45423f4b3
-  data.tar.gz: f0258265ef190bccce9fb5360e733a03c38ce4ba
+  metadata.gz: 384e3245517c1613d4551a8d401f1f398a5900ee
+  data.tar.gz: 92d176c5595e3a0c2d456710bc9d527d99f12b0c
 SHA512:
-  metadata.gz: 138b331deb24d582e1da4126a8f661bec5e101b2a251068b5cd12f3da422a672bf0e6d00c3d1c6bed4d0955e536138063bb7d707e7a7cc3ac6d8c1ae84f3f2ac
-  data.tar.gz: deb399044bf8266c9f9d0d70f9aec93f01f7c092b6f931cbf73bcc13a8569f393a07243803cd1bccffe981ccc7c210058448b5249cbdd9ee15d263006f407a42
+  metadata.gz: 02583e06f9b53687229298b169c703f9be058e507ad95014286538fb5d537c9ecec57f9732903c56ae397dcb605f18ba77998d406248d23465fb34e945692233
+  data.tar.gz: d72f9f576ecf78cc7870cb317cea3a182052c0b937034e4befa7df483b9711699feb34ca835f5e1f89f2f3bd919a150b45660cf9eafa568360f71c420010c0bc

data/README.md

@@ -153,6 +153,12 @@ every(1.hour, 'reminders.send', :at => ['12:00', '18:00'])
 # send reminders at noon and evening
 ```
 
+You can specify the day of week to run:
+
+```ruby
+every(1.week, 'myjob', :at => 'Monday 16:20')
+```
+
 You can also specify a timezone (default is the local timezone):
 
 ```ruby
@@ -223,6 +229,23 @@ Clockwork.configure do |config|
 end
 ```
 
+### error_handler
+
+You can add error_handler to define your own logging or error rescue.
+
+```ruby
+Clockwork.error_handler do |error|
+  Airbrake.notify_or_ignore(error)
+end
+```
+
+Current specifications are as follows.
+
+- defining error_handler does not disable original logging
+- errors from error_handler itself do not rescued, and stop clockwork
+
+Any suggestion about these specifications is welcome.
+
 Anatomy of a clock file
 -----------------------
 
@@ -306,7 +329,7 @@ Meta
 
 Created by Adam Wiggins
 
-Inspired by [rufus-scheduler](http://rufus.rubyforge.org/rufus-scheduler/) and [resque-scheduler](http://github.com/bvandenbos/resque-scheduler)
+Inspired by [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler) and [resque-scheduler](https://github.com/bvandenbos/resque-scheduler)
 
 Design assistance from Peter van Hardenberg and Matthew Soldo
 

data/clockwork.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "clockwork"
-  s.version = "0.6.1"
+  s.version = "0.6.2"
 
   s.authors = ["Adam Wiggins", "tomykaira"]
   s.license = 'MIT'

data/lib/clockwork.rb

@@ -18,6 +18,10 @@ module Clockwork
     @@manager.handler(&block)
   end
 
+  def error_handler(&block)
+    @@manager.error_handler(&block)
+  end
+
   def on(event, options={}, &block)
     @@manager.on(event, options, &block)
   end

data/lib/clockwork/event.rb

@@ -51,6 +51,7 @@ module Clockwork
       @block.call(@job)
     rescue => e
       log_error e
+      handle_error e
     end
 
     def log_error(e)
@@ -67,5 +68,11 @@ module Clockwork
 
       msg.join("\n")
     end
+
+    def handle_error(e)
+      if handler = @manager.get_error_handler
+        handler.call(e)
+      end
+    end
   end
 end

data/lib/clockwork/manager.rb

@@ -32,6 +32,14 @@ module Clockwork
       @handler
     end
 
+    def error_handler(&block)
+      @error_handler = block
+    end
+
+    def get_error_handler
+      @error_handler
+    end
+
     def on(event, options={}, &block)
       raise "Unsupported callback #{event}" unless [:before_tick, :after_tick, :before_run, :after_run].include?(event.to_sym)
       (@callbacks[event.to_sym]||=[]) << block
@@ -99,7 +107,7 @@ module Clockwork
 
       options
     end
-    
+
     def every_with_multiple_times(period, job, options={}, &block)
       each_options = options.clone
       options[:at].each do |at|

data/test/manager_test.rb

@@ -339,4 +339,39 @@ class ManagerTest < Test::Unit::TestCase
       assert_equal 1, counter
     end
   end
+
+  describe 'error_handler' do
+    setup do
+      @errors = []
+      @manager.error_handler do |e|
+        @errors << e
+      end
+
+      # block error log
+      @string_io = StringIO.new
+      @manager.configure do |config|
+        config[:logger] = Logger.new(@string_io)
+      end
+      @manager.every(1.second, 'myjob') { raise 'test error' }
+    end
+
+    test 'registered error_handler handles error from event' do
+      @manager.tick
+      assert_equal ['test error'], @errors.map(&:message)
+    end
+
+    test 'error is notified to logger and handler' do
+      @manager.tick
+      assert @string_io.string.include?('test error')
+    end
+
+    test 'error in handler will NOT be suppressed' do
+      @manager.error_handler do |e|
+        raise e.message + ' re-raised'
+      end
+      assert_raise(RuntimeError, 'test error re-raised') do
+        @manager.tick
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clockwork
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Adam Wiggins
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-30 00:00:00.000000000 Z
+date: 2013-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo