rufus-scheduler 2.0.3 → 2.0.4

data/CHANGELOG.txt

@@ -2,7 +2,12 @@
 = rufus-scheduler CHANGELOG.txt
 
 
-== rufus-scheduler - 2.0.3    not yet released
+== rufus-scheduler - 2.0.4    released 2010/02/12
+
+- addressing issue with every and timeout, thanks Tony Day
+
+
+== rufus-scheduler - 2.0.3    released 2009/11/04
 
 - made sure Schedulables with a call(job) method were OK when passed as second
   parameter (thanks Nate Wiger)

data/CREDITS.txt

@@ -10,6 +10,7 @@
 
 == Feedback
 
+- Tony Day - http://github.com/tonyday - every and overlapping timeout issue
 - Nate Wiger (Schedulable call/trigger issue)
 - Aldric (readme errors)
 - Kenneth Kalmer (daemon-kit)

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2005-2009, John Mettraux, jmettraux@gmail.com
+Copyright (c) 2005-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

data/Rakefile

@@ -0,0 +1,82 @@
+
+require 'rubygems'
+require 'rake'
+
+
+load 'lib/rufus/sc/scheduler.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 = '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.
+  }
+  gem.email = 'jmettraux@gmail.com'
+  gem.homepage = 'http://github.com/jmettraux/rufus-scheduler/'
+  gem.authors = [ 'John Mettraux' ]
+  gem.rubyforge_project = 'rufus'
+
+  gem.test_file = 'spec/spec.rb'
+
+  #gem.add_dependency 'yajl-ruby'
+  gem.add_development_dependency 'yard', '>= 0'
+  gem.add_development_dependency 'bacon', '>= 0'
+  gem.add_development_dependency 'jeweler', '>= 0'
+
+  # 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/lib/rufus/sc/cronline.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006-2009, John Mettraux, jmettraux@gmail.com
+# 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
@@ -97,6 +97,7 @@ module Rufus
     # 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

data/lib/rufus/sc/jobqueues.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006-2009, John Mettraux, jmettraux@gmail.com
+# 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

data/lib/rufus/sc/jobs.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006-2009, John Mettraux, jmettraux@gmail.com
+# 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
@@ -39,10 +39,10 @@ module Scheduler
     #
     attr_reader :t
 
-    # When the job is actually running, this attribute will hold the
-    # thread in which the job is running.
+    # Returns the thread instance of the last triggered job.
+    # May be null (especially before the first trigger).
     #
-    attr_reader :job_thread
+    attr_reader :last_job_thread
 
     # The job parameters (passed via the schedule method)
     #
@@ -116,19 +116,21 @@ module Scheduler
     def trigger (t=Time.now)
 
       @last = t
+      job_thread = nil
 
       @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 = Thread.current
+        @last_job_thread = job_thread
 
         begin
 
           trigger_block
 
-          @job_thread = nil
+          job_thread = nil
 
         rescue Exception => e
 
@@ -145,8 +147,8 @@ module Scheduler
 
           # at this point, @job_thread might be set
 
-          @job_thread.raise(Rufus::Scheduler::TimeOutError) \
-            if @job_thread and @job_thread.alive?
+          job_thread.raise(Rufus::Scheduler::TimeOutError) \
+            if job_thread && job_thread.alive?
         end
       end
     end

data/lib/rufus/sc/rtime.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2009, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-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

data/lib/rufus/sc/scheduler.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006-2009, John Mettraux, jmettraux@gmail.com
+# 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
@@ -33,7 +33,7 @@ module Rufus::Scheduler
 
   # This gem's version
   #
-  VERSION = '2.0.3'
+  VERSION = '2.0.4'
 
   #
   # It's OK to pass an object responding to :trigger when scheduling a job

data/lib/rufus/scheduler.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006-2009, John Mettraux, jmettraux@gmail.com
+# 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

data/misc/cronline_next_time_cost.rb

@@ -0,0 +1,14 @@
+
+$:.unshift('lib')
+require 'rufus/scheduler'
+
+loop do
+
+  print "> "
+  s = gets
+
+  t = Time.now
+  puts Rufus::CronLine.new(s).next_time
+  puts "took #{Time.now - t} secs"
+end
+

data/rufus-scheduler.gemspec

