rufus-scheduler 3.0.4 → 3.0.5

data/CHANGELOG.txt

@@ -2,7 +2,13 @@
 = rufus-scheduler CHANGELOG.txt
 
 
-== rufus-scheduler - 3.0.4    released 2014/10/19
+== rufus-scheduler - 3.0.5    released 2014/01/30
+
+- implement Job#call(do_rescue=false), gh-97
+- implement :first => :now for repeat jobs, gh-96
+
+
+== rufus-scheduler - 3.0.4    released 2014/01/19
 
 - make CronLine#frequency faster (to avoid 20s schedule_cron times)
 

data/CREDITS.txt

@@ -30,6 +30,8 @@
 
 == Feedback
 
+- Joe Taylor and Agis Anastasopoulos -
+  http://stackoverflow.com/questions/21280870 - :first => :now and Job#call
 - Gatis Tomsons - https://github.io/gacha - heavy work threads and lock errors
 - https://github.com/joast - missing .to_time_string alias (code and doc)
 - Tamir Duberstein - https://github.com/tamird - rdoc inaccuracies

data/README.md

@@ -366,7 +366,7 @@ end
 
 The :timeout option accepts either a duration (like "1d" or "2w3d") or a point in time (like "2013/12/12 12:00").
 
-### :first_at, :first_in, :first
+### :first_at, :first_in, :first, :first_time
 
 This option is for repeat jobs (cron / every) only.
 
