clockwork 0.5.0 → 0.5.1

data/README.md

@@ -1,4 +1,4 @@
-Clockwork - a clock process to replace cron
+Clockwork - a clock process to replace cron [![Build Status](https://secure.travis-ci.org/tomykaira/clockwork.png?branch=master)](http://travis-ci.org/tomykaira/clockwork)
 ===========================================
 
 Cron is non-ideal for running scheduled application tasks, especially in an app
@@ -149,6 +149,12 @@ This argument cannot be omitted.  Please use _ as placeholder if not needed.
     Clockwork.every(1.second, 'myjob', :if => lambda { |_| true })
 
 
+### :thread
+
+A handler with `:thread` parameter runs in a different thread.
+
+If a job is long running or IO-intensive, this option will be useful to keep the clock precise.
+
 Configuration
 -----------------------
 
@@ -170,12 +176,18 @@ the `sleep_timeout` configuration option to set like shown below.
 This is the default timezone to use for all events.  When not specified this defaults to the local
 timezone.  Specifying :tz in the the parameters for an event overrides anything set here.
 
+### :max_threads
+
+Clockwork runs handlers in threads. If it exceeds `max_threads`, it will warn you about missing
+jobs.
+
 ### Configuration example
 
     Clockwork.configure do |config|
       config[:sleep_timeout] = 5
       config[:logger] = Logger.new(log_file_path)
       config[:tz] = 'EST'
+      config[:max_threads] = 15
     end
 
 Anatomy of a clock file
@@ -251,7 +263,7 @@ Meta
 
 Created by Adam Wiggins
 
-Inspired by [rufus-scheduler](http://rufus.rubyforge.org/rufus-scheduler/) and [resque-scehduler](http://github.com/bvandenbos/resque-scheduler)
+Inspired by [rufus-scheduler](http://rufus.rubyforge.org/rufus-scheduler/) and [resque-scheduler](http://github.com/bvandenbos/resque-scheduler)
 
 Design assistance from Peter van Hardenberg and Matthew Soldo
 

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.5.1

data/lib/clockwork.rb

@@ -69,6 +69,10 @@ module Clockwork
         end
       end
 
+      if options[:thread]
+        @thread = options[:thread]
+      end
+
       tz = options[:tz] || Clockwork.config[:tz]
       @timezone = TZInfo::Timezone.get(tz) if tz
     end
@@ -87,12 +91,33 @@ module Clockwork
       elapsed_ready and (@at.nil? or @at.ready?(t)) and (@if.nil? or @if.call(t))
     end
 
+    def thread?
+      @thread
+    end
+
+    def thread_available?
+      Thread.list.count < Clockwork.config[:max_threads]
+    end
+
     def run(t)
       t = convert_timezone(t)
       @last = t
+
+      if thread?
+        if thread_available?
+          Thread.new { execute }
+        else
+          log_error "Threads exhausted; skipping #{self}"
+        end
+      else
+        execute
+      end
+    end
+
+    def execute
       @block.call(@job)
     rescue => e
-      log_error(e)
+      log_error e
     end
 
     def log_error(e)
@@ -122,7 +147,7 @@ module Clockwork
   extend self
 
   def default_configuration
-    { :sleep_timeout => 1, :logger => Logger.new(STDOUT) }
+    { :sleep_timeout => 1, :logger => Logger.new(STDOUT), :max_threads => 10 }
   end
 
   @@configuration = default_configuration

data/test/clockwork_test.rb

@@ -152,6 +152,7 @@ class ClockworkTest < Test::Unit::TestCase
     $set_me = 0
     Clockwork.every(1.minute, 'myjob') { $set_me = 2 }
     Clockwork.tick(Time.now)
+
     assert_equal 2, $set_me
   end
 
@@ -159,7 +160,10 @@ class ClockworkTest < Test::Unit::TestCase
     Clockwork.handler { raise 'boom' }
     event = Clockwork.every(1.minute, 'myjob')
     event.expects(:log_error)
-    assert_nothing_raised { Clockwork.tick(Time.now) }
+
+    assert_nothing_raised do
+      Clockwork.tick(Time.now)
+    end
   end
 
   test "exceptions still set the last timestamp to avoid spastic error loops" do
@@ -174,15 +178,18 @@ class ClockworkTest < Test::Unit::TestCase
     Clockwork.configure do |config|
       config[:sleep_timeout] = 200
       config[:logger] = "A Logger"
+      config[:max_threads] = 10
     end
 
     assert_equal 200, Clockwork.config[:sleep_timeout]
     assert_equal "A Logger", Clockwork.config[:logger]
+    assert_equal 10, Clockwork.config[:max_threads]
   end
 
   test "configuration should have reasonable defaults" do
     assert_equal 1, Clockwork.config[:sleep_timeout]
     assert Clockwork.config[:logger].is_a?(Logger)
+    assert_equal 10, Clockwork.config[:max_threads]
   end
 
   test "should be able to specify a different timezone than local" do
@@ -243,4 +250,15 @@ class ClockworkTest < Test::Unit::TestCase
     end
   end
 
+  test "should warn about missing jobs upon exhausting threads" do
+    Clockwork.configure do |config|
+      config[:max_threads] = 0
+    end
+
+    event = Clockwork.every(1.minute, 'myjob', :thread => true)
+    event.expects(:log_error).with("Threads exhausted; skipping #{event}")
+
+    Clockwork.tick(Time.now)
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clockwork
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-27 00:00:00.000000000 Z
+date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -124,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -352792223
+      hash: -423339919
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: