rufus-scheduler 2.0.18 → 2.0.19

data/CHANGELOG.txt

@@ -2,7 +2,13 @@
 = rufus-scheduler CHANGELOG.txt
 
 
-== rufus-scheduler - 2.0.18    released 2012/03/06
+== rufus-scheduler - 2.0.19    released 2013/05/07
+
+- raise ArgumentError on <= 0.0 "every" frequency (Thanks Lucy Fu)
+- support multiple mutexes (Thanks Rainux Luo)
+
+
+== rufus-scheduler - 2.0.18    released 2013/03/06
 
 - support for "L" in cron lines (Thanks Andrew Davey)
 - support for negative time strings (Thanks Danny "northox" Fullerton)

data/CREDITS.txt

@@ -4,6 +4,8 @@
 
 == Contributors
 
+- Lucy Fu (https://github.com/lfu) arg error on <= 0 "every" freq
+- Rainux Luo (https://github.com/rainux) multiple mutexes
 - Andrew Davey (https://github.com/asdavey) "L" in cron lines
 - Stig Kleppe-Jørgensen (https://github.com/stigkj)
 - Danny "northox" Fullerton (https://github.com/northox) negative time strings

data/README.rdoc

@@ -231,6 +231,46 @@ It can be handy for even more fine-grained control:
     # non-critical
   end
 
+Please note that a mutex can also be used to prevent overlapping executions of the same job:
+
+  scheduler.every '5m', :mutex => 'the_mutex' do
+    puts "order ristretto"
+    # do something that might take more that 5 minutes...
+    puts "ah, that was delicious"
+  end
+
+But beware the cascades...
+
+
+== :mutex => ['mutex_a', 'mutex_b', ...]
+
+Multiple mutexes can be used to ensure exlusivity:
+
+  scheduler.in '20m', :mutex => 'mutex_r' do
+    puts "order ristretto"
+    sleep 2 * 60
+  end
+
+  scheduler.in '20m' :mutex => 'mutex_e' do
+    puts "order espresso"
+    sleep 3 * 60
+  end
+
+  scheduler.in '1h' :mutex => ['mutex_r', 'mutex_e'] do
+    puts "code for fun"
+  end
+
+This allow you order ristretto and espresso at same time, but when you coding it ensure you can't order any thing, and when you ordering anything it ensure you can't code.
+
+Sure you can also use array of Mutex object directly:
+
+  mutex_r = Mutex.new
+  mutex_e = Mutex.new
+  # ...
+  scheduler.in '1h' :mutex => [mutex_r, mutex_e] do
+    puts "code for fun"
+  end
+
 
 == :allow_overlapping => false
 

data/lib/rufus/sc/jobs.rb

@@ -365,11 +365,16 @@ module Scheduler
 
     def determine_frequency
 
-      @frequency = if @t.is_a?(Fixnum) || @t.is_a?(Float)
-        @t
-      else
-        Rufus.parse_duration_string(@t)
-      end
+      @frequency =
+        if @t.is_a?(Fixnum) || @t.is_a?(Float)
+          @t
+        else
+          Rufus.parse_duration_string(@t)
+        end
+
+      raise ArgumentError.new(
+        'cannot initialize an EveryJob with a <= 0.0 frequency'
+      ) if @frequency <= 0.0
     end
 
     def determine_at

data/lib/rufus/sc/rtime.rb

@@ -118,8 +118,13 @@ module Rufus
   #   Rufus.parse_time_string "1h10s"  # => 3610.0
   #   Rufus.parse_time_string "1w2d"   # => 777600.0
   #
+  # Note will call #to_s on the input "string", so anything that is a String
+  # or responds to #to_s will be OK.
+  #
   def self.parse_time_string(string)
 
+    string = string.to_s
+
     return 0.0 if string == ''
 
     m = string.match(/^(-?)([\d\.#{DURATION_LETTERS}]+)$/)

data/lib/rufus/sc/scheduler.rb

@@ -410,12 +410,25 @@ module Rufus::Scheduler
       if params[:blocking]
         block.call
       elsif m = params[:mutex]
-        m = (@mutexes[m.to_s] ||= Mutex.new) unless m.is_a?(Mutex)
-        Thread.new { m.synchronize { block.call } }
+        Thread.new { synchronize_with_mutex(m, &block) }
       else
         Thread.new { block.call }
       end
     end
+
+    def synchronize_with_mutex(mutex, &block)
+      case mutex
+      when Mutex
+        mutex.synchronize { block.call }
+      when Array
+        mutex.reduce(block) do |memo, m|
+          m = (@mutexes[m.to_s] ||= Mutex.new) unless m.is_a?(Mutex)
+          lambda { m.synchronize { memo.call } }
+        end.call
+      else
+        (@mutexes[mutex.to_s] ||= Mutex.new).synchronize { block.call }
+      end
+    end
   end
 
   #--
@@ -549,8 +562,7 @@ module Rufus::Scheduler
       if params[:blocking]
         EM.next_tick { block.call }
       elsif m = params[:mutex]
-        m = (@mutexes[m.to_s] ||= Mutex.new) unless m.is_a?(Mutex)
-        EM.defer { m.synchronize { block.call } }
+        EM.defer { synchronize_with_mutex(m, &block) }
       else
         EM.defer { block.call }
       end

data/lib/rufus/sc/version.rb

@@ -26,7 +26,7 @@
 module Rufus
 module Scheduler
 
-  VERSION = '2.0.18'
+  VERSION = '2.0.19'
 end
 end
 

data/out.txt

@@ -0,0 +1,4 @@
+ruby-1.8.7-p249 :001 > nada
+NameError: undefined local variable or method `nada' for #<Object:0x1001d1298>
+	from (irb):1
+ruby-1.8.7-p249 :002 > ^D

data/spec/every_spec.rb

@@ -43,6 +43,51 @@ describe "#{SCHEDULER_CLASS}#every" do
     var.should == 3
   end
 
+  it 'schedules every 0.1s' do
+
+    var = 0
+
+    job = @s.every '0.1s' do
+      var += 1
+    end
+
+    sleep 3.7
+
+    var.should be_within(10).of(37)
+  end
+
+  it 'raises on schedule every 0s' do
+
+    lambda {
+      @s.every '0s' do
+      end
+    }.should raise_error(ArgumentError)
+  end
+
+  it 'raises on schedule every -1s' do
+
+    lambda {
+      @s.every '-1s' do
+      end
+    }.should raise_error(ArgumentError)
+  end
+
+  it 'raises on schedule every \'\'' do
+
+    lambda {
+      @s.every '' do
+      end
+    }.should raise_error(ArgumentError)
+  end
+
+  it 'raises on schedule every nil' do
+
+    lambda {
+      @s.every nil do
+      end
+    }.should raise_error(ArgumentError)
+  end
+
   it 'is punctilious' do
 
     hits = []

data/spec/job_spec.rb

@@ -40,7 +40,7 @@ describe 'job classes' do
         job.running.should == true
       end
 
-      it 'returns false when the job hit some error' do
+      it 'returns false when the job hits some error' do
 
         $exception = nil
 

data/spec/mutex_spec.rb

@@ -89,5 +89,71 @@ describe SCHEDULER_CLASS do
       @s.instance_variable_get(:@mutexes).size.should == 0
     end
   end
+
+  context ':mutexes => Array of String' do
+
+    it 'ensure exclusivity' do
+
+      $var = ''
+      m0 = 'm0'
+      m1 = 'm1'
+
+      @s.in('1s', :mutex => m0) { MJOB.call(0) }
+      @s.in('1s', :mutex => m1) { MJOB.call(1) }
+      @s.in('1s', :mutex => [m0, m1]) { MJOB.call(2) }
+
+      sleep 4.5
+
+      $var.should include('in2out2')
+    end
+
+    it 'creates new mutexes when the names are first encountered' do
+
+      @s.instance_variable_get(:@mutexes).size.should == 0
+
+      @s.in('1s', :mutex => ['fruit', 'bread']) { sleep 0.1 }
+
+      sleep 1.5
+
+      @s.instance_variable_get(:@mutexes).size.should == 2
+    end
+
+    it 'creates a unique mutex for a given name' do
+
+      @s.in('1s', :mutex => ['fruit', 'bread']) { sleep 0.1 }
+      @s.in('1s', :mutex => ['fruit', 'bread']) { sleep 0.1 }
+
+      sleep 1.5
+
+      @s.instance_variable_get(:@mutexes).size.should == 2
+    end
+  end
+
+  context ':mutexes => Array of Mutex' do
+
+    it 'ensure exclusivity' do
+
+      $var = ''
+      m0 = Mutex.new
+      m1 = Mutex.new
+
+      @s.in('1s', :mutex => m0) { MJOB.call(0) }
+      @s.in('1s', :mutex => m1) { MJOB.call(1) }
+      @s.in('1s', :mutex => [m0, m1]) { MJOB.call(2) }
+
+      sleep 4.5
+
+      $var.should include('in2out2')
+    end
+
+    it 'does not register the mutexes' do
+
+      @s.in('1s', :mutex => [Mutex.new, Mutex.new]) { sleep 0.1 }
+
+      sleep 1.5
+
+      @s.instance_variable_get(:@mutexes).size.should == 0
+    end
+  end
 end
 

data/spec/rtime_spec.rb

@@ -53,6 +53,23 @@ describe 'rufus/rtime' do
     pts('5.m').should == 300.0
     pts('1m.5s').should == 60.5
     pts('-.5m').should == -30.0
+
+    pts('1d').should == 86400.0
+    pts('0.1d').should == 8640.0
+    pts('0.1s').should == 0.1
+
+    pts('0.1').should == 0.1
+    pts('1').should == 0.001
+      #
+      # the two evil twins :-(
+  end
+
+  it 'parses duration "strings"' do
+
+    o = Object.new
+    def o.to_s; '-2'; end
+
+    pts(o).should == -0.002
   end
 
   it 'raises on wrong duration strings' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rufus-scheduler
 version: !ruby/object:Gem::Version
-  version: 2.0.18
+  version: 2.0.19
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-05 00:00:00.000000000 Z
+date: 2013-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -67,38 +67,39 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Rakefile
-- lib/rufus-scheduler.rb
-- lib/rufus/scheduler.rb
-- lib/rufus/sc/scheduler.rb
-- lib/rufus/sc/rtime.rb
-- lib/rufus/sc/version.rb
+- lib/rufus/otime.rb
 - lib/rufus/sc/cronline.rb
-- lib/rufus/sc/jobs.rb
 - lib/rufus/sc/jobqueues.rb
-- lib/rufus/otime.rb
-- spec/job_spec.rb
-- spec/stress_schedule_unschedule_spec.rb
-- spec/schedulable_spec.rb
-- spec/exception_spec.rb
-- spec/in_spec.rb
-- spec/timeout_spec.rb
-- spec/at_spec.rb
+- lib/rufus/sc/jobs.rb
+- lib/rufus/sc/rtime.rb
+- lib/rufus/sc/scheduler.rb
+- lib/rufus/sc/version.rb
+- lib/rufus/scheduler.rb
+- lib/rufus-scheduler.rb
 - spec/at_in_spec.rb
-- spec/spec_base.rb
+- spec/at_spec.rb
+- spec/blocking_spec.rb
+- spec/cron_spec.rb
 - spec/cronline_spec.rb
-- spec/rtime_spec.rb
+- spec/every_spec.rb
+- spec/exception_spec.rb
+- spec/in_spec.rb
+- spec/job_spec.rb
 - spec/mutex_spec.rb
+- spec/rtime_spec.rb
+- spec/schedulable_spec.rb
 - spec/scheduler_spec.rb
-- spec/blocking_spec.rb
-- spec/every_spec.rb
-- spec/cron_spec.rb
-- test/t.rb
+- spec/spec_base.rb
+- spec/stress_schedule_unschedule_spec.rb
+- spec/timeout_spec.rb
 - test/kjw.rb
+- test/t.rb
 - rufus-scheduler.gemspec
 - CHANGELOG.txt
-- TODO.txt
-- LICENSE.txt
 - CREDITS.txt
+- LICENSE.txt
+- out.txt
+- TODO.txt
 - README.rdoc
 homepage: http://github.com/jmettraux/rufus-scheduler
 licenses: []
@@ -114,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4543164608551708958
+      hash: -1513262691769122142
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -123,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4543164608551708958
+      hash: -1513262691769122142
 requirements: []
 rubyforge_project: rufus
 rubygems_version: 1.8.24