@@ -0,0 +1,87 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rufus-scheduler}
+  s.version = "2.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Mettraux"]
+  s.date = %q{2010-02-12}
+  s.description = %q{
+    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.
+  }
+  s.email = %q{jmettraux@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+     "README.rdoc"
+  ]
+  s.files = [
+    "CHANGELOG.txt",
+     "CREDITS.txt",
+     "LICENSE.txt",
+     "README.rdoc",
+     "Rakefile",
+     "TODO.txt",
+     "lib/rufus-scheduler.rb",
+     "lib/rufus/otime.rb",
+     "lib/rufus/sc/cronline.rb",
+     "lib/rufus/sc/jobqueues.rb",
+     "lib/rufus/sc/jobs.rb",
+     "lib/rufus/sc/rtime.rb",
+     "lib/rufus/sc/scheduler.rb",
+     "lib/rufus/scheduler.rb",
+     "misc/cronline_next_time_cost.rb",
+     "rufus-scheduler.gemspec",
+     "spec/at_in_spec.rb",
+     "spec/at_spec.rb",
+     "spec/blocking_spec.rb",
+     "spec/cron_spec.rb",
+     "spec/cronline_spec.rb",
+     "spec/every_spec.rb",
+     "spec/exception_spec.rb",
+     "spec/in_spec.rb",
+     "spec/rtime_spec.rb",
+     "spec/schedulable_spec.rb",
+     "spec/scheduler_spec.rb",
+     "spec/spec.rb",
+     "spec/spec_base.rb",
+     "spec/stress_schedule_unschedule_spec.rb",
+     "spec/timeout_spec.rb",
+     "test/kjw.rb",
+     "test/t.rb"
+  ]
+  s.homepage = %q{http://github.com/jmettraux/rufus-scheduler/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rufus}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{job scheduler for Ruby (at, cron, in and every jobs)}
+  s.test_files = [
+    "spec/spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<bacon>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<bacon>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<bacon>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/spec/at_in_spec.rb

@@ -0,0 +1,48 @@
+
+#
+# Specifying rufus-scheduler
+#
+# Sun Mar 22 16:47:28 JST 2009
+#
+
+require File.dirname(__FILE__) + '/spec_base'
+
+
+describe SCHEDULER_CLASS do
+
+  before do
+    @s = start_scheduler
+  end
+  after do
+    stop_scheduler(@s)
+  end
+
+
+  it 'should override jobs with the same id' do
+
+    hits = []
+
+    job0 = @s.in '1s', :job_id => 'nada' do
+      hits << 0
+    end
+
+    wait_next_tick
+
+    job1 = @s.in '1s', :job_id => 'nada' do
+      hits << 1
+    end
+
+    wait_next_tick
+    @s.jobs.size.should.equal(1)
+
+    hits.should.be.empty
+
+    sleep 1.5
+
+    hits.should.equal([ 1 ])
+
+    @s.jobs.size.should.equal(0)
+  end
+
+end
+

data/spec/at_spec.rb

@@ -0,0 +1,121 @@
+
+#
+# Specifying rufus-scheduler
+#
+# Sat Mar 21 20:19:30 JST 2009
+#
+
+require File.dirname(__FILE__) + '/spec_base'
+
+
+describe "#{SCHEDULER_CLASS}#schedule_at" do
+
+  before do
+    @s = start_scheduler
+  end
+  after do
+    stop_scheduler(@s)
+  end
+
+  it 'should have job ids with the class name in it' do
+
+    j0 = @s.at(Time.now + 1) {}
+    j0.job_id.should.match(/Rufus::Scheduler::AtJob/)
+  end
+
+  it "should accept integers as 'at'" do
+
+    lambda { @s.at(1) {} }.should.not.raise
+  end
+
+  it "should schedule at 'top + 1'" do
+
+    var = nil
+
+    @s.at Time.now + 1 do
+      var = true
+    end
+
+    var.should.be.nil
+    sleep 1.5
+
+    var.should.be.true
+    @s.jobs.should.be.empty
+  end
+
+  it 'should trigger immediately jobs in the past' do
+
+    var = nil
+
+    j = @s.at Time.now - 2 do
+      var = true
+    end
+
+    j.should.not.be.nil
+
+    #wait_next_tick
+    sleep 0.500
+
+    var.should.be.true
+    @s.jobs.should.be.empty
+  end
+
+  it 'should unschedule' do
+
+    job = @s.at Time.now + 3 * 3600 do
+    end
+
+    wait_next_tick
+
+    @s.jobs.size.should.equal(1)
+
+    @s.unschedule(job.job_id)
+
+    @s.jobs.size.should.equal(0)
+  end
+
+  it 'should accept tags for jobs' do
+
+    job = @s.at Time.now + 3 * 3600, :tags => 'spec' do
+    end
+
+    wait_next_tick
+
+    @s.find_by_tag('spec').size.should.equal(1)
+    @s.find_by_tag('spec').first.job_id.should.equal(job.job_id)
+  end
+
+end
+
+describe Rufus::Scheduler::AtJob do
+
+  before do
+    @s = start_scheduler
+  end
+  after do
+    stop_scheduler(@s)
+  end
+
+  it 'should unschedule itself' do
+
+    job = @s.at Time.now + 3 * 3600 do
+    end
+
+    wait_next_tick
+
+    job.unschedule
+
+    @s.jobs.size.should.equal(0)
+  end
+
+  it 'should respond to #next_time' do
+
+    t = Time.now + 3 * 3600
+
+    job = @s.at Time.now + 3 * 3600 do
+    end
+
+    job.next_time.to_i.should.equal(t.to_i)
+  end
+end
+