recurring 0.3.2 → 0.3.10

data/History.txt

@@ -1,3 +1,7 @@
+== 0.3.5 / 2006-12-14
+
+* documentation / hoe
+
 == 0.3.2 / 2006-12-13
 
 * initialization bugfixes

data/Rakefile

@@ -25,7 +25,6 @@ Hoe.new('recurring', Recurring::VERSION) do |p|
   p.description =<<-DESC
   Recurring allows you to define Schedules, which can tell you whether or not a given Time falls in the Schedule, as well as being able to return a list of times which match the Schedule within a given range.
 DESC
-  puts p.changes
 end
 
 # specification = Gem::Specification.new do |s|
@@ -52,17 +51,17 @@ end
 #   pkg.need_tar = true
 # end
 # 
-# Rake::RDocTask.new(:docs) do |rd|
-#   rd.main = "README.txt"
-#   rd.options << '-d' if RUBY_PLATFORM !~ /win32/ and `which dot` =~ /\/dot/
-#   rd.rdoc_dir = 'doc'
-#   files = ["History.txt", "README.txt", "Rakefile", "lib/recurring.rb", "spec/recurring_spec.rb"]
-#   rd.rdoc_files.push(*files)
-# 
-#   title = "#{specification.name}-#{specification.version} Documentation"
-#   #title = "#{rubyforge_name}'s " + title if rubyforge_name != title
-# 
-#   rd.options << "-t #{title}"
-# end
+Rake::RDocTask.new(:docs) do |rd|
+  rd.main = "README.txt"
+  rd.options << '-d' if RUBY_PLATFORM !~ /win32/ and `which dot` =~ /\/dot/
+  rd.rdoc_dir = 'doc'
+  files = ["History.txt", "README.txt", "Rakefile", "lib/recurring.rb", "spec/recurring_spec.rb"]
+  rd.rdoc_files.push(*files)
+
+  title = "Recurring-#{VERSION} Documentation"
+  #title = "#{rubyforge_name}'s " + title if rubyforge_name != title
+
+  rd.options << "-t #{title}"
+end
 
 

data/lib/recurring.rb

@@ -1,7 +1,7 @@
 module Recurring
-  VERSION = '0.3.2'
-
+  VERSION = '0.3.10'
   class << self
+    
     # returns a number starting with 1
     def week_in_month date
       (((date.day - 1).to_f / 7.0) + 1).floor
@@ -45,8 +45,8 @@ module Recurring
     
     attr_reader :unit, :frequency, :anchor, :months, :weeks, :monthdays, :weekdays, :times
     
-    # * options is a hash with keys <tt>:unit, :frequency, :anchor, :weeks, :monthdays, :weekdays, :times</tt>
-    # * valid units are <tt>years, months, weeks, days, hours, and minutes</tt>
+    # Options hash has keys <tt>:unit, :frequency, :anchor, :weeks, :monthdays, :weekdays, :times</tt>
+    # * valid values for :unit are <tt>years, months, weeks, days, hours, minutes</tt>
     # * :frequency defaults to 1
     # * :anchor is required if the frequency is other than one
     # * :weeks alongside :weekdays is used to specify the nth instance of a weekday in a month. 
@@ -64,11 +64,19 @@ module Recurring
       @frequency = options[:frequency] || 1
       @anchor = options[:anchor]
       @times = parse_times options[:times]
-      @months = Array(options[:months]).collect{|d|d.to_s.downcase.to_sym} if options[:months]
-      @weeks = Array(options[:weeks]) if options[:weeks]
-      @weekdays = Array(options[:weekdays]).collect{|d|d.to_s.downcase.to_sym} if options[:weekdays]
-      @monthdays = Array(options[:monthdays]) if options[:monthdays]
+      if options[:months]
+	@months = Array(options[:months]).collect{|d|d.to_s.downcase.to_sym}
+	raise ArgumentError, 'provide valid months' unless @months.all?{|m|ordinal_month(m)}
+      end
+      
+      @weeks = Array(options[:weeks]).collect{|n|n.to_i} if options[:weeks]
+      if options[:weekdays]
+	@weekdays = Array(options[:weekdays]).collect{|d|d.to_s.downcase.to_sym}
+	raise ArgumentError, 'provide valid weekdays' unless @weekdays.all?{|w|ordinal_weekday(w)}
+      end
+      @monthdays = Array(options[:monthdays]).collect{|n|n.to_i} if options[:monthdays]
       
+     
       @anchor_multiple = options[:times].nil? && options[:weeks].nil? && options[:weekdays].nil? && options[:monthdays].nil?
     end
     
@@ -100,6 +108,7 @@ module Recurring
     def find_next date
       loop do
       	return date if include?(date)
