rufus-scheduler 2.0.9 → 2.0.10

data/CHANGELOG.txt

@@ -2,7 +2,12 @@
 = rufus-scheduler CHANGELOG.txt
 
 
-== rufus-scheduler - 2.0.9    released 2010/04/22
+== rufus-scheduler - 2.0.10    released 2011/06/26
+
+- every and allow_overlapping now surviving exceptions. Thanks sha1dy
+
+
+== rufus-scheduler - 2.0.9    released 2011/04/22
 
 - Scheduler#first_at and :discard_past => true. Thanks concept47
 - Scheduler#cron and monthdays (sun#2 or mon#1)
@@ -16,6 +21,7 @@
 
 == rufus-scheduler - 2.0.7    released 2010/11/09
 
+- :allow_overlapping => false, thanks Adam Davies
 - cron and timezones, thanks Tanzeeb Khalili
 - Scheduler#trigger_threads, thanks Tim Uckun
 

data/CREDITS.txt

@@ -7,13 +7,14 @@
 - 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
+- Adam Davies (http://github.com/adz), :allow_overlapping => 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
 
 
 == Feedback
 
+- sha1dy - https://github.com/sha1dy - every and overlapping exception issue
 - Defusal - unschedule_by_tag
 - pickerel - https://github.com/pickerel
 - Gonzalo Suarez - parse_time_string(s) issue

data/README.rdoc

@@ -158,7 +158,7 @@ http://rufus.rubyforge.org/rufus-scheduler/classes/Rufus/Scheduler/Job.html
   p Rufus.to_time_string 7 * 24 * 3600   # => "1w"
 
 
-== :blocking
+== :blocking => true
 
 Jobs will, by default, trigger in their own thread. This is usually desirable since one expects the scheduler to continue scheduling even if a job is currently running.
 
@@ -175,6 +175,27 @@ Jobs scheduled with the :blocking parameter will run in the thread of the schedu
 Hence, our espresso will come in 22 minutes instead of 21.
 
 
+== :allow_overlapping => false
+
+By default, every and cron jobs will "overlap" :
+
+  scheduler.every '3s' do
+    4.times do
+      puts "hello!"
+      sleep 1
+    end
+  end
+
+This every job, will have overlaps. To prevent that :
+
+  scheduler.every '3s', :allow_overlapping => false do
+    4.times do
+      puts "hello!"
+      sleep 1
+    end
+  end
+
+
 == 'every' jobs and :first_at / :first_in
 
 This job will execute every 3 days, but first time will be in 5 days from now :

data/Rakefile

@@ -20,7 +20,7 @@ CLEAN.include('pkg', 'rdoc')
 
 #task :spec => :check_dependencies do
 task :spec do
-  sh 'rspec spec/'
+  exec 'rspec spec/'
 end
 task :test => :spec
 

data/lib/rufus/sc/jobs.rb

@@ -67,8 +67,6 @@ module Scheduler
     #
     attr_reader :job_id
 
-    attr_accessor :running
-
     # Instantiating the job.
     #
     def initialize(scheduler, t, params, &block)
@@ -79,10 +77,6 @@ module Scheduler
       @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'
@@ -95,6 +89,15 @@ module Scheduler
       determine_at
     end
 
+    # Returns true if this job is currently running (in the middle of #trigger)
+    #
+    def running
+
+      @running
+    end
+
+    alias running? running
+
     # Returns the list of tags attached to the job.
     #
     def tags
@@ -126,9 +129,10 @@ module Scheduler
       job_thread = nil
       to_job = nil
 
-      return if @running && !@allow_overlapping
+      return if @running and (params[:allow_overlapping] == false)
 
       @running = true
+
       @scheduler.send(:trigger_job, @params[:blocking]) do
         #
         # Note that #trigger_job is protected, hence the #send
@@ -147,12 +151,12 @@ module Scheduler
           job_thread = nil
           to_job.unschedule if to_job
 
-          @running = false
-
         rescue Exception => e
 
           @scheduler.handle_exception(self, e)
         end
+
+        @running = false
       end
 
       # note that add_job and add_cron_job ensured that :blocking is
@@ -169,7 +173,6 @@ module Scheduler
           end
         end
       end
-
     end
 
     # Simply encapsulating the block#call/trigger operation, for easy

data/lib/rufus/sc/version.rb

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

data/rufus-scheduler.gemspec

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
-load 'lib/rufus/sc/version.rb'
+require File.join(File.dirname(__FILE__), 'lib/rufus/sc/version')
+  # bundler wants absolute path
 
 
 Gem::Specification.new do |s|

data/spec/at_spec.rb

@@ -101,35 +101,3 @@ describe "#{SCHEDULER_CLASS}#schedule_at" do
   end
 end
 
-describe Rufus::Scheduler::AtJob do
-
-  before do
-    @s = start_scheduler
-  end
-  after do
-    stop_scheduler(@s)
-  end
-
-  it 'unschedules itself' do
-
-    job = @s.at Time.now + 3 * 3600 do
-    end
-
-    wait_next_tick
-
-    job.unschedule
-
-    @s.jobs.size.should == 0
-  end
-
-  it 'responds to #next_time' do
-
-    t = Time.now + 3 * 3600
-
-    job = @s.at Time.now + 3 * 3600 do
-    end
-
-    job.next_time.to_i.should == t.to_i
-  end
-end
-

data/spec/cron_spec.rb

@@ -99,24 +99,5 @@ describe "#{SCHEDULER_CLASS}#cron" do
     @s.jobs.size.should == 0
     stack.should == %w[ ok ok ok done ]
   end
-
-end
-
-describe Rufus::Scheduler::CronJob do
-
-  before(:each) do
-    @s = start_scheduler
-  end
-  after(:each) do
-    stop_scheduler(@s)
-  end
-
-  it 'responds to #next_time' do
-
-    job = @s.cron '* * * * *' do
-    end
-
-    (job.next_time.to_i - Time.now.to_i).should satisfy { |v| v < 60 }
-  end
 end
 

data/spec/every_spec.rb

@@ -202,29 +202,8 @@ describe "#{SCHEDULER_CLASS}#every" do
 
     @s.trigger_threads.size.should == 4
   end
-end
-
-describe Rufus::Scheduler::EveryJob do
-
-  before(:each) do
-    @s = start_scheduler
-  end
-  after(:each) do
-    stop_scheduler(@s)
-  end
-
-  it 'responds to #next_time' do
-
-    t = Time.now + 3 * 3600
-
-    job = @s.every '3h' do
-    end
-
-    job.next_time.to_i.should == t.to_i
-  end
 
-
-  it 'does not allow a job to overlap execution if set !allow_overlapping' do
+  it "doesn't allow overlapped execution if :allow_overlapping => false" do
 
     stack = []
 
@@ -238,7 +217,7 @@ describe Rufus::Scheduler::EveryJob do
     stack.size.should == 2
   end
 
-  it 'allows a job to overlap execution (backward compatibility?)' do
+  it 'allows overlapped execution by default' do
 
     stack = []
 
@@ -251,5 +230,22 @@ describe Rufus::Scheduler::EveryJob do
 
     stack.size.should == 4
   end
+
+  it 'schedules anyway when exception and :allow_overlapping => false' do
+
+    $exceptions = []
+
+    def @s.handle_exception(job, exception)
+      $exceptions << exception
+    end
+
+    @s.every '1s', :allow_overlapping => false do
+      raise 'fail'
+    end
+
+    sleep 4
+
+    $exceptions.size.should be > 1
+  end
 end
 

data/spec/in_spec.rb

@@ -140,35 +140,3 @@ describe "#{SCHEDULER_CLASS}#in" do
   end
 end
 
-describe Rufus::Scheduler::InJob do
-
-  before(:each) do
-    @s = start_scheduler
-  end
-  after(:each) do
-    stop_scheduler(@s)
-  end
-
-  it 'unschedules itself' do
-
-    job = @s.in '2d' do
-    end
-
-    wait_next_tick
-
-    job.unschedule
-
-    @s.jobs.size.should == 0
-  end
-
-  it 'responds to #next_time' do
-
-    t = Time.now + 3 * 3600
-
-    job = @s.in '3h' do
-    end
-
-    job.next_time.to_i.should == t.to_i
-  end
-end
-

data/spec/job_spec.rb

@@ -0,0 +1,174 @@
+
+#
+# Specifying rufus-scheduler
+#
+# Wed Apr 27 00:51:07 JST 2011
+#
+
+require File.join(File.dirname(__FILE__), 'spec_base')
+
+
+describe 'job classes' do
+
+  before(:each) do
+    @s = start_scheduler
+  end
+  after(:each) do
+    stop_scheduler(@s)
+  end
+
+  describe Rufus::Scheduler::Job do
+
+    describe '#running' do
+
+      it 'returns false when the job is inactive' do
+
+        job = @s.in '2d' do
+        end
+
+        job.running.should == false
+      end
+
+      it 'returns true when the job is active' do
+
+        job = @s.in 0 do
+          sleep(100)
+        end
+
+        wait_next_tick
+
+        job.running.should == true
+      end
+
+      it 'returns false when the job hit some error' do
+
+        $exception = nil
+
+        def @s.handle_exception(j, e)
+          #p e
+          $exception = e
+        end
+
+        job = @s.in 0 do
+          raise "nada"
+        end
+
+        wait_next_tick
+
+        $exception.should_not == nil
+        job.running.should == false
+      end
+    end
+
+    describe '#running?' do
+
+      it 'is an alias for #running' do
+
+        job = @s.in 0 do
+          sleep(100)
+        end
+
+        wait_next_tick
+
+        job.running?.should == true
+      end
+    end
+  end
+
+  describe Rufus::Scheduler::AtJob do
+
+    describe '#unschedule' do
+
+      it 'removes the job from the scheduler' do
+
+        job = @s.at Time.now + 3 * 3600 do
+        end
+
+        wait_next_tick
+
+        job.unschedule
+
+        @s.jobs.size.should == 0
+      end
+    end
+
+    describe '#next_time' do
+
+      it 'returns the time when the job will trigger' do
+
+        t = Time.now + 3 * 3600
+
+        job = @s.at Time.now + 3 * 3600 do
+        end
+
+        job.next_time.class.should == Time
+        job.next_time.to_i.should == t.to_i
+      end
+    end
+  end
+
+  describe Rufus::Scheduler::InJob do
+
+    describe '#unschedule' do
+
+      it 'removes the job from the scheduler' do
+
+        job = @s.in '2d' do
+        end
+
+        wait_next_tick
+
+        job.unschedule
+
+        @s.jobs.size.should == 0
+      end
+    end
+
+    describe '#next_time' do
+
+      it 'returns the time when the job will trigger' do
+
+        t = Time.now + 3 * 3600
+
+        job = @s.in '3h' do
+        end
+
+        job.next_time.class.should == Time
+        job.next_time.to_i.should == t.to_i
+      end
+    end
+  end
+
+  describe Rufus::Scheduler::EveryJob do
+
+    describe '#next_time' do
+
+      it 'returns the time when the job will trigger' do
+
+        t = Time.now + 3 * 3600
+
+        job = @s.every '3h' do
+        end
+
+        job.next_time.class.should == Time
+        job.next_time.to_i.should == t.to_i
+      end
+    end
+  end
+
+  describe Rufus::Scheduler::CronJob do
+
+    describe '#next_time' do
+
+      it 'returns the time when the job will trigger' do
+
+        job = @s.cron '* * * * *' do
+        end
+
+        job.next_time.class.should == Time
+        (job.next_time.to_i - Time.now.to_i).should satisfy { |v| v < 60 }
+      end
+    end
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-scheduler
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 2
   - 0
-  - 9
-  version: 2.0.9
+  - 10
+  version: 2.0.10
 platform: ruby
 authors: 
 - John Mettraux
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-22 00:00:00 +09:00
+date: 2011-06-26 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -91,6 +91,7 @@ files:
 - spec/every_spec.rb
 - spec/exception_spec.rb
 - spec/in_spec.rb
+- spec/job_spec.rb
 - spec/rtime_spec.rb
 - spec/schedulable_spec.rb
 - spec/scheduler_spec.rb