recurring 0.2.0 → 0.3.2

data/History.txt

@@ -1,3 +1,14 @@
+== 0.3.2 / 2006-12-13
+
+* initialization bugfixes
+
+== 0.2.0 / 2006-12-11
+
+* Documentation
+* find_before
+* bugfixes
+
+
 == 0.1.0 / 2006-12-09
 
 * Initial releast

data/Rakefile

@@ -1,12 +1,13 @@
 # -*- ruby -*-
 
 require 'rubygems'
-#require 'hoe'
+require 'hoe'
 #require_gem 'rspec'
 #require 'rspec/lib/spec/rake/spectask'
 require './lib/recurring.rb'
 require 'spec/rake/spectask'
 require 'rake/gempackagetask'
+require 'rake/rdoctask'
 
 Spec::Rake::SpecTask.new :spec do |t|
   t.spec_files = FileList['spec/**/*_spec.rb']
@@ -15,50 +16,53 @@ end
 
 task :default => :spec
 
-# Hoe.new('recurring', Recurring::VERSION) do |p|
-#   p.rubyforge_name = 'recurring'
-#   p.summary = 'A scheduling library for recurring events'
-#   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
-#   
-# #  p.authors = "Chris Anderson"
-#   p.email = 'jchris@mfdz.com'
-#   p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
-#   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
-# end
-
-specification = Gem::Specification.new do |s|
-  s.name = %q{recurring}
-  s.version = "0.2.0"
-  s.platform = Gem::Platform::RUBY
-  s.date = %q{2006-12-10}
-  s.summary = %q{A scheduling library for recurring events}
-  s.email = %q{jchris@mfdz.com}
-  s.homepage = %q{http://jchris.mfdz.com}
-  s.rubyforge_project = %q{recurring}
-  s.autorequire  =  'recurring'
-  s.description = %q{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.}
-  s.authors = ["Chris Anderson"]
-  s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "lib/recurring.rb", "spec/recurring_spec.rb"]
-  #s.add_dependency(%q<hoe>, [">= 1.1.6"])
-  s.add_dependency(%q<rspec>, [">= 0.7.4"])
-  s.has_rdoc     = true
-end
-
-
-Rake::GemPackageTask.new specification do |pkg|
-  pkg.need_zip = true
-  pkg.need_tar = true
+Hoe.new('recurring', Recurring::VERSION) do |p|
+  p.url = 'http://jchris.mfdz.com'
+  p.author = "Chris Anderson"
+  p.email = 'jchris@mfdz.com'
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.summary = 'A scheduling library for recurring events'
+  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|
+#   s.name = %q{recurring}
+#   s.version = Recurring::VERSION
+#   s.platform = Gem::Platform::RUBY
+#   s.date = %q{2006-12-11}
+#   s.summary = %q{A scheduling library for recurring events}
+#   s.email = %q{jchris@mfdz.com}
+#   s.homepage = %q{http://jchris.mfdz.com}
+#   s.rubyforge_project = %q{recurring}
+#   s.autorequire  =  'recurring'
+#   s.description = %q{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.}
+#   s.authors = ["Chris Anderson"]
+#   s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "lib/recurring.rb", "spec/recurring_spec.rb"]
+#   #s.add_dependency(%q<hoe>, [">= 1.1.6"])
+#   s.add_dependency(%q<rspec>, [">= 0.7.4"])
+#   s.has_rdoc     = true
+# end
 
-# desc "Run the specs"
-# task :spec do
-#   system "spec spec/recurring_spec.rb -f specdoc"
+# 
+# Rake::GemPackageTask.new specification do |pkg|
+#   pkg.need_zip = true
+#   pkg.need_tar = true
 # end
-#Spec::Rake::SpecTask.new('spec') do |t|
-#  t.spec_files = FileList['examples/**/*.rb']
-#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
+
 
-# vim: syntax=Ruby

data/lib/recurring.rb

@@ -1,5 +1,5 @@
 module Recurring
-  VERSION = '0.1.1'
+  VERSION = '0.3.2'
 
   class << self
     # returns a number starting with 1
@@ -56,14 +56,17 @@ module Recurring
     def initialize options
       raise ArgumentError, 'specify a valid unit' unless options[:unit] &&
         %w{years months weeks days hours minutes}.include?(options[:unit])
-      raise ArgumentError, 'frequency > 1 requires an anchor Time' if options[:frequency] && !options[:anchor]
+      raise ArgumentError, 'frequency > 1 requires an anchor Time' if options[:frequency] && options[:frequency] != 1 && !options[:anchor]
       @unit = options[:unit].to_sym