+      	#puts "#{@resolution} : #{date}"
       	date = beginning_of_next @resolution, date
       end
     end
@@ -108,6 +117,7 @@ module Recurring
     def find_previous date
       loop do
 	return date if include?(date)
+	#puts "#{@resolution} : #{date}"
 	date = end_of_previous @resolution, date
       end
     end
@@ -153,7 +163,7 @@ module Recurring
       	when :week
       	  to_sunday = date.wday
       	  previous_week = (date - to_sunday*24*60*60)
-      	  Time.utc(previous_week.year, previous_week.month, previous_week.day)
+      	  Time.utc(previous_week.year, previous_week.month, previous_week.day) - 1
       	when :day
       	  Time.utc(date.year, date.month, date.day) - 1
       	when :time
@@ -179,6 +189,10 @@ module Recurring
       	  Time.utc(dayp.year, dayp.month, dayp.day)
       	when :time
       	  next_time date
+      	when :hour
+      	  date.hour < 23 ? Time.utc(date.year, date.month, date.day, date.hour+1) : beginning_of_next(:day, date)
+      	when :sub_hour
+      	  next_sub_hour date
       	else
       	  date + 1
       	end
@@ -221,6 +235,23 @@ module Recurring
       	end
       end
 
+      def next_sub_hour date
+      	me = {:minute => date.min, :second => date.sec, :me => true}      
+      	my_times = times + [me]
+      	my_times += [{:minute => @anchor.min, :second => @anchor.sec}] if check_anchor?
+      	my_times.sort! do |a,b|
+      	  v = a[:minute] <=> b[:minute]
+      	  v = a[:second] <=> b[:second] if v == 0
+      	  v
+      	end
+      	ntime = my_times[my_times.index(me)+1]
+      	if ntime
+      	  Time.utc(date.year, date.month, date.day, date.hour, ntime[:minute], ntime[:second])
+      	else
+      	  beginning_of_next :hour, date
+      	end      
+      end
+
       def mismatch unit
 	      @resolution = unit
 	      false
@@ -246,9 +277,9 @@ module Recurring
       end
 
       def week_matches? date
-	      if @unit == :weeks 
+	if @unit == :weeks 
       	  return true if @frequency == 1
-      	  return (Recurring.week_of_year(date) - Recurring.week_of_year(@anchor)) % @frequency == 0
+      	  return ((Recurring.week_of_year(date) - Recurring.week_of_year(@anchor)) % @frequency) == 0
       	end
       	if @weeks
       	  @weeks.include?(Recurring.week_in_month(date))
@@ -325,7 +356,8 @@ module Recurring
                 4 => [:thursday, :thurs],
                 5 => [:friday, :fri],
                 6 => [:saturday, :sat]}
-	      lookup.select{|k,v| v.include?(symbol)}.first.first
+	      pair = lookup.select{|k,v| v.include?(symbol)}.first
+	      pair.first if pair
       end
     
     def ordinal_month symbol
@@ -341,7 +373,8 @@ module Recurring
                 10 => [:october, :oct],
                 11 => [:november, :nov],
                 12 => [:december, :dec]}
-      lookup.select{|k,v| v.include?(symbol)}.first.first
+	      pair = lookup.select{|k,v| v.include?(symbol)}.first
+	      pair.first if pair
     end
 
       def parse_times string
@@ -356,7 +389,8 @@ module Recurring
 	  time[:hour], time[:minute], time[:second] = st.split(':').collect {|n| n.to_i}
     	  time[:minute] ||= 0
     	  time[:second] ||= 0
-    	  time[:hour] = time[:hour] + 12 if am_pm == 'pm'
+    	  time[:hour] = time[:hour] + 12 if am_pm == 'pm' && time[:hour] < 12
+    	  time[:hour] = 0 if am_pm == 'am' && time[:hour] == 12
     	  time
 	    end
 	  #this is an implementation of Array#uniq required because Hash#eql? is not a synonym for Hash#==  

data/spec/recurring_spec.rb

@@ -34,6 +34,18 @@ context "Initializing a Schedule" do
     rs.times.should == [{:hour => 16, :minute => 30, :second => 0}, {:hour => 17, :minute => 0, :second => 0}, {:hour => 3, :minute => 30, :second => 30}] 
   end
 
+  specify "should not add 12 hours to '12pm'" do
+    rs = Recurring::Schedule.new :unit => 'days', :times => '12pm'
+    rs.times.should == [{:hour => 12, :minute => 0, :second => 0}] 
+  end
+
+  specify "should subtract 12 hours from '12am'" do
+    rs = Recurring::Schedule.new :unit => 'days', :times => '12am'
+    rs.times.should == [{:hour => 0, :minute => 0, :second => 0}] 
+  end
+
+
+
    specify "should be graceful about a duplicate times string" do
     rs = Recurring::Schedule.new :unit => 'days', :times => '4:30 4:30'
     rs.times.should == [{:hour => 4, :minute => 30, :second => 0}] 
