recurrence 1.0.3 → 1.1.0

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    recurrence (1.0.3)
+    recurrence (1.1.0)
       activesupport (>= 2.3.0)
+      i18n
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.1.1)
-      multi_json (~> 1.0)
-    diff-lcs (1.1.3)
-    multi_json (1.0.3)
-    rake (0.9.2.2)
+    activesupport (3.0.9)
+    diff-lcs (1.1.2)
+    i18n (0.6.0)
+    rake (0.9.2)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)
@@ -25,6 +25,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  rake
+  rake (~> 0.9)
   recurrence!
   rspec (~> 2.6)

data/History.txt

@@ -81,7 +81,3 @@
 == 1.0.2 2011-02-09
 
 * Added Ruby 1.8 support
-
-== 1.0.3 2011-19-14
-
-* Added support for default ending date through Recurrence.default_until_date

data/README.rdoc

@@ -59,6 +59,9 @@ A simple library to handle recurring events.
   r = Recurrence.new(:every => :day, :until => '2010-01-31')
   r = Recurrence.new(:every => :day, :starts => Date.today, :until => '2010-01-31')
 
+  # 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 })
+
   # 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/Rakefile

@@ -4,7 +4,7 @@ Bundler::GemHelper.install_tasks
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new
 
-require "rake/rdoctask"
+require "rdoc/task"
 Rake::RDocTask.new do |rd|
  rd.main = "README.rdoc"
  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb", "History.txt", "License.txt")

data/lib/recurrence/event/daily.rb

@@ -6,7 +6,7 @@ module SimplesIdeias
         def next_in_recurrence
           date  = @date.to_date
           date += @options[:interval] if initialized?
-          date
+          @options[:handler].call(date.day, date.month, date.year)
         end
       end
     end

data/lib/recurrence/event/monthly.rb

@@ -59,9 +59,8 @@ module SimplesIdeias
 
           next_year  = date.year + raw_month / 12
           next_month = (raw_month % 12) + 1 # change back to ruby interval
-          next_day   = [ @options[:on], Time.days_in_month(next_month, next_year) ].min
 
-          Date.new(next_year, next_month, next_day)
+          @options[:handler].call(@options[:on], next_month, next_year)
         end
 
         def advance_to_month_by_weekday(date, interval=@options[:interval])
@@ -84,7 +83,7 @@ module SimplesIdeias
             date -= weeks * 7
           end
 
-          date
+          @options[:handler].call(date.day, date.month, date.year)
         end
 
         private

data/lib/recurrence/event/weekly.rb

@@ -22,7 +22,8 @@ module SimplesIdeias
             to_add += @options[:on].first            # Go to first required day
           end
 
-          @date.to_date + to_add
+          new_date = @date.to_date + to_add
+          @options[:handler].call(new_date.day, new_date.month, new_date.year)
         end
       end
     end

data/lib/recurrence/event/yearly.rb

@@ -35,16 +35,15 @@ module SimplesIdeias
           else
             new_date = advance_to_year(@date, 0)
             new_date = advance_to_year(new_date) if @date > new_date
-            new_date
+            @options[:handler].call(new_date.day, new_date.month, new_date.year)
           end
         end
 
         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
 
-          Date.new(next_year, next_month, next_day)
+          @options[:handler].call(@options[:on].last, next_month, next_year)
         end
 
         private

data/lib/recurrence/handler.rb

@@ -0,0 +1,7 @@
+module SimplesIdeias
+  class Recurrence
+    module Handler # :nodoc: all
+      autoload :FallBack, 'recurrence/handler/fall_back'
+    end
+  end
+end

data/lib/recurrence/handler/fall_back.rb

@@ -0,0 +1,23 @@
+module SimplesIdeias
+  class Recurrence
+    module Handler # :nodoc: all
+      ##
+      # If the given date is invalid - beyond the end of the month - then this
+      # will move the day back to the last day of the given month.
+      #
+      # Examples
+      #
+      #   FallBack.call(1, 1, 2011)
+      #   # => January 1, 2011
+      #
+      #   FallBack.call(31, 2, 2011)
+      #   # => February 28, 2011
+      #
+      module FallBack
+        def self.call(day, month, year)
+          Date.new(year, month, [day, Time.days_in_month(month, year)].min)
+        end
+      end
+    end
+  end
+end

data/lib/recurrence/namespace.rb

@@ -5,6 +5,7 @@ require "enumerator"
 module SimplesIdeias
   class Recurrence
     autoload :Event,    "recurrence/event"
+    autoload :Handler, "recurrence/handler"
     autoload :Version,  "recurrence/version"
 
     include Enumerable
@@ -14,15 +15,6 @@ module SimplesIdeias
     FREQUENCY = %w(day week month year)
 
     attr_reader :event, :options
-    
-    def self.as_date(date) # :nodoc:
-      case date
-      when String
-        Date.parse(date)
-      else
-        date
-      end
-    end
 
     # Return the default starting date.
     #