@@ -393,6 +393,34 @@ job.first_at = Time.now + 10
 job.first_at = Rufus::Scheduler.parse('2029-12-12')
 ```
 
+The first argument (in all its flavours) accepts a :now or :immediately value. That schedules the first occurence for immediate triggering. Consider:
+
+```ruby
+require 'rufus-scheduler'
+
+s = Rufus::Scheduler.new
+
+n = Time.now; p [ :scheduled_at, n, n.to_f ]
+
+s.every '3s', :first => :now do
+  n = Time.now; p [ :in, n, n.to_f ]
+end
+
+s.join
+
+```
+
+that'll output something like:
+
+```
+[:scheduled_at, 2014-01-22 22:21:21 +0900, 1390396881.344438]
+[:in, 2014-01-22 22:21:21 +0900, 1390396881.6453865]
+[:in, 2014-01-22 22:21:24 +0900, 1390396884.648807]
+[:in, 2014-01-22 22:21:27 +0900, 1390396887.651686]
+[:in, 2014-01-22 22:21:30 +0900, 1390396890.6571937]
+...
+```
+
 ### :last_at, :last_in, :last
 
 This option is for repeat jobs (cron / every) only.
@@ -671,6 +699,44 @@ job.keys
 
 Job-local variables are thread-safe.
 
+### call
+
+Job instances have a #call method. It simply calls the scheduled block or callable immediately.
+
+```ruby
+job =
+  @scheduler.schedule_every '10m' do |job|
+    # ...
+  end
+
+job.call
+```
+
+Warning: the Scheduler#on_error handler is not involved. Error handling is the responsibility of the caller.
+
+If the call has to be rescued by the error handler of the scheduler, ```call(true)``` might help:
+
+```ruby
+require 'rufus-scheduler'
+
+s = Rufus::Scheduler.new
+
+def s.on_error(job, err)
+  p [ 'error in scheduled job', job.class, job.original, err.message ]
+rescue
+  p $!
+end
+
+job =
+  s.schedule_in('1d') do
+    fail 'again'
+  end
+
+job.call(true)
+  #
+  # true lets the error_handler deal with error in the job call
+```
+
 ## AtJob and InJob methods
 
 ### time

data/lib/rufus/scheduler.rb

@@ -38,7 +38,7 @@ module Rufus
     require 'rufus/scheduler/cronline'
     require 'rufus/scheduler/job_array'
 
-    VERSION = '3.0.4'
+    VERSION = '3.0.5'
 
     #
     # A common error class for rufus-scheduler

data/lib/rufus/scheduler/jobs.rb

@@ -183,6 +183,15 @@ module Rufus
         #
         # might be necessary at some point
 
+      # Calls the callable (usually a block) wrapped in this Job instance.
+      #
+      # Warning: error rescueing is the responsibity of the caller.
+      #
+      def call(do_rescue=false)
+
+        do_call(Time.now, do_rescue)
+      end
+
       protected
 
       def callback(meth, time)
@@ -209,6 +218,22 @@ module Rufus
         m.is_a?(Mutex) ? m : (@scheduler.mutexes[m.to_s] ||= Mutex.new)
       end
 
+      def do_call(time, do_rescue)
+
+        args = [ self, time ][0, @callable.arity]
+        @callable.call(*args)
+
+      rescue StandardError => se
+
+        raise se unless do_rescue
+
+        return if se.is_a?(KillSignal) # discard
+
+        @scheduler.on_error(self, se)
+
+      # exceptions above StandardError do pass through
+      end
+
       def do_trigger(time)
 
         t = Time.now
@@ -220,16 +245,7 @@ module Rufus
 
         @last_time = t
 
-        args = [ self, time ][0, @callable.arity]
-        @callable.call(*args)
-
-      rescue KillSignal
-
-        # discard
-
-      rescue StandardError => se
-
-        @scheduler.on_error(self, se)
+        do_call(time, true)
 
       ensure
 
@@ -368,19 +384,24 @@ module Rufus
         ) unless @times == nil || @times.is_a?(Fixnum)
 
         self.first_at =
-          opts[:first] || opts[:first_at] || opts[:first_in] || 0
+          opts[:first] || opts[:first_time] ||
+          opts[:first_at] || opts[:first_in] ||
+          0
         self.last_at =
           opts[:last] || opts[:last_at] || opts[:last_in]
       end
 
       def first_at=(first)
 
+        n = Time.now
+        first = n + 0.001 if first == :now || first == :immediately
+
         @first_at = Rufus::Scheduler.parse_to_time(first)
 
         raise ArgumentError.new(
           "cannot set first[_at|_in] in the past: " +
           "#{first.inspect} -> #{@first_at.inspect}"
-        ) if first != 0 && @first_at < Time.now
+        ) if first != 0 && @first_at < n
       end
 
       def last_at=(last)

data/out.txt

@@ -0,0 +1,8 @@
+[:scheduled_at, 2014-01-22 22:21:21 +0900, 1390396881.344438]
+[:in, 2014-01-22 22:21:21 +0900, 1390396881.6453865]
+[:in, 2014-01-22 22:21:24 +0900, 1390396884.648807]
+[:in, 2014-01-22 22:21:27 +0900, 1390396887.651686]
+[:in, 2014-01-22 22:21:30 +0900, 1390396890.6571937]
+[:in, 2014-01-22 22:21:33 +0900, 1390396893.661189]
+[:in, 2014-01-22 22:21:36 +0900, 1390396896.6648037]
+[:in, 2014-01-22 22:21:39 +0900, 1390396899.6698604]

data/spec/job_repeat_spec.rb

@@ -174,6 +174,29 @@ describe Rufus::Scheduler::RepeatJob do
 
       }.should raise_error(ArgumentError)
     end
+
+    context ':first_time => :now/:immediately' do
+
+      it 'schedules the first execution immediately' do
+
+        n = Time.now
+        ft = nil
+
+        job =
+          @scheduler.schedule_every '7s', :first => :now do
+            ft ||= Time.now
+          end
+
+        sleep 0.5
+
+        #p n.to_f
+        #p job.first_at.to_f
+        #p ft.to_f
+
+        job.first_at.should < n + 0.5
+        ft.should < job.first_at + @scheduler.frequency + 0.1
+      end
+    end
   end
 
   describe ':first/:first_in/:first_at => duration' do

data/spec/job_spec.rb

@@ -178,6 +178,70 @@ describe Rufus::Scheduler::Job do
     end
   end
 
+  describe '#call' do
+
+    it 'calls the job (like it were a proc)' do
+
+      counter = 0
+
+      job =
+        @scheduler.schedule_in('0.5s') do
+          counter = counter + 1
+        end
+      job.call
+
+      sleep 0.8
+
+      counter.should == 2
+    end
+  end
+
+  describe '#call(true)' do
+
+    it 'calls the job and let the scheduler handle errors' do
+
+      $err = nil
+
+      def @scheduler.on_error(job, err)
+        $err = "#{job.class} #{job.original} #{err.message}"
+      rescue
+        p $!
+      end
+
+      job =
+        @scheduler.schedule_in('1d') do
+          fail 'again'
+        end
+
+      job.call(true)
+
+      $err.should == 'Rufus::Scheduler::InJob 1d again'
+    end
+  end
+
+  describe '#call(false)' do
+
+    it 'calls the job and let errors slip through' do
+
+      job =
+        @scheduler.schedule_in('1d') do
+          fail 'fast'
+        end
+
+      begin
+
+        #job.call(false)
+        job.call # false is the default
+
+        false.should == true
+
+      rescue => ex
+
+        ex.message.should == 'fast'
+      end
+    end
+  end
+
   context 'job-local variables' do
 
     describe '#[]=' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rufus-scheduler
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-18 00:00:00.000000000 Z
+date: 2014-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -98,12 +98,13 @@ files:
 - CHANGELOG.txt
 - TODO.txt
 - LICENSE.txt
+- out.txt
 - CREDITS.txt
 - README.md
 homepage: http://github.com/jmettraux/rufus-scheduler
 licenses:
 - MIT
-post_install_message: ! "\n***\n\nThanks for installing rufus-scheduler 3.0.4\n\nIt
+post_install_message: ! "\n***\n\nThanks for installing rufus-scheduler 3.0.5\n\nIt
   might not be 100% compatible with rufus-scheduler 2.x.\n\nIf you encounter issues
   with this new rufus-scheduler, especially\nif your app worked fine with previous
   versions of it, you can\n\nA) Forget it and peg your Gemfile to rufus-scheduler