recurring 0.1.0 → 0.2.0

data/README.txt

@@ -11,8 +11,13 @@ Schedules can be like:
 * The 1st and 15th of every other month
 * Every 2 hours
 * The first Friday of every month at 11:15am and 4:45:15pm
-
-== FEATURES/PROBLEMS:
+  
+= See more examples at Recurring::Schedule documentation
+  
+  # This Schedule will match every Tuesday at 5pm
+    @rs = Recurring::Schedule.new :unit => 'weeks', :weekdays => 'tuesday', :times => '5pm'
+    @rs.include?(Time.utc(2006,12,12,17)) #=> true
+    @rs.include?(Time.utc(2006,12,13,17)) #=> false
   
 = Features
   * Fast searching of long ranges for matching times.
@@ -24,13 +29,6 @@ Schedules can be like:
   * Untested timezone support
   * Plans to offer complex Schedule and Masks
 
-== SYNOPSYS:
-
-  # This Schedule will match every Tuesday at 5pm
-    @rs = Recurring::Schedule.new :unit => 'weeks', :weekdays => 'tuesday', :times => '5pm'
-    @rs.include?(Time.utc(2006,12,12,17)) #=> true
-    @rs.include?(Time.utc(2006,12,13,17)) #=> false 
-
 == REQUIREMENTS:
 
 * RSpec >= 0.7.4 to run the specs.

data/Rakefile

@@ -1,23 +1,62 @@
 # -*- 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'
 
-Hoe.new('recurring', Recurring::VERSION) do |p|
-  p.rubyforge_name = 'recurring'
-  p.summary = 'A scheduling library for recurring events'
-  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
-  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")
+Spec::Rake::SpecTask.new :spec do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts << "-f s"
 end
 
-desc "Run the specs"
-task :spec do
-  system "spec spec/recurring_spec.rb -f specdoc"
+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
+end
+
+
+# desc "Run the specs"
+# task :spec do
+#   system "spec spec/recurring_spec.rb -f specdoc"
+# end
 #Spec::Rake::SpecTask.new('spec') do |t|
 #  t.spec_files = FileList['examples/**/*.rb']
 #end

data/lib/recurring.rb

@@ -1,5 +1,5 @@
 module Recurring
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 
   class << self
     # returns a number starting with 1
@@ -17,7 +17,11 @@ module Recurring
   # Initialize a Schedule object with the proper options to calculate occurances in 
   # that schedule. Schedule#new take a hash of options <tt>:unit, :frequency, :anchor, :weeks, :monthdays, :weekdays, :times</tt>
   #
-  # =  Monthly
+  # = Yearly
+  # [Every two years from an anchor time] <tt>Recurring::Schedule.new :unit => 'years', :frequency => 2, :anchor => Time.utc(2006,4,15,10,30)</tt>
+  # [Every year in February and May on the 1st and 15th] <tt>Recurring::Schedule.new :unit => 'years', :months => ['feb', 'may'], :monthdays => [1,15]</tt>
+  # [Every year in February and May on the 1st and 15th] <tt>Recurring::Schedule.new :unit => 'years', :months => ['feb', 'may'], :monthdays => [1,15]</tt>
+  # = Monthly
   # [Every two months from an anchor time] <tt>Recurring::Schedule.new :unit => 'months', :frequency => 2, :anchor => Time.utc(2006,4,15,10,30)</tt>
   # [The first and fifteenth of every month] <tt>Recurring::Schedule.new :unit => 'months', :monthdays => [1,15]</tt>
   # [The first and eighteenth of every third month] <tt>Recurring::Schedule.new :unit => 'months', :frequency => 3, :anchor => Time.utc(2006,4,15,10,30), :monthdays => [10,18]</tt>
@@ -39,10 +43,10 @@ module Recurring
   # See the specs using "rake spec" for even more examples.
     class Schedule
     
-    attr_reader :unit, :frequency, :anchor, :weeks, :monthdays, :weekdays, :times
+    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>months, weeks, days, hours, and minutes</tt>
+    # * valid units are <tt>years, months, weeks, days, hours, and 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. 
@@ -51,12 +55,13 @@ module Recurring
     # * :times takes a string with a simple format. <tt>"4pm 5:15pm 6:45:30pm"</tt>
     def initialize options
       raise ArgumentError, 'specify a valid unit' unless options[:unit] &&
-        %w{months weeks days hours minutes}.include?(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]
       @unit = options[:unit].to_sym
       @frequency = options[:frequency] || 1
       @anchor = options[:anchor]
       @times = parse_times options[:times]
