recurrence 0.1.4 → 0.1.5

data/History.txt

@@ -56,3 +56,12 @@
 == 0.1.3 2010-09-14
 
 * Moved Recurrence class to SimpleIdeias namespace; see troubleshooting section for instructions.
+
+== 0.1.4 2010-10-19
+
+* Bug fix: yearly recurrence was raising an error
+
+== 0.1.5 2010-11-03
+
+* Recurrence.default_starts_date is now configurable; pass in a String or block
+* Add #options reader so we'll be able to use Recurrence with ActiveRecord.composed_of

data/lib/recurrence/namespace.rb

@@ -8,7 +8,27 @@ module SimplesIdeias
 
     FREQUENCY = %w(day week month year)
 
-    attr_reader :event
+    attr_reader :event, :options
+
+    def self.default_starts_date
+      if @default_starts_date
+        if @default_starts_date.is_a?(String)
+          eval(@default_starts_date)
+        else
+          @default_starts_date.call
+        end
+      else
+        Date.today
+      end
+    end
+
+    def self.default_starts_date=(date)
+      unless date.respond_to?(:call) || date.is_a?(String) || date == nil
+        raise ArgumentError, 'default_starts_date must be a proc or an evaluatable string such as "Date.current"'
+      end
+
+      @default_starts_date = date
+    end
 
     def self.default_until_date
       @default_until_date ||= Date.new(2037, 12, 31)
@@ -46,18 +66,19 @@ module SimplesIdeias
       raise ArgumentError, ":every option is required" unless options.key?(:every)
       raise ArgumentError, "invalid :every option"     unless FREQUENCY.include?(options[:every].to_s)
 
-      @options = initialize_dates(options)
-      @options[:interval] ||= 1
+      @options = options.dup
+      @normalized_options = initialize_dates(options)
+      @normalized_options[:interval] ||= 1
 
-      @event = case @options[:every].to_sym
+      @event = case @normalized_options[:every].to_sym
         when :day
-          Recurrence::Event::Daily.new(@options)
+          Recurrence::Event::Daily.new(@normalized_options)
         when :week
-          Recurrence::Event::Weekly.new(@options)
+          Recurrence::Event::Weekly.new(@normalized_options)
         when :month
-          Recurrence::Event::Monthly.new(@options)
+          Recurrence::Event::Monthly.new(@normalized_options)
         when :year
-          Recurrence::Event::Yearly.new(@options)
+          Recurrence::Event::Yearly.new(@normalized_options)
       end
     end
 
@@ -69,7 +90,7 @@ module SimplesIdeias
     def include?(required_date)
       required_date = Date.parse(required_date) if required_date.is_a?(String)
 
-      if required_date < @options[:starts] || required_date > @options[:until]
+      if required_date < @normalized_options[:starts] || required_date > @normalized_options[:until]
         false
       else
         each do |date|
@@ -135,7 +156,7 @@ module SimplesIdeias
         options[name] = Date.parse(options[name]) if options[name].is_a?(String)
       end
 
-      options[:starts] ||= Date.today
+      options[:starts] ||= self.class.default_starts_date
       options[:until]  ||= self.class.default_until_date
 
       options

data/lib/recurrence/version.rb

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

data/spec/recurrence_spec.rb

@@ -33,6 +33,44 @@ describe "recurrence" do
     expect { recurrence(:every => :month, :on => 10, :interval => :invalid) }.to raise_error(ArgumentError)
   end
 
+  describe '.default_starts_date' do
+    it 'should return Date.today by default' do
+      Recurrence.default_starts_date.should == Date.today
+    end
+
+    it 'should require only strings and procs' do
+      expect { Recurrence.default_starts_date = Date.tomorrow }.to raise_error(ArgumentError)
+    end
+
+    context 'when .default_starts_date is reassigned to "Date.tomorrow" string' do
+      before { Recurrence.default_starts_date = 'Date.tomorrow' }
+      after { Recurrence.default_starts_date = nil }
+
+      it 'should return Date.tomorrow' do
+        Recurrence.default_starts_date.should == Date.tomorrow
+      end
+
+      it 'should have effect on generated events' do
+        r = Recurrence.new(:every => :day, :until => 3.days.from_now.to_date)
+        r.events.first.should == Date.tomorrow
+      end
+    end
+
+    context 'when .default_starts_date is reassigned to lambda { Date.tomorrow } proc' do
+      before { Recurrence.default_starts_date = lambda { Date.tomorrow } }
+      after { Recurrence.default_starts_date = nil }
+
+      it 'should return Date.tomorrow' do
+        Recurrence.default_starts_date.should == Date.tomorrow
+      end
+
+      it 'should have effect on generated events' do
+        r = Recurrence.new(:every => :day, :until => 3.days.from_now.to_date)
+        r.events.first.should == Date.tomorrow
+      end
+    end
+  end
+
   context "with daily recurring" do
     it "should recur until limit date" do
       @recurrence = Recurrence.daily
@@ -359,6 +397,13 @@ describe "recurrence" do
     end
   end
 
+  describe "#options" do
+    it "should return passed-in options" do
+      @recurrence = recurrence(:every => :day)
+      @recurrence.options.should == {:every => :day}
+    end
+  end
+
   describe "#include?" do
     it "should include date (day)" do
       @recurrence = recurrence(:every => :day, :starts => "2008-09-30")

metadata

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