rufus-scheduler 1.0.1 → 1.0.2

data/CHANGELOG.txt

@@ -2,5 +2,13 @@
 = rufus-scheduler CHANGELOG.txt
 
 
+== rufus-scheduler - 1.0.2    released 2008/01/26
+
+- patch #17505 : added params :first_at and :first_in for schedule_every()
+                 a patch by John Didion - s115
+
+
 == rufus-scheduler - 1.0    released 2008/01/24
 
+- initial release after "openwferu-scheduler" - 0.9.16
+

data/lib/rufus/scheduler.rb

@@ -45,7 +45,25 @@ module Rufus
     # params (usually an array or nil), either a block, which is more in the 
     # Ruby way.
     #
+    # == The gem "openwferu-scheduler"
+    #
+    # This scheduler was previously known as the "openwferu-scheduler" gem.
+    # 
+    # To ensure that code tapping the previous gem still runs fine with
+    # "rufus-scheduler", this new gem has 'pointers' for the old class
+    # names.
+    #
+    #    require 'rubygems'
+    #    require 'openwfe/util/scheduler'
+    #    s = OpenWFE::Scheduler.new
+    #
+    # will still run OK with "rufus-scheduler".
+    #
     # == Examples
+    #
+    #    require 'rubygems'
+    #    require 'rufus/scheduler'
+    #     
     #     
     #    scheduler.schedule_in("3d") do
     #        regenerate_monthly_report()
@@ -199,6 +217,19 @@ module Rufus
     #         params[:dont_reschedule] = true if $mail
     #     end
     #
+    # == 'Every jobs', :first_at and :first_in
+    #
+    # Since rufus-scheduler 1.0.2, the schedule_every methods recognizes two
+    # optional parameters, :first_at and :first_in
+    #
+    #     scheduler.schedule_every "2d", :first_in => "5h" do
+    #         # schedule something every two days, start in 5 hours...
+    #     end
+    #
+    #     scheduler.schedule_every "2d", :first_at => "5h" do
+    #         # schedule something every two days, start in 5 hours...
+    #     end
+    #
     class Scheduler
 
         #
@@ -375,6 +406,13 @@ module Rufus
         #             # won't get rescheduled in case of exception
         #     end
         #
+        # Since rufus-scheduler 1.0.2, the params :first_at and :first_in are
+        # accepted.
+        #
+        #     scheduler.schedule_every "2d", :first_in => "5h" do
+        #         # schedule something every two days, start in 5 hours...
+        #     end
+        #
         def schedule_every (freq, params={}, &block)
 
             f = duration_to_f freq
@@ -383,9 +421,17 @@ module Rufus
             schedulable = params[:schedulable]
             params[:every] = freq
 
-            last_at = params[:last_at]
-            next_at = if last_at
-                last_at + f
+            first_at = params.delete :first_at
+            first_in = params.delete :first_in
+
+            previous_at = params[:previous_at]
+
+            next_at = if first_at
+                first_at
+            elsif first_in
+                Time.now.to_f + duration_to_f(first_in)
+            elsif previous_at
+                previous_at + f
             else
                 Time.now.to_f + f
             end
@@ -423,7 +469,7 @@ module Rufus
                     # ok, reschedule ...
 
                     params[:job_id] = job_id
-                    params[:last_at] = at
+                    params[:previous_at] = at
                     
                     schedule_every params[:every], params, &block
                         #
@@ -662,14 +708,7 @@ module Rufus
 
                 #puts "0 at is '#{at.to_s}' (#{at.class})"
 
-                at = Rufus::to_ruby_time(at) \
-                    if at.kind_of?(String)
-
-                at = Rufus::to_gm_time(at) \
-                    if at.kind_of?(DateTime)
-
-                at = at.to_f \
-                    if at.kind_of?(Time)
+                at = at_to_f at
 
                 #puts "1 at is '#{at.to_s}' (#{at.class})"}"
 
@@ -677,13 +716,14 @@ module Rufus
 
                 job_id = params[:job_id]
 
-                b = to_block(params, &block)
+                b = to_block params, &block
 
-                job = jobClass.new(self, at, job_id, params, &b)
+                job = jobClass.new self, at, job_id, params, &b
 
                 #do_unschedule(job_id) if job_id 
 
                 if at < (Time.new.to_f + @precision)
+
                     job.trigger() unless params[:discard_past]
                     return nil
                 end
@@ -707,6 +747,18 @@ module Rufus
                 Float(s.to_s)
             end
 
+            #
+            # Ensures an 'at' instance is translated to a float
+            # (to be compared with the float coming from time.to_f)
+            #
+            def at_to_f (at)
+
+                at = Rufus::to_ruby_time(at) if at.kind_of?(String)
+                at = Rufus::to_gm_time(at) if at.kind_of?(DateTime)
+                at = at.to_f if at.kind_of?(Time)
+                at
+            end
+
             #
             # Returns a block. If a block is passed, will return it, else, 
             # if a :schedulable is set in the params, will return a block 

data/test/scheduler_4_test.rb

@@ -20,7 +20,7 @@ class Scheduler4Test < Test::Unit::TestCase
     #end
 
     #
-    # Checking that a sleep in a schedule won't raise any execption
+    # Checking that a sleep in a schedule won't raise any exception
     #
     def test_0
 

data/test/scheduler_5_test.rb

@@ -0,0 +1,82 @@
+
+#
+# Testing the 'rufus-scheduler'
+#
+# John Mettraux at openwfe.org
+#
+# Sat Jan 26 20:05:57 JST 2008
+#
+
+require 'test/unit'
+require 'rufus/scheduler'
+
+
+class Scheduler5Test < Test::Unit::TestCase
+
+    #def setup
+    #end
+
+    #def teardown
+    #end
+
+    #
+    # Testing the :first_at parameter
+    #
+    def test_0
+
+        s = Rufus::Scheduler.new
+        s.start
+
+        $count = 0
+
+        fa = Time.now + 3
+        
+        s.schedule_every "1s", :first_at => fa do
+            $count += 1
+        end
+
+        sleep 1
+
+        assert_equal 0, $count
+
+        sleep 3
+
+        assert_equal 1, $count
+
+        sleep 1
+
+        assert_equal 2, $count
+
+        s.stop
+    end
+
+    #
+    # Testing the :first_in parameter
+    #
+    def test_1
+
+        s = Rufus::Scheduler.new
+        s.start
+
+        $count = 0
+
+        s.schedule_every "1s", :first_in => "3s" do
+            $count += 1
+        end
+
+        sleep 1
+
+        assert_equal 0, $count
+
+        sleep 3
+
+        assert_equal 1, $count
+
+        sleep 1
+
+        assert_equal 2, $count
+
+        s.stop
+    end
+end
+

data/test/test.rb

@@ -6,6 +6,7 @@ require 'scheduler_1_test'
 require 'scheduler_2_test'
 require 'scheduler_3_test'
 require 'scheduler_4_test'
+require 'scheduler_5_test'
 
 require 'cron_test'
 require 'cronline_test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-scheduler
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - John Mettraux
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-24 00:00:00 +09:00
+date: 2008-01-26 00:00:00 +09:00
 default_executable: 
 dependencies: []
 
@@ -36,6 +36,7 @@ files:
 - test/scheduler_2_test.rb
 - test/scheduler_3_test.rb
 - test/scheduler_4_test.rb
+- test/scheduler_5_test.rb
 - test/test.rb
 - test/time_test.rb
 - README.txt