rufus-scheduler 3.2.2 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d295240539281a67916e2d17affe1b83406f28ff
-  data.tar.gz: a597f93ce56ecd1988f65d8fe46a9cd5401974fb
+  metadata.gz: f5efdaec8fd127103673241abfcb7a14d9135aef
+  data.tar.gz: 95b4b8f72eaea194b946e9b6738fa42b9086fc2a
 SHA512:
-  metadata.gz: 39652b4c2cbf22b58b4a216fb866ab292eacb2042a7acc740d5d1c5bd936e3a68a0307cb4bcfc7b463b256751c1dd465bc8b32bc05130d9bce1b11fc16518b16
-  data.tar.gz: 37f9c3f06c4a49e75e3d38b20cd4a7bd8934263d671a78d78d5daa2c71f68d1a7273653512ca5b5fafc07412fa8a5b4c12c390bb57d9db0072887b8d84e8f7f4
+  metadata.gz: d511d09f4a9c0deffd90a97005d0824b891a55a92236cf885fde676830960ebbaad407d1a4fd4817b81d20d0f7ef9a504ad35b96a58b7a195e30bae89eda0046
+  data.tar.gz: d4da5209b9d01d6a4c861ed022b36971377762ae31ec785d068c0070af3e098e0ff0f6939cd128a96f5752deb74c49daf798a074d6a7557fa80d125f4286dcd5

data/CHANGELOG.txt

@@ -2,6 +2,14 @@
 = rufus-scheduler CHANGELOG.txt
 
 
+== rufus-scheduler - 3.3.0    released 2016-11-28
+
+- Bring in Piavka's Job#trigger_off_schedule, gh-214
+- Reject "day 0" in cronlines, thanks to Ramon Tayag, https://github.com/ramontayag
+- Move away from ENV['TZ'], thanks to Akinori Musha, https://github.com/knu
+- Fix .parse_to_time vs Date issue, as reported by @nsatragno
+
+
 == rufus-scheduler - 3.2.2    released 2016-08-14
 
 - job opt hash preservation, as suggested in gh-212, by https://github.com/d-m-u

data/CREDITS.txt

@@ -4,6 +4,7 @@
 
 == Contributors
 
