rufus-scheduler 1.0.11 → 1.0.12

data/CHANGELOG.txt

@@ -1,6 +1,12 @@
 
 = rufus-scheduler CHANGELOG.txt
 
+== rufus-scheduler - 1.0.12    not yet released
+
+- todo  #23257 : added :timeout parameter for cron/in/at/every
+- bug   #22546 : added note about CronLine#next_time, K Liu
+- todo  #22489 : find_jobs(tag=nil) patch by Xianhang Zhang
+
 
 == rufus-scheduler - 1.0.11    released 2008/09/03
 

data/CREDITS.txt

@@ -3,6 +3,9 @@
 
 == Feedback
 
+- Tim Uckun, :timeout concept
+- K Liu, for the note about CronLine#next_time
+- Xianhang Zhang, find_jobs(tag=nil) patch
 - Yi Wen, for lib/rufus-scheduler.rb
 - Adam Green and Rael Dornfest for the Taskr breaking issue feedback
 - Sean Liu, unschedule_every issue

data/README.txt

@@ -44,6 +44,8 @@ some examples :
        init_self_destruction_sequence()
      end
 
+     scheduler.join # join the scheduler (prevents exiting)
+
 
 For all the scheduling related information, see the Rufus::Scheduler class rdoc itself (http://rufus.rubyforge.org/rufus-scheduler/classes/Rufus/Scheduler.html) or the original OpenWFEru scheduler documentation at http://openwferu.rubyforge.org/scheduler.html
 
@@ -63,6 +65,11 @@ Apart from scheduling, There are also two interesting methods in this gem, they
     Rufus.to_time_string 7 * 24 * 3600        # => '1w'
 
 
+Something about the rufus-scheduler, threads and ActiveRecord connections :
+
+http://jmettraux.wordpress.com/2008/09/14/the-scheduler-and-the-active_record/
+
+
 == dependencies
 
 None.

data/lib/rufus/cronline.rb

@@ -123,6 +123,25 @@ module Rufus
     #
     # This is raw, 3 secs to iterate over 1 year on my macbook :( brutal.
     #
+    # This method accepts an optional Time parameter. It's the starting point
+    # for the 'search'. By default, it's Time.now
+    #
+    # Note that the time instance returned will be in the same time zone that
+    # the given start point Time (thus a result in the local time zone will
+    # be passed if no start time is specified (search start time set to
+    # Time.now))
+    #
+    #   >> Rufus::CronLine.new('30 7 * * *').next_time( Time.mktime(2008,10,24,7,29) )
+    #   => Fri Oct 24 07:30:00 -0500 2008
+    #
+    #   >> Rufus::CronLine.new('30 7 * * *').next_time( Time.utc(2008,10,24,7,29) )
+    #   => Fri Oct 24 07:30:00 UTC 2008
+    #
+    #   >> Rufus::CronLine.new('30 7 * * *').next_time( Time.utc(2008,10,24,7,29)  ).localtime
+    #   => Fri Oct 24 02:30:00 -0500 2008
+    #
+    # (Thanks to K Liu for the note and the examples)
+    #
     def next_time (now = Time.now)
 
       #

data/lib/rufus/scheduler.rb

@@ -29,7 +29,6 @@
 #
 
 require 'thread'
-require 'monitor'
 require 'rufus/otime'
 require 'rufus/cronline'
 
@@ -82,6 +81,9 @@ module Rufus
   #     init_self_destruction_sequence()
   #   end
   #
+  #   scheduler.join # join the scheduler (prevents exiting)
+  #
+  #
   # an example that uses a Schedulable class :
   #
   #  class Regenerator < Schedulable
@@ -218,6 +220,13 @@ module Rufus
   #     end
   #   end
   #
+  #     # or
+  #
+  #   def scheduler.lwarn (&block)
+  #     puts "oops, something wrong happened : "
+  #     puts block.call
+  #   end
+  #
   #   # 2 - overriding the [protected] method log_exception(e) :
   #
   #   class << scheduler
@@ -226,6 +235,12 @@ module Rufus
   #     end
   #   end
   #
+  #     # or
+  #
+  #   def scheduler.log_exception (e)
+  #     puts "something wrong happened : "+e.to_s
+  #   end
+  #
   # == 'Every jobs' and rescheduling
   #
   # Every jobs can reschedule/unschedule themselves. A reschedule example :
@@ -304,9 +319,25 @@ module Rufus
   # will return the thread of the last triggered instance, thus, in case
   # of overlapping executions, you only get the most recent thread.
   #
+  #
+  # == specifying a :timeout for a job
+  #
+  # rufus-scheduler 1.0.12 introduces a :timeout parameter for jobs.
+  #
+  #   scheduler.every "3h", :timeout => '2h30m' do
+  #     do_that_long_job()
+  #   end
+  #
+  # after 2 hours and half, the 'long job' will get interrupted by a
+  # Rufus::TimeOutError (so that you know what to catch).
+  #
+  # :timeout is applicable to all types of jobs : at, in, every, cron. It
+  # accepts a String value following the "Mdhms" scheme the rufus-scheduler
+  # uses.
+  #
   class Scheduler
 
-    VERSION = '1.0.11'
+    VERSION = '1.0.12'
 
     #
     # By default, the precision is 0.250, with means the scheduler
@@ -319,7 +350,7 @@ module Rufus
     #
     def precision= (f)
 
-      raise "precision must be 0.0 < p <= 1.0" \
+      raise 'precision must be 0.0 < p <= 1.0' \
         if f <= 0.0 or f > 1.0
 
       @precision = f
@@ -401,7 +432,7 @@ module Rufus
 
           next if d > @precision
 
-          sleep (@precision - d)
+          sleep(@precision - d)
         end
       end
     end
@@ -552,12 +583,14 @@ module Rufus
     #
     def schedule_every (freq, params={}, &block)
 
-      params = prepare_params params
+      params = prepare_params(params)
       params[:every] = freq
 
       first_at = params[:first_at]
       first_in = params[:first_in]
 
+      #params[:delayed] = true if first_at or first_in
+
       first_at = if first_at
         at_to_f(first_at)
       elsif first_in
@@ -679,10 +712,19 @@ module Rufus
     #
     # Returns an array of jobs that have the given tag.
     #
-    def find_jobs (tag)
+    def find_jobs (tag=nil)
 
-      @cron_jobs.values.find_all { |job| job.has_tag?(tag) } +
-      @non_cron_jobs.values.find_all { |job| job.has_tag?(tag) }
+      jobs = @cron_jobs.values + @non_cron_jobs.values
+      jobs = jobs.select { |job| job.has_tag?(tag) } if tag
+      jobs
+    end
+
+    #
+    # Returns all the jobs in the scheduler.
+    #
+    def all_jobs
+
+      find_jobs()
     end
 
     #
@@ -779,15 +821,15 @@ module Rufus
       #
       def do_schedule_at (at, params={}, &block)
 
-        job = params.delete :job
+        job = params.delete(:job)
 
         unless job
 
           jobClass = params[:every] ? EveryJob : AtJob
 
-          b = to_block params, &block
+          b = to_block(params, &block)
 
-          job = jobClass.new self, at_to_f(at), params[:job_id], params, &b
+          job = jobClass.new(self, at_to_f(at), params[:job_id], params, &b)
         end
 
         if jobClass == AtJob && job.at < (Time.new.to_f + @precision)
@@ -1020,9 +1062,15 @@ module Rufus
     end
   end
 
+  #
+  # This error is thrown when the :timeout attribute triggers
+  #
+  class TimeOutError < RuntimeError
+  end
+
   protected
 
-    JOB_ID_LOCK = Monitor.new
+    JOB_ID_LOCK = Mutex.new
       #
       # would it be better to use a Mutex instead of a full-blown
       # Monitor ?
@@ -1131,7 +1179,19 @@ module Rufus
           @trigger_thread = nil
             # overlapping executions, what to do ?
         end
+
+        if trigger_thread_alive? and (to = @params[:timeout])
+          @scheduler.in(to, :tags => 'timeout') do
+            @trigger_thread.raise(Rufus::TimeOutError) if trigger_thread_alive?
+          end
+        end
       end
+
+      protected
+
+        def trigger_thread_alive?
+          (@trigger_thread && @trigger_thread.alive?)
+        end
     end
 
     #

data/test/cron_test.rb

@@ -7,9 +7,10 @@
 # Sun Oct 29 16:18:25 JST 2006
 #
 
-require 'test/unit'
+$:.unshift(File.dirname(__FILE__) + '/../lib')
 
-require 'openwfe/util/scheduler'
+require 'test/unit'
+require 'rufus/scheduler'
 
 
 #

data/test/cronline_test.rb

@@ -7,8 +7,9 @@
 # Sun Oct 29 16:18:25 JST 2006
 #
 
-require 'test/unit'
+$:.unshift(File.dirname(__FILE__) + '/../lib')
 
+require 'test/unit'
 require 'rufus/scheduler'
 
 

data/test/dev.rb

@@ -24,5 +24,5 @@ s.schedule "* * * * *" do
   puts "#{tcurr.to_s} #{tcurr.to_f}  (#{compute_dev(s, tprev, tcurr)})"
 end
 
-s.join 
+s.join
 

data/test/scheduler_0_test.rb

@@ -7,22 +7,17 @@
 # Sun Oct 29 16:18:25 JST 2006
 #
 
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
 require 'test/unit'
-require 'openwfe/util/scheduler'
+require 'rufus/scheduler'
 
 
 #
 # testing otime and the scheduler
 #
-
 class Scheduler0Test < Test::Unit::TestCase
 
-  #def setup
-  #end
-
-  #def teardown
-  #end
-
   def test_scheduler_0
 
     #Thread.abort_on_exception = true

data/test/scheduler_1_test.rb

@@ -7,21 +7,17 @@
 # Sun Oct 29 16:18:25 JST 2006
 #
 
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
 require 'test/unit'
 require 'openwfe/util/scheduler'
 
+
 #
 # testing otime and the scheduler
 #
-
 class Scheduler1Test < Test::Unit::TestCase
 
-  #def setup
-  #end
-
-  #def teardown
-  #end
-
   def test_0
 
     scheduler = Rufus::Scheduler.new

data/test/scheduler_2_test.rb

@@ -7,21 +7,17 @@
 # Sun Oct 29 16:18:25 JST 2006
 #
 
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
 require 'test/unit'
 require 'openwfe/util/scheduler'
 
+
 #
 # testing otime and the scheduler
 #
-
 class Scheduler2Test < Test::Unit::TestCase
 
-  #def setup
-  #end
-
-  #def teardown
-  #end
-
   def test_0
 
     scheduler = Rufus::Scheduler.new

data/test/scheduler_3_test.rb

@@ -7,18 +7,14 @@
 # Sun Oct 29 16:18:25 JST 2006
 #
 
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
 require 'test/unit'
 require 'openwfe/util/scheduler'
 
 
 class Scheduler3Test < Test::Unit::TestCase
 
-  #def setup
-  #end
-
-  #def teardown
-  #end
-
   #
   # Testing tags
   #
@@ -50,6 +46,13 @@ class Scheduler3Test < Test::Unit::TestCase
     assert_equal 2, scheduler.find_jobs('fish').size
     #puts scheduler.find_jobs('fish')
 
+    assert_equal(
+      3,
+      scheduler.all_jobs.size)
+    assert_equal(
+      [ "Rufus::CronJob", "Rufus::CronJob", "Rufus::AtJob" ],
+      scheduler.all_jobs.collect { |j| j.class.name })
+
     scheduler.find_jobs('fish').each do |job|
       scheduler.unschedule(job.job_id)
     end

data/test/scheduler_4_test.rb

@@ -7,18 +7,14 @@
 # Tue Jan  8 13:46:17 JST 2008
 #
 
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
 require 'test/unit'
 require 'rufus/scheduler'
 
 
 class Scheduler4Test < Test::Unit::TestCase
 
-  #def setup
-  #end
-
-  #def teardown
-  #end
-
   #
   # Checking that a sleep in a schedule won't raise any exception
   #

data/test/scheduler_5_test.rb

@@ -7,18 +7,14 @@
 # Sat Jan 26 20:05:57 JST 2008
 #
 
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
 require 'test/unit'
 require 'rufus/scheduler'
 
 
 class Scheduler5Test < Test::Unit::TestCase
 
-  #def setup
-  #end
-
-  #def teardown
-  #end
-
   #
   # Testing the :first_at parameter
   #
@@ -31,7 +27,7 @@ class Scheduler5Test < Test::Unit::TestCase
 
     fa = Time.now + 3
 
-    s.schedule_every "1s", :first_at => fa do
+    s.schedule_every '1s', :first_at => fa do
       $count += 1
     end
 
@@ -60,7 +56,7 @@ class Scheduler5Test < Test::Unit::TestCase
 
     $count = 0
 
-    s.schedule_every "1s", :first_in => "3s" do
+    s.schedule_every '1s', :first_in => '3s' do
       $count += 1
     end
 
@@ -78,5 +74,79 @@ class Scheduler5Test < Test::Unit::TestCase
 
     s.stop
   end
+
+  #
+  # Testing the :timeout parameter
+  #
+  def test_2
+
+    s = Rufus::Scheduler.start_new
+
+    $count = 0
+    $error = nil
+
+    def s.log_exception (e)
+      $error = e
+    end
+
+    s.in '3s', :timeout => '2s' do
+      loop do
+        $count += 1
+        sleep 3
+      end
+    end
+
+    sleep 6
+
+    assert_kind_of Rufus::TimeOutError, $error
+    assert_equal 1, $count
+
+    s.stop
+  end
+
+  #
+  # Testing the :first_in + :timeout parameters
+  #
+  def test_3
+
+    s = Rufus::Scheduler.start_new
+
+    $count = 0
+    $error = nil
+    $jobs = nil
+    $status = :out
+
+    def s.log_exception (e)
+      $error = e
+      $status = :timedout
+    end
+
+    s.every '5s', :first_in => '2s', :timeout => '1s' do
+      $status = :in
+      Thread.pass # let the timeout job get scheduled
+      jobs = s.all_jobs
+      $jobs = [ jobs.size, jobs.collect { |j| j.tags }.flatten ]
+      $count += 1
+      sleep 4
+      $status = :out
+    end
+
+    sleep 4 # until after 1st timeout
+
+    assert_kind_of Rufus::TimeOutError, $error
+    assert_equal 1, $count
+    assert_equal [ 2, [ 'timeout' ] ], $jobs
+    assert_equal :timedout, $status
+
+    assert_equal 1, s.all_jobs.size
+
+    sleep 3.5 # right in the middle of the 2nd timeout
+
+    assert_equal :in, $status
+    assert_equal 2, s.all_jobs.size
+    assert_equal [ 'timeout' ], s.all_jobs.collect { |j| j.tags }.flatten
+
+    s.stop
+  end
 end
 

data/test/scheduler_6_test.rb

@@ -7,18 +7,14 @@
 # Thu Feb 14 08:19:10 JST 2008
 #
 
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
 require 'test/unit'
 require 'rufus/scheduler'
 
 
 class Scheduler6Test < Test::Unit::TestCase
 
-  #def setup
-  #end
-
-  #def teardown
-  #end
-
   #
   # just a small test
   #

data/test/scheduler_7_test.rb

@@ -7,6 +7,8 @@
 # Sun Jul 13 19:20:27 JST 2008
 #
 
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
 require 'test/unit'
 require 'rufus/scheduler'
 
@@ -14,15 +16,8 @@ require 'rufus/scheduler'
 #
 # checking if bug #20893 got fixed
 #
-
 class Scheduler7Test < Test::Unit::TestCase
 
-  #def setup
-  #end
-
-  #def teardown
-  #end
-
   def test_0
 
     count = 0

data/test/scheduler_name_test.rb

@@ -7,6 +7,8 @@
 # Fri Apr 18 11:29:18 JST 2008
 #
 
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
 require 'test/unit'
 require 'openwfe/util/scheduler'
 
@@ -14,15 +16,8 @@ require 'openwfe/util/scheduler'
 #
 # testing otime and the scheduler
 #
-
 class SchedulerNameTest < Test::Unit::TestCase
 
-  #def setup
-  #end
-
-  #def teardown
-  #end
-
   def test_0
 
     scheduler = Rufus::Scheduler.new

data/test/time_0_test.rb

@@ -7,22 +7,17 @@
 # Sun Oct 29 16:18:25 JST 2006
 #
 
-require 'test/unit'
+$:.unshift(File.dirname(__FILE__) + '/../lib')
 
+require 'test/unit'
 require 'rufus/otime'
 
+
 #
 # testing otime
 #
-
 class Time0Test < Test::Unit::TestCase
 
-  #def setup
-  #end
-
-  #def teardown
-  #end
-
   def _test_to_iso_date
     #
     # well... this test is not timezone friendly...

data/test/time_1_test.rb

@@ -7,22 +7,17 @@
 # Fri Feb 29 11:18:48 JST 2008
 #
 
-require 'test/unit'
+$:.unshift(File.dirname(__FILE__) + '/../lib')
 
+require 'test/unit'
 require 'rufus/otime'
 
+
 #
 # testing otime
 #
-
 class Time1Test < Test::Unit::TestCase
 
-  #def setup
-  #end
-
-  #def teardown
-  #end
-
   def test_0
 
     tts 0, "0s"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-scheduler
 version: !ruby/object:Gem::Version 
-  version: 1.0.11
+  version: 1.0.12
 platform: ruby
 authors: 
 - John Mettraux
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-03 00:00:00 +09:00
+date: 2008-12-18 00:00:00 +09:00
 default_executable: 
 dependencies: []
 
@@ -72,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: scheduler for Ruby (at, cron and every jobs), formerly known as 'openwferu-scheduler'