@@ -153,6 +145,7 @@ module SimplesIdeias
       @options = options
       @_options = initialize_dates(options.dup)
       @_options[:interval] ||= 1
+      @_options[:handler] ||= Handler::FallBack
 
       @event = case @_options[:every].to_sym
         when :day
@@ -300,7 +293,12 @@ module SimplesIdeias
     end
 
     def as_date(date) # :nodoc:
-      self.class.as_date(date)
+      case date
+      when String
+        Date.parse(date)
+      else
+        date
+      end
     end
   end
 end

data/lib/recurrence/version.rb

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

data/recurrence.gemspec

@@ -1,10 +1,10 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "recurrence"
+require 'recurrence/version'
 
 Gem::Specification.new do |s|
   s.name        = "recurrence"
-  s.version     = Recurrence::Version::STRING
+  s.version     = SimplesIdeias::Recurrence::Version::STRING
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Nando Vieira"]
   s.email       = ["fnando.vieira@gmail.com"]
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "activesupport", ">= 2.3.0"
+  s.add_dependency "i18n"
   s.add_development_dependency "rspec", "~> 2.6"
-  s.add_development_dependency "rake"
+  s.add_development_dependency "rake", "~> 0.9"
 end

data/spec/recurrence_spec.rb

@@ -94,51 +94,6 @@ describe Recurrence do
       end
     end
   end
-  
-  describe ".default_until_date" do
-    after(:each){ Recurrence.default_until_date = Date.new(2037, 12, 31)}
-    
-    it "should return 2037-12-31 by default" do
-      Recurrence.default_until_date.should == Date.new(2037, 12, 31)
-    end
-
-    it "should return new until when changed" do
-      Recurrence.default_until_date = Date.new(2057, 12, 31)
-      Recurrence.default_until_date.should == Date.new(2057, 12, 31)
-    end
-
-    it "should alter event end with new default until" do
-      @recurrence = Recurrence.daily
-      @recurrence.events[-1].should == Date.parse("2037-12-31")
-
-      Recurrence.default_until_date = Date.new(2057, 12, 31)
-
-      @recurrence = Recurrence.daily
-      @recurrence.events[-1].should == Date.parse("2057-12-31")
-    end
-
-    it "should not return any events when default until is past" do
-      Recurrence.default_until_date = Date.new(2007, 12, 31)
-      @recurrence = Recurrence.daily
-      @recurrence.events.length.should == 0
-    end  
-
-    it "should allow value to be changed multiple times" do
-      Recurrence.default_until_date = Date.new(2057, 12, 31)
-      Recurrence.default_until_date.should == Date.new(2057, 12, 31)
-      @recurrence1 = Recurrence.monthly(:on => 2)
-
-      Recurrence.default_until_date = Date.new(2187, 12, 31)
-      Recurrence.default_until_date.should == Date.new(2187, 12, 31)
-      @recurrence2 = Recurrence.monthly(:on => 2)
-      @recurrence2.events.length.should == @recurrence1.events.length + 130 * 12
-
-      Recurrence.default_until_date = Date.new(2257, 12, 31)
-      Recurrence.default_until_date.should == Date.new(2257, 12, 31)
-      @recurrence3 = Recurrence.monthly(:on => 2)
-      @recurrence3.events.length.should == @recurrence2.events.length + 70 * 12
-    end
-  end
 
   context "with daily recurring" do
     it "should recur until limit date" do
@@ -816,6 +771,23 @@ describe Recurrence do
     end
   end
 
+  context "with custom handlers" do
+    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)
+      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')
+    end
+  end
+
   private
   def recurrence(options)
     Recurrence.new(options)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recurrence
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-14 00:00:00.000000000 Z
+date: 2011-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70267646596360 !ruby/object:Gem::Requirement
+  requirement: &70129728758960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,21 @@ dependencies:
         version: 2.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70267646596360
+  version_requirements: *70129728758960
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70129728757820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70129728757820
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70267646595780 !ruby/object:Gem::Requirement
+  requirement: &70129728756940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,18 +43,18 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70267646595780
+  version_requirements: *70129728756940
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70267646595300 !ruby/object:Gem::Requirement
+  requirement: &70129728756300 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70267646595300
+  version_requirements: *70129728756300
 description: A simple library to handle recurring events
 email:
 - fnando.vieira@gmail.com
@@ -67,6 +78,8 @@ files:
 - lib/recurrence/event/monthly.rb
 - lib/recurrence/event/weekly.rb
 - lib/recurrence/event/yearly.rb
+- lib/recurrence/handler.rb
+- lib/recurrence/handler/fall_back.rb
 - lib/recurrence/namespace.rb
 - lib/recurrence/version.rb
 - recurrence.gemspec
@@ -86,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4581356905210184239
+      hash: 2739782105165041222
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -95,10 +108,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4581356905210184239
+      hash: 2739782105165041222
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: A simple library to handle recurring events