@@ -64,12 +76,25 @@ context "Initializing a Schedule" do
     rs.weekdays.should == [:monday, :wednesday]
   end
 
+  specify "should flip out if weekdays aren't in the white list" do
+    lambda{Recurring::Schedule.new :unit => 'months', :weeks => [1,2], :weekdays => %w{garbage_day thanksgiving}}.should_raise ArgumentError
+  end
+
+  specify "should flip out if months aren't in the white list" do
+    lambda{Recurring::Schedule.new :unit => 'years', :months => %w{monsoon ramadan}, :weeks => [1,2], :weekdays => %w{mon}}.should_raise ArgumentError
+  end
+
   specify "should accept months params" do
     rs = Recurring::Schedule.new :unit => 'years', :months => 'feb', :monthdays => [4]
     rs.months.should == [:feb]
   end
 
-  specify "should accept days as integers" do
+  specify "should accept monthdays as strings" do
+    rs = Recurring::Schedule.new :unit => 'months', :monthdays => ['1','15']
+    rs.monthdays.should == [1,15]
+  end
+
+  specify "should accept monthdays as integers" do
     rs = Recurring::Schedule.new :unit => 'months', :monthdays => [1,15]
     rs.monthdays.should == [1,15]
   end
@@ -320,6 +345,49 @@ end
 
 #WEEKLY
 
+context "A bi-weekly schedule with weekdays and a midnight time" do
+  setup do
+    @rs = Recurring::Schedule.new :unit => 'weeks', :weekdays => %w{sat sunday}, :times => '12am', :frequency => 2, :anchor => Time.utc(2001)
+    @danger = Time.utc(2006,12,17,18)
+  end
+
+  specify "should include midnights of every other weekend" do
+    @rs.should_include Time.utc(2006,12,16)
+    @rs.should_include Time.utc(2006,12,10)
+  end
+
+  specify "should not include other midnights" do 
+    @rs.should_not_include Time.utc(2006,12,22)
+    @rs.should_not_include Time.utc(2006,12,25)
+  end
+
+  specify "should find the previous time from a dangerous time" do
+    @rs.find_previous(@danger).should == Time.utc(2006,12,16)
+  end
+  
+end
+
+context "A bi-weekly schedule with weekdays and a noon time" do
+  setup do
+    @rs = Recurring::Schedule.new :unit => 'weeks', :weekdays => %w{sat sunday}, :times => '12pm', :frequency => 2, :anchor => Time.utc(2001)
+    @danger = Time.utc(2006,12,17,18)
+  end
+
+  specify "should include noons of every other weekend" do
+    @rs.should_include Time.utc(2006,12,10,12)
+    @rs.should_include Time.utc(2006,12,16,12)
+  end
+
+  specify "should not include other midnights" do 
+    @rs.should_not_include Time.utc(2006,12,22,12)
+    @rs.should_not_include Time.utc(2006,12,25,12)
+  end
+
+  specify "should find the previous time from a dangerous time" do
+    @rs.find_previous(@danger).should == Time.utc(2006,12,16,12)
+  end
+end
+
 context "A weekly schedule with weekday params" do
   
   setup do
@@ -406,6 +474,11 @@ context "A third-weekly schedule with weekday and times params" do
     @rs.find_next(Time.utc(2006,12,4)).should == Time.utc(2006,12,18,15)
     @rs.find_next(Time.utc(2006,12,18)).should == Time.utc(2006,12,18,15)
   end
+
+  specify "should find the previous date" do
+    @rs.find_previous(Time.utc(2006,12,4)).should == Time.utc(2006,12,2,15)
+    @rs.find_previous(Time.utc(2006,12,18,20)).should == Time.utc(2006,12,18,15)
+  end
   
 end
 
@@ -574,7 +647,11 @@ context "An hourly schedule with an anchor" do
 
   specify "should not include any times with different sub hour parts" do
   end
- 
+
+  specify "should find in range" do
+    @rs.find_in_range(Time.utc(2006), Time.utc(2007)).length.should == 24*365
+  end
+	 
 end
 
 context "An bi-hourly schedule with time params" do

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: recurring
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
-date: 2006-12-14 00:00:00 -08:00
+  version: 0.3.10
+date: 2006-12-18 00:00:00 -08:00
 summary: A scheduling library for recurring events
 require_paths: 
 - lib