+      raise ArgumentError, 'weekdays are required with the weeks param, if there are times params' if @unit == :weeks && 
+	options[:times] && 
+	!options[:weekdays]
       @frequency = options[:frequency] || 1
       @anchor = options[:anchor]
       @times = parse_times options[:times]
-      @months = Array(options[:months]).collect{|d|d.to_sym} if options[:months]
+      @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_sym} if options[:weekdays]
+      @weekdays = Array(options[:weekdays]).collect{|d|d.to_s.downcase.to_sym} if options[:weekdays]
       @monthdays = Array(options[:monthdays]) if options[:monthdays]
       
       @anchor_multiple = options[:times].nil? && options[:weeks].nil? && options[:weekdays].nil? && options[:monthdays].nil?
@@ -93,14 +96,22 @@ module Recurring
       true
     end
 
-    # Starts from the argument, and returns the next included time. Returns the argument if it is included in the schedule.
+    # Starts from the argument time, and returns the next included time. Returns the argument if it is included in the schedule.
     def find_next date
       loop do
       	return date if include?(date)
       	date = beginning_of_next @resolution, date
       end
     end
-    
+   
+    # Starts from the argument time, and works backwards until it hits a time that is included
+    def find_previous date
+      loop do
+	return date if include?(date)
+	date = end_of_previous @resolution, date
+      end
+    end
+ 
     # Takes a range, which can specified as two Times, or as an object that returns Time objects from the methods <tt>first</tt> and <tt>last</tt>. Really, the argment objects just need to be duck-type compatible with most of the Time instance methods, and the <tt>utc</tt> factory method.
     #
     # <tt>rs.find_in_range(Time.now, Time.now+24*60*60)</tt>
@@ -125,6 +136,7 @@ module Recurring
 
     # Two Schedules are equal if they have the same attributes.
     def == other
+      return false unless self.class == other.class
       [:unit, :frequency, :anchor, :weeks, :monthdays, :weekdays, :times].all? do |attribute|
         self.send(attribute) == other.send(attribute)
       end
@@ -132,6 +144,26 @@ module Recurring
 
     private
 
+      def end_of_previous scope, date
+  	case scope
+  	when :year
+  	  Time.utc(date.year) - 1
+      	when :month
+      	  Time.utc(date.year, date.month) -1
+      	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)
+      	when :day
+      	  Time.utc(date.year, date.month, date.day) - 1
+      	when :time
+      	  previous_time date
+      	else
+      	  date - 1
+      	end
+      end
+
+
       def beginning_of_next scope, date
   	    case scope
   	    when :year
@@ -152,6 +184,25 @@ module Recurring
       	end
       end
 
+      def previous_time date
+      	me = {:hour => date.hour, :minute => date.min, :second => date.sec, :me => true}      
+      	my_times = times + [me]
+      	my_times += [{:hour => @anchor.hour, :minute => @anchor.min, :second => @anchor.sec}] if check_anchor?
+      	my_times.sort! do |a,b|
+      	  v = a[:hour] <=> b[:hour]
+      	  v = a[:minute] <=> b[:minute] if v == 0
+      	  v = a[:second] <=> b[:second] if v == 0
+      	  v
+      	end
+	my_times.reverse!
+      	ntime = my_times[my_times.index(me)+1]
+      	if ntime
+      	  Time.utc(date.year, date.month, date.day, ntime[:hour], ntime[:minute], ntime[:second])
+      	else
+      	  end_of_previous :day, date
+      	end
+      end
+
       def next_time date
       	me = {:hour => date.hour, :minute => date.min, :second => date.sec, :me => true}      
       	my_times = times + [me]
@@ -294,7 +345,7 @@ module Recurring
     end
 
       def parse_times string
-      	unless string
+      	if string.nil? || string.empty?
       	  return [{:hour => 0, :minute => 0, :second => 0}]
       	end
       	times = string.downcase.gsub(',','').split(' ')
@@ -302,18 +353,22 @@ module Recurring
     	  st = st.gsub /pm|am/, ''
     	  am_pm = $&
     	  time = {}
-    	  time[:hour], time[:minute], time[:second] = st.split(':').collect {|n| n.to_i}
+	  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
 	    end
-	    parsed
+	  #this is an implementation of Array#uniq required because Hash#eql? is not a synonym for Hash#==  
+	  result = []  
+	  parsed.each_with_index do |h,i|
+	    result << h unless parsed[(i+1)..parsed.length].include?(h)
+	  end
+	  result
     end  
   end
 end
 
-  
 # RDS does not match ranges as such, just times specified to varying precision
 # eg, you can construct a Schedule that matches all of February, by not specifying the 
 # week, day, or time. If you want February through August, you'll have to specify all the months

data/spec/recurring_spec.rb

@@ -33,7 +33,22 @@ context "Initializing a Schedule" do
     rs = Recurring::Schedule.new :unit => 'days', :times => '4:30pm 5pm 3:30:30'
     rs.times.should == [{:hour => 16, :minute => 30, :second => 0}, {:hour => 17, :minute => 0, :second => 0}, {:hour => 3, :minute => 30, :second => 30}] 
   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}] 
+  end
+
+   specify "should be graceful about a busted times string" do
+    rs = Recurring::Schedule.new :unit => 'days', :times => 'afs4 th'
+    rs.times.should == [{:hour => 0, :minute => 0, :second => 0}] 
+  end
+
+  specify "should be graceful about an empty times string" do
+    rs = Recurring::Schedule.new :unit => 'days', :times => ''
+    rs.times.should == [{:hour => 0, :minute => 0, :second => 0}] 
+  end
+ 
   specify "should provide a sensible default time param" do
     rs = Recurring::Schedule.new :unit => 'days'
     rs.times.should == [{:hour => 0, :minute => 0, :second => 0}]
@@ -330,6 +345,16 @@ context "A weekly schedule with weekday params" do
 
 end
 
+context "A Schedule with uppercase weekdays" do
+  setup do
+    @rs = Recurring::Schedule.new :unit => 'weeks', :weekdays => %w{Friday}, :anchor => Time.now, :times => '12'
+  end
+
+  specify "should include Friday's at noon" do
+    @rs.should_include Time.utc(2006,12,8,12)
+  end
+end
+
 context "A weekly schedule with only an anchor" do
   
   setup do
@@ -350,6 +375,10 @@ context "A weekly schedule with only an anchor" do
     @rs.find_next(Time.utc(2006,5,4)).should == Time.utc(2006,5,10,17,30)
     @rs.find_next(Time.utc(2006,6,11)).should == Time.utc(2006,6,14,17,30)
   end
+
+  specify "should find the previous date" do
+    @rs.find_previous(Time.utc(2006,5,14)).should == Time.utc(2006,5,10,17,30)
+  end
 end
 
 context "A third-weekly schedule with weekday and times params" do
@@ -405,12 +434,8 @@ end
 
 context "A weekly schedule with times params but no days params" do
 
-  setup do
-    @rs = Recurring::Schedule.new :unit => 'weeks', :times => '4pm'
-  end
-
   specify "should flip out hard" do
-    lambda{@rs.find_next(Time.utc(2006,1,1,16))}.should_raise RangeError
+    lambda{@rs = Recurring::Schedule.new :unit => 'weeks', :times => '4pm'}.should_raise ArgumentError
   end
 
 end
@@ -603,6 +628,10 @@ context "An hourly schedule with times params" do
     @rs.find_next(Time.utc(2006,6,13,5,31)).should == Time.utc(2006,6,13,5,45,30)
   end
 
+  specify "should find the previous minute that match" do
+    @rs.find_previous(Time.utc(2006,5,5,5,17)).should == Time.utc(2006,5,5,5,15)
+  end
+
 end
 
 context "An eight-hourly schedule with times params" do
@@ -683,4 +712,4 @@ context "a daily schedule with a time 4:29am" do
   specify "should not include times other than 4:29am" do
     @rs.should_not_include Time.utc(2004,5,17,1,39)
   end
-end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: recurring
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
-date: 2006-12-10 00:00:00 -08:00
+  version: 0.3.2
+date: 2006-12-14 00:00:00 -08:00
 summary: A scheduling library for recurring events
 require_paths: 
 - lib
@@ -12,7 +12,7 @@ email: jchris@mfdz.com
 homepage: http://jchris.mfdz.com
 rubyforge_project: recurring
 description: 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.
-autorequire: recurring
+autorequire: 
 default_executable: 
 bindir: bin
 has_rdoc: true
@@ -48,11 +48,11 @@ requirements: []
 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: hoe
   version_requirement: 
   version_requirements: !ruby/object:Gem::Version::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.7.4
+        version: 1.1.6
     version: