vrinek-periodicity 0.1.1 → 0.2

data/README.rdoc

@@ -12,7 +12,6 @@ Helps calculate the next run for schedulers using a human readable syntax.
 means: every 2 hours at :20 from 10:00 to 15:00 (10:20, 12:20, 14:20)
   
   period.next_run # returns the next calculated time as a Time object
-  period.next_run(1) # skips 1 run (as of 0.1, it behaves buggy with from and to limits)
   
   Period.new.every(:half).hour # every 30 minutes
   Period.every.week # every week
@@ -29,5 +28,4 @@ means: every 2 hours at :20 from 10:00 to 15:00 (10:20, 12:20, 14:20)
 
 == TODO:
 
-* support "overnight" limits (from 22:00 tonight to 02:00 tomorrow) like:
-    Period.every.hour.from(20).to(2)
+* add <em>sub-sub-time</em> precision to at(time) (e.g. '5:30')

data/lib/periodicity/period.rb

@@ -92,8 +92,6 @@ class Period
     every(2).hours.from(8) # means "every 2 hours beginning from 8:00"
 =end
   def from(time)
-    raise "From can't be after to" if @to and @to < time
-    
     @from = time
     return self
   end
@@ -103,8 +101,6 @@ class Period
     every(2).hours.to(12) # means "every 2 hours until 12:00"
 =end
   def to(time)
-    raise "To can't be before from" if @from and time < @from
-    
     @to = time
     return self
   end
@@ -139,9 +135,9 @@ class Period
     now = "Aug 05 14:40:23 2009".to_time
     Period.new(now).every(2).hours.next_run # => Wed Aug 05 16:00:00 UTC 2009
     
-  Note that it round all "sub-time" to 0 by default (can be overriden with at)
+  Note that it rounds all "sub-time" to 0 by default (can be overriden with at)
 =end
-  def next_run(skip = 0)
+  def next_run
     return Time.now unless @last_run
     
     @next_run = @last_run
@@ -152,12 +148,6 @@ class Period
       calc_precision
       
       calc_limits
-      
-      unless skip.zero?
-        @next_run += @interval * @scope * skip
-
-        calc_limits
-      end
     else
       raise 'No proper period specified'
     end
@@ -186,43 +176,31 @@ class Period
   
   def calc_precision(scope = nil)
     @at = 0 if scope
-    
-    case scope || @scope
-    when 1.minute
-      unless @next_run.sec == @at
-        @next_run += (@at - @next_run.sec)
-      end
-    when 1.hour
-      unless @next_run.min == @at
-        @next_run += (@at - @next_run.min).minutes
-      end
-      calc_precision 1.minute
-    when 1.day
-      unless @next_run.hour == @at
-        @next_run += (@at - @next_run.hour).hours
-      end
-      calc_precision 1.hour
-    when 1.week
-      unless @next_run.hour == @at
-        @next_run += (@at - @next_run.hour).hours
+
+    if down = downtime(scope || @scope)
+      unless now(down) == @at
+        @next_run += (@at - now(down)) * down
       end
-      calc_precision 1.hour
+      calc_precision down
     end
   end
   
   def calc_limits
-    if @from or @to
-      now = case @scope
-      when 1.second
-        @next_run.sec
-      when 1.minute
-        @next_run.min
-      when 1.hour
-        @next_run.hour
-      when 1.day
-        @next_run.day
+    if @from and @to and @from > @to # aka overnight limits
+      if now < @from
+        @next_run += (
+        if @to < now + (now(downtime)*(downtime / @scope.to_f) || 0)
+          @from - now
+        else
+          0
+        end
+        ) * @scope
       end
-      
+
+      if now > @to and @from < @to
+        @next_run += (@from - now) * @scope + uptime
+      end
+    elsif @from or @to
       if @from and now < @from
         @next_run += (@from - now) * @scope
       elsif @to and now > @to
@@ -231,6 +209,19 @@ class Period
     end
   end
   
+  def now(scope = nil)
+    case scope || @scope
+    when 1.second
+      @next_run.sec
+    when 1.minute
+      @next_run.min
+    when 1.hour
+      @next_run.hour
+    when 1.day
+      @next_run.day
+    end
+  end
+  
   def uptime
     case @scope
     when 1.second
@@ -246,8 +237,8 @@ class Period
     end
   end
   
-  def downtime
-    case @scope
+  def downtime(scope = nil)
+    case scope || @scope
     when 1.minute
       1.second
     when 1.hour

data/lib/periodicity.rb

@@ -5,5 +5,5 @@ require 'activesupport'
 require 'periodicity/period'
 
 module Periodicity
-  VERSION = '0.1.1'
+  VERSION = '0.2'
 end

