recurrence 1.0.0 → 1.0.1

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    recurrence (0.1.5)
-      activesupport (>= 3.0.0)
+    recurrence (1.0.0)
+      activesupport
 
 GEM
   remote: http://rubygems.org/
@@ -36,7 +36,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (>= 3.0.0)
+  activesupport
   recurrence!
   rspec (>= 2.0.0)
   ruby-debug19

data/History.txt

@@ -72,3 +72,8 @@
 * Recurrence now includes Enumerable
 * The public API is now documented
 * Remove support for Rails plugin
+
+== 1.0.1 2010-11-19
+
+* Added :repeat option
+* Added support for weekday shortcut (sun..sat)

data/README.rdoc

@@ -14,6 +14,7 @@ A simple library to handle recurring events.
   # Daily
   r = Recurrence.new(:every => :day)
   r = Recurrence.new(:every => :day, :interval => 9)
+  r = Recurrence.new(:every => :day, :repeat => 7)
   r = Recurrence.daily(options = {})
 
   # Weekly
@@ -22,6 +23,7 @@ A simple library to handle recurring events.
   r = Recurrence.new(:every => :week, :on => [:monday, :friday])
   r = Recurrence.new(:every => :week, :on => [:monday, :wednesday, :friday])
   r = Recurrence.new(:every => :week, :on => :friday, :interval => 2)
+  r = Recurrence.new(:every => :week, :on => :friday, :repeat => 4)
   r = Recurrence.weekly(:on => :thursday)
 
   # Monthly by month day
@@ -30,6 +32,7 @@ A simple library to handle recurring events.
   r = Recurrence.new(:every => :month, :on => 7, :interval => 2)
   r = Recurrence.new(:every => :month, :on => 7, :interval => :monthly)
   r = Recurrence.new(:every => :month, :on => 7, :interval => :bimonthly)
+  r = Recurrence.new(:every => :month, :on => 7, :repeat => 6)
   r = Recurrence.monthly(:on => 31)
 
   # Monthly by week day
@@ -39,12 +42,14 @@ A simple library to handle recurring events.
   r = Recurrence.new(:every => :month, :on => :last,  :weekday => :friday, :interval => 2)
   r = Recurrence.new(:every => :month, :on => :last,  :weekday => :friday, :interval => :quarterly)
   r = Recurrence.new(:every => :month, :on => :last,  :weekday => :friday, :interval => :semesterly)
+  r = Recurrence.new(:every => :month, :on => :last,  :weekday => :friday, :repeat => 3)
 
   # Yearly
   r = Recurrence.new(:every => :year, :on => [7, 4]) # => [month, day]
   r = Recurrence.new(:every => :year, :on => [10, 31], :interval => 3)
   r = Recurrence.new(:every => :year, :on => [:jan, 31])
   r = Recurrence.new(:every => :year, :on => [:january, 31])
+  r = Recurrence.new(:every => :year, :on => [10, 31], :repeat => 3)
   r = Recurrence.yearly(:on => [:january, 31])
 
   # Limit recurrence