+      @months = Array(options[:months]).collect{|d|d.to_sym} if options[:months]
       @weeks = Array(options[:weeks]) if options[:weeks]
       @weekdays = Array(options[:weekdays]).collect{|d|d.to_sym} if options[:weekdays]
       @monthdays = Array(options[:monthdays]) if options[:monthdays]
@@ -69,9 +74,10 @@ module Recurring
     def include? date
       @resolution = nil	
       return true if check_anchor? && date == @anchor 
-      return mismatch(:month) unless month_matches?(date) if @unit == :months
-      return mismatch(:week) unless week_matches?(date) if [:months, :weeks].include?(@unit)
-      if [:months, :weeks, :days].include?(@unit)
+      return mismatch(:year) unless year_matches?(date) if @unit == :years
+      return mismatch(:month) unless month_matches?(date) if [:months, :years].include?(@unit)
+      return mismatch(:week) unless week_matches?(date) if [:years, :months, :weeks].include?(@unit)
+      if [:years, :months, :weeks, :days].include?(@unit)
         return mismatch(:day) unless day_matches?(date)
 	      return mismatch(:time) unless time_matches?(date)
       end
@@ -95,7 +101,7 @@ module Recurring
       end
     end
     
-    # Takes a range, which can specified as two Times, or as an object that returns times from the methods .first and .last
+    # 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>
     #
@@ -169,10 +175,23 @@ module Recurring
 	      false
       end
 
+      def year_matches? date
+    	  return true if @frequency == 1
+    	  return (date.year - @anchor.year) % @frequency == 0        
+      end
+
       def month_matches? date
       	#only concerned with multiples
-      	return true if @frequency == 1
-      	(date.month - @anchor.month) % @frequency == 0
+	      if @unit == :months 
+      	  return true if @frequency == 1
+      	  return (date.month - @anchor.month) % @frequency == 0
+    	  end
+    	  if @months
+      	  month_nums = @months.collect{|w| ordinal_month w}
+      	  return month_nums.include?(date.month)
+      	else
+  	      true
+	      end
       end
 
       def week_matches? date
@@ -258,21 +277,21 @@ module Recurring
 	      lookup.select{|k,v| v.include?(symbol)}.first.first
       end
     
-    # def ordinal_month symbol
-    #   lookup = {1 => [:january, :jan],
-    #             2 => [:february, :feb],
-    #             3 => [:march, :mar],
-    #             4 => [:april, :apr],
-    #             5 => [:may],
-    #             6 => [:june, :jun],
-    #             7 => [:july, :jul],
-    #             8 => [:august, :aug],
-    #             9 => [:september, :sept],
-    #             10 => [:october, :oct],
-    #             11 => [:november, :nov],
-    #             12 => [:december, :dec]}
-    #   lookup.select{|k,v| v.include?(symbol)}.first.first
-    # end
+    def ordinal_month symbol
+      lookup = {1 => [:january, :jan],
+                2 => [:february, :feb],
+                3 => [:march, :mar],
+                4 => [:april, :apr],
+                5 => [:may],
+                6 => [:june, :jun],
+                7 => [:july, :jul],
+                8 => [:august, :aug],
+                9 => [:september, :sept],
+                10 => [:october, :oct],
+                11 => [:november, :nov],
+                12 => [:december, :dec]}
+      lookup.select{|k,v| v.include?(symbol)}.first.first
+    end
 
       def parse_times string
       	unless string

data/spec/recurring_spec.rb

@@ -10,9 +10,10 @@ def results_should_be_included results, schedule
 end
 
 def should_find_in_range schedule, length, *range
-  result = schedule.find_in_range(range.first, range.last)
+  result = schedule.find_in_range(range)
   result.length.should_be length
   results_should_be_included result, schedule
+  result
 end
 
 context "Initializing a Schedule" do
@@ -48,6 +49,11 @@ context "Initializing a Schedule" do
     rs.weekdays.should == [:monday, :wednesday]
   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
     rs = Recurring::Schedule.new :unit => 'months', :monthdays => [1,15]
     rs.monthdays.should == [1,15]
@@ -82,6 +88,71 @@ context "A complex Schedule" do
 
 end
 
