openwferu-scheduler 0.9.16 → 0.9.16.1404

data/lib/openwfe/util/otime.rb

@@ -128,7 +128,8 @@ module OpenWFE
 
         number = ""
 
-        while true
+        loop do
+
             index = index + 1
 
             if index >= string.length

data/lib/openwfe/util/scheduler.rb

@@ -53,7 +53,7 @@ module OpenWFE
     # params (usually an array or nil), either a block, which is more in the 
     # Ruby way.
     #
-    # Some examples :
+    # == Examples
     #     
     #    scheduler.schedule_in("3d") do
     #        regenerate_monthly_report()
@@ -120,6 +120,8 @@ module OpenWFE
     #         # (the default is 4 times per second (0.250))
     #
     #
+    # == Tags
+    #
     # Since OpenWFEru 0.9.16, tags can be attached to jobs scheduled :
     #
     #     scheduler.schedule_in "2h", :tags => "backup" do
@@ -144,6 +146,8 @@ module OpenWFE
     # by itself, so no serialization issue.
     #
     #
+    # == Cron up to the second
+    #
     # Since OpenWFEru 0.9.16, a cron schedule can be set at the second level :
     #
     #     scheduler.schedule "7 * * * * *" do
@@ -154,6 +158,55 @@ module OpenWFE
     # 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").
     #
+    # == Exceptions
+    # 
+    # The OpenWFEru scheduler will output a stacktrace to the STDOUT in
+    # case of exception. There are two ways to change that behaviour.
+    #
+    #     # 1 - providing a lwarn method to the scheduler instance :
+    # 
+    #     class << scheduler
+    #         def lwarn (&block)
+    #             puts "oops, something wrong happened : "
+    #             puts block.call
+    #         end
+    #     end
+    #
+    #     # 2 - overriding the [protected] method log_exception(e) :
+    #
+    #     class << scheduler
+    #         def log_exception (e)
+    #             puts "something wrong happened : "+e.to_s
+    #         end
+    #     end
+    #
+    # == 'Every jobs' and rescheduling
+    #
+    # Every jobs can reschedule/unschedule themselves. A reschedule example :
+    #
+    #     schedule.schedule_every "5h" do |job_id, at, params|
+    #
+    #         mails = $inbox.fetch_mails
+    #         mails.each { |m| $inbox.mark_as_spam(m) if is_spam(m) }
+    #
+    #         params[:every] = if mails.size > 100
+    #             "1h" # lots of spam, check every hour
+    #         else
+    #             "5h" # normal schedule, every 5 hours
+    #         end
+    #     end
+    #
+    # Unschedule example :
+    #
+    #     schedule.schedule_every "10s" do |job_id, at, params|
+    #         #
+    #         # polls every 10 seconds until a mail arrives
+    #
+    #         $mail = $inbox.fetch_last_mail
+    #
+    #         params[:dont_reschedule] = true if $mail
+    #     end
+    #
     class Scheduler
         include MonitorMixin
 
@@ -211,7 +264,7 @@ module OpenWFE
                         "openwferu scheduler (Ruby Thread)"
                 end
 
-                while true
+                loop do
                     break if @stopped
                     step
                     sleep @precision
@@ -301,6 +354,14 @@ module OpenWFE
         # This method returns a job identifier which can be used to unschedule()
         # the job.
         #
+        # In case of exception in the job, it will be rescheduled. If you don't
+        # want the job to be rescheduled, set the parameter :try_again to false.
+        #
+        #     scheduler.schedule_every "500", :try_again => false do
+        #         do_some_prone_to_error_stuff()
+        #             # won't get rescheduled in base of exception
+        #     end
+        #
         def schedule_every (freq, params={}, &block)
 
             f = duration_to_f freq
@@ -318,20 +379,58 @@ module OpenWFE
 
             sschedule_at next_at, params do |job_id, at|
 
-                if schedulable
-                    schedulable.trigger(params)
-                else
-                    block.call job_id, at
+                #
+                # trigger ...
+
+                hit_exception = false
+
+                begin
+
+                    if schedulable
+                        schedulable.trigger params
+                    else
+                        block.call job_id, at, params
+                    end
+
+                rescue Exception => e
+
+                    log_exception e
+
+                    hit_exception = true
                 end
 
-                params[:job_id] = job_id
-                params[:last_at] = at
-                
-                schedule_every(freq, params, &block) \
-                    unless @dont_reschedule_every
+                # cannot use a return here !!! (block)
+
+                #unless (hit_exception and params[:try_again] == false)
+                #    #
+                #    # reschedule ...
+                #    params[:job_id] = job_id
+                #    params[:last_at] = at
+                #    
+                #    schedule_every(params[:every], params, &block) \
+                #        unless @dont_reschedule_every
+                #            #
+                #            # yes, this is a kind of recursion
+                #end
+                unless \
+                    @dont_reschedule_every or
+                    (params[:dont_reschedule] == true) or
+                    (hit_exception and params[:try_again] == false)
+
+                    #
+                    # ok, reschedule ...
+
+                    params[:job_id] = job_id
+                    params[:last_at] = at
+                    
+                    schedule_every params[:every], params, &block
                         #
                         # yes, this is a kind of recursion
 