data/spec/periodicity_spec.rb

@@ -28,9 +28,9 @@ describe Period do
     period.every.day.at(:noon).next_run.should == "Aug 06 12:00:00 2009".to_time
     period.every.day.at(:afternoon).next_run.should == "Aug 06 19:00:00 2009".to_time
     
-    period.every.day.at(:midnight).next_run.should == "Aug 06 00:00:00 2009".to_time
-    period.every.day.at(:midnight).next_run(1).should == "Aug 07 00:00:00 2009".to_time
-    period.every.day.at(:midnight).next_run(2).should == "Aug 08 00:00:00 2009".to_time
+    (n = period.every.day.at(:midnight).next_run).should == "Aug 06 00:00:00 2009".to_time
+    (n = Period.new(n).every.day.at(:midnight).next_run).should == "Aug 07 00:00:00 2009".to_time
+    (n = Period.new(n).every.day.at(:midnight).next_run).should == "Aug 08 00:00:00 2009".to_time
 
     period.every.day.at('5').next_run.should == "Aug 06 05:00:00 2009".to_time
     period.every.day.at('5:00').next_run.should == "Aug 06 05:00:00 2009".to_time
@@ -43,9 +43,9 @@ describe Period do
     period.every.week.at(20).next_run.should == "Aug 12 20:00:00 2009".to_time
     period.every.day.at(14).next_run.should == "Aug 06 14:00:00 2009".to_time
     
-    period.every.hour.at(30).next_run.should == "Aug 05 15:30:00 2009".to_time
-    period.every.hour.at(30).next_run(1).should == "Aug 05 16:30:00 2009".to_time
-    period.every.hour.at(30).next_run(2).should == "Aug 05 17:30:00 2009".to_time
+    (n = period.every.hour.at(30).next_run).should == "Aug 05 15:30:00 2009".to_time
+    (n = Period.new(n).every.hour.at(30).next_run).should == "Aug 05 16:30:00 2009".to_time
+    (n = Period.new(n).every.hour.at(30).next_run).should == "Aug 05 17:30:00 2009".to_time
   end
   
   it "should take into account the limits" do
@@ -53,39 +53,90 @@ describe Period do
     period.every.hour.from(13).next_run.should == "Aug 05 15:00:00 2009".to_time
     period.every(2).hours.from(12).next_run.should == "Aug 05 16:00:00 2009".to_time
     
-    period.every(2).hours.from(21).next_run.should == "Aug 05 21:00:00 2009".to_time
-    period.every(2).hours.from(21).next_run(1).should == "Aug 05 23:00:00 2009".to_time
-    period.every(2).hours.from(21).next_run(2).should == "Aug 06 21:00:00 2009".to_time
+    (n = period.every(2).hours.from(21).next_run).should == "Aug 05 21:00:00 2009".to_time
+    (n = Period.new(n).every(2).hours.from(21).next_run).should == "Aug 05 23:00:00 2009".to_time
+    (n = Period.new(n).every(2).hours.from(21).next_run).should == "Aug 06 21:00:00 2009".to_time
     
-    period.every(2).hours.to(12).next_run.should == "Aug 06 00:00:00 2009".to_time
-    period.every(2).hours.to(12).next_run(1).should == "Aug 06 02:00:00 2009".to_time
-    period.every(2).hours.to(12).next_run(2).should == "Aug 06 04:00:00 2009".to_time
+    (n = period.every(2).hours.to(12).next_run).should == "Aug 06 00:00:00 2009".to_time
+    (n = Period.new(n).every(2).hours.to(12).next_run).should == "Aug 06 02:00:00 2009".to_time
+    (n = Period.new(n).every(2).hours.to(12).next_run).should == "Aug 06 04:00:00 2009".to_time
     
-    period.every(5).minutes.from(15).to(50).next_run(0).should == "Aug 05 14:45:00 2009".to_time
-    period.every(5).minutes.from(15).to(50).next_run(1).should == "Aug 05 14:50:00 2009".to_time
-    period.every(5).minutes.from(15).to(50).next_run(2).should == "Aug 05 15:15:00 2009".to_time
-    # period.every(5).minutes.from(15).to(50).next_run(3).should == "Aug 05 15:20:00 2009".to_time # skip has limits...
+    (n = period.every(5).minutes.from(15).to(50).next_run).should == "Aug 05 14:45:00 2009".to_time
+    (n = Period.new(n).every(5).minutes.from(15).to(50).next_run).should == "Aug 05 14:50:00 2009".to_time
+    (n = Period.new(n).every(5).minutes.from(15).to(50).next_run).should == "Aug 05 15:15:00 2009".to_time
+    (n = Period.new(n).every(5).minutes.from(15).to(50).next_run).should == "Aug 05 15:20:00 2009".to_time
 
-    period.every(2).hours.from(8).to(12).next_run(0).should == "Aug 06 08:00:00 2009".to_time
-    period.every(2).hours.from(8).to(12).next_run(1).should == "Aug 06 10:00:00 2009".to_time
-    period.every(2).hours.from(8).to(12).next_run(2).should == "Aug 06 12:00:00 2009".to_time
-    period.every(2).hours.from(8).to(12).next_run(3).should == "Aug 07 08:00:00 2009".to_time
-    # period.every(2).hours.from(8).to(12).next_run(4).should == "Aug 07 10:00:00 2009".to_time # skip has limits...
+    (n = period.every(2).hours.from(8).to(12).next_run).should == "Aug 06 08:00:00 2009".to_time
+    (n = Period.new(n).every(2).hours.from(8).to(12).next_run).should == "Aug 06 10:00:00 2009".to_time
+    (n = Period.new(n).every(2).hours.from(8).to(12).next_run).should == "Aug 06 12:00:00 2009".to_time
+    (n = Period.new(n).every(2).hours.from(8).to(12).next_run).should == "Aug 07 08:00:00 2009".to_time
+    (n = Period.new(n).every(2).hours.from(8).to(12).next_run).should == "Aug 07 10:00:00 2009".to_time
 
-    period.every(3).days.from(5).to(20).next_run(0).should == "Aug 08 00:00:00 2009".to_time
-    period.every(3).days.from(5).to(20).next_run(1).should == "Aug 11 00:00:00 2009".to_time
-    period.every(3).days.from(5).to(20).next_run(2).should == "Aug 14 00:00:00 2009".to_time
-    period.every(3).days.from(5).to(20).next_run(3).should == "Aug 17 00:00:00 2009".to_time
-    period.every(3).days.from(5).to(20).next_run(4).should == "Aug 20 00:00:00 2009".to_time
-    period.every(3).days.from(5).to(20).next_run(5).should == "Sep 05 00:00:00 2009".to_time
+    (n = period.every(3).days.from(5).to(20).next_run).should == "Aug 08 00:00:00 2009".to_time
+    (n = Period.new(n).every(3).days.from(5).to(20).next_run).should == "Aug 11 00:00:00 2009".to_time
+    (n = Period.new(n).every(3).days.from(5).to(20).next_run).should == "Aug 14 00:00:00 2009".to_time
+    (n = Period.new(n).every(3).days.from(5).to(20).next_run).should == "Aug 17 00:00:00 2009".to_time
+    (n = Period.new(n).every(3).days.from(5).to(20).next_run).should == "Aug 20 00:00:00 2009".to_time
+    (n = Period.new(n).every(3).days.from(5).to(20).next_run).should == "Sep 05 00:00:00 2009".to_time
+  end
+  
+  it "should calculate overnight limits correctly" do
+    (n = period.every.hour.from(21).to(2).next_run).should == "Aug 05 21:00:00 2009".to_time
+    (n = Period.new(n).every.hour.from(21).to(2).next_run).should == "Aug 05 22:00:00 2009".to_time
+    (n = Period.new(n).every.hour.from(21).to(2).next_run).should == "Aug 05 23:00:00 2009".to_time
+    (n = Period.new(n).every.hour.from(21).to(2).next_run).should == "Aug 06 00:00:00 2009".to_time
+    (n = Period.new(n).every.hour.from(21).to(2).next_run).should == "Aug 06 01:00:00 2009".to_time
+    (n = Period.new(n).every.hour.from(21).to(2).next_run).should == "Aug 06 02:00:00 2009".to_time
+    (n = Period.new(n).every.hour.from(21).to(2).next_run).should == "Aug 06 21:00:00 2009".to_time
+    (n = Period.new(n).every.hour.from(21).to(2).next_run).should == "Aug 06 22:00:00 2009".to_time
+    (n = Period.new(n).every.hour.from(21).to(2).next_run).should == "Aug 06 23:00:00 2009".to_time
+    (n = Period.new(n).every.hour.from(21).to(2).next_run).should == "Aug 07 00:00:00 2009".to_time
+    (n = Period.new(n).every.hour.from(21).to(2).next_run).should == "Aug 07 01:00:00 2009".to_time
+    (n = Period.new(n).every.hour.from(21).to(2).next_run).should == "Aug 07 02:00:00 2009".to_time
+    (n = Period.new(n).every.hour.from(21).to(2).next_run).should == "Aug 07 21:00:00 2009".to_time
+
+    (n = period.every.day.from(29).to(2).next_run).should == "Aug 29 00:00:00 2009".to_time
+    (n = Period.new(n).every.day.from(29).to(2).next_run).should == "Aug 30 00:00:00 2009".to_time
+    (n = Period.new(n).every.day.from(29).to(2).next_run).should == "Aug 31 00:00:00 2009".to_time
+    (n = Period.new(n).every.day.from(29).to(2).next_run).should == "Sep 01 00:00:00 2009".to_time
+
+    (n = period.every(3).days.from(29).to(10).next_run).should == "Aug 08 00:00:00 2009".to_time
+    (n = Period.new(n).every(3).days.from(29).to(10).next_run).should == "Aug 29 00:00:00 2009".to_time
+    (n = Period.new(n).every(3).days.from(29).to(10).next_run).should == "Sep 01 00:00:00 2009".to_time
+    (n = Period.new(n).every(3).days.from(29).to(10).next_run).should == "Sep 04 00:00:00 2009".to_time
+    (n = Period.new(n).every(3).days.from(29).to(10).next_run).should == "Sep 07 00:00:00 2009".to_time
+    (n = Period.new(n).every(3).days.from(29).to(10).next_run).should == "Sep 10 00:00:00 2009".to_time
+    (n = Period.new(n).every(3).days.from(29).to(10).next_run).should == "Sep 29 00:00:00 2009".to_time
+    (n = Period.new(n).every(3).days.from(29).to(10).next_run).should == "Oct 02 00:00:00 2009".to_time
+  end
+  
+  it "should calculate overnight with precision limits correctly" do
+    (n = period.every.hour.at(15).from(21).to(2).next_run).should == "Aug 05 21:15:00 2009".to_time
+    (n = Period.new(n).every.hour.at(15).from(21).to(2).next_run).should == "Aug 05 22:15:00 2009".to_time
+    (n = Period.new(n).every.hour.at(15).from(21).to(2).next_run).should == "Aug 05 23:15:00 2009".to_time
+    (n = Period.new(n).every.hour.at(15).from(21).to(2).next_run).should == "Aug 06 00:15:00 2009".to_time
+    (n = Period.new(n).every.hour.at(15).from(21).to(2).next_run).should == "Aug 06 01:15:00 2009".to_time
+    (n = Period.new(n).every.hour.at(15).from(21).to(2).next_run).should == "Aug 06 21:15:00 2009".to_time
+    (n = Period.new(n).every.hour.at(15).from(21).to(2).next_run).should == "Aug 06 22:15:00 2009".to_time
+    (n = Period.new(n).every.hour.at(15).from(21).to(2).next_run).should == "Aug 06 23:15:00 2009".to_time
+    (n = Period.new(n).every.hour.at(15).from(21).to(2).next_run).should == "Aug 07 00:15:00 2009".to_time
+
+    (n = period.every(5).minutes.at(30).from(40).to(10).next_run).should == "Aug 05 14:45:30 2009".to_time
+    (n = Period.new(n).every.every(5).minutes.at(30).from(40).to(10).next_run).should == "Aug 05 14:50:30 2009".to_time
+    (n = Period.new(n).every.every(5).minutes.at(30).from(40).to(10).next_run).should == "Aug 05 14:55:30 2009".to_time
+    (n = Period.new(n).every.every(5).minutes.at(30).from(40).to(10).next_run).should == "Aug 05 15:00:30 2009".to_time
+    (n = Period.new(n).every.every(5).minutes.at(30).from(40).to(10).next_run).should == "Aug 05 15:05:30 2009".to_time
+    (n = Period.new(n).every.every(5).minutes.at(30).from(40).to(10).next_run).should == "Aug 05 15:40:30 2009".to_time
+    (n = Period.new(n).every.every(5).minutes.at(30).from(40).to(10).next_run).should == "Aug 05 15:45:30 2009".to_time
+    (n = Period.new(n).every.every(5).minutes.at(30).from(40).to(10).next_run).should == "Aug 05 15:50:30 2009".to_time
   end
   
   it "should avoid some pitfalls" do
     Period.new("Aug 05 14:41:23 2009".to_time).every.hour.at(40).next_run.should == "Aug 05 15:40:00 2009".to_time
     Period.new("Aug 05 14:39:23 2009".to_time).every.hour.at(40).next_run.should == "Aug 05 15:40:00 2009".to_time
     
-    lambda {period.from(5).to(1)}.should raise_error
-    lambda {period.to(1).from(5)}.should raise_error
+    # lambda {period.from(5).to(1)}.should raise_error
+    # lambda {period.to(1).from(5)}.should raise_error
   end
   
   def period

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vrinek-periodicity
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: "0.2"
 platform: ruby
 authors: 
 - Kostas Karachalios