@@ -99,6 +104,7 @@ If you're using Rails/Bundler or something like that, remember to override the <
 
 * José Valim (http://plataformatec.com.br)
 * Maxim Chernyak (http://mediumexposure.com)
+* Ricardo H. (https://github.com/ricardohsd)
 
 == License
 

data/lib/recurrence/event/base.rb

@@ -3,11 +3,19 @@ module SimplesIdeias
     module Event # :nodoc: all
       class Base
         CARDINALS = %w(first second third fourth fifth)
-        DAYS = %w(sunday monday tuesday wednesday thursday friday saturday)
+        WEEKDAYS = {
+          "sun" => 0, "sunday"    => 0,
+          "mon" => 1, "monday"    => 1,
+          "tue" => 2, "tuesday"   => 2,
+          "wed" => 3, "wednesday" => 3,
+          "thu" => 4, "thursday"  => 4,
+          "fri" => 5, "friday"    => 5,
+          "sat" => 6, "saturday"  => 6
+        }
 
         attr_accessor :start_date
 
-        def initialize(options={})
+        def initialize(options = {})
           every, options = nil, every if every.kind_of?(Hash)
 
           @options    = options
@@ -16,6 +24,7 @@ module SimplesIdeias
 
           validate
           raise ArgumentError, "interval should be greater than zero" if @options[:interval] <= 0
+          raise ArgumentError, "repeat should be greater than zero" if !@options[:repeat].nil? && @options[:repeat] <= 0
 
           prepare!
         end
@@ -72,8 +81,9 @@ module SimplesIdeias
             raise ArgumentError, "invalid day #{value}" unless (0..6).include?(value)
             value
           else
-            raise ArgumentError, "invalid weekday #{value}" unless DAYS.include?(value.to_s)
-            DAYS.index(value.to_s)
+            weekday = WEEKDAYS[value.to_s]
+            raise ArgumentError, "invalid weekday #{value}" unless weekday
+            weekday
           end
         end
       end

data/lib/recurrence/event/yearly.rb

@@ -42,7 +42,7 @@ module SimplesIdeias
         def advance_to_year(date, interval=@options[:interval])
           next_year  = date.year + interval
           next_month = @options[:on].first
-          next_day   = [ @options[:on].last, Time.days_in_month(next_month, next_year) ].min
+          next_day   = [@options[:on].last, Time.days_in_month(next_month, next_year)].min
 
           Date.new(next_year, next_month, next_day)
         end

data/lib/recurrence/namespace.rb

@@ -69,6 +69,7 @@ module SimplesIdeias
     #   Recurrence.daily(:interval => 2) #=> every 2 days
     #   Recurrence.daily(:starts => 3.days.from_now)
     #   Recurrence.daily(:until => 10.days.from_now)
+    #   Recurrence.daily(:repeat => 5)
     #
     def self.daily(options = {})
       options[:every] = :day
@@ -81,6 +82,7 @@ module SimplesIdeias
     #   Recurrence.weekly(:on => :saturday)
     #   Recurrence.weekly(:on => [sunday, :saturday])
     #   Recurrence.weekly(:on => :saturday, :interval => 2)
+    #   Recurrence.weekly(:on => :saturday, :repeat => 5)
     #
     def self.weekly(options = {})
       options[:every] = :week
@@ -101,6 +103,12 @@ module SimplesIdeias
     #   Recurrence.monthly(:on => 15, :interval => :bimonthly)
     #   Recurrence.monthly(:on => 15, :interval => :quarterly)
     #   Recurrence.monthly(:on => 15, :interval => :semesterly)
+    #   Recurrence.monthly(:on => 15, :repeat => 5)
+    #
+    # The <tt>:on</tt> option can be one of the following:
+    #
+    #   * :sunday, :monday, :tuesday, :wednesday, :thursday, :friday, :saturday
+    #   * :sun, :mon, :tue, :wed, :thu, :fri, :sat
     #
     def self.monthly(options = {})
       options[:every] = :month
@@ -113,6 +121,7 @@ module SimplesIdeias
     #   Recurrence.yearly(:on => [7, 14], :interval => 2) #=> every 2 years on Jul 14
     #   Recurrence.yearly(:on => [:jan, 14], :interval => 2)
     #   Recurrence.yearly(:on => [:january, 14], :interval => 2)
+    #   Recurrence.yearly(:on => [:january, 14], :repeat => 5)
     #
     def self.yearly(options = {})
       options[:every] = :year
@@ -133,18 +142,18 @@ module SimplesIdeias
       raise ArgumentError, "invalid :every option"     unless FREQUENCY.include?(options[:every].to_s)
 
       @options = options
-      @normalized_options = initialize_dates(options.dup)
-      @normalized_options[:interval] ||= 1
+      @_options = initialize_dates(options.dup)
+      @_options[:interval] ||= 1
 
-      @event = case @normalized_options[:every].to_sym
+      @event = case @_options[:every].to_sym
         when :day
-          Event::Daily.new(@normalized_options)
+          Event::Daily.new(@_options)
         when :week
-          Event::Weekly.new(@normalized_options)
+          Event::Weekly.new(@_options)
         when :month
-          Event::Monthly.new(@normalized_options)
+          Event::Monthly.new(@_options)
         when :year
-          Event::Yearly.new(@normalized_options)
+          Event::Yearly.new(@_options)
       end
     end
 
@@ -163,7 +172,7 @@ module SimplesIdeias
     def include?(required_date)
       required_date = as_date(required_date)
 
-      if required_date < @normalized_options[:starts] || required_date > @normalized_options[:until]
+      if required_date < @_options[:starts] || required_date > @_options[:until]
         false
       else
         each do |date|
@@ -213,25 +222,25 @@ module SimplesIdeias
     def events(options={})
       options[:starts] = as_date(options[:starts])
       options[:until]  = as_date(options[:until])
+      options[:repeat] ||= @options[:repeat]
 
       reset! if options[:starts] || options[:until]
 
-      @events ||= begin
-        _events = []
-
+      @events ||= Array.new.tap do |list|
         loop do
           date = @event.next!
 
-          break if date.nil?
+          break unless date
 
           valid_start = options[:starts].nil? || date >= options[:starts]
           valid_until = options[:until].nil?  || date <= options[:until]
-          _events << date if valid_start && valid_until
+          list << date if valid_start && valid_until
 
-          break if options[:until] && options[:until] <= date
-        end
+          stop_repeat = options[:repeat] && list.size == options[:repeat]
+          stop_until = options[:until] && options[:until] <= date
 
-        _events
+          break if stop_until || stop_repeat
+        end
       end
     end
 

data/lib/recurrence/version.rb

@@ -3,7 +3,7 @@ module SimplesIdeias
     module Version
       MAJOR = 1
       MINOR = 0
-      PATCH = 0
+      PATCH = 1
       STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
     end
   end

data/spec/recurrence_spec.rb

@@ -13,6 +13,10 @@ describe Recurrence do
     expect { recurrence(:every => :day, :interval => 0) }.to raise_error(ArgumentError)
   end
 
+  it "should require :repeat to be greater than zero when provided" do
+    expect { recurrence(:every => :day, :repeat => 0) }.to raise_error(ArgumentError)
+  end
+
   it "should return an enumerator when Recurrence#each is called without a block" do
     recurrence(:every => :day).each.should be_instance_of(Enumerator)
   end
@@ -123,6 +127,11 @@ describe Recurrence do
       @recurrence.events[2].to_s.should == "2008-09-25"
     end
 
+    it "should use repeat" do
+      @recurrence = recurrence(:every => :day, :starts => "2008-09-21", :repeat => 10)
+      @recurrence.events.size.should == 10
+    end
+
     it "should have a lacking day if the interval does not match the last day" do
       @recurrence = recurrence(
         :every    => :day,
@@ -192,6 +201,18 @@ describe Recurrence do
       @recurrence.events[6].to_s.should == "2008-12-14"
     end
 
+    it "should use repeat" do
+      starts = Date.parse("2008-09-21")
+      @recurrence = recurrence(
+        :every    => :week,
+        :on       => starts.wday,
+        :starts   => starts,
+        :until    => "2011-01-01",
+        :repeat    => 5
+      )
+      @recurrence.events.size.should == 5
+    end
+
     it "should occur several times per week" do
       starts = Date.parse("2008-09-21") #=> sunday
       @recurrence = recurrence(
@@ -328,6 +349,18 @@ describe Recurrence do
         @recurrence.events[2].to_s.should == "2008-10-31"
         @recurrence.events[3].to_s.should == "2009-02-28"
       end
+
+      it "should use repeat" do
+        starts = Date.parse("2008-01-31")
+        @recurrence = recurrence(
+          :every    => :month,
+          :on       => 31,
+          :starts   => starts,
+          :until    => "2010-01-01",
+          :repeat    => 5
+        )
+        @recurrence.events.size.should == 5
+      end
     end
 
     context "using weekday" do
@@ -336,6 +369,11 @@ describe Recurrence do
         @recurrence.events[-1].should == Date.parse("2037-12-31")
       end
 
+      it "should use weekday shortcut" do
+        @recurrence = Recurrence.daily(:on => 5, :weekday => :thu)
+        @recurrence.events[-1].should == Date.parse("2037-12-31")
+      end
+
       it "should repeat until 8 months from now" do
         date = 8.months.from_now
         week = (date.day - 1) / 7 + 1
@@ -408,6 +446,19 @@ describe Recurrence do
         @recurrence.events[5].to_s.should == "2009-11-15"
         @recurrence.events[6].to_s.should == "2010-01-17"
       end
+
+      it "should use repeat" do
+        starts = Date.parse("2009-01-01")
+        @recurrence = recurrence(
+          :every    => :month,
+          :on       => :third,
+          :weekday  => :sunday,
+          :starts   => starts,
+          :until    => "2011-02-01",
+          :repeat    => 5
+        )
+        @recurrence.events.size.should == 5
+      end
     end
 
     context "using interval" do
@@ -519,6 +570,18 @@ describe Recurrence do
       @recurrence.events[3].to_s.should == "2014-09-21"
     end
 
+    it "should use repeat" do
+      starts = Date.parse("2008-09-21")
+
+      @recurrence = recurrence(
+        :every    => :year,
+        :on       => [starts.month, starts.day],
+        :starts   => starts,
+        :repeat    => 5
+      )
+      @recurrence.events.size.should == 5
+    end
+
     it "should run until next available date when chosen settings are greater than start date" do
       starts = Date.parse("2008-09-03")
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Nando Vieira
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-16 00:00:00 -02:00
+date: 2010-11-19 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency