rufus-scheduler 2.0.6 → 2.0.7

data/.gitignore

@@ -0,0 +1,2 @@
+.rvmrc
+rdoc

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/CHANGELOG.txt

@@ -2,6 +2,12 @@
 = rufus-scheduler CHANGELOG.txt
 
 
+== rufus-scheduler - 2.0.7    released 2010/11/09
+
+- cron and timezones, thanks Tanzeeb Khalili
+- Scheduler#trigger_threads, thanks Tim Uckun
+
+
 == rufus-scheduler - 2.0.6    released 2010/05/01
 
 - timeout jobs not outliving their parent job anymore, thanks Joel Wood

data/CREDITS.txt

@@ -4,6 +4,8 @@
 
 == Contributors
 
+- Tanzeeb Khalili (http://github.com/tanzeeb) cron and timezones
+- Adam Davies (http://github.com/adz), @allow_overlap = false
 - Klaas Jan Wierenga, at/every/in stress tests (1.0 and 2.0)
 - TobyH (http://github.com/tobyh), faster and cleaner CronLine#next_time
 

data/README.rdoc

@@ -10,13 +10,14 @@ rufus-scheduler is no replacement for cron/at since it runs inside of Ruby.
 
 A list of related Ruby projects :
 
-http://github.com/javan/whenever
-http://github.com/yakischloba/em-timers/
+* http://github.com/javan/whenever
+* http://github.com/yakischloba/em-timers
+* http://github.com/adamwiggins/clockwork
 
 More like complements :
 
-http://github.com/mojombo/chronic/
-http://github.com/hpoydar/chronic_duration
+* http://github.com/mojombo/chronic
+* http://github.com/hpoydar/chronic_duration
 
 
 == installation
@@ -69,6 +70,32 @@ Note that is there is EventMachine present and running,
 will return an instance of Rufus::Scheduler::EmScheduler (leveraging EventMachine).
 
 
+== a note about cron jobs
+
+This is a classical cron :
+
+  scheduler.cron '0 22 * * 1-5' do
+    # every day of the week at 22:00 (10pm)
+  end
+
+Rufus-scheduler supports two variants to that notation : seconds and timezones.
+
+  scheduler.cron '13 0 22 * * 1-5' do
+    # every day of the week at 22:00:13
+  end
+
+  scheduler.cron '0 22 * * 1-5 Europe/Paris' do
+    # every day of the week when it's 22:00 in Paris
+  end
+  scheduler.cron '0 22 * * 1-5 Etc/GMT+2' do
+    # every day of the week when it's 22:00 in GMT+2
+  end
+
+The timezones are the ones supported by the 'tzinfo' rubygem (http://tzinfo.rubyforge.org/).
+
+The timezone support was contributed by Tanzeeb Khalili.
+
+
 == scheduler.join
 
 Note that if you have a tiny script like this one :
@@ -187,10 +214,10 @@ In this example, the 'every' job will unschedule itself when the crop is ready.
 Sometimes passing a block isn't that convenient :
 
   class JobThing
-    def initialize (relevant_info)
+    def initialize(relevant_info)
       @ri = relevant_info
     end
-    def call (job)
+    def call(job)
       do_something_about_it
     end
   end
@@ -205,7 +232,7 @@ rufus-scheduler accepts anything that responds to a call method with a unique pa
 For compatibility with older (1.x) versions, schedulables with a trigger methods are accepted :
 
   class JobThing
-    def trigger (params)
+    def trigger(params)
       job = params[:job]
     end
   end
@@ -287,13 +314,13 @@ It's easy to customize that behaviour :
     # or
   #scheduler = Rufus::Scheduler::EmScheduler.start_new
 
-  def scheduler.handle_exception (job, exception)
+  def scheduler.handle_exception(job, exception)
     puts "job #{job.job_id} caught exception '#{exception}'"
   end
 
 For backward compatibility, overriding #log_exception is still OK :
 
-  def scheduler.log_exception (exception)
+  def scheduler.log_exception(exception)
     puts "caught exception '#{exception}'"
   end
 
@@ -334,13 +361,19 @@ More and more ruby applications are using EventMachine. This flavour of the sche
 
 == tested with
 
-ruby 1.8.6, ruby 1.9.1p0
-on jruby 1.2.0 it has some tiny issues (spec/blocking_spec.rb)
+* 1.8.7-p249
+* 1.9.1-p378
+* 1.9.2-p0
+* jruby-1.5.1
+
+on Mac OS X (Snow Leopard).
 
 
 == dependencies
 
-the ruby gem 'eventmachine' if you use Rufus::Scheduler::EmScheduler, else no other dependencies.
+The 'tzinfo' rubygem.
+
+The ruby gem 'eventmachine' if you use Rufus::Scheduler::EmScheduler, else no other dependencies.
 
 
 == mailing list

data/Rakefile

@@ -10,8 +10,18 @@ load 'lib/rufus/sc/version.rb'
 # CLEAN
 
 require 'rake/clean'
-CLEAN.include('pkg', 'tmp', 'html')
-task :default => [ :clean ]
+CLEAN.include('pkg', 'tmp', 'rdoc')
+
+
+#
+# TEST / SPEC
+
+task :spec do
+  sh 'rspec spec/'
+end
+task :test => :spec
+
+task :default => :spec
 
 
 #
@@ -35,12 +45,11 @@ Jeweler::Tasks.new do |gem|
   gem.authors = [ 'John Mettraux' ]
   gem.rubyforge_project = 'rufus'
 
-  gem.test_file = 'spec/spec.rb'
+  #gem.test_file = 'spec/spec.rb'
 
-  #gem.add_dependency 'yajl-ruby'
+  gem.add_dependency 'tzinfo'
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'yard'
-  gem.add_development_dependency 'bacon'
+  gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'jeweler'
 
   # gemspec spec : http://www.rubygems.org/read/chapter/20
@@ -51,33 +60,29 @@ 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
+#
+# make sure to have rdoc 2.5.x to run that
+#
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rd|
 
-rescue LoadError
+  rd.main = 'README.rdoc'
+  rd.rdoc_dir = 'rdoc/rufus-scheduler'
+  rd.title = "rufus-scheduler #{Rufus::Scheduler::VERSION}"
 
-  task :yard do
-    abort "YARD is not available : sudo gem install yard"
-  end
+  rd.rdoc_files.include(
+    'README.rdoc', 'CHANGELOG.txt', 'LICENSE.txt', 'CREDITS.txt', 'lib/**/*.rb')
 end
 
 
 #
 # TO THE WEB
 
-task :upload_website => [ :clean, :yard ] do
+task :upload_rdoc => [ :clean, :rdoc ] do
 
   account = 'jmettraux@rubyforge.org'
   webdir = '/var/www/gforge-projects/rufus'
 
-  sh "rsync -azv -e ssh html/rufus-scheduler #{account}:#{webdir}/"
+  sh "rsync -azv -e ssh rdoc/rufus-scheduler #{account}:#{webdir}/"
 end
 

data/lib/rufus/sc/cronline.rb

@@ -22,6 +22,8 @@
 # Made in Japan.
 #++
 
+require 'tzinfo'
+
 
 module Rufus
 
@@ -31,20 +33,19 @@ module Rufus
   #
   class CronLine
 
-    #
     # The string used for creating this cronline instance.
     #
     attr_reader :original
 
-    attr_reader \
-      :seconds,
-      :minutes,
-      :hours,
-      :days,
-      :months,
-      :weekdays
+    attr_reader :seconds
+    attr_reader :minutes
+    attr_reader :hours
+    attr_reader :days
+    attr_reader :months
+    attr_reader :weekdays
+    attr_reader :timezone
 
-    def initialize (line)
+    def initialize(line)
 
       super()
 
@@ -52,10 +53,12 @@ module Rufus
 
       items = line.split
 
-      unless items.length == 5 or items.length == 6
-        raise(
-          "cron '#{line}' string should hold 5 or 6 items, not #{items.length}")
-      end
+      @timezone = (TZInfo::Timezone.get(items.last) rescue nil)
+      items.pop if @timezone
+
+      raise ArgumentError.new(
+        "not a valid cronline : '#{line}'"
+      ) unless items.length == 5 or items.length == 6
 
       offset = items.length - 5
 
@@ -67,13 +70,14 @@ module Rufus
       @weekdays = parse_weekdays(items[4 + offset])
     end
 
-    #
     # Returns true if the given time matches this cron line.
     #
-    def matches? (time)
+    def matches?(time)
 
       time = Time.at(time) unless time.kind_of?(Time)
 
+      time = @timezone.utc_to_local(time.getutc) if @timezone
+
       return false unless sub_match?(time.sec, @seconds)
       return false unless sub_match?(time.min, @minutes)
       return false unless sub_match?(time.hour, @hours)
@@ -83,17 +87,6 @@ module Rufus
       true
     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 ]
-    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.
@@ -107,21 +100,26 @@ module Rufus
     # 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.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))
+    #   #=> 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
+    #   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)
+    def next_time(now=Time.now)
+
+      time = @timezone ? @timezone.utc_to_local(now.getutc) : now
 
-      time -= time.usec * 1e-6
-      time += 1
+      time = time - time.usec * 1e-6 + 1
+        # little adjustment before starting
 
       loop do
 
@@ -129,17 +127,14 @@ module Rufus
           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
@@ -148,16 +143,37 @@ module Rufus
         break
       end
 
+      if @timezone
+        time = @timezone.local_to_utc(time)
+        time = time.getlocal unless now.utc?
+      end
+
       time
     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,
+        @timezone ? @timezone.name : nil
+      ]
+    end
+
     private
 
     WDS = %w[ sun mon tue wed thu fri sat ]
-      #
       # used by parse_weekday()
 
-    def parse_weekdays (item)
+    def parse_weekdays(item)
 
       item = item.downcase
 
@@ -170,7 +186,7 @@ module Rufus
         r
     end
 
-    def parse_item (item, min, max)
+    def parse_item(item, min, max)
 
       return nil if item == '*'
       return parse_list(item, min, max) if item.index(',')
@@ -184,14 +200,14 @@ module Rufus
       [ i ]
     end
 
-    def parse_list (item, min, max)
+    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)
+    def parse_range(item, min, max)
 
       i = item.index('-')
       j = item.index('/')
@@ -235,16 +251,17 @@ module Rufus
     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

@@ -63,7 +63,7 @@ module Scheduler
 
     # Adds this job to the map.
     #
-    def << (job)
+    def <<(job)
 
       @mutex.synchronize do
         delete(job.job_id)
@@ -74,7 +74,7 @@ module Scheduler
 
     # Removes a job (given its id). Returns nil if the job was not found.
     #
-    def unschedule (job_id)
+    def unschedule(job_id)
 
       @mutex.synchronize { delete(job_id) }
     end
@@ -88,7 +88,7 @@ module Scheduler
 
     # Returns a list of jobs of the given type (:at|:in|:every)
     #
-    def select (type)
+    def select(type)
 
       type = JOB_TYPES[type]
       @jobs.select { |j| j.is_a?(type) }
@@ -101,7 +101,7 @@ module Scheduler
 
     protected
 
-    def delete (job_id)
+    def delete(job_id)
 
       j = @jobs.find { |j| j.job_id == job_id }
       @jobs.delete(j) if j
@@ -109,7 +109,7 @@ module Scheduler
 
     # Returns the next job to trigger. Returns nil if none eligible.
     #
-    def job_to_trigger (now)
+    def job_to_trigger(now)
 
       @mutex.synchronize do
         if @jobs.size > 0 && now.to_f >= @jobs.first.at
@@ -146,7 +146,7 @@ module Scheduler
       jobs.each { |job| job.trigger_if_matches(now) }
     end
 
-    def << (job)
+    def <<(job)
 
       @mutex.synchronize do
         delete(job.job_id)
@@ -154,7 +154,6 @@ module Scheduler
       end
     end
   end
-
 end
 end