+                        # note that params[:every] might have been changed
+                        # by the block/schedulable code
+                end
+
                 job_id
             end
         end
@@ -524,6 +623,7 @@ module OpenWFE
             # Making sure that params is a Hash.
             #
             def prepare_params (params)
+
                 params = { :schedulable => params } \
                     if params.is_a?(Schedulable)
                 params
@@ -595,6 +695,7 @@ module OpenWFE
             # will yields 10.0
             #
             def duration_to_f (s)
+
                 return s if s.kind_of? Float
                 return OpenWFE::parse_time_string(s) if s.kind_of? String
                 Float(s.to_s)
@@ -697,7 +798,7 @@ module OpenWFE
                         #
                         # that's what at jobs do understand
 
-                    while true
+                    loop do
 
                         #puts "step() job.count is #{@pending_jobs.length}"
 
@@ -716,7 +817,7 @@ module OpenWFE
 
                         trigger job
 
-                        @pending_jobs.delete_at(0)
+                        @pending_jobs.delete_at 0
                     end
                 end
             end
@@ -724,28 +825,41 @@ module OpenWFE
             #
             # Triggers the job (in a dedicated thread).
             #
-            # If an error occurs in the job, it well get caught and an error
-            # message will be displayed to STDOUT.
-            # If this scheduler provides a lwarn(message) method, it will
-            # be used insted.
-            #
             def trigger (job)
 
                 Thread.new do
                     begin
+
                         job.trigger
+
                     rescue Exception => e
-                        message =
-                            "trigger() caught exception\n" + 
-                            OpenWFE::exception_to_s(e)
-                        if self.respond_to? :lwarn
-                            lwarn { message }
-                        else
-                            puts message
-                        end
+
+                        log_exception e
                     end
                 end
             end
+
+            #
+            # If an error occurs in the job, it well get caught and an error
+            # message will be displayed to STDOUT.
+            # If this scheduler provides a lwarn(message) method, it will
+            # be used insted.
+            #
+            # Of course, one can override this method.
+            #
+            def log_exception (e)
+
+                message =
+                    "trigger() caught exception\n" +
+                    e.to_s + "\n" +
+                    e.backtrace.join("\n")
+
+                if self.respond_to?(:lwarn)
+                    lwarn { message }
+                else
+                    puts message
+                end
+            end
     end
 
     #
@@ -1009,9 +1123,8 @@ module OpenWFE
             #
             def matches? (time)
 
-                if time.kind_of?(Float) or time.kind_of?(Integer)
-                    time = Time.at(time)
-                end
+                time = Time.at(time) \
+                    if time.kind_of?(Float) or time.kind_of?(Integer)
 
                 return false if no_match?(time.sec, @seconds)
                 return false if no_match?(time.min, @minutes)
@@ -1132,7 +1245,7 @@ module OpenWFE
                     result = []
 
                     value = istart
-                    while true
+                    loop do
 
                         result << value
                         value = value + inc

metadata

@@ -1,47 +1,54 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: openwferu-scheduler
 version: !ruby/object:Gem::Version 
-  version: 0.9.16
-date: 2007-11-19 00:00:00 +09:00
-summary: OpenWFEru scheduler for Ruby (at, cron and every)
-require_paths: 
-- lib
-email: john at openwfe dot org
-homepage: http://openwferu.rubyforge.org/scheduler.html
-rubyforge_project: 
-description: 
-autorequire: openwferu-scheduler
-default_executable: 
-bindir: bin
-has_rdoc: false
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.9.16.1404
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - John Mettraux
-files: 
-- lib/openwfe/util/otime.rb
-- lib/openwfe/util/scheduler.rb
-test_files: []
-
-rdoc_options: []
+autorequire: openwferu-scheduler
+bindir: bin
+cert_chain: []
 
-extra_rdoc_files: []
+date: 2007-12-28 00:00:00 +09:00
+default_executable: 
+dependencies: []
 
+description: 
+email: john at openwfe dot org
 executables: []
 
 extensions: []
 
+extra_rdoc_files: []
+
+files: 
+- lib/openwfe/util/otime.rb
+- lib/openwfe/util/scheduler.rb
+has_rdoc: false
+homepage: http://openwferu.rubyforge.org/scheduler.html
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
+rubyforge_project: 
+rubygems_version: 0.9.5
+signing_key: 
+specification_version: 2
+summary: OpenWFEru scheduler for Ruby (at, cron and every)
+test_files: []