rufus-scheduler 1.0.6 → 1.0.7

data/CHANGELOG.txt

@@ -2,7 +2,14 @@
 = rufus-scheduler CHANGELOG.txt
 
 
-== rufus-scheduler - 1.0.6    not yet released
+== rufus-scheduler - 1.0.7    released 2008/06/16
+
+- todo  #20669 : implemented CronJob.next_time()
+- todo  #20667 : now passing params to schedule() blocks as well.
+- bug   #20648 : find_schedulable(tag) broken. Fixed.
+
+
+== rufus-scheduler - 1.0.6    released 2008/05/02
 
 - bug   #20476 : no cron jobs on sundays (wday == 0). Fixed.
                  (thanks to Manfred Usselmann)

data/README.txt

@@ -52,6 +52,11 @@ On the rufus-ruby list[http://groups.google.com/group/rufus-ruby] :
 http://rubyforge.org/tracker/?atid=18584&group_id=4812&func=browse
 
 
+== irc
+
+irc.freenode.net #ruote
+
+
 == source
 
 http://github.com/jmettraux/rufus-scheduler

data/lib/openwfe/util/scheduler.rb

@@ -8,10 +8,10 @@
 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 # copies of the Software, and to permit persons to whom the Software is
 # furnished to do so, subject to the following conditions:
-# 
+#
 # The above copyright notice and this permission notice shall be included in
 # all copies or substantial portions of the Software.
-# 
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -26,16 +26,16 @@ require 'rufus/scheduler'
 
 
 #
-# An 'alias' to Rufus::Scheduler to keep backward compatibility for 
+# An 'alias' to Rufus::Scheduler to keep backward compatibility for
 # the users of the gem 'openwferu-scheduler'.
 #
 module OpenWFE
 
-    class Scheduler < Rufus::Scheduler
-    end
+  class Scheduler < Rufus::Scheduler
+  end
 
-    module Schedulable 
-        include Rufus::Schedulable
-    end
+  module Schedulable
+    include Rufus::Schedulable
+  end
 end
 

data/lib/rufus/scheduler.rb

@@ -64,6 +64,7 @@ module Rufus
   #  require 'rubygems'
   #  require 'rufus/scheduler'
   #
+  #  scheduler = Rufus::Scheduler.start_new
   #
   #  scheduler.schedule_in("3d") do
   #    regenerate_monthly_report()
@@ -180,6 +181,26 @@ module Rufus
   # scheduling. This column can, like for the other columns, specify a
   # value ("7"), a list of values ("7,8,9,27") or a range ("7-12").
   #
+  #
+  # == information passed to schedule blocks
+  #
+  # When calling schedule_every(), schedule_in() or schedule_at(), the block
+  # expects zero or 3 parameters like in
+  #
+  #   scheduler.schedule_every("1h20m") do |job_id, at, params|
+  #       puts "my job_id is #{job_id}"
+  #   end
+  #
+  # For schedule(), zero or two parameters can get passed
+  #
+  #   scheduler.schedule "7 * * * * *" do |job_id, cron_line, params|
+  #     puts "my job_id is #{job_id}"
+  #   end
+  #
+  # In both cases, params corresponds to the params passed to the schedule
+  # method (:tags, :first_at, :first_in, :dont_reschedule, ...)
+  #
+  #
   # == Exceptions
   #
   # The rufus scheduler will output a stacktrace to the STDOUT in
@@ -242,6 +263,23 @@ module Rufus
   #     # schedule something every two days, start in 5 hours...
   #   end
   #
+  # == job.next_time()
+  #
+  # Jobs, be they at, every or cron have a next_time() method, which tells
+  # when the job will be fired next time (for at and in jobs, this is also the
+  # last time).
+  #
+  # For cron jobs, the current implementation is quite brutal. It takes three
+  # seconds on my 2006 macbook to reach a cron schedule 1 year away.
+  #
+  # When is the next friday 13th ?
+  #
+  #   require 'rubygems'
+  #   require 'rufus/scheduler'
+  #
+  #   puts Rufus::CronLine.new("* * 13 * fri").next_time
+  #
+  #
   # == :thread_name option
   #
   # You can specify the name of the scheduler's thread. Should make
@@ -348,6 +386,16 @@ module Rufus
       end
     end
 
+    #
+    # Instantiates a new Rufus::Scheduler instance, starts it and returns it
+    #
+    def self.start_new
+
+      s = self.new
+      s.start
+      s
+    end
+
     #
     # The scheduler is stoppable via sstop()
     #
@@ -612,12 +660,7 @@ module Rufus
     #
     def get_job (job_id)
 
-      job = @cron_jobs[job_id]
-      return job if job
-
-      @pending_jobs.find do |job|
-        job.job_id == job_id
-      end
+      @cron_jobs[job_id] || @pending_jobs.find { |job| job.job_id == job_id }
     end
 
     #
@@ -640,13 +683,8 @@ module Rufus
     #
     def find_jobs (tag)
 
-      result = @cron_jobs.values.find_all do |job|
-        job.has_tag?(tag)
-      end
-
-      result + @pending_jobs.find_all do |job|
-        job.has_tag?(tag)
-      end
+      @cron_jobs.values.find_all { |job| job.has_tag?(tag) } +
+      @pending_jobs.find_all { |job| job.has_tag?(tag) }
     end
 
     #
@@ -657,18 +695,7 @@ module Rufus
     #
     def find_schedulables (tag)
 
-      #jobs = find_jobs(tag)
-      #result = []
-      #jobs.each do |job|
-      #  result.push(job.schedulable) if job.respond_to?(:schedulable)
-      #end
-      #result
-
-      find_jobs(tags).inject([]) do |result, job|
-
-        result.push(job.schedulable) if job.respond_to?(:schedulable)
-        result
-      end
+      find_jobs(tag).find_all { |job| job.respond_to?(:schedulable) }
     end
 
     #
@@ -709,10 +736,9 @@ module Rufus
     #
     def Scheduler.is_cron_string (s)
 
-      s.match ".+ .+ .+ .+ .+"
+      s.match ".+ .+ .+ .+ .+" # well...
     end
 
-    #protected
     private
 
       def do_unschedule (job_id)
@@ -1158,6 +1184,15 @@ module Rufus
 
         Time.at(@at)
       end
+
+      #
+      # next_time is last_time (except for EveryJob instances). Returns
+      # a Time instance.
+      #
+      def next_time
+
+        schedule_info
+      end
     end
 
     #
@@ -1222,7 +1257,7 @@ module Rufus
       #
       def trigger
 
-        @block.call @job_id, @cron_line
+        @block.call @job_id, @cron_line, @params
       end
 
       #
@@ -1233,6 +1268,18 @@ module Rufus
 
         @cron_line.original
       end
+
+      #
+      # Returns a Time instance : the next time this cron job is
+      # supposed to "fire".
+      #
+      # 'from' is used to specify the starting point for determining
+      # what will be the next time. Defaults to now.
+      #
+      def next_time (from=Time.now)
+
+        @cron_line.next_time(from)
+      end
     end
 
     #
@@ -1293,8 +1340,7 @@ module Rufus
       def matches? (time)
       #def matches? (time, precision)
 
-        time = Time.at(time) \
-          if time.kind_of?(Float) or time.kind_of?(Integer)
+        time = Time.at(time) unless time.kind_of?(Time)
 
         return false \
           if no_match?(time.sec, @seconds)
@@ -1320,9 +1366,70 @@ module Rufus
       # This method is used by the cronline unit tests.
       #
       def to_array
+
         [ @seconds, @minutes, @hours, @days, @months, @weekdays ]
       end
 
+      #
+      # Returns the next time that this cron line is supposed to 'fire'
+      #
+      # This is raw, 3 secs to iterate over 1 year on my macbook :( brutal.
+      #
+      def next_time (now = Time.now)
+
+        #
+        # position now to the next cron second
+
+        if @seconds
+          next_sec = @seconds.find { |s| s > now.sec } || 60 + @seconds.first
+          now += next_sec - now.sec
+        else
+          now += 1
+        end
+
+        #
+        # prepare sec jump array
+
+        sjarray = nil
+
+        if @seconds
+
+          sjarray = []
+
+          i = @seconds.index(now.sec)
+          ii = i
+
+          loop do
+            cur = @seconds[ii]
+            ii += 1
+            ii = 0 if ii == @seconds.size
+            nxt = @seconds[ii]
+            nxt += 60 if ii == 0
+            sjarray << (nxt - cur)
+            break if ii == i
+          end
+
+        else
+
+          sjarray = [ 1 ]
+        end
+
+        #
+        # ok, seek...
+
+        i = 0
+
+        loop do
+          return now if matches?(now)
+          now += sjarray[i]
+          i += 1
+          i = 0 if i == sjarray.size
+          # danger... potentially no exit...
+        end
+
+        nil
+      end
+
       private
 
         #--

data/test/cron_test.rb

@@ -1,6 +1,6 @@
 
 #
-# Testing OpenWFE
+# Testing Rufus
 #
 # John Mettraux at openwfe.org
 #
@@ -27,7 +27,7 @@ class CronTest < Test::Unit::TestCase
 
     $var = 0
 
-    scheduler = OpenWFE::Scheduler.new
+    scheduler = Rufus::Scheduler.new
     scheduler.start
 
     sid = scheduler.schedule(
@@ -46,7 +46,7 @@ class CronTest < Test::Unit::TestCase
 
   def test_1
 
-    scheduler = OpenWFE::Scheduler.new
+    scheduler = Rufus::Scheduler.new
     scheduler.start
 
     sec = nil
@@ -76,7 +76,7 @@ class CronTest < Test::Unit::TestCase
 
   def test_2
 
-    scheduler = OpenWFE::Scheduler.new
+    scheduler = Rufus::Scheduler.new
     scheduler.start
 
     counter = 0
@@ -97,7 +97,7 @@ class CronTest < Test::Unit::TestCase
   #
   def test_3
 
-    scheduler = OpenWFE::Scheduler.new
+    scheduler = Rufus::Scheduler.new
     scheduler.start
 
     counter = 0
@@ -111,6 +111,7 @@ class CronTest < Test::Unit::TestCase
     #puts "job_id : #{job_id}"
 
     assert_equal 1, scheduler.cron_job_count
+    assert_equal 0, scheduler.find_schedulables("nada").size
 
     scheduler.unschedule job_id
 
@@ -121,10 +122,27 @@ class CronTest < Test::Unit::TestCase
     scheduler.stop
   end
 
+  def test_4
+
+    scheduler = Rufus::Scheduler.start_new
+
+    val = nil
+
+    job_id = scheduler.schedule "* * * * * *" do |job_id, cron_line, params|
+      val = params.inspect
+    end
+
+    sleep 2
+
+    assert_equal '{}', val
+
+    scheduler.stop
+  end
+
   protected
 
     class CounterSchedulable
-      include OpenWFE::Schedulable
+      include Rufus::Schedulable
 
       def trigger (params)
         $var = $var + 1

data/test/cronline_test.rb

@@ -49,8 +49,35 @@ class CronLineTest < Test::Unit::TestCase
     dotest "1-5 * * * * *", [ [1,2,3,4,5], nil, nil, nil, nil, nil ]
   end
 
+  def test_2
+
+    now = Time.at(0) # something like 'Thu Jan 01 09:00:00 +0900 1970'
+
+    assert_equal now + 60, cl("* * * * *").next_time(now)
+    assert_equal now + 226800, cl("* * * * sun").next_time(now)
+    assert_equal now + 1, cl("* * * * * *").next_time(now)
+    assert_equal now + 3682800, cl("* * 13 * fri").next_time(now)
+
+    assert_equal now + 29905800, cl("10 12 13 12 *").next_time(now)
+      # this one is slow (1 year == 3 seconds)
+
+    assert_equal now + 601200, cl("* 8 * * thu").next_time(now)
+  end
+
+  def test_3
+
+    now = Time.local(2008, 12, 31, 23, 59, 59, 0)
+
+    assert_equal now + 1, cl("* * * * *").next_time(now)
+  end
+
   protected
 
+    def cl (cronline_string)
+
+      Rufus::CronLine.new(cronline_string)
+    end
+
     def dotest (line, array)
 
       cl = Rufus::CronLine.new(line)

data/test/scheduler_0_test.rb

@@ -1,6 +1,6 @@
 
 #
-# Testing OpenWFE
+# Testing Rufus
 #
 # John Mettraux at openwfe.org
 #
@@ -29,8 +29,7 @@ class Scheduler0Test < Test::Unit::TestCase
 
     $var = nil
 
-    scheduler = OpenWFE::Scheduler.new
-    scheduler.sstart
+    scheduler = Rufus::Scheduler.start_new
 
     sid = scheduler.schedule_in('2s', :schedulable => TestSchedulable.new)
 
@@ -60,8 +59,8 @@ class Scheduler0Test < Test::Unit::TestCase
 
     $var = nil
 
-    scheduler = OpenWFE::Scheduler.new
-    scheduler.sstart
+    scheduler = Rufus::Scheduler.new
+    scheduler.start
 
     sid = scheduler.schedule_in('1s') do
       $var = "ok..1"
@@ -90,8 +89,8 @@ class Scheduler0Test < Test::Unit::TestCase
 
     text = ""
 
-    scheduler = OpenWFE::Scheduler.new()
-    scheduler.sstart
+    scheduler = Rufus::Scheduler.new()
+    scheduler.start
 
     scheduler.schedule_in("1s") do
       text << "one"
@@ -117,8 +116,7 @@ class Scheduler0Test < Test::Unit::TestCase
 
     Thread.abort_on_exception = true
 
-    scheduler = OpenWFE::Scheduler.new()
-    scheduler.sstart
+    scheduler = Rufus::Scheduler.start_new
 
     #
     # phase 0
@@ -149,7 +147,7 @@ class Scheduler0Test < Test::Unit::TestCase
     job_id = scheduler.schedule_every "500", es
 
     #puts "1 job_id : " + job_id.to_s
-    
+
     #sleep(3.4) # was a bit soonish for JRuby...
     sleep 3.5
 
@@ -174,8 +172,8 @@ class Scheduler0Test < Test::Unit::TestCase
   #
   def test_scheduler_5
 
-    scheduler = OpenWFE::Scheduler.new
-    scheduler.sstart
+    scheduler = Rufus::Scheduler.new
+    scheduler.start
 
     touched = false
 
@@ -193,7 +191,7 @@ class Scheduler0Test < Test::Unit::TestCase
   #
   def test_scheduler_6
 
-    scheduler = OpenWFE::Scheduler.new
+    scheduler = Rufus::Scheduler.new
     scheduler.start
 
     #class << scheduler
@@ -267,7 +265,7 @@ class Scheduler0Test < Test::Unit::TestCase
   #
   def test_8b
 
-    scheduler = OpenWFE::Scheduler.new
+    scheduler = Rufus::Scheduler.new
     scheduler.start
 
     var = nil
@@ -287,7 +285,7 @@ class Scheduler0Test < Test::Unit::TestCase
   #
   def test_9
 
-    scheduler = OpenWFE::Scheduler.new
+    scheduler = Rufus::Scheduler.new
     scheduler.start
 
     value = nil
@@ -317,7 +315,7 @@ class Scheduler0Test < Test::Unit::TestCase
 
     e = nil
     begin
-      OpenWFE::Scheduler.new.precision = 10
+      Rufus::Scheduler.new.precision = 10
     rescue Exception => e
     end
 
@@ -327,7 +325,7 @@ class Scheduler0Test < Test::Unit::TestCase
   protected
 
     class TestSchedulable
-      include OpenWFE::Schedulable
+      include Rufus::Schedulable
 
       def trigger (params)
         $var = "ok"
@@ -335,7 +333,7 @@ class Scheduler0Test < Test::Unit::TestCase
     end
 
     class EverySchedulable
-      include OpenWFE::Schedulable
+      include Rufus::Schedulable
 
       attr_accessor :job_id, :count
 

data/test/scheduler_1_test.rb

@@ -1,6 +1,6 @@
 
 #
-# Testing OpenWFE
+# Testing Rufus
 #
 # John Mettraux at openwfe.org
 #
@@ -24,8 +24,8 @@ class Scheduler1Test < Test::Unit::TestCase
 
   def test_0
 
-    scheduler = OpenWFE::Scheduler.new
-    scheduler.sstart
+    scheduler = Rufus::Scheduler.new
+    scheduler.start
 
     job_id = scheduler.schedule_every "500", :tags => "Avery" do
       # don't do a thing
@@ -47,8 +47,8 @@ class Scheduler1Test < Test::Unit::TestCase
 
   def test_1
 
-    scheduler = OpenWFE::Scheduler.new
-    scheduler.sstart
+    scheduler = Rufus::Scheduler.new
+    scheduler.start
 
     job_id = scheduler.schedule_every "500", :tags => "Avery" do
       # don't do a thing
@@ -74,8 +74,8 @@ class Scheduler1Test < Test::Unit::TestCase
   #
   def _test_2
 
-    scheduler = OpenWFE::Scheduler.new
-    scheduler.sstart
+    scheduler = Rufus::Scheduler.new
+    scheduler.start
     last = nil
     job_id = scheduler.schedule_every "1s" do
       t = Time.now

data/test/scheduler_2_test.rb

@@ -1,6 +1,6 @@
 
 #
-# Testing OpenWFE
+# Testing Rufus
 #
 # John Mettraux at openwfe.org
 #
@@ -24,8 +24,8 @@ class Scheduler2Test < Test::Unit::TestCase
 
   def test_0
 
-    scheduler = OpenWFE::Scheduler.new
-    scheduler.sstart
+    scheduler = Rufus::Scheduler.new
+    scheduler.start
 
     counter = 0
     $error_counter = 0
@@ -52,8 +52,8 @@ class Scheduler2Test < Test::Unit::TestCase
 
     # repeating myself
 
-    scheduler = OpenWFE::Scheduler.new
-    scheduler.sstart
+    scheduler = Rufus::Scheduler.new
+    scheduler.start
 
     counter = 0
     $error_counter = 0
@@ -78,8 +78,8 @@ class Scheduler2Test < Test::Unit::TestCase
 
   def test_2
 
-    scheduler = OpenWFE::Scheduler.new
-    scheduler.sstart
+    scheduler = Rufus::Scheduler.new
+    scheduler.start
 
     def scheduler.lwarn (&block)
       puts block.call
@@ -101,8 +101,8 @@ class Scheduler2Test < Test::Unit::TestCase
 
     # repeating myself ...
 
-    scheduler = OpenWFE::Scheduler.new
-    scheduler.sstart
+    scheduler = Rufus::Scheduler.new
+    scheduler.start
 
     def scheduler.lwarn (&block)
       puts block.call

data/test/scheduler_3_test.rb

@@ -1,6 +1,6 @@
 
 #
-# Testing OpenWFE
+# Testing Rufus
 #
 # John Mettraux at openwfe.org
 #
@@ -24,7 +24,7 @@ class Scheduler3Test < Test::Unit::TestCase
   #
   def test_0
 
-    scheduler = OpenWFE::Scheduler.new
+    scheduler = Rufus::Scheduler.new
     scheduler.start
 
     value = nil

data/test/scheduler_name_test.rb

@@ -1,6 +1,6 @@
 
 #
-# Testing OpenWFE
+# Testing Rufus
 #
 # John Mettraux at openwfe.org
 #
@@ -25,8 +25,8 @@ class SchedulerNameTest < Test::Unit::TestCase
 
   def test_0
 
-    scheduler = OpenWFE::Scheduler.new
-    scheduler.sstart
+    scheduler = Rufus::Scheduler.new
+    scheduler.start
 
     sleep 0.350 if defined?(JRUBY_VERSION)
 
@@ -39,8 +39,8 @@ class SchedulerNameTest < Test::Unit::TestCase
 
   def test_1
 
-    scheduler = OpenWFE::Scheduler.new :thread_name => "genjiguruma"
-    scheduler.sstart
+    scheduler = Rufus::Scheduler.new :thread_name => "genjiguruma"
+    scheduler.start
 
     sleep 0.350 if defined?(JRUBY_VERSION)
 

data/test/time_0_test.rb

@@ -1,6 +1,6 @@
 
 #
-# Testing OpenWFE
+# Testing Rufus
 #
 # John Mettraux at openwfe.org
 #

data/test/time_1_test.rb

@@ -1,6 +1,6 @@
 
 #
-# Testing OpenWFE
+# Testing Rufus
 #
 # John Mettraux at openwfe.org
 #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-scheduler
 version: !ruby/object:Gem::Version 
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors: 
 - John Mettraux
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-02 00:00:00 +09:00
+date: 2008-06-17 00:00:00 +09:00
 default_executable: 
 dependencies: []