rufus-scheduler 3.0.0 → 3.0.1

data/CHANGELOG.txt

@@ -2,6 +2,12 @@
 = rufus-scheduler CHANGELOG.txt
 
 
+== rufus-scheduler - 3.0.1    not yet released
+
+- fix post_install_message, thanks Ted Pennings
+- bring back .parse_time_string and .parse_duration_string
+
+
 == rufus-scheduler - 3.0.0    released 2013/10/02
 
 - complete rewrite.

data/CREDITS.txt

@@ -4,6 +4,7 @@
 
 == Contributors
 
+- Ted Pennings (https://github.com/tedpennings) typo in post_install_message
 - Tobias Kraze (https://github.com/kratob) timeout vs mutex fix
 - Patrick Farrell (https://github.com/pfarrell) pointing at deprecated start_new
 - Thomas Sevestre (https://github.com/thomassevestre) :exception option
@@ -27,6 +28,9 @@
 
 == Feedback
 
+- Gatis Tomsons - https://github.io/gacha - heavy duty work threads
+- https://github.com/joast - missing .to_time_string alias (code and doc)
+- Tamir Duberstein - https://github.com/tamird - rdoc inaccuracies
 - Kevin Bouwkamp - https://github.com/bmxpert1 - first_at issues
 - Daniel Beauchamp - https://github.com/pushmatrix - pre/post trigger callbacks
 - Arthur Maltson - https://github.com/amaltson - readme fixes
@@ -60,5 +64,6 @@
 
 == and finally
 
+- many thanks to the author and contributors of the tzinfo gem (http://tzinfo.github.io/)
 - many thanks to the EventMachine team (especially Aman Gupta)
 

data/README.md

@@ -78,7 +78,7 @@ There is no EventMachine-based scheduler anymore.
 * The scheduler isn't catching the whole of Exception anymore, only StandardError
 * The error_handler is #on_error (instead of #on_exception), by default it now prints the details of the error to $stderr (used to be $stdout)
 * Rufus::Scheduler::TimeOutError renamed to Rufus::Scheduler::TimeoutError
-* Introduction of "interval" jobs. Whereas "every" jobs are like "every 10 minuts, do this", interval jobs are like "do that, then wait for 10 minutes, then do that again, and so on"
+* Introduction of "interval" jobs. Whereas "every" jobs are like "every 10 minutes, do this", interval jobs are like "do that, then wait for 10 minutes, then do that again, and so on"
 * Introduction of a :lockfile => true/filename mechanism to prevent multiple schedulers from executing
 * "discard_past" is on by default. If the scheduler (its host) sleeps for 1 hour and a ```every '10m'``` job is on, it will trigger once at wakeup, not 6 times (discard_past was false by default in rufus-scheduler 2.x). No intention to re-introduce ```:discard_past => false``` in 3.0 for now.
 * Introduction of Scheduler #on_pre_trigger and #on_post_trigger callback points
@@ -1052,6 +1052,38 @@ Rufus::Scheduler.to_duration_hash(62.127, :drop_seconds => true)
   # => { :m => 1 }
 ```
 
+## a note about timezones
+
+Cron schedules and at schedules support the specification of a timezone.
+
+```ruby
+scheduler.cron '0 22 * * 1-5 America/Chicago' do
+  # the job...
+end
+
+scheduler.at '2013-12-12 14:00 Pacific/Samoa' do
+  puts "it's tea time!"
+end
+
+# or even
+
+Rufus::Scheduler.parse("2013-12-12 14:00 Pacific/Saipan")
+  # => 2013-12-12 04:00:00 UTC
+```
+
+Behind the scenes, rufus-scheduler uses [tzinfo](http://tzinfo.github.io/) to deal with timezones.
+
+Here is a [list of timezones](misc/tz_all.txt) known to my Debian GNU/Linux 7. It was generated with this script:
+
+```ruby
+require 'tzinfo'
+TZInfo::Timezone.all.each { |tz| puts tz.name }
+```
+
+Unknown timezones, typos, will be rejected by tzinfo thus rufus-scheduler.
+
+On its own tzinfo derives the timezones from the system's information. On some system it needs some help, one can install the 'tzinfo-data' gem to provide the missing information.
+
 
 ## support
 

data/lib/rufus/scheduler.rb

@@ -38,7 +38,7 @@ module Rufus
     require 'rufus/scheduler/cronline'
     require 'rufus/scheduler/job_array'
 
-    VERSION = '3.0.0'
+    VERSION = '3.0.1'
 
     #
     # This error is thrown when the :timeout attribute triggers

data/lib/rufus/scheduler/cronline.rb

@@ -106,15 +106,15 @@ class Rufus::Scheduler
     # be passed if no start time is specified (search start time set to
     # Time.now))
     #
-    #   Rufus::CronLine.new('30 7 * * *').next_time(
+    #   Rufus::Scheduler::CronLine.new('30 7 * * *').next_time(
     #     Time.mktime(2008, 10, 24, 7, 29))
     #   #=> Fri Oct 24 07:30:00 -0500 2008
     #
-    #   Rufus::CronLine.new('30 7 * * *').next_time(
+    #   Rufus::Scheduler::CronLine.new('30 7 * * *').next_time(
     #     Time.utc(2008, 10, 24, 7, 29))
     #   #=> Fri Oct 24 07:30:00 UTC 2008
     #
-    #   Rufus::CronLine.new('30 7 * * *').next_time(
+    #   Rufus::Scheduler::CronLine.new('30 7 * * *').next_time(
     #     Time.utc(2008, 10, 24, 7, 29)).localtime
     #   #=> Fri Oct 24 02:30:00 -0500 2008
     #

data/lib/rufus/scheduler/util.rb

@@ -133,17 +133,17 @@ module Rufus
     #
     # Some examples:
     #
-    #   Rufus::Scheduler.parse_duration_string "0.5"    # => 0.5
-    #   Rufus::Scheduler.parse_duration_string "500"    # => 0.5
-    #   Rufus::Scheduler.parse_duration_string "1000"   # => 1.0
-    #   Rufus::Scheduler.parse_duration_string "1h"     # => 3600.0
-    #   Rufus::Scheduler.parse_duration_string "1h10s"  # => 3610.0
-    #   Rufus::Scheduler.parse_duration_string "1w2d"   # => 777600.0
+    #   Rufus::Scheduler.parse_duration "0.5"    # => 0.5
+    #   Rufus::Scheduler.parse_duration "500"    # => 0.5
+    #   Rufus::Scheduler.parse_duration "1000"   # => 1.0
+    #   Rufus::Scheduler.parse_duration "1h"     # => 3600.0
+    #   Rufus::Scheduler.parse_duration "1h10s"  # => 3610.0
+    #   Rufus::Scheduler.parse_duration "1w2d"   # => 777600.0
     #
     # Negative time strings are OK (Thanks Danny Fullerton):
     #
-    #   Rufus::Scheduler.parse_duration_string "-0.5"   # => -0.5
-    #   Rufus::Scheduler.parse_duration_string "-1h"    # => -3600.0
+    #   Rufus::Scheduler.parse_duration "-0.5"   # => -0.5
+    #   Rufus::Scheduler.parse_duration "-1h"    # => -3600.0
     #
     def self.parse_duration(string, opts={})
 
@@ -183,13 +183,22 @@ module Rufus
       mod * val
     end
 
+    class << self
+      #-
+      # for compatibility with rufus-scheduler 2.x
+      #+
+      alias parse_duration_string parse_duration
+      alias parse_time_string parse_duration
+    end
+
+
     # Turns a number of seconds into a a time string
     #
-    #   Rufus.to_duration_string 0                    # => '0s'
-    #   Rufus.to_duration_string 60                   # => '1m'
-    #   Rufus.to_duration_string 3661                 # => '1h1m1s'
-    #   Rufus.to_duration_string 7 * 24 * 3600        # => '1w'
-    #   Rufus.to_duration_string 30 * 24 * 3600 + 1   # => "4w2d1s"
+    #   Rufus.to_duration 0                    # => '0s'
+    #   Rufus.to_duration 60                   # => '1m'
+    #   Rufus.to_duration 3661                 # => '1h1m1s'
+    #   Rufus.to_duration 7 * 24 * 3600        # => '1w'
+    #   Rufus.to_duration 30 * 24 * 3600 + 1   # => "4w2d1s"
     #
     # It goes from seconds to the year. Months are not counted (as they
     # are of variable length). Weeks are counted.
@@ -197,16 +206,14 @@ module Rufus
     # For 30 days months to be counted, the second parameter of this
     # method can be set to true.
     #
-    #   Rufus.to_time_string 30 * 24 * 3600 + 1, true   # => "1M1s"
-    #
-    # (to_time_string is an alias for to_duration_string)
+    #   Rufus.to_duration 30 * 24 * 3600 + 1, true   # => "1M1s"
     #
     # If a Float value is passed, milliseconds will be displayed without
     # 'marker'
     #
-    #   Rufus.to_duration_string 0.051                       # => "51"
-    #   Rufus.to_duration_string 7.051                       # => "7s51"
-    #   Rufus.to_duration_string 0.120 + 30 * 24 * 3600 + 1  # => "4w2d1s120"
+    #   Rufus.to_duration 0.051                       # => "51"
+    #   Rufus.to_duration 7.051                       # => "7s51"
+    #   Rufus.to_duration 0.120 + 30 * 24 * 3600 + 1  # => "4w2d1s120"
     #
     # (this behaviour mirrors the one found for parse_time_string()).
     #
@@ -238,7 +245,11 @@ module Rufus
     end
 
     class << self
+      #-
+      # for compatibility with rufus-scheduler 2.x
+      #+
       alias to_duration_string to_duration
+      alias to_time_string to_duration
     end
 
     # Turns a number of seconds (integer or Float) into a hash like in :
@@ -250,8 +261,7 @@ module Rufus
     #   Rufus.to_duration_hash 0.120 + 30 * 24 * 3600 + 1
     #     # => { :w => 4, :d => 2, :s => 1, :ms => "120" }
     #
-    # This method is used by to_duration_string (to_time_string) behind
-    # the scene.
+    # This method is used by to_duration behind the scenes.
     #
     # Options are :
     #

data/rufus-scheduler.gemspec

@@ -49,7 +49,7 @@ A) Forget it and peg your Gemfile to rufus-scheduler 2.0.24
 and / or
 
 B) Take some time to carefully report the issue at
-   https://github.com/jmettraux/rufus-scheduler/issue
+   https://github.com/jmettraux/rufus-scheduler/issues
 
 For general help about rufus-scheduler, ask via:
 http://stackoverflow.com/questions/ask?tags=rufus-scheduler+ruby

data/spec/cronline_spec.rb

@@ -74,8 +74,15 @@ describe Rufus::Scheduler::CronLine do
 
     it 'interprets cron strings with TZ correctly' do
 
-      to_a '* * * * * EST', [ [0], nil, nil, nil, nil, nil, nil, 'EST' ]
-      to_a '* * * * * * EST', [ nil, nil, nil, nil, nil, nil, nil, 'EST' ]
+      to_a('* * * * * EST', [ [0], nil, nil, nil, nil, nil, nil, 'EST' ])
+      to_a('* * * * * * EST', [ nil, nil, nil, nil, nil, nil, nil, 'EST' ])
+
+      to_a(
+        '* * * * * * America/Chicago',
+        [ nil, nil, nil, nil, nil, nil, nil, 'America/Chicago' ])
+      to_a(
+        '* * * * * * America/New_York',
+        [ nil, nil, nil, nil, nil, nil, nil, 'America/New_York' ])
 
       lambda { cl '* * * * * NotATimeZone' }.should raise_error
       lambda { cl '* * * * * * NotATimeZone' }.should raise_error

data/spec/parse_spec.rb

@@ -138,6 +138,22 @@ describe Rufus::Scheduler do
     end
   end
 
+  describe '.parse_time_string -> .parse_duration' do
+
+    it 'is still around for libs using it out there' do
+
+      Rufus::Scheduler.parse_time_string('1d1w1d').should == 777600.0
+    end
+  end
+
+  describe '.parse_duration_string -> .parse_duration' do
+
+    it 'is still around for libs using it out there' do
+
+      Rufus::Scheduler.parse_duration_string('1d1w1d').should == 777600.0
+    end
+  end
+
   describe '.to_duration' do
 
     def td(o, opts={})

data/spec/threads_spec.rb

@@ -45,6 +45,27 @@ describe Rufus::Scheduler do
       @scheduler.work_threads.size.should == 5
     end
 
+    it 'does not cross the max_work_threads threshold (overlap: false)' do
+
+      #@scheduler.min_work_threads = 2
+      @scheduler.max_work_threads = 5
+
+      10.times do
+        @scheduler.in '0s', :overlap => false do
+          sleep 5
+        end
+      end
+
+      sleep 0.5
+
+      #@scheduler.job_threads.each do |t|
+      #  p t.keys
+      #  p t[:rufus_scheduler_job].class
+      #end
+
+      @scheduler.work_threads.size.should == 5
+    end
+
     it 'does not execute unscheduled jobs' do
 
       @scheduler.max_work_threads = 1

metadata

@@ -1,64 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: rufus-scheduler
 version: !ruby/object:Gem::Version
-  prerelease:
-  version: 3.0.0
+  version: 3.0.1
+  prerelease: 
 platform: ruby
 authors:
 - John Mettraux
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
+date: 2013-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: rake
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  prerelease: false
-  type: :development
 - !ruby/object:Gem::Dependency
   name: rspec
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.13.0
-    none: false
-  prerelease: false
-  type: :development
 description: job scheduler for Ruby (at, cron, in and every jobs).
 email:
 - jmettraux@gmail.com
@@ -102,32 +102,32 @@ files:
 homepage: http://github.com/jmettraux/rufus-scheduler
 licenses:
 - MIT
-post_install_message: "\n***\n\nThanks for installing rufus-scheduler 3.0.0\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\
-  \ 2.0.24\n\nand / or\n\nB) Take some time to carefully report the issue at\n   https://github.com/jmettraux/rufus-scheduler/issue\n\
-  \nFor general help about rufus-scheduler, ask via:\nhttp://stackoverflow.com/questions/ask?tags=rufus-scheduler+ruby\n\
-  \nCheers.\n\n***\n    "
+post_install_message: ! "\n***\n\nThanks for installing rufus-scheduler 3.0.1\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
+  2.0.24\n\nand / or\n\nB) Take some time to carefully report the issue at\n   https://github.com/jmettraux/rufus-scheduler/issues\n\nFor
+  general help about rufus-scheduler, ask via:\nhttp://stackoverflow.com/questions/ask?tags=rufus-scheduler+ruby\n\nCheers.\n\n***\n
+  \   "
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: rufus
-rubygems_version: 1.8.24
-signing_key:
+rubygems_version: 1.8.23
+signing_key: 
 specification_version: 3
 summary: job scheduler for Ruby (at, cron, in and every jobs)
 test_files: []