+- Piavka (https://github.com/piavka) - Job#trigger_off_schedule, gh-214
 - Paulo Delgado (https://github.com/paulodelgado) counter ActiveRecord, gh-210
 - Anjali Sharma (https://github.com/anjali-sharma) enhance job#last_time example
 - Kyle Simukka (https://github.com/simook) raise on "*/0 * * * *"
@@ -50,6 +51,9 @@
 
 == Feedback
 
+- Ramon Tayag - https://github.com/ramontayag - prevent day 0 in cronlines
+- Akinori Musha - https://github.com/knu - ENV['TZ'] setting is harmful
+- Nicolás Satragno - https://twitter.com/nsatragno - parse_to_time vs Date
 - d-m-u duhlmann - https://github.com/d-m-u - job opt hash preservation
 - Anjali Sharma - https://github.com/anjali-sharma - fix typographical error
 - Jonathan Campos - https://github.com/jonbcampos - negative cron day idea

data/README.md

@@ -6,6 +6,8 @@
 
 Job scheduler for Ruby (at, cron, in and every jobs).
 
+It uses threads.
+
 **Note**: maybe are you looking for the [README of rufus-scheduler 2.x](https://github.com/jmettraux/rufus-scheduler/blob/two/README.rdoc)?
 
 Quickstart:
@@ -55,10 +57,12 @@ end
 
 ## non-features
 
-Rufus-scheduler (out of the box) is an in-process, in-memory scheduler.
+Rufus-scheduler (out of the box) is an in-process, in-memory scheduler. It uses threads.
 
 It does not persist your schedules. When the process is gone and the scheduler instance with it, the schedules are gone.
 
+A rufus-scheduler instance will go on scheduling while it is present among the object in a Ruby process. To make it stop scheduling you have to call its [`#shutdown` method](#schedulershutdown).
+
 
 ## related and similar gems
 
@@ -371,6 +375,8 @@ Since, by default, jobs are triggered in their own new thread, job instances mig
 
 To prevent overlap, one can set :overlap => false. Such a job will not trigger if one of its instance is already running.
 
+The `:overlap` option is considered before the `:mutex` option when the scheduler is reviewing jobs for triggering.
+
 ### :mutex => mutex_instance / mutex_name / array of mutexes
 
 When a job with a mutex triggers, the job's block is executed with the mutex around it, preventing other jobs with the same mutex to enter (it makes the other jobs wait until it exits the mutex).
@@ -383,6 +389,8 @@ Array of mutexes: original idea and implementation by [Rainux Luo](https://githu
 
 Warning: creating lots of different mutexes is OK. Rufus-scheduler will place them in its Scheduler#mutexes hash... And they won't get garbage collected.
 
+The `:overlap` option is considered before the `:mutex` option when the scheduler is reviewing jobs for triggering.
+
 ### :timeout => duration or point in time
 
 It's OK to specify a timeout when scheduling some work. After the time specified, it gets interrupted via a Rufus::Scheduler::TimeoutError.

data/fail18.txt

@@ -0,0 +1,12 @@
+
+rspec ./spec/job_spec.rb:640 # Rufus::Scheduler::Job work time #mean_work_time gathers work times and computes the mean
+rspec ./spec/schedule_at_spec.rb:60 # Rufus::Scheduler#at triggers a job
+rspec ./spec/schedule_in_spec.rb:44 # Rufus::Scheduler#in removes the job after execution
+rspec ./spec/scheduler_spec.rb:83 # Rufus::Scheduler a schedule method passes the job to its block when it triggers
+rspec ./spec/scheduler_spec.rb:534 # Rufus::Scheduler#running_jobs(:tag/:tags => x) returns a list of running jobs filtered by tag
+rspec ./spec/scheduler_spec.rb:601 # Rufus::Scheduler#occurrences(time0, time1) respects :times for repeat jobs
+rspec ./spec/scheduler_spec.rb:1019 # Rufus::Scheduler#on_post_trigger is called right after a job triggers
+
+
+determine_id specs are slower... much slower...
+

data/lib/rufus/scheduler.rb

@@ -25,7 +25,7 @@
 require 'date' if RUBY_VERSION < '1.9.0'
 require 'time'
 require 'thread'
-#require 'tzinfo'
+require 'tzinfo'
 
 
 module Rufus
@@ -39,7 +39,7 @@ module Rufus
     require 'rufus/scheduler/job_array'
     require 'rufus/scheduler/locks'
 
-    VERSION = '3.2.2'
+    VERSION = '3.3.0'
 
     #
     # A common error class for rufus-scheduler
@@ -154,7 +154,7 @@ module Rufus
 
     def uptime
 
-      @started_at ? Time.now - @started_at : nil
+      @started_at ? Rufus::Scheduler::ZoTime.now - @started_at : nil
     end
 
     def uptime_s
@@ -478,6 +478,7 @@ module Rufus
       stderr.puts("  #{pre}   tz:")
       stderr.puts("  #{pre}     ENV['TZ']: #{ENV['TZ']}")
       stderr.puts("  #{pre}     Time.now: #{Time.now}")
+      stderr.puts("  #{pre}     local_tzone: #{Rufus::Scheduler::ZoTime.local_tzone.inspect}")
       stderr.puts("  #{pre}   scheduler:")
       stderr.puts("  #{pre}     object_id: #{object_id}")
       stderr.puts("  #{pre}     opts:")
@@ -557,7 +558,7 @@ module Rufus
 
     def start
 
-      @started_at = Time.now
+      @started_at = Rufus::Scheduler::ZoTime.now
 
       @thread =
         Thread.new do
@@ -584,7 +585,7 @@ module Rufus
 
     def trigger_jobs
 
-      now = Time.now
+      now = Rufus::Scheduler::ZoTime.now
 
       @jobs.each(now) do |job|
 
@@ -603,9 +604,9 @@ module Rufus
         next unless job && to && ts
           # thread might just have become inactive (job -> nil)
 
-        to = to.is_a?(Time) ? to : ts + to
+        to = ts + to unless to.is_a?(Rufus::Scheduler::ZoTime)
 
-        next if to > Time.now
+        next if to > Rufus::Scheduler::ZoTime.now
 
         t.raise(Rufus::Scheduler::TimeoutError)
       end
@@ -626,7 +627,7 @@ module Rufus
         case job_type
           when :once
             opts[:_t] ||= Rufus::Scheduler.parse(t, opts)
-            opts[:_t].is_a?(Time) ? AtJob : InJob
+            opts[:_t].is_a?(Numeric) ? InJob : AtJob
           when :every
             EveryJob
           when :interval

data/lib/rufus/scheduler/cronline.rb

@@ -36,6 +36,7 @@ class Rufus::Scheduler
     # The string used for creating this cronline instance.
     #
     attr_reader :original
+    attr_reader :original_timezone
 
     attr_reader :seconds
     attr_reader :minutes
@@ -53,10 +54,15 @@ class Rufus::Scheduler
       ) unless line.is_a?(String)
 
       @original = line
+      @original_timezone = nil
 
       items = line.split
 
-      @timezone = items.pop if ZoTime.is_timezone?(items.last)
+      if @timezone = ZoTime.get_tzone(items.last)
+        @original_timezone = items.pop
+      else
+        @timezone = ZoTime.get_tzone(:current)
+      end
 
       fail ArgumentError.new(
         "not a valid cronline : '#{line}'"
@@ -77,18 +83,26 @@ class Rufus::Scheduler
           "invalid cronline: '#{line}'"
         ) if es && es.find { |e| ! e.is_a?(Fixnum) }
       end
+
+      if @days && @days.include?(0) # gh-221
+
+        fail ArgumentError.new('invalid day 0 in cronline')
+      end
     end
 
     # Returns true if the given time matches this cron line.
     #
     def matches?(time)
 
-      time = ZoTime.new(time.to_f, @timezone || ENV['TZ']).time
+        # FIXME Don't create a new ZoTime if time is already a ZoTime in same
+        #       zone ...
+        #       Wait, this seems only used in specs...
+      t = ZoTime.new(time.to_f, @timezone)
 
-      return false unless sub_match?(time, :sec, @seconds)
-      return false unless sub_match?(time, :min, @minutes)
-      return false unless sub_match?(time, :hour, @hours)
-      return false unless date_match?(time)
+      return false unless sub_match?(t, :sec, @seconds)
+      return false unless sub_match?(t, :min, @minutes)
+      return false unless sub_match?(t, :hour, @hours)
+      return false unless date_match?(t)
       true
     end
 
@@ -119,36 +133,36 @@ class Rufus::Scheduler
     #
     # (Thanks to K Liu for the note and the examples)
     #
-    def next_time(from=Time.now)
+    def next_time(from=ZoTime.now)
 
-      time = nil
-      zotime = ZoTime.new(from.to_i + 1, @timezone || ENV['TZ'])
+      nt = nil
+      zt = ZoTime.new(from.to_i + 1, @timezone)
 
       loop do
 
-        time = zotime.time
+        nt = zt.dup
 
-        unless date_match?(time)
-          zotime.add((24 - time.hour) * 3600 - time.min * 60 - time.sec)
+        unless date_match?(nt)
+          zt.add((24 - nt.hour) * 3600 - nt.min * 60 - nt.sec)
           next
         end
-        unless sub_match?(time, :hour, @hours)
-          zotime.add((60 - time.min) * 60 - time.sec)
+        unless sub_match?(nt, :hour, @hours)
+          zt.add((60 - nt.min) * 60 - nt.sec)
           next
         end
-        unless sub_match?(time, :min, @minutes)
-          zotime.add(60 - time.sec)
+        unless sub_match?(nt, :min, @minutes)
+          zt.add(60 - nt.sec)
           next
         end
-        unless sub_match?(time, :sec, @seconds)
-          zotime.add(next_second(time))
+        unless sub_match?(nt, :sec, @seconds)
+          zt.add(next_second(nt))
           next
         end
 
         break
       end
 
-      time
+      nt
     end
 
     # Returns the previous time the cronline matched. It's like next_time, but
@@ -156,34 +170,34 @@ class Rufus::Scheduler
     #
     def previous_time(from=Time.now)
 
-      time = nil
-      zotime = ZoTime.new(from.to_i - 1, @timezone || ENV['TZ'])
+      pt = nil
+      zt = ZoTime.new(from.to_i - 1, @timezone)
 
       loop do
 
-        time = zotime.time
+        pt = zt.dup
 
-        unless date_match?(time)
-          zotime.substract(time.hour * 3600 + time.min * 60 + time.sec + 1)
+        unless date_match?(pt)
+          zt.substract(pt.hour * 3600 + pt.min * 60 + pt.sec + 1)
           next
         end
-        unless sub_match?(time, :hour, @hours)
-          zotime.substract(time.min * 60 + time.sec + 1)
+        unless sub_match?(pt, :hour, @hours)
+          zt.substract(pt.min * 60 + pt.sec + 1)
           next
         end
-        unless sub_match?(time, :min, @minutes)
-          zotime.substract(time.sec + 1)
+        unless sub_match?(pt, :min, @minutes)
+          zt.substract(pt.sec + 1)
           next
         end
-        unless sub_match?(time, :sec, @seconds)
-          zotime.substract(prev_second(time))
+        unless sub_match?(pt, :sec, @seconds)
+          zt.substract(prev_second(pt))
           next
         end
 
         break
       end
 
-      time
+      pt
     end
 
     # Returns an array of 6 arrays (seconds, minutes, hours, days,
@@ -200,7 +214,7 @@ class Rufus::Scheduler
         toa(@months),
         toa(@weekdays),
         toa(@monthdays),
-        @timezone
+        @timezone.name
       ]
     end
     alias to_array to_a
@@ -260,7 +274,9 @@ class Rufus::Scheduler
         break if delta <= 1
         break if delta <= 60 && @seconds && @seconds.size == 1
 
+#st = Time.now
         t1 = next_time(t0)
+#p Time.now - st
         d = t1 - t0
         delta = d if d < delta
 
@@ -314,7 +330,6 @@ class Rufus::Scheduler
 
     WEEKDAYS = %w[ sun mon tue wed thu fri sat ]
     DAY_S = 24 * 3600
-    WEEK_S = 7 * DAY_S
 
     def parse_weekdays(item)
 
@@ -431,12 +446,14 @@ class Rufus::Scheduler
       r.uniq
     end
 
+    # FIXME: Eventually split into day_match?, hour_match? and monthdays_match?o
+    #
     def sub_match?(time, accessor, values)
 
-      value = time.send(accessor)
-
       return true if values.nil?
 
+      value = time.send(accessor)
+
       if accessor == :day
 
         values.each do |v|
@@ -450,48 +467,31 @@ class Rufus::Scheduler
         return true if value == 0 && values.include?(24)
       end
 
-      values.include?(value)
-    end
-
-    def monthday_match?(date, values)
+      if accessor == :monthdays
 
-      return true if values.nil?
-
-      today_values = monthdays(date)
-
-      (today_values & values).any?
-    end
-
-    def date_match?(date)
+        return true if (values & value).any?
+      end
 
-      return false unless sub_match?(date, :day, @days)
-      return false unless sub_match?(date, :month, @months)
-      return false unless sub_match?(date, :wday, @weekdays)
-      return false unless monthday_match?(date, @monthdays)
-      true
+      values.include?(value)
     end
 
-    def monthdays(date)
-
-      pos = 1
-      d = date.dup
-
-      loop do
-        d = d - WEEK_S
-        break if d.month != date.month
-        pos = pos + 1
-      end
+#    def monthday_match?(zt, values)
+#
+#      return true if values.nil?
+#
+#      today_values = monthdays(zt)
+#
+#      (today_values & values).any?
+#    end
 
-      neg = -1
-      d = date.dup
+    def date_match?(zt)
 
-      loop do
-        d = d + WEEK_S
-        break if d.month != date.month
-        neg = neg - 1
-      end
-
-      [ "#{date.wday}##{pos}", "#{date.wday}##{neg}" ]
+      return false unless sub_match?(zt, :day, @days)
+      return false unless sub_match?(zt, :month, @months)
+      return false unless sub_match?(zt, :wday, @weekdays)
+      #return false unless monthday_match?(zt, @monthdays)
+      return false unless sub_match?(zt, :monthdays, @monthdays)
+      true
     end
   end
 end

data/lib/rufus/scheduler/job_array.rb

@@ -53,10 +53,14 @@ module Rufus
 
       def each(now, &block)
 
-        to_a.sort_by { |j| j.next_time || (now + 1) }.each do |job|
+        to_a.sort_by do |job|
 
-          break unless job.next_time
-          break if job.next_time > now
+          job.next_time || (now + 1)
+
+        end.each do |job|
+
+          nt = job.next_time
+          break if ( ! nt) || (nt > now)
 
           block.call(job)
         end