rufus-scheduler 2.0.13 → 2.0.14

data/CHANGELOG.txt

@@ -2,6 +2,13 @@
 = rufus-scheduler CHANGELOG.txt
 
 
+== rufus-scheduler - 2.0.14    released 2011/12/11
+
+- Job #pause and #resume
+- Scheduler #pause(job_or_job_id) and #resume(job_or_job_id)
+- Scheduler#unschedule(job_or_job_id)
+
+
 == rufus-scheduler - 2.0.13    released 2011/11/14
 
 - cron lines now OK with "09". Thanks Anthony Lewis

data/CREDITS.txt

@@ -15,6 +15,7 @@
 
 == Feedback
 
+- Henrique G. Testa - pause/resume concept
 - Sam Gibson - https://github.com/samfoo - exception handling hardening
 - sha1dy - https://github.com/sha1dy - every and overlapping exception issue
 - Defusal - unschedule_by_tag

data/README.rdoc

@@ -295,6 +295,49 @@ Note : setting a :first_at/:first_in in the past will get rufus-scheduler to tri
 In this example, the 'every' job will unschedule itself when the crop is ready.
 
 
+== #running?
+
+  job = scheduler.every '3d' do
+    # ...
+  end
+
+  # ...
+
+  p job.running?
+
+Job#running? will return true when the job got triggered and is actually performing.
+
+Please note, that #running? is not related to the #paused? which is detailed in the next section.
+
+
+== #pause, #resume and #paused?
+
+Jobs, as well as the scheduler itself have a pair of #pause and #resume methods.
+
+  job = scheduler.every '2h' do
+    # ...
+  end
+
+  # ...
+
+  job.pause # the job will be scheduled but won't trigger
+
+  # ...
+
+  puts job.paused?
+
+Pausing / resuming a job doesn't affect the scheduling of a job, it merely "silences" it, its block won't get executed. Calling resume will not reset the schedule of the job. If you schedule a job to trigger every 10 minutes at 10am and pause it from 1020 to 1025, it's next triggering time will be 1030 approximately.
+
+One can pause an "at" or "in" job. If it's still paused at trigger time, it will simply become a dud.
+
+As said, the scheduler has a #pause(job_or_job_id) and a #resume(job_or_job_id) pair of methods:
+
+  scheduler.pause(job)
+  scheduler.pause(job_id)
+  scheduler.resume(job)
+  scheduler.resume(job_id)
+
+
 == schedulables
 
 Sometimes passing a block isn't that convenient :

data/lib/rufus/sc/jobs.rb

@@ -77,6 +77,7 @@ module Scheduler
       @block = block || params[:schedulable]
 
       @running = false
+      @paused = false
 
       raise ArgumentError.new(
         'no block or :schedulable passed, nothing to schedule'
@@ -91,6 +92,8 @@ module Scheduler
 
     # Returns true if this job is currently running (in the middle of #trigger)
     #
+    # Note : paused? is not related to running?
+    #
     def running
 
       @running
@@ -98,6 +101,39 @@ module Scheduler
 
     alias running? running
 
+    # Returns true if this job is paused, false else.
+    #
+    # A paused job is still scheduled, but does not trigger.
+    #
+    # Note : paused? is not related to running?
+    #
+    def paused?
+
+      @paused
+    end
+
+    # Pauses this job (sets the paused flag to true).
+    #
+    # Note that it will not pause the execution of a block currently 'running'.
+    # Future triggering of the job will not occur until #resume is called.
+    #
+    # Note too that, during the pause time, the schedule kept the same. Calling
+    # #resume will not force old triggers in.
+    #
+    def pause
+
+      @paused = true
+    end
+
+    # Resumes this job (sets the paused flag to false).
+    #
+    # This job will trigger again.
+    #
+    def resume
+
+      @paused = false
+    end
+
     # Returns the list of tags attached to the job.
     #
     def tags
@@ -125,6 +161,8 @@ module Scheduler
     #
     def trigger(t=Time.now)
 
+      return if @paused
+
       @last = t
       job_thread = nil
       to_job = nil
@@ -353,6 +391,8 @@ module Scheduler
 
     def trigger_if_matches(time)
 
+      return if @paused
+
       trigger(time) if @cron_line.matches?(time)
     end
 

data/lib/rufus/sc/scheduler.rb

@@ -177,11 +177,13 @@ module Rufus::Scheduler
     end
     alias :schedule :cron
 
-    # Unschedules a job (cron or at/every/in job) given its id.
+    # Unschedules a job (cron or at/every/in job).
     #
     # Returns the job that got unscheduled.
     #
-    def unschedule(job_id)
+    def unschedule(job_or_id)
+
+      job_id = job_or_id.respond_to?(:job_id) ? job_or_id.job_id : job_or_id
 
       @jobs.unschedule(job_id) || @cron_jobs.unschedule(job_id)
     end
@@ -196,6 +198,22 @@ module Rufus::Scheduler
       jobs
     end
 
+    # Pauses a given job. If the argument is an id (String) and the
+    # corresponding job cannot be found, an ArgumentError will get raised.
+    #
+    def pause(job_or_id)
+
+      find(job_or_id).pause
+    end
+
+    # Resumes a given job. If the argument is an id (String) and the
+    # corresponding job cannot be found, an ArgumentError will get raised.
+    #
+    def resume(job_or_id)
+
+      find(job_or_id).resume
+    end
+
     #--
     # MISC
     #++
@@ -270,6 +288,25 @@ module Rufus::Scheduler
       all_jobs.values.select { |j| j.tags.include?(tag) }
     end
 
+    # Mostly used to find a job given its id. If the argument is a job, will
+    # simply return it.
+    #
+    # If the argument is an id, and no job with that id is found, it will
+    # raise an ArgumentError.
+    #
+    def find(job_or_id)
+
+      return job_or_id if job_or_id.respond_to?(:job_id)
+
+      job = all_jobs[job_or_id]
+
+      raise ArgumentError.new(
+        "couldn't find job #{job_or_id.inspect}"
+      ) unless job
+
+      job
+    end
+
     # Returns the current list of trigger threads (threads) dedicated to
     # the execution of jobs.
     #
@@ -386,7 +423,7 @@ module Rufus::Scheduler
       @thread = Thread.new do
         loop do
           sleep(@frequency)
-          self.step
+          step
         end
       end
 

data/lib/rufus/sc/version.rb

@@ -26,7 +26,7 @@
 module Rufus
 module Scheduler
 
-  VERSION = '2.0.13'
+  VERSION = '2.0.14'
 end
 end
 

data/spec/at_spec.rb

@@ -60,12 +60,12 @@ describe "#{SCHEDULER_CLASS}#schedule_at" do
     @s.jobs.should == {}
   end
 
-  it 'unschedules' do
+  it 'unschedules (job_id)' do
 
     job = @s.at Time.now + 3 * 3600 do
     end
 
-    wait_next_tick
+    sleep 0.300
 
     @s.jobs.size.should == 1
 
@@ -74,6 +74,20 @@ describe "#{SCHEDULER_CLASS}#schedule_at" do
     @s.jobs.size.should == 0
   end
 
+  it 'unschedules (job)' do
+
+    job = @s.at Time.now + 3 * 3600 do
+    end
+
+    sleep 0.300
+
+    @s.jobs.size.should == 1
+
+    @s.unschedule(job)
+
+    @s.jobs.size.should == 0
+  end
+
   it 'accepts tags for jobs' do
 
     job = @s.at Time.now + 3 * 3600, :tags => 'spec' do

data/spec/cron_spec.rb

@@ -37,7 +37,7 @@ describe "#{SCHEDULER_CLASS}#cron" do
     seconds.uniq.size.should == seconds.size
   end
 
-  it 'unschedules' do
+  it 'unschedules (self)' do
 
     second = nil
 
@@ -60,6 +60,29 @@ describe "#{SCHEDULER_CLASS}#cron" do
     second.should == after
   end
 
+  it 'unschedules (job)' do
+
+    second = nil
+
+    job = @s.cron '* * * * * *'  do |job|
+      second = job.last.sec
+    end
+
+    second.should == nil
+
+    sleep 2
+
+    second.should_not == nil
+
+    @s.unschedule(job)
+
+    after = second
+
+    sleep 2
+
+    second.should == after
+  end
+
   it 'keeps track of cron jobs' do
 
     j0 = @s.cron '7 10-12 * * * *' do

data/spec/job_spec.rb

@@ -154,6 +154,40 @@ describe 'job classes' do
         job.next_time.to_i.should == t.to_i
       end
     end
+
+    describe '#paused?' do
+
+      it 'returns false initially' do
+
+        job = @s.every '3h' do; end
+
+        job.paused?.should == false
+      end
+    end
+
+    describe '#pause' do
+
+      it 'pauses the job' do
+
+        job = @s.every '3h' do; end
+
+        job.pause
+
+        job.paused?.should == true
+      end
+    end
+
+    describe '#resume' do
+
+      it 'resumes the job' do
+
+        job = @s.every '3h' do; end
+
+        job.resume
+
+        job.paused?.should == false
+      end
+    end
   end
 
   describe Rufus::Scheduler::CronJob do
@@ -169,6 +203,40 @@ describe 'job classes' do
         (job.next_time.to_i - Time.now.to_i).should satisfy { |v| v < 60 }
       end
     end
+
+    describe '#paused?' do
+
+      it 'returns false initially' do
+
+        job = @s.cron '* * * * *' do; end
+
+        job.paused?.should == false
+      end
+    end
+
+    describe '#pause' do
+
+      it 'pauses the job' do
+
+        job = @s.cron '* * * * *' do; end
+
+        job.pause
+
+        job.paused?.should == true
+      end
+    end
+
+    describe '#resume' do
+
+      it 'resumes the job' do
+
+        job = @s.cron '* * * * *' do; end
+
+        job.resume
+
+        job.paused?.should == false
+      end
+    end
   end
 end
 

data/spec/scheduler_spec.rb

@@ -64,6 +64,98 @@ describe SCHEDULER_CLASS do
 
     stop_scheduler(s)
   end
+
+  context 'pause/resume' do
+
+    before(:each) do
+      @s = start_scheduler
+    end
+    after(:each) do
+      stop_scheduler(@s)
+    end
+
+    describe '#pause' do
+
+      it 'pauses a job (every)' do
+
+        $count = 0
+
+        j = @s.every '1s' do
+          $count = $count + 1
+        end
+
+        @s.pause(j.job_id)
+
+        sleep 2.5
+
+        j.paused?.should == true
+        $count.should == 0
+      end
+
+      it 'pauses a job (cron)' do
+
+        $count = 0
+
+        j = @s.cron '* * * * * *' do
+          $count = $count + 1
+        end
+
+        @s.pause(j.job_id)
+
+        sleep 2.5
+
+        j.paused?.should == true
+        $count.should == 0
+      end
+    end
+
+    describe '#resume' do
+
+      it 'resumes a job (every)' do
+
+        $count = 0
+
+        j = @s.every '1s' do
+          $count = $count + 1
+        end
+
+        @s.pause(j.job_id)
+
+        sleep 2.5
+
+        c = $count
+
+        @s.resume(j.job_id)
+
+        sleep 1.5
+
+        j.paused?.should == false
+        ($count > c).should == true
+      end
+
+      it 'pauses a job (cron)' do
+
+        $count = 0
+
+        j = @s.cron '* * * * * *' do
+          $count = $count + 1
+        end
+
+        @s.pause(j.job_id)
+
+        sleep 2.5
+
+        c = $count
+
+        @s.resume(j.job_id)
+
+        sleep 1.5
+
+        j.paused?.should == false
+        ($count > c).should == true
+      end
+    end
+  end
 end
 
 describe 'Rufus::Scheduler#start_new' do

metadata

@@ -1,79 +1,57 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rufus-scheduler
-version: !ruby/object:Gem::Version 
-  hash: 21
+version: !ruby/object:Gem::Version
+  version: 2.0.14
   prerelease: 
-  segments: 
-  - 2
-  - 0
-  - 13
-  version: 2.0.13
 platform: ruby
-authors: 
+authors:
 - John Mettraux
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-14 00:00:00 +09:00
+date: 2011-12-11 00:00:00.000000000 +09:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: tzinfo
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2160139540 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 61
-        segments: 
-        - 0
-        - 3
-        - 23
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.3.23
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2160139540
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2160138880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2160138880
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2160138220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 2
-        - 7
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.7.0
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *2160138220
 description: job scheduler for Ruby (at, cron, in and every jobs).
-email: 
+email:
 - jmettraux@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - Rakefile
 - lib/rufus/otime.rb
 - lib/rufus/sc/cronline.rb
@@ -105,45 +83,32 @@ files:
 - rufus-scheduler.gemspec
 - CHANGELOG.txt
 - CREDITS.txt
-- dump.txt
 - LICENSE.txt
-- release.txt
-- t.txt
 - TODO.txt
 - README.rdoc
 has_rdoc: true
 homepage: http://github.com/jmettraux/rufus-scheduler
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: rufus
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: job scheduler for Ruby (at, cron, in and every jobs)
 test_files: []
-

data/dump.txt

@@ -1,18 +0,0 @@
-
-jmettraux@sanma ~/tmp/billen/bill 円 script/server 
-=> Booting WEBrick
-=> Rails 2.3.10 application starting on http://0.0.0.0:3000
-=> Call with -d to detach
-=> Ctrl-C to shutdown server
-[2010-12-15 09:41:55] INFO  WEBrick 1.3.1
-[2010-12-15 09:41:55] INFO  ruby 1.8.7 (2010-04-19) [i686-darwin10.5.0]
-[2010-12-15 09:41:55] INFO  WEBrick::HTTPServer#start: pid=15393 port=3000
-"Wed Dec 15 09:43:00 +0900 2010 - run 0"
-"Wed Dec 15 10:43:00 +0900 2010 - run 1"
-"Wed Dec 15 11:43:00 +0900 2010 - run 2"
-"Wed Dec 15 12:43:00 +0900 2010 - run 3"
-"Wed Dec 15 13:43:00 +0900 2010 - run 4"
-"Wed Dec 15 14:43:00 +0900 2010 - run 5"
-"Wed Dec 15 15:43:00 +0900 2010 - run 6"
-"Wed Dec 15 16:43:00 +0900 2010 - run 7"
-

data/release.txt

@@ -1,18 +0,0 @@
-Rufus-scheduler is a thread-based scheduler written in Ruby. It lets you write code like
-
-[sourcecode language="ruby"]
-s = Rufus::Scheduler.start_new
-
-s.every '10m' do
-  puts 'open the window for the cat'
-end
-
-s.at '2012-01-01 12:00' do
-  puts 'reminder: wife's birthday'
-end
-
-s.cron '0 22 * * 1-5' do
-  puts 'activate the security system'
-end
-[/sourcecode]
-

data/t.txt

@@ -1,2 +0,0 @@
-$a = []; require 'rubygems'; load 'lib/rufus/scheduler.rb'; s = Rufus::Scheduler.start_new; s.cron('* * * * *') { $a << Time.now.strftime('%T.%3N') }
-s.join