rufus-scheduler 2.0.8 → 2.0.9

data/CHANGELOG.txt

@@ -2,6 +2,13 @@
 = rufus-scheduler CHANGELOG.txt
 
 
+== rufus-scheduler - 2.0.9    released 2010/04/22
+
+- Scheduler#first_at and :discard_past => true. Thanks concept47
+- Scheduler#cron and monthdays (sun#2 or mon#1)
+- Scheduler#unschedule_by_tag(t)
+
+
 == rufus-scheduler - 2.0.8    released 2010/12/31
 
 - issue with cron '0 7-23/2 * * *' fixed. Thanks Pickerel

data/CREDITS.txt

@@ -4,6 +4,7 @@
 
 == Contributors
 
+- concept47 (https://github.com/concept47) every and :discard_past
 - Chris Kampemeier (http://github.com/chrisk) rspec 2.0 refinements
 - Tanzeeb Khalili (http://github.com/tanzeeb) cron and timezones
 - Adam Davies (http://github.com/adz), @allow_overlap = false
@@ -13,6 +14,7 @@
 
 == Feedback
 
+- Defusal - unschedule_by_tag
 - pickerel - https://github.com/pickerel
 - Gonzalo Suarez - parse_time_string(s) issue
 - Tony Day - http://github.com/tonyday - every and overlapping timeout issue

data/README.rdoc

@@ -22,7 +22,7 @@ More like complements :
 
 == installation
 
-  sudo gem install rufus-scheduler --source http://gemcutter.org
+  gem install rufus-scheduler
 
 
 == usage
@@ -95,6 +95,12 @@ The timezones are the ones supported by the 'tzinfo' rubygem (http://tzinfo.ruby
 
 The timezone support was contributed by Tanzeeb Khalili.
 
+Since 2.0.9, "monthdays" are supported
+
+  scheduler.cron '0 22 * * sun#1,sun#2' do
+    # every first and second sunday of the month, at 22:00
+  end
+
 
 == scheduler.join
 
@@ -166,7 +172,7 @@ Jobs scheduled with the :blocking parameter will run in the thread of the schedu
     puts "order espresso"
   end
 
-Hence, our espresso wil come in 22 minutes instead of 21.
+Hence, our espresso will come in 22 minutes instead of 21.
 
 
 == 'every' jobs and :first_at / :first_in
@@ -191,6 +197,8 @@ The chronic gem may help (http://chronic.rubyforge.org/) :
     # do something starting this tueday
   end
 
+Note : setting a :first_at/:first_in in the past will get rufus-scheduler to trigger for all the past schedules until now. Adding :discard_past => true will prevent this.
+
 
 == self unschedule for 'cron' and 'every' jobs
 

data/Rakefile

@@ -2,6 +2,7 @@
 $:.unshift('.') # 1.9.2
 
 require 'rubygems'
+require 'rubygems/user_interaction' if Gem::RubyGemsVersion == '1.5.0'
 
 require 'rake'
 require 'rake/clean'
@@ -78,7 +79,7 @@ desc %{
 task :upload_rdoc => [ :clean, :rdoc ] do
 
   account = 'jmettraux@rubyforge.org'
-  webdir = "/var/www/gforge-projects/rufus"
+  webdir = '/var/www/gforge-projects/rufus'
 
   sh "rsync -azv -e ssh rdoc/#{GEMSPEC.name} #{account}:#{webdir}/"
 end

data/lib/rufus/sc/cronline.rb

@@ -43,6 +43,7 @@ module Rufus
     attr_reader :days
     attr_reader :months
     attr_reader :weekdays
+    attr_reader :monthdays
     attr_reader :timezone
 
     def initialize(line)
@@ -67,7 +68,7 @@ module Rufus
       @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])
+      @weekdays, @monthdays = parse_weekdays(items[4 + offset])
     end
 
     # Returns true if the given time matches this cron line.
@@ -81,9 +82,7 @@ module Rufus
       return false unless sub_match?(time.sec, @seconds)
       return false unless sub_match?(time.min, @minutes)
       return false unless sub_match?(time.hour, @hours)
-      return false unless sub_match?(time.day, @days)
-      return false unless sub_match?(time.month, @months)
-      return false unless sub_match?(time.wday, @weekdays)
+      return false unless date_match?(time)
       true
     end
 
@@ -164,26 +163,47 @@ module Rufus
         @days,
         @months,
         @weekdays,
+        @monthdays,
         @timezone ? @timezone.name : nil
       ]
     end
 
     private
 
-    WDS = %w[ sun mon tue wed thu fri sat ]
-      # used by parse_weekday()
+    WEEKDAYS = %w[ sun mon tue wed thu fri sat ]
 
     def parse_weekdays(item)
 
-      item = item.downcase
+      return nil if item == '*'
+
+      items = item.downcase.split(',')
+
+      weekdays = nil
+      monthdays = nil
+
+      items.each do |it|
+
+        if it.match(/#[12345]$/)
+
+          raise ArgumentError.new(
+            "ranges are not supported for monthdays (#{it})"
+          ) if it.index('-')
 
-      WDS.each_with_index { |day, index| item = item.gsub(day, index.to_s) }
+          (monthdays ||= []) << it
+        else
+
+          WEEKDAYS.each_with_index { |a, i| it.gsub!(/#{a}/, i.to_s) }
+
+          its = it.index('-') ? parse_range(it, 0, 7) : [ Integer(it) ]
+          its = its.collect { |i| i == 7 ? 0 : i }
+
+          (weekdays ||= []).concat(its)
+        end
+      end
 
-      r = parse_item(item, 0, 7)
+      weekdays = weekdays.uniq if weekdays
 
-      r.is_a?(Array) ?
-        r.collect { |e| e == 7 ? 0 : e }.uniq :
-        r
+      [ weekdays, monthdays ]
     end
 
     def parse_item(item, min, max)
@@ -255,13 +275,36 @@ module Rufus
       values.nil? || values.include?(value)
     end
 
+    def monthday_match(monthday, monthdays)
+
+      return true if monthdays == nil
+      return true if monthdays.include?(monthday)
+    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)
+      return false unless sub_match?(CronLine.monthday(date), @monthdays)
       true
     end
+
+    DAY_IN_SECONDS = 7 * 24 * 3600
+
+    def self.monthday(date)
+
+      count = 1
+      date2 = date.dup
+
+      loop do
+        date2 = date2 - DAY_IN_SECONDS
+        break if date2.month != date.month
+        count = count + 1
+      end
+
+      "#{WEEKDAYS[date.wday]}##{count}"
+    end
   end
 end
 

data/lib/rufus/sc/jobs.rb

@@ -255,7 +255,9 @@ module Scheduler
     attr_reader :frequency
 
     def initialize(scheduler, t, params, &block)
+
       super
+
       determine_frequency
       determine_at
     end
@@ -284,17 +286,23 @@ module Scheduler
       @last = @at
         # the first time, @last will be nil
 
+      now = Time.now.to_f
+
       @at = if @last
         @last + @frequency
       else
         if fi = @params[:first_in]
-          Time.now.to_f + Rufus.duration_to_f(fi)
+          now + Rufus.duration_to_f(fi)
         elsif fa = @params[:first_at]
           Rufus.at_to_f(fa)
         else
-          Time.now.to_f + @frequency
+          now + @frequency
         end
       end
+
+      while @at < now do
+        @at += @frequency
+      end if @params[:discard_past]
     end
 
     # It's an every job, have to schedule next time it occurs...

data/lib/rufus/sc/scheduler.rb

@@ -184,6 +184,16 @@ module Rufus::Scheduler
       @jobs.unschedule(job_id) || @cron_jobs.unschedule(job_id)
     end
 
+    # Given a tag, unschedules all the jobs that bear that tag.
+    #
+    def unschedule_by_tag(tag)
+
+      jobs = find_by_tag(tag)
+      jobs.each { |job| unschedule(job.job_id) }
+
+      jobs
+    end
+
     #--
     # MISC
     #++
@@ -297,7 +307,7 @@ module Rufus::Scheduler
 
       complain_if_blocking_and_timeout(job)
 
-      return if job.params[:discard_past] && Time.now.to_f >= job.at
+      return nil if job.params[:discard_past] && Time.now.to_f >= job.at
 
       @jobs << job
 

data/lib/rufus/sc/version.rb

@@ -26,7 +26,7 @@
 module Rufus
 module Scheduler
 
-  VERSION = '2.0.8'
+  VERSION = '2.0.9'
 end
 end
 

data/rufus-scheduler.gemspec

@@ -1,9 +1,12 @@
 # encoding: utf-8
 
+load 'lib/rufus/sc/version.rb'
+
+
 Gem::Specification.new do |s|
 
   s.name = 'rufus-scheduler'
-  s.version = File.read('lib/rufus/sc/version.rb').match(/VERSION = '([^']+)'/)[1]
+  s.version = Rufus::Scheduler::VERSION
   s.platform = Gem::Platform::RUBY
   s.authors = [ 'John Mettraux' ]
   s.email = [ 'jmettraux@gmail.com' ]

data/spec/at_spec.rb

@@ -84,6 +84,21 @@ describe "#{SCHEDULER_CLASS}#schedule_at" do
     @s.find_by_tag('spec').size.should == 1
     @s.find_by_tag('spec').first.job_id.should == job.job_id
   end
+
+  it 'accepts unschedule_by_tag' do
+
+    3.times do
+      @s.at Time.now + 3 * 3600, :tags => 'spec' do
+      end
+    end
+
+    sleep 0.500
+
+    r = @s.unschedule_by_tag('spec')
+
+    r.size.should == 3
+    r.first.class.should == Rufus::Scheduler::AtJob
+  end
 end
 
 describe Rufus::Scheduler::AtJob do

data/spec/cronline_spec.rb

@@ -17,6 +17,9 @@ describe Rufus::CronLine do
   def match(line, time)
     cl(line).matches?(time).should == true
   end
+  def no_match(line, time)
+    cl(line).matches?(time).should == false
+  end
   def to_a(line, array)
     cl(line).to_array.should == array
   end
@@ -32,29 +35,31 @@ describe Rufus::CronLine do
 
     it 'interprets cron strings correctly' do
 
-      to_a '* * * * *', [ [0], nil, nil, nil, nil, nil, nil ]
-      to_a '10-12 * * * *', [ [0], [10, 11, 12], nil, nil, nil, nil, nil ]
-      to_a '* * * * sun,mon', [ [0], nil, nil, nil, nil, [0, 1], nil ]
-      to_a '* * * * mon-wed', [ [0], nil, nil, nil, nil, [1, 2, 3], nil ]
-      to_a '* * * * 7', [ [0], nil, nil, nil, nil, [0], nil ]
-      to_a '* * * * 0', [ [0], nil, nil, nil, nil, [0], nil ]
-      to_a '* * * * 0,1', [ [0], nil, nil, nil, nil, [0,1], nil ]
-      to_a '* * * * 7,1', [ [0], nil, nil, nil, nil, [0,1], nil ]
-      to_a '* * * * 7,0', [ [0], nil, nil, nil, nil, [0], nil ]
-      to_a '* * * * sun,2-4', [ [0], nil, nil, nil, nil, [0, 2, 3, 4], nil ]
-
-      to_a '* * * * sun,mon-tue', [ [0], nil, nil, nil, nil, [0, 1, 2], nil ]
-
-      to_a '* * * * * *', [ nil, nil, nil, nil, nil, nil, nil ]
-      to_a '1 * * * * *', [ [1], nil, nil, nil, nil, nil, nil ]
-      to_a '7 10-12 * * * *', [ [7], [10, 11, 12], nil, nil, nil, nil, nil ]
-      to_a '1-5 * * * * *', [ [1,2,3,4,5], nil, nil, nil, nil, nil, nil ]
+      to_a '* * * * *', [ [0], nil, nil, nil, nil, nil, nil, nil ]
+      to_a '10-12 * * * *', [ [0], [10, 11, 12], nil, nil, nil, nil, nil, nil ]
+      to_a '* * * * sun,mon', [ [0], nil, nil, nil, nil, [0, 1], nil, nil ]
+      to_a '* * * * mon-wed', [ [0], nil, nil, nil, nil, [1, 2, 3], nil, nil ]
+      to_a '* * * * 7', [ [0], nil, nil, nil, nil, [0], nil, nil ]
+      to_a '* * * * 0', [ [0], nil, nil, nil, nil, [0], nil, nil ]
+      to_a '* * * * 0,1', [ [0], nil, nil, nil, nil, [0,1], nil, nil ]
+      to_a '* * * * 7,1', [ [0], nil, nil, nil, nil, [0,1], nil, nil ]
+      to_a '* * * * 7,0', [ [0], nil, nil, nil, nil, [0], nil, nil ]
+      to_a '* * * * sun,2-4', [ [0], nil, nil, nil, nil, [0, 2, 3, 4], nil, nil ]
+
+      to_a '* * * * sun,mon-tue', [ [0], nil, nil, nil, nil, [0, 1, 2], nil, nil ]
+
+      to_a '* * * * * *', [ nil, nil, nil, nil, nil, nil, nil, nil ]
+      to_a '1 * * * * *', [ [1], nil, nil, nil, nil, nil, nil, nil ]
+      to_a '7 10-12 * * * *', [ [7], [10, 11, 12], nil, nil, nil, nil, nil, nil ]
+      to_a '1-5 * * * * *', [ [1,2,3,4,5], nil, nil, nil, nil, nil, nil, nil ]
+
+      to_a '0 0 1 1 *', [ [0], [0], [0], [1], [1], nil, nil, nil ]
     end
 
     it 'interprets cron strings with TZ correctly' do
 
-      to_a '* * * * * EST', [ [0], nil, nil, nil, nil, nil, 'EST' ]
-      to_a '* * * * * * EST', [ nil, nil, nil, nil, nil, nil, 'EST' ]
+      to_a '* * * * * EST', [ [0], nil, nil, nil, nil, nil, nil, 'EST' ]
+      to_a '* * * * * * EST', [ nil, nil, nil, nil, nil, nil, nil, 'EST' ]
 
       lambda { cl '* * * * * NotATimeZone' }.should raise_error
       lambda { cl '* * * * * * NotATimeZone' }.should raise_error
@@ -64,13 +69,20 @@ describe Rufus::CronLine do
 
       to_a(
         '0 */2 * * *',
-        [[0], [0], [0, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24], nil, nil, nil, nil])
+        [ [0], [0], (0..12).collect { |e| e * 2 }, nil, nil, nil, nil, nil ])
       to_a(
         '0 7-23/2 * * *',
-        [[0], [0], [7, 9, 11, 13, 15, 17, 19, 21, 23], nil, nil, nil, nil])
+        [ [0], [0], (7..23).select { |e| e.odd? }, nil, nil, nil, nil, nil ])
       to_a(
         '*/10 * * * *',
-        [[0], [0, 10, 20, 30, 40, 50], nil, nil, nil, nil, nil])
+        [ [0], [0, 10, 20, 30, 40, 50], nil, nil, nil, nil, nil, nil ])
+    end
+
+    it 'does not support ranges for monthdays (sun#1-sun#2)' do
+
+      lambda {
+        Rufus::CronLine.new('* * * * sun#1-sun#2')
+      }.should raise_error(ArgumentError)
     end
   end
 
@@ -99,10 +111,6 @@ describe Rufus::CronLine do
       nt('* * * * *', now).should == now + 1
     end
 
-#
-# the specs that follow are from Tanzeeb Khalili
-#
-
     it 'computes the next occurence correctly in UTC (TZ not specified)' do
 
       now = utc(1970, 1, 1)
@@ -166,6 +174,29 @@ describe Rufus::CronLine do
     #  nt("* * 1 6 * #{zone}", now).should == local(1970, 5, 31, 19)
     #  nt("0 0 * * thu #{zone}", now).should == local(1970, 1, 7, 18)
     #end
+
+    it 'computes the next time correctly when there is a sun#2 involved' do
+
+      now = local(1970, 1, 1)
+
+      nt('* * * * sun#1', now).should == local(1970, 1, 4)
+      nt('* * * * sun#2', now).should == local(1970, 1, 11)
+
+      now = local(1970, 1, 12)
+
+      nt('* * * * sun#2', now).should == local(1970, 2, 8)
+    end
+
+    it 'computes the next time correctly when there is a sun#2,sun#3 involved' do
+
+      now = local(1970, 1, 1)
+
+      nt('* * * * sun#2,sun#3', now).should == local(1970, 1, 11)
+
+      now = local(1970, 1, 12)
+
+      nt('* * * * sun#2,sun#3', now).should == local(1970, 1, 18)
+    end
   end
 
   describe '#matches?' do
@@ -181,6 +212,9 @@ describe Rufus::CronLine do
       match '* * 1 6 *', utc(1970, 6, 1)
 
       match '0 0 * * thu', utc(1970, 1, 8)
+
+      match '0 0 1 1 *', utc(2012, 1, 1)
+      no_match '0 0 1 1 *', utc(2012, 1, 1, 1, 0)
     end
 
     it 'matches correctly in local TZ (TZ not specified)' do
@@ -194,6 +228,9 @@ describe Rufus::CronLine do
       match '* * 1 6 *', local(1970, 6, 1)
 
       match '0 0 * * thu', local(1970, 1, 8)
+
+      match '0 0 1 1 *', local(2012, 1, 1)
+      no_match '0 0 1 1 *', local(2012, 1, 1, 1, 0)
     end
 
     it 'matches correctly in UTC (TZ specified)' do
@@ -210,6 +247,33 @@ describe Rufus::CronLine do
 
       match "0 0 * * thu #{zone}", utc(1970, 1, 7, 23)
     end
+
+    it 'matches correctly when there is a sun#2 involved' do
+
+      match '* * 13 * fri#2', utc(1970, 2, 13)
+      no_match '* * 13 * fri#2', utc(1970, 2, 20)
+    end
+
+    it 'matches correctly when there is a sun#2,sun#3 involved' do
+
+      no_match '* * * * sun#2,sun#3', local(1970, 1, 4)
+      match '* * * * sun#2,sun#3', local(1970, 1, 11)
+      match '* * * * sun#2,sun#3', local(1970, 1, 18)
+      no_match '* * * * sun#2,sun#3', local(1970, 1, 25)
+    end
+  end
+
+  describe '.monthday' do
+
+    it 'returns the appropriate "sun#2"-like string' do
+
+      d = local(1970, 1, 1)
+      Rufus::CronLine.monthday(d).should == 'thu#1'
+      Rufus::CronLine.monthday(d + 6 * 24 * 3600).should == 'wed#1'
+      Rufus::CronLine.monthday(d + 13 * 24 * 3600).should == 'wed#2'
+
+      Rufus::CronLine.monthday(local(2011, 3, 11)).should == 'fri#2'
+    end
   end
 end
 

data/spec/every_spec.rb

@@ -95,7 +95,7 @@ describe "#{SCHEDULER_CLASS}#every" do
 
     counter = 0
 
-    job = @s.every '1s', :first_at => Time.now + 2 do
+    @s.every '1s', :first_at => Time.now + 2 do
       counter += 1
     end
 
@@ -106,11 +106,35 @@ describe "#{SCHEDULER_CLASS}#every" do
     counter.should == 2
   end
 
+  it 'triggers for the missed schedules when :first_at is in the past' do
+
+    counter = 0
+
+    @s.every '1s', :first_at => Time.now - 2 do
+      counter += 1
+    end
+
+    wait_next_tick
+    counter.should == 3
+  end
+
+  it 'does not trigger for the missed schedules when :first_at is in the past and :discard_past => true' do
+
+    counter = 0
+
+    @s.every '1s', :first_at => Time.now - 2, :discard_past => true do
+      counter += 1
+    end
+
+    wait_next_tick
+    counter.should == 0
+  end
+
   it 'honours :first_in' do
 
     counter = 0
 
-    job = @s.every '1s', :first_in => 2 do
+    @s.every '1s', :first_in => 2 do
       counter += 1
     end
 

data/spec/in_spec.rb

@@ -77,17 +77,26 @@ describe "#{SCHEDULER_CLASS}#in" do
     var.should == true
   end
 
+  it 'returns the new job' do
+
+    r = @s.in '1s' do
+    end
+
+    r.class.should == Rufus::Scheduler::InJob
+  end
+
   it 'triggers [almost] immediately jobs in the past' do
 
     var = nil
 
-    @s.in -2 do
+    r = @s.in -2 do
       var = true
     end
 
     #wait_next_tick
     sleep 0.550
 
+    r.class.should == Rufus::Scheduler::InJob
     var.should == true
     @s.jobs.should == {}
   end
@@ -96,10 +105,11 @@ describe "#{SCHEDULER_CLASS}#in" do
 
     var = nil
 
-    @s.in -2, :discard_past => true do
+    r = @s.in -2, :discard_past => true do
       var = true
     end
 
+    r.should == nil
     var.should == nil
     @s.jobs.should == {}
   end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-scheduler
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 29
+  prerelease: 
   segments: 
   - 2
   - 0
-  - 8
-  version: 2.0.8
+  - 9
+  version: 2.0.9
 platform: ruby
 authors: 
 - John Mettraux
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-31 00:00:00 +09:00
+date: 2011-04-22 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 61
         segments: 
         - 0
         - 3
@@ -40,6 +42,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -53,6 +56,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 2
         - 0
@@ -98,9 +102,9 @@ files:
 - rufus-scheduler.gemspec
 - CHANGELOG.txt
 - CREDITS.txt
+- dump.txt
 - LICENSE.txt
 - TODO.txt
-- dump.txt
 - README.rdoc
 has_rdoc: true
 homepage: http://github.com/jmettraux/rufus-scheduler
@@ -116,6 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -124,13 +129,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: rufus
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: job scheduler for Ruby (at, cron, in and every jobs)