+#YEARS
+context "A yearly schedule with month and monthdays" do
+  setup do
+    @rs = Recurring::Schedule.new :unit => 'years', :months => 'feb', :monthdays => [4]
+  end
+  
+  specify "should include the day of the month in any year" do
+    @rs.should_include Time.utc(1980,2,4)
+    @rs.should_include Time.utc(1989,2,4)
+  end
+  specify "should not include other days of the month in any year" do
+    @rs.should_not_include Time.utc(1989,4,4)
+    @rs.should_not_include Time.utc(1980,2,5)
+  end
+  
+  specify "should find 20 times in 20 years" do
+    should_find_in_range(@rs, 20, Time.utc(2006,12,12,1), Time.utc(2026,12,12,1,45))
+  end
+end
+
+context "A yearly schedule with months and weekdays" do
+  setup do
+    @rs = Recurring::Schedule.new :unit => 'years', :months => 'feb', :weekdays => ['tuesday', 'weds']
+  end
+  specify "should match every tuesday and wednesday in febraury" do
+    @rs.should_include Time.utc(2007,2,6)
+    @rs.should_include Time.utc(2007,2,7)
+    @rs.should_include Time.utc(2007,2,20)
+    @rs.should_include Time.utc(2007,2,21)
+  end
+  specify "should not include other days of the week in feburary" do
+    @rs.should_not_include Time.utc(2007,2,8)
+    @rs.should_not_include Time.utc(2007,2,9)
+    @rs.should_not_include Time.utc(2007,2,23)
+    @rs.should_not_include Time.utc(2007,2,24)
+  end
+  specify "should not include tuesday and wednesday outside of febraury" do
+    @rs.should_not_include Time.utc(2007,3,6)
+    @rs.should_not_include Time.utc(2007,3,7)
+    @rs.should_not_include Time.utc(2007,3,20)
+    @rs.should_not_include Time.utc(2007,3,21)
+  end
+  specify "should find 20 times in 20 years" do
+    should_find_in_range(@rs, 161, Time.utc(2006,12,12,1), Time.utc(2026,12,12,1,45))
+  end
+end
+
+context "A bi-yearly schedule with months, weeks, weekdays, and times" do
+  setup do
+    @rs = Recurring::Schedule.new :unit => 'years', :frequency => 2, :anchor => Time.utc(2006,6), :months => ['feb', 'may'], :weeks => [2], :weekdays => 'fri', :times => '5:15'
+  end
+  
+  specify "should include the correct days at the right times" do
+    @rs.should_include Time.utc(2006,2,10,5,15)
+    @rs.should_include Time.utc(2006,5,12,5,15)
+    @rs.should_include Time.utc(2008,2,8,5,15)
+    @rs.should_include Time.utc(2008,5,9,5,15)
+  end
+  
+  specify "should not include good times in bad years" do
+    @rs.should_not_include Time.utc(2007,2,9,5,15)
+    @rs.should_not_include Time.utc(2007,5,11,5,15)
+  end
+end
+
 #MONTHS
 
 context "A bi-monthly Schedule without more params" do
@@ -395,6 +466,19 @@ context "A fourth-daily schedule with only the unit and frequency != 1" do
   end
 end
 
+context "A daily schedule with a sub-second precise anchor" do
+  setup do
+    @rs = Recurring::Schedule.new :unit => 'days', :anchor => Time.utc(2006,11,27,0,0,30,45)
+  end
+  specify "should include times equal up to second accuracy" do
+    @rs.should_include Time.utc(2006,11,27,0,0,30)
+    @rs.should_include Time.utc(2006,11,27,0,0,30,55)
+  end
+  specify "should not include other times" do
+    @rs.should_not_include Time.utc(2006,11,27,0,0,31,45)
+  end
+end
+
 context "A fourth-daily schedule with no other params" do
 
   setup do

metadata

@@ -3,16 +3,16 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: recurring
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 date: 2006-12-10 00:00:00 -08:00
 summary: A scheduling library for recurring events
 require_paths: 
 - lib
-email: ryand-ruby@zenspider.com
-homepage: "    by Chris Anderson"
+email: jchris@mfdz.com
+homepage: http://jchris.mfdz.com
 rubyforge_project: recurring
-description: "Schedules can be like: * Every Tuesday at 5pm * The 1st and 15th of every other month * Every 2 hours * The first Friday of every month at 11:15am and 4:45:15pm  == FEATURES/PROBLEMS:  = Features * Fast searching of long ranges for matching times. * Ability to define Schedules in a few flexible ways. * Extensive RSpec specifications (run \"rake spec\" to see them) * Extensive RSpec specifications (run \"rake spec\" to see them)  = Problems / Todo * Untested timezone support * Plans to offer complex Schedule and Masks  == SYNOPSYS:"
-autorequire: 
+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
 default_executable: 
 bindir: bin
 has_rdoc: true
@@ -26,7 +26,7 @@ platform: ruby
 signing_key: 
 cert_chain: 
 authors: 
-- Ryan Davis
+- Chris Anderson
 files: 
 - History.txt
 - Manifest.txt
@@ -48,11 +48,11 @@ requirements: []
 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: rspec
   version_requirement: 
   version_requirements: !ruby/object:Gem::Version::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.6
+        version: 0.7.4
     version: