tanzeeb-rufus-scheduler 2.0.7.2

data/Rakefile

@@ -0,0 +1,86 @@
+
+require 'rubygems'
+require 'rake'
+
+
+load 'lib/rufus/sc/version.rb'
+
+
+#
+# CLEAN
+
+require 'rake/clean'
+CLEAN.include('pkg', 'tmp', 'html')
+task :default => [ :clean ]
+
+
+#
+# GEM
+
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+
+  gem.version = Rufus::Scheduler::VERSION
+  gem.name = 'tanzeeb-rufus-scheduler'
+  gem.summary = 'job scheduler for Ruby (at, cron, in and every jobs)'
+
+  gem.description = %{
+    job scheduler for Ruby (at, cron, in and every jobs).
+
+    By default uses a Ruby thread, if EventMachine is present, it will rely on it.
+
+    This fork adds timezone support to cron schedules.
+  }
+  gem.email = 'tanzeeb@gmail.com'
+  gem.homepage = 'http://github.com/tanzeeb/rufus-scheduler/'
+  gem.authors = [ 'John Mettraux', 'Tanzeeb Khalili', 'Matt Briggs', 'Sean Kirby' ]
+  gem.rubyforge_project = 'rufus'
+
+  gem.test_file = 'spec/spec.rb'
+
+  #gem.add_dependency 'yajl-ruby'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'bacon'
+  gem.add_development_dependency 'jeweler'
+  gem.add_dependency 'tzinfo'
+
+  # gemspec spec : http://www.rubygems.org/read/chapter/20
+end
+Jeweler::GemcutterTasks.new
+
+
+#
+# DOC
+
+begin
+
+  require 'yard'
+
+  YARD::Rake::YardocTask.new do |doc|
+    doc.options = [
+      '-o', 'html/rufus-scheduler', '--title',
+      "rufus-scheduler #{Rufus::Scheduler::VERSION}"
+    ]
+  end
+
+rescue LoadError
+
+  task :yard do
+    abort "YARD is not available : sudo gem install yard"
+  end
+end
+
+
+#
+# TO THE WEB
+
+task :upload_website => [ :clean, :yard ] do
+
+  account = 'jmettraux@rubyforge.org'
+  webdir = '/var/www/gforge-projects/rufus'
+
+  sh "rsync -azv -e ssh html/rufus-scheduler #{account}:#{webdir}/"
+end
+

data/TODO.txt

@@ -0,0 +1,57 @@
+
+[o] spec for jobs in the past (in and at)
+[o] :discard_past
+
+[o] every
+[o] cron
+
+[o] CHECK every and unschedule !!!
+
+[o] :tags
+[o] timeout feature (at/in/every/cron) in Job class
+
+[o] :first_in, :first_at
+
+[x] :dont_reschedule (or block returns false ?)
+
+[o] [get_]jobs methods
+[o] find methods
+
+[x] CTRL-C during tests : allow, trap_int...
+
+[o] 1.9
+[o] j1.2.0
+
+[o] revise trigger block arity
+    use a compatibility switch ? yes
+
+[o] synchronize @cron_jobs ?
+
+[o] why not : make it work even if EM is not present
+    EmScheduler < Scheduler
+    FiberScheduler < Scheduler
+
+[x] :blocking => 'blockname' idea, mutex = @mutexes['blockname'] ...
+[o] eventually, make sleep frequency customizable
+
+[o] PlainScheduler : name thread
+
+[o] document :blocking
+
+[o] README.rdoc
+[o] fix jruby120 --em
+
+[o] handle_exception (job, e)
+
+[o] Schedulable
+
+[o] Rufus::Scheduler.start_new() : autodetect EM ?
+[o] check :blocking and every (reschedule blocking...)
+[o] document :thread_name scheduler option
+
+[o] unify cron_jobs#trigger_matching_jobs(now) and jobs#job_to_trigger
+[o] pluggable job queues
+
+[ ] Joel's complaint about timeout jobs gone ballistic
+[x] move trigger_job out of the scheduler
+

data/lib/rufus-scheduler.rb

@@ -0,0 +1,3 @@
+
+require 'rufus/sc/scheduler'
+

data/lib/rufus/otime.rb

@@ -0,0 +1,3 @@
+
+require 'rufus/sc/rtime.rb'
+

data/lib/rufus/sc/cronline.rb

@@ -0,0 +1,281 @@
+#--
+# Copyright (c) 2006-2010, John Mettraux, jmettraux@gmail.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# 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
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# Made in Japan.
+#++
+
+require 'tzinfo'
+
+module Rufus
+
+  #
+  # A 'cron line' is a line in the sense of a crontab
+  # (man 5 crontab) file line.
+  #
+  class CronLine
+
+    #
+    # The string used for creating this cronline instance.
+    #
+    attr_reader :original
+
+    attr_reader \
+      :seconds,
+      :minutes,
+      :hours,
+      :days,
+      :months,
+      :weekdays,
+      :zone
+
+    def initialize (line)
+
+      super()
+
+      @original = line
+
+      times, zone = line.split(' : ')
+      items = times.split
+      
+      @zone = parse_zone(zone.to_s)
+
+      if zone && !@zone
+        raise "zone '#{zone}' is an invalid timezone"
+      end
+
+      unless items.length == 5 or items.length == 6 
+        raise(
+          "cron '#{line}' string should hold 5 or 6 items, not #{items.length}")
+      end
+
+      offset = items.length - 5
+
+      @seconds = offset == 1 ? parse_item(items[0], 0, 59) : [ 0 ]
+      @minutes = parse_item(items[0 + offset], 0, 59)
+      @hours = parse_item(items[1 + offset], 0, 24)
+      @days = parse_item(items[2 + offset], 1, 31)
+      @months = parse_item(items[3 + offset], 1, 12)
+      @weekdays = parse_weekdays(items[4 + offset])
+
+    end
+
+    #
+    # Returns true if the given time matches this cron line.
+    #
+    def matches? (time)
+      time = Time.at(time) unless time.kind_of?(Time)
+
+      if @zone
+        utc = time.utc?
+        time = time.getutc unless utc
+        time = @zone.utc_to_local time
+      end
+
+      [
+        sub_match?(time.sec, @seconds),
+        sub_match?(time.min, @minutes),
+        sub_match?(time.hour, @hours),
+        sub_match?(time.day, @days),
+        sub_match?(time.month, @months),
+        sub_match?(time.wday, @weekdays)
+      ].all?
+    end
+
+    #
+    # Returns an array of 6 arrays (seconds, minutes, hours, days,
+    # months, weekdays).
+    # This method is used by the cronline unit tests.
+    #
+    def to_array
+
+      [ @seconds, @minutes, @hours, @days, @months, @weekdays, (@zone.name if @zone) ]
+    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.
+    # (Well, I was wrong, takes 0.001 sec on 1.8.7 and 1.9.1)
+    #
+    # 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 (time=Time.now)
+
+      if @zone
+        utc = time.utc?
+        time = time.getutc unless utc
+        time = @zone.utc_to_local time
+      end
+
+      time -= time.usec * 1e-6
+      time += 1
+
+      loop do
+
+        unless date_match?(time)
+          time += (24 - time.hour) * 3600 - time.min * 60 - time.sec
+          next
+        end
+
+        unless sub_match?(time.hour, @hours)
+          time += (60 - time.min) * 60 - time.sec
+          next
+        end
+
+        unless sub_match?(time.min, @minutes)
+          time += 60 - time.sec
+          next
+        end
+
+        unless sub_match?(time.sec, @seconds)
+          time += 1
+          next
+        end
+
+        break
+      end
+
+      if @zone
+        time = @zone.local_to_utc time
+        time = time.getlocal unless utc
+      end
+
+      time
+    end
+
+    private
+
+    WDS = %w[ sun mon tue wed thu fri sat ]
+      #
+      # used by parse_weekday()
+
+    def parse_weekdays (item)
+
+      item = item.downcase
+
+      WDS.each_with_index { |day, index| item = item.gsub(day, index.to_s) }
+
+      r = parse_item(item, 0, 7)
+
+      r.is_a?(Array) ?
+        r.collect { |e| e == 7 ? 0 : e }.uniq :
+        r
+    end
+
+    def parse_item (item, min, max)
+
+      return nil if item == '*'
+      return parse_list(item, min, max) if item.index(',')
+      return parse_range(item, min, max) if item.index('*') or item.index('-')
+
+      i = Integer(item)
+
+      i = min if i < min
+      i = max if i > max
+
+      [ i ]
+    end
+
+    def parse_list (item, min, max)
+
+      item.split(',').inject([]) { |r, i|
+        r.push(parse_range(i, min, max))
+      }.flatten
+    end
+
+    def parse_range (item, min, max)
+
+      i = item.index('-')
+      j = item.index('/')
+
+      return item.to_i if (not i and not j)
+
+      inc = j ? Integer(item[j+1..-1]) : 1
+
+      istart = -1
+      iend = -1
+
+      if i
+
+        istart = Integer(item[0..i - 1])
+
+        if j
+          iend = Integer(item[i + 1..j])
+        else
+          iend = Integer(item[i + 1..-1])
+        end
+
+      else # case */x
+
+        istart = min
+        iend = max
+      end
+
+      istart = min if istart < min
+      iend = max if iend > max
+
+      result = []
+
+      value = istart
+      loop do
+        result << value
+        value = value + inc
+        break if value > iend
+      end
+
+      result
+    end
+
+    def parse_zone zone
+      TZInfo::Timezone.get(zone) rescue nil
+    end
+
+    def sub_match?(value, values)
+      values.nil? || values.include?(value)
+    end
+
+    def date_match?(date)
+      return false unless sub_match?(date.day, @days)
+      return false unless sub_match?(date.month, @months)
+      return false unless sub_match?(date.wday, @weekdays)
+      true
+    end
+  end
+
+end
+

data/lib/rufus/sc/jobqueues.rb

@@ -0,0 +1,160 @@
+#--
+# Copyright (c) 2006-2010, John Mettraux, jmettraux@gmail.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# 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
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# Made in Japan.
+#++
+
+
+require 'thread'
+
+
+module Rufus
+module Scheduler
+
+  #
+  # Tracking at/in/every jobs.
+  #
+  # In order of trigger time.
+  #
+  class JobQueue
+
+    # Mapping :at|:in|:every to their respective job classes.
+    #
+    JOB_TYPES = {
+      :at => Rufus::Scheduler::AtJob,
+      :in => Rufus::Scheduler::InJob,
+      :every => Rufus::Scheduler::EveryJob
+    }
+
+    def initialize
+
+      @mutex = Mutex.new
+      @jobs = []
+    end
+
+    # Triggers all the jobs that are scheduled for 'now'.
+    #
+    def trigger_matching_jobs
+
+      now = Time.now
+
+      while job = job_to_trigger(now)
+        job.trigger
+      end
+    end
+
+    # Adds this job to the map.
+    #
+    def << (job)
+
+      @mutex.synchronize do
+        delete(job.job_id)
+        @jobs << job
+        @jobs.sort! { |j0, j1| j0.at <=> j1.at }
+      end
+    end
+
+    # Removes a job (given its id). Returns nil if the job was not found.
+    #
+    def unschedule (job_id)
+
+      @mutex.synchronize { delete(job_id) }
+    end
+
+    # Returns a mapping job_id => job
+    #
+    def to_h
+
+      @jobs.inject({}) { |h, j| h[j.job_id] = j; h }
+    end
+
+    # Returns a list of jobs of the given type (:at|:in|:every)
+    #
+    def select (type)
+
+      type = JOB_TYPES[type]
+      @jobs.select { |j| j.is_a?(type) }
+    end
+
+    def size
+
+      @jobs.size
+    end
+
+    protected
+
+    def delete (job_id)
+
+      j = @jobs.find { |j| j.job_id == job_id }
+      @jobs.delete(j) if j
+    end
+
+    # Returns the next job to trigger. Returns nil if none eligible.
+    #
+    def job_to_trigger (now)
+
+      @mutex.synchronize do
+        if @jobs.size > 0 && now.to_f >= @jobs.first.at
+          @jobs.shift
+        else
+          nil
+        end
+      end
+    end
+  end
+
+  #
+  # Tracking cron jobs.
+  #
+  class CronJobQueue < JobQueue
+
+    def initialize
+
+      super
+      @last_cron_second = nil
+    end
+
+    def trigger_matching_jobs
+
+      now = Time.now
+
+      return if now.sec == @last_cron_second
+      @last_cron_second = now.sec
+        #
+        # ensuring the crons are checked within 1 second (not 1.2 second)
+
+      jobs = @mutex.synchronize { @jobs.dup }
+
+      jobs.each { |job| job.trigger_if_matches(now) }
+    end
+
+    def << (job)
+
+      @mutex.synchronize do
+        delete(job.job_id)
+        @jobs << job
+      end
+    end
+  end
+
+end
+end
+