rufus-scheduler 2.0.6 → 2.0.7

data/lib/rufus/sc/jobs.rb

@@ -67,16 +67,23 @@ module Scheduler
     #
     attr_reader :job_id
 
+    attr_accessor :running
 
     # Instantiating the job.
     #
-    def initialize (scheduler, t, params, &block)
+    def initialize(scheduler, t, params, &block)
 
       @scheduler = scheduler
       @t = t
       @params = params
       @block = block || params[:schedulable]
 
+      @running = false
+      @allow_overlapping = true
+      if !params[:allow_overlapping].nil?
+        @allow_overlapping = params[:allow_overlapping]
+      end
+
       raise ArgumentError.new(
         'no block or :schedulable passed, nothing to schedule'
       ) unless @block
@@ -98,7 +105,7 @@ module Scheduler
     # Sets the list of tags attached to the job (Usually they are set
     # via the schedule every/at/in/cron method).
     #
-    def tags= (tags)
+    def tags=(tags)
 
       @params[:tags] = Array(tags)
     end
@@ -113,18 +120,24 @@ module Scheduler
 
     # Triggers the job.
     #
-    def trigger (t=Time.now)
+    def trigger(t=Time.now)
 
       @last = t
       job_thread = nil
       to_job = nil
 
+      return if @running && !@allow_overlapping
+
+      @running = true
       @scheduler.send(:trigger_job, @params[:blocking]) do
         #
         # Note that #trigger_job is protected, hence the #send
         # (Only jobs know about this method of the scheduler)
 
         job_thread = Thread.current
+        job_thread[
+          "rufus_scheduler__trigger_thread__#{@scheduler.object_id}"
+        ] = true
         @last_job_thread = job_thread
 
         begin
@@ -134,6 +147,8 @@ module Scheduler
           job_thread = nil
           to_job.unschedule if to_job
 
+          @running = false
+
         rescue Exception => e
 
           @scheduler.handle_exception(self, e)
@@ -154,6 +169,7 @@ module Scheduler
           end
         end
       end
+
     end
 
     # Simply encapsulating the block#call/trigger operation, for easy
@@ -207,7 +223,7 @@ module Scheduler
     #
     attr_reader :parent
 
-    def initialize (scheduler, t, params)
+    def initialize(scheduler, t, params)
       @parent = params[:parent]
       super
     end
@@ -238,7 +254,7 @@ module Scheduler
     #
     attr_reader :frequency
 
-    def initialize (scheduler, t, params, &block)
+    def initialize(scheduler, t, params, &block)
       super
       determine_frequency
       determine_at
@@ -310,7 +326,7 @@ module Scheduler
 
     # Creates a new CronJob instance.
     #
-    def initialize (scheduler, cron_string, params, &block)
+    def initialize(scheduler, cron_string, params, &block)
 
       super
 
@@ -319,18 +335,19 @@ module Scheduler
         when String then CronLine.new(@t)
         when CronLine then @t
 
-        else raise "cannot initialize a CronJob out of #{@t.inspect}"
+        else raise ArgumentError.new(
+          "cannot initialize a CronJob out of #{@t.inspect}")
       end
     end
 
-    def trigger_if_matches (time)
+    def trigger_if_matches(time)
 
       trigger(time) if @cron_line.matches?(time)
     end
 
     # Returns the next time this job is meant to trigger
     #
-    def next_time (from=Time.now)
+    def next_time(from=Time.now)
 
       @cron_line.next_time(from)
     end
@@ -338,10 +355,10 @@ module Scheduler
     protected
 
     def determine_at
+
       # empty
     end
   end
-
 end
 end
 

data/lib/rufus/sc/rtime.rb

@@ -24,21 +24,37 @@
 
 
 require 'date'
-#require 'parsedate'
 
 
 module Rufus
 
+  #--
+  #
+  # keeping that as a note.
+  #
+  #require 'tzinfo'
+  #def time_zone(time)
+  #  offset = time.utc_offset / 3600
+  #  offset = offset < 0 ? offset.to_s : "+#{offset}"
+  #  TZInfo::Timezone.get("Etc/GMT#{offset}")
+  #end
+  #def timeshift(time, tz)
+  #  tz = TZInfo::Timezone.get(tz) unless tz.is_a?(TZInfo::Timezone)
+  #  t = tz.utc_to_local(time.getutc)
+  #  Time.parse(t.to_s[0..-5])
+  #end
+  #++
+
   # Returns the current time as an ISO date string
   #
   def Rufus.now
 
-    to_iso8601_date(Time.new())
+    to_iso8601_date(Time.new)
   end
 
   # As the name implies.
   #
-  def Rufus.to_iso8601_date (date)
+  def Rufus.to_iso8601_date(date)
 
     date = case date
       when Date then date
@@ -55,9 +71,9 @@ module Rufus
 
   # the old method we used to generate our ISO datetime strings
   #
-  def Rufus.time_to_iso8601_date (time)
+  def Rufus.time_to_iso8601_date(time)
 
-    s = time.getutc().strftime(TIME_FORMAT)
+    s = time.getutc.strftime(TIME_FORMAT)
     o = time.utc_offset / 3600
     o = "#{o}00"
     o = "0#{o}" if o.length < 4
@@ -68,7 +84,7 @@ module Rufus
 
   # Returns a Ruby time
   #
-  def Rufus.to_ruby_time (sdate)
+  def Rufus.to_ruby_time(sdate)
 
     DateTime.parse(sdate)
   end
@@ -99,12 +115,12 @@ module Rufus
   #
   #   Rufus.parse_time_string "0.5"    # => 0.5
   #   Rufus.parse_time_string "500"    # => 0.5
-  #   Rufus.parse_time_string "1000"     # => 1.0
+  #   Rufus.parse_time_string "1000"   # => 1.0
   #   Rufus.parse_time_string "1h"     # => 3600.0
-  #   Rufus.parse_time_string "1h10s"    # => 3610.0
-  #   Rufus.parse_time_string "1w2d"     # => 777600.0
+  #   Rufus.parse_time_string "1h10s"  # => 3610.0
+  #   Rufus.parse_time_string "1w2d"   # => 777600.0
   #
-  def Rufus.parse_time_string (string)
+  def Rufus.parse_time_string(string)
 
     return string.to_f if FLOAT_DURATION.match(string)
 
@@ -136,7 +152,7 @@ module Rufus
 
       multiplier = DURATIONS[c]
 
-      raise "unknown time char '#{c}'" unless multiplier
+      raise ArgumentError.new("unknown time char '#{c}'") unless multiplier
 
       result = result + (value * multiplier)
     end
@@ -148,8 +164,9 @@ module Rufus
     alias_method :parse_duration_string, :parse_time_string
   end
 
-  #
+  #--
   # conversion methods between Date[Time] and Time
+  #++
 
   #--
   # Ruby Cookbook 1st edition p.111
@@ -159,21 +176,14 @@ module Rufus
 
   # Converts a Time instance to a DateTime one
   #
-  def Rufus.to_datetime (time)
+  def Rufus.to_datetime(time)
 
     s = time.sec + Rational(time.usec, 10**6)
     o = Rational(time.utc_offset, 3600 * 24)
 
     begin
 
-      DateTime.new(
-        time.year,
-        time.month,
-        time.day,
-        time.hour,
-        time.min,
-        s,
-        o)
+      DateTime.new(time.year, time.month, time.day, time.hour, time.min, s, o)
 
     rescue Exception => e
 
@@ -188,17 +198,17 @@ module Rufus
     end
   end
 
-  def Rufus.to_gm_time (dtime)
+  def Rufus.to_gm_time(dtime)
 
     to_ttime(dtime.new_offset, :gm)
   end
 
-  def Rufus.to_local_time (dtime)
+  def Rufus.to_local_time(dtime)
 
     to_ttime(dtime.new_offset(DateTime.now.offset-offset), :local)
   end
 
-  def Rufus.to_ttime (d, method)
+  def Rufus.to_ttime(d, method)
 
     usec = (d.sec_fraction * 3600 * 24 * (10**6)).to_i
     Time.send(method, d.year, d.month, d.day, d.hour, d.min, d.sec, usec)
@@ -206,10 +216,10 @@ module Rufus
 
   # Turns a number of seconds into a a time string
   #
-  #   Rufus.to_duration_string 0          # => '0s'
-  #   Rufus.to_duration_string 60           # => '1m'
-  #   Rufus.to_duration_string 3661         # => '1h1m1s'
-  #   Rufus.to_duration_string 7 * 24 * 3600    # => '1w'
+  #   Rufus.to_duration_string 0                    # => '0s'
+  #   Rufus.to_duration_string 60                   # => '1m'
+  #   Rufus.to_duration_string 3661                 # => '1h1m1s'
+  #   Rufus.to_duration_string 7 * 24 * 3600        # => '1w'
   #   Rufus.to_duration_string 30 * 24 * 3600 + 1   # => "4w2d1s"
   #
   # It goes from seconds to the year. Months are not counted (as they
@@ -225,8 +235,8 @@ module Rufus
   # If a Float value is passed, milliseconds will be displayed without
   # 'marker'
   #
-  #   Rufus.to_duration_string 0.051             # =>"51"
-  #   Rufus.to_duration_string 7.051             # =>"7s51"
+  #   Rufus.to_duration_string 0.051                       # =>"51"
+  #   Rufus.to_duration_string 7.051                       # =>"7s51"
   #   Rufus.to_duration_string 0.120 + 30 * 24 * 3600 + 1  # =>"4w2d1s120"
   #
   # (this behaviour mirrors the one found for parse_time_string()).
@@ -238,18 +248,18 @@ module Rufus
   # * :drop_seconds, if set to true, seconds and milliseconds will be trimmed
   #   from the result
   #
-  def Rufus.to_duration_string (seconds, options={})
+  def Rufus.to_duration_string(seconds, options={})
 
     return (options[:drop_seconds] ? '0m' : '0s') if seconds <= 0
 
     h = to_duration_hash seconds, options
 
-    s = DU_KEYS.inject('') do |r, key|
+    s = DU_KEYS.inject('') { |r, key|
       count = h[key]
       count = nil if count == 0
       r << "#{count}#{key}" if count
       r
-    end
+    }
 
     ms = h[:ms]
     s << ms.to_s if ms
@@ -280,7 +290,7 @@ module Rufus
   # * :drop_seconds, if set to true, seconds and milliseconds will be trimmed
   #   from the result
   #
-  def Rufus.to_duration_hash (seconds, options={})
+  def Rufus.to_duration_hash(seconds, options={})
 
     h = {}
 
@@ -313,18 +323,17 @@ module Rufus
   #
   # will yield 10.0
   #
-  def Rufus.duration_to_f (s)
+  def Rufus.duration_to_f(s)
 
     return s if s.kind_of?(Float)
     return parse_time_string(s) if s.kind_of?(String)
     Float(s.to_s)
   end
 
-  #
   # Ensures an 'at' value is translated to a float
   # (to be compared with the float coming from time.to_f)
   #
-  def Rufus.at_to_f (at)
+  def Rufus.at_to_f(at)
 
     # TODO : use chronic if present
 
@@ -360,6 +369,5 @@ module Rufus
   end
 
   DU_KEYS = DURATIONS2M.collect { |k, v| k.to_sym }
-
 end
 

data/lib/rufus/sc/scheduler.rb

@@ -40,10 +40,10 @@ module Rufus::Scheduler
   # object quack (respond to :trigger anyway).
   #
   module Schedulable
-    def call (job)
+    def call(job)
       trigger(job.params)
     end
-    def trigger (params)
+    def trigger(params)
       raise NotImplementedError.new('implementation is missing')
     end
   end
@@ -61,7 +61,7 @@ module Rufus::Scheduler
   #
   module LegacyMethods
 
-    def find_jobs (tag=nil)
+    def find_jobs(tag=nil)
       tag ? find_by_tag(tag) : all_jobs.values
     end
     def at_job_count
@@ -97,7 +97,7 @@ module Rufus::Scheduler
 
     # Instantiates a Rufus::Scheduler.
     #
-    def initialize (opts={})
+    def initialize(opts={})
 
       @options = opts
 
@@ -109,7 +109,7 @@ module Rufus::Scheduler
 
     # Instantiates and starts a new Rufus::Scheduler.
     #
-    def self.start_new (opts={})
+    def self.start_new(opts={})
 
       s = self.new(opts)
       s.start
@@ -128,7 +128,7 @@ module Rufus::Scheduler
     #
     # will order an espresso (well sort of) in 20 minutes.
     #
-    def in (t, s=nil, opts={}, &block)
+    def in(t, s=nil, opts={}, &block)
 
       add_job(InJob.new(self, t, combine_opts(s, opts), &block))
     end
@@ -142,7 +142,7 @@ module Rufus::Scheduler
     #
     # pizza is for Thursday at 2000 (if the shop brochure is right).
     #
-    def at (t, s=nil, opts={}, &block)
+    def at(t, s=nil, opts={}, &block)
 
       add_job(AtJob.new(self, t, combine_opts(s, opts), &block))
     end
@@ -156,7 +156,7 @@ module Rufus::Scheduler
     #
     # checking blood pressure every 5 months and 1 week.
     #
-    def every (t, s=nil, opts={}, &block)
+    def every(t, s=nil, opts={}, &block)
 
       add_job(EveryJob.new(self, t, combine_opts(s, opts), &block))
     end
@@ -169,7 +169,7 @@ module Rufus::Scheduler
     #     puts 'activate security system'
     #   end
     #
-    def cron (cronstring, s=nil, opts={}, &block)
+    def cron(cronstring, s=nil, opts={}, &block)
 
       add_cron_job(CronJob.new(self, cronstring, combine_opts(s, opts), &block))
     end
@@ -179,7 +179,7 @@ module Rufus::Scheduler
     #
     # Returns the job that got unscheduled.
     #
-    def unschedule (job_id)
+    def unschedule(job_id)
 
       @jobs.unschedule(job_id) || @cron_jobs.unschedule(job_id)
     end
@@ -191,7 +191,7 @@ module Rufus::Scheduler
     # Feel free to override this method. The default implementation simply
     # outputs the error message to STDOUT
     #
-    def handle_exception (job, exception)
+    def handle_exception(job, exception)
 
       if self.respond_to?(:log_exception)
         #
@@ -236,18 +236,28 @@ module Rufus::Scheduler
 
     # Returns a list of jobs with the given tag
     #
-    def find_by_tag (tag)
+    def find_by_tag(tag)
 
       all_jobs.values.select { |j| j.tags.include?(tag) }
     end
 
+    # Returns the current list of trigger threads (threads) dedicated to
+    # the execution of jobs.
+    #
+    def trigger_threads
+
+      Thread.list.select { |t|
+        t["rufus_scheduler__trigger_thread__#{self.object_id}"] == true
+      }
+    end
+
     protected
 
     # Returns a job queue instance.
     #
     # (made it into a method for easy override)
     #
-    def get_queue (type, opts)
+    def get_queue(type, opts)
 
       q = if type == :cron
         opts[:cron_job_queue] || Rufus::Scheduler::CronJobQueue.new
@@ -260,7 +270,7 @@ module Rufus::Scheduler
       q
     end
 
-    def combine_opts (schedulable, opts)
+    def combine_opts(schedulable, opts)
 
       if schedulable.respond_to?(:trigger) || schedulable.respond_to?(:call)
 
@@ -283,7 +293,7 @@ module Rufus::Scheduler
       @jobs.trigger_matching_jobs
     end
 
-    def add_job (job)
+    def add_job(job)
 
       complain_if_blocking_and_timeout(job)
 
@@ -294,7 +304,7 @@ module Rufus::Scheduler
       job
     end
 
-    def add_cron_job (job)
+    def add_cron_job(job)
 
       complain_if_blocking_and_timeout(job)
 
@@ -305,7 +315,7 @@ module Rufus::Scheduler
 
     # Raises an error if the job has the params :blocking and :timeout set
     #
-    def complain_if_blocking_and_timeout (job)
+    def complain_if_blocking_and_timeout(job)
 
       raise(
         ArgumentError.new('cannot set a :timeout on a :blocking job')
@@ -319,7 +329,7 @@ module Rufus::Scheduler
     # TODO : clarify, the blocking here blocks the whole scheduler, while
     # EmScheduler blocking triggers for the next tick. Not the same thing ...
     #
-    def trigger_job (blocking, &block)
+    def trigger_job(blocking, &block)
 
       if blocking
         block.call
@@ -353,7 +363,7 @@ module Rufus::Scheduler
         "#{self.class} - #{Rufus::Scheduler::VERSION}"
     end
 
-    def stop (opts={})
+    def stop(opts={})
 
       @thread.exit
     end
@@ -376,7 +386,7 @@ module Rufus::Scheduler
   #
   class SignalScheduler < SchedulerCore
 
-    def initialize (opts={})
+    def initialize(opts={})
 
       super(opts)
 
@@ -397,7 +407,7 @@ module Rufus::Scheduler
   #
   class EmScheduler < SchedulerCore
 
-    def initialize (opts={})
+    def initialize(opts={})
 
       raise LoadError.new(
         'EventMachine missing, "require \'eventmachine\'" might help'
@@ -431,7 +441,7 @@ module Rufus::Scheduler
     # If the :stop_em option is passed and set to true, it will stop the
     # EventMachine (but only if it started the EM by itself !).
     #
-    def stop (opts={})
+    def stop(opts={})
 
       @timer.cancel
 
@@ -451,7 +461,7 @@ module Rufus::Scheduler
     # If 'blocking' is set to true, the block will get called at the
     # 'next_tick'. Else the block will get called via 'defer' (own thread).
     #
-    def trigger_job (blocking, &block)
+    def trigger_job(blocking, &block)
 
       m = blocking ? :next_tick : :defer
         #