recurrence 1.1.0 → 1.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    recurrence (1.1.0)
+    recurrence (1.2.0)
       activesupport (>= 2.3.0)
       i18n
 

data/README.rdoc

@@ -62,6 +62,9 @@ A simple library to handle recurring events.
   # Override the next date handler
   r = Recurrence.new(:every => :month, :on => 1, :handler => Proc.new { |day, month, year| raise("Date not allowed!") if year == 2011 && month == 12 && day == 31 })
 
+  # Shift the recurrences to maintain dates around boundaries (Jan 31 -> Feb 28 -> Mar 28)
+  r = Recurrence.new(:every => :month, :on => 31, :shift => true)
+
   # Getting an array with all events
   r.events.each {|date| puts date.to_s }  # => Memoized array
   r.events!.each {|date| puts date.to_s } # => reset items cache and re-execute it

data/lib/recurrence/event/base.rb

@@ -36,6 +36,7 @@ module SimplesIdeias
           @date = next_in_recurrence
 
           @finished, @date = true, nil if @date > @options[:until]
+          shift_to @date if @date && @options[:shift]
           @date
         end
 
@@ -86,6 +87,10 @@ module SimplesIdeias
             weekday
           end
         end
+
+        def shift_to(date)
+          # no-op
+        end
       end
     end
   end

data/lib/recurrence/event/monthly.rb

@@ -86,6 +86,10 @@ module SimplesIdeias
           @options[:handler].call(date.day, date.month, date.year)
         end
 
+        def shift_to(date)
+          @options[:on] = date.day
+        end
+
         private
         def valid_cardinal?(cardinal)
           raise ArgumentError, "invalid cardinal #{cardinal}" unless CARDINALS.include?(cardinal.to_s)

data/lib/recurrence/event/yearly.rb

@@ -46,6 +46,10 @@ module SimplesIdeias
           @options[:handler].call(@options[:on].last, next_month, next_year)
         end
 
+        def shift_to(date)
+          @options[:on] = [date.month, date.day]
+        end
+
         private
         def valid_month?(month)
           raise ArgumentError, "invalid month #{month}" unless (1..12).include?(month)

data/lib/recurrence/version.rb

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

data/spec/recurrence_spec.rb

@@ -772,19 +772,68 @@ describe Recurrence do
   end
 
   context "with custom handlers" do
-    let(:exception_handler) { Proc.new { raise 'HANDLED' } }
+    let(:exception_handler) { Proc.new { raise "HANDLED" } }
     let(:shift_handler) { Proc.new { |day, month, year| day += 1 if month % 2 == 0; Date.new(year, month, day) } }
 
-    it 'offsets every other month day' do
-      r = recurrence(:every => :month, :on => 1, :starts => '2011-01-01', :handler => shift_handler)
+    it "offsets every other month day" do
+      r = recurrence(:every => :month, :on => 1, :starts => "2011-01-01", :handler => shift_handler)
       r.events[0].should == Date.new(2011, 1, 1)
       r.events[1].should == Date.new(2011, 2, 2)
       r.events[2].should == Date.new(2011, 3, 1)
       r.events[3].should == Date.new(2011, 4, 2)
     end
 
-    it 'raises an exception from the handler' do
-      expect { recurrence(:every => :day, :handler => exception_handler) }.to raise_error(RuntimeError, 'HANDLED')
+    it "raises an exception from the handler" do
+      expect { recurrence(:every => :day, :handler => exception_handler) }.to raise_error(RuntimeError, "HANDLED")
+    end
+  end
+
+  context "with shifting enabled" do
+    it "shifts yearly recurrences around February 29" do
+      r = recurrence(:every => :year, :starts => "2012-02-29", :on => [2,29], :shift => true)
+      r.events[0].should == Date.new(2012, 2, 29)
+      r.events[1].should == Date.new(2013, 2, 28)
+      r.events[2].should == Date.new(2014, 2, 28)
+      r.events[3].should == Date.new(2015, 2, 28)
+      r.events[4].should == Date.new(2016, 2, 28)
+    end
+
+    it "shifts monthly recurrences around the 31st" do
+      r = recurrence(:every => :month, :starts => "2011-01-31", :on => 31, :shift => true)
+      r.events[0].should == Date.new(2011, 1, 31)
+      r.events[1].should == Date.new(2011, 2, 28)
+      r.events[2].should == Date.new(2011, 3, 28)
+    end
+
+    it "shifts monthly recurrences around the 30th" do
+      r = recurrence(:every => :month, :starts => "2011-01-30", :on => 30, :shift => true)
+      r.events[0].should == Date.new(2011, 1, 30)
+      r.events[1].should == Date.new(2011, 2, 28)
+      r.events[2].should == Date.new(2011, 3, 28)
+    end
+
+    it "shifts monthly recurrences around the 29th" do
+      r = recurrence(:every => :month, :starts => "2011-01-29", :on => 29, :shift => true)
+      r.events[0].should == Date.new(2011, 1, 29)
+      r.events[1].should == Date.new(2011, 2, 28)
+      r.events[2].should == Date.new(2011, 3, 28)
+
+      r = recurrence(:every => :month, :starts => "2012-01-29", :on => 29, :shift => true)
+      r.events[0].should == Date.new(2012, 1, 29)
+      r.events[1].should == Date.new(2012, 2, 29)
+      r.events[2].should == Date.new(2012, 3, 29)
+    end
+
+    it "correctly resets to original day for monthly" do
+      r = recurrence(:every => :month, :starts => "2011-01-31", :on => 31, :shift => true)
+      r.next!; r.next!
+      expect { r.reset! }.to change(r, :next).from(Date.new(2011, 2, 28)).to(Date.new(2011, 1, 31))
+    end
+
+    it "correctly resets to original month and day for yearly" do
+      r = recurrence(:every => :year, :starts => "2012-02-29", :on => [2,29], :shift => true)
+      r.next!; r.next!
+      expect { r.reset! }.to change(r, :next).from(Date.new(2013, 2, 28)).to(Date.new(2012, 2, 29))
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recurrence
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-05 00:00:00.000000000 Z
+date: 2011-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70129728758960 !ruby/object:Gem::Requirement
+  requirement: &70272129285780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70129728758960
+  version_requirements: *70272129285780
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70129728757820 !ruby/object:Gem::Requirement
+  requirement: &70272129283720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70129728757820
+  version_requirements: *70272129283720
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70129728756940 !ruby/object:Gem::Requirement
+  requirement: &70272129280220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70129728756940
+  version_requirements: *70272129280220
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70129728756300 !ruby/object:Gem::Requirement
+  requirement: &70272129277740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70129728756300
+  version_requirements: *70272129277740
 description: A simple library to handle recurring events
 email:
 - fnando.vieira@gmail.com
@@ -99,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2739782105165041222
+      hash: 4417332307528947128
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2739782105165041222
+      hash: 4417332307528947128
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.6