fnando-recurrence 0.0.3 → 0.0.6

data/History.txt

@@ -13,3 +13,24 @@
 * 1 major enhancement:
   * The recurrence now considers the starting date and its configurations
   * Added lots of specs
+
+== 0.0.4 2008-09-30
+
+* 1 major enhancement:
+  * Renamed items method to events
+  * Added each! method
+  * Added lots of specs
+
+== 0.0.5 2008-09-30
+
+* 1 major enhancement:
+  * Monthly interval now accepts symbols: monthly, bimonthly, quarterly, 
+	semesterly
+
+== 0.0.6 2009-01-06
+
+* 1 major enhancement:
+	* Code refactoring
+	* Added next and next! methods
+	* Added more specs
+	* Yearly interval now accepts symbols: jan-dec and january-december

data/README.markdown

@@ -40,35 +40,39 @@ USAGE:
 	r = Recurrence.new(:every => :month, :on => 15)
 	r = Recurrence.new(:every => :month, :on => 31)
 	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, :interval => :quarterly)
+	r = Recurrence.new(:every => :month, :on => 7, :interval => :semesterly)
 	
 	# 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])
 	
 	# Limit recurrence
 	# :starts defaults to Date.today
 	# :until defaults to 2037-12-31
-	r = Recurrence.new(:day, :starts => Date.today)
-	r = Recurrence.new(:day, :until => '2010-01-31')
-	r = Recurrence.new(:day, :starts => Date.today, :until => '2010-01-31')
-	
-	# Iterating events
-	r.each do |date|
-	  puts date.to_s
-	end
+	r = Recurrence.new(:every => :day, :starts => Date.today)
+	r = Recurrence.new(:every => :day, :until => '2010-01-31')
+	r = Recurrence.new(:every => :day, :starts => Date.today, :until => '2010-01-31')
 	
 	# Getting an array with all events
-	r.items.each {|date| puts date.to_s }  # => Memoized array
-	r.items!.each {|date| puts date.to_s } # => reset items cache and re-execute it
+	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
+	
+	# Iterating events
+	r.each { |date| puts date.to_s } # => Use items method
+	r.each! { |date| puts date.to_s } # => Use items! method
 	
 	# Check if a date is included
 	r.include?(Date.today) # => true or false
 	r.include?('2008-09-21')
-
-TODO
-----	
-
-* Write the specs
+	
+	# Get next available date
+	r.next 	# => Keep the original date object
+	r.next! # => Change the internal date object to the next available date
 
 MAINTAINER
 ----------

data/Rakefile

@@ -1,11 +1,11 @@
 require 'rake'
 
-PKG_FILES = %w(init.rb Rakefile recurrence.gemspec History.txt License.txt README.markdown TODO.txt) + 
+PKG_FILES = %w(init.rb Rakefile recurrence.gemspec History.txt License.txt README.markdown) + 
   Dir["lib/**/*"]
 
 spec = Gem::Specification.new do |s|
   s.name = "recurrence"
-  s.version = "0.0.3"
+  s.version = "0.0.6"
   s.summary = "A simples library that handles recurring events"
   s.authors = ["Nando Vieira"]
   s.email = ["fnando.vieira@gmail.com"]
@@ -15,7 +15,7 @@ spec = Gem::Specification.new do |s|
   s.files = PKG_FILES
 	
   s.add_dependency "rubigen"
-  s.add_dependency "activesupport"
+  s.add_dependency "activesupport", ">=2.1.1"
 end
 
 namespace :gem do
@@ -31,7 +31,7 @@ namespace :gem do
     spec.instance_variables.each do |ivar|
       value = spec.instance_variable_get(ivar)
       name  = ivar.split("@").last
-      value = Time.now if name == "date"
+      next if name == "date"
       
       next if skip_fields.include?(name) || value.nil? || value == "" || (value.respond_to?(:empty?) && value.empty?)
       if name == "dependencies"
@@ -71,6 +71,6 @@ namespace :gem do
 end
 
 desc "Execute specs"
-task :specs do
-  system "spec specs/recurrence_spec.rb -c -f s"
+task :spec do
+  system "spec spec/recurrence_spec.rb -c -f s"
 end

data/lib/recurrence/base.rb

@@ -1,17 +1,41 @@
 class Recurrence
   FREQUENCY = %w(day week month year)
   DAYS = %w(sunday monday tuesday wednesday thursday friday saturday)
+  MONTHS = {
+    "jan" => 1, "january" => 1,
+    "feb" => 2, "february" => 2,
+    "mar" => 3, "march" => 3,
+    "apr" => 4, "april" => 4,
+    "may" => 5,
+    "jun" => 6, "june" => 6,
+    "jul" => 7, "july" => 7,
+    "aug" => 8, "august" => 8,
+    "sep" => 9, "september" => 9,
+    "oct" => 10, "october" => 10,
+    "nov" => 11, "november" => 11,
+    "dec" => 12, "december" => 12
+  }
+  
   INTERVALS = {
     :monthly => 1,
     :bimonthly => 2,
     :quarterly => 3,
-    :semestral => 6
+    :semesterly => 6
   }
   
+  attr_reader :event
+  
   def initialize(options)
-    raise ArgumentError, ':every options is required' unless options.key?(:every)
+    raise ArgumentError, ':every option is required' unless options.key?(:every)
     raise ArgumentError, 'invalid :every option' unless FREQUENCY.include?(options[:every].to_s)
-    raise ArgumentError, 'interval should be greater than zero' if options.key?(:interval) && options[:interval].to_i == 0
+    
+    if options.key?(:interval)
+      if options[:every].to_sym == :month && options[:interval].is_a?(Symbol) && !INTERVALS.key?(options[:interval])
+        raise ArgumentError, 'interval symbol is not valid'
+      elsif options[:interval].to_i == 0
+        raise ArgumentError, 'interval should be greater than zero'
+      end
+    end
     
     @options = initialize_dates(options)
     @options[:interval] ||= 1
@@ -25,16 +49,19 @@ class Recurrence
         @event = Recurrence::Event.new(:week, @options)
       when :month then
         raise ArgumentError, 'invalid day' unless (1..31).include?(@options[:on])
+        options.merge!(:interval => INTERVALS[options[:interval]]) if options[:interval].is_a?(Symbol)
         @event = Recurrence::Event.new(:month, @options)
       when :year then
-        raise ArgumentError, 'invalid month' unless (1..12).include?(@options[:on].first)
+        raise ArgumentError, 'invalid month' if !(1..12).include?(@options[:on].first) && !MONTHS.keys.include?(@options[:on].first)
         raise ArgumentError, 'invalid day' unless (1..31).include?(@options[:on].last)
+        @options.merge!(:on => [MONTHS[@options[:on].first.to_s], @options.last]) unless @options[:on].first.kind_of?(Numeric)
         @event = Recurrence::Event.new(:year, @options)
     end
   end
   
   def reset!
     @event.reset!
+    @events = nil
   end
   
   def include?(required_date)
@@ -51,31 +78,42 @@ class Recurrence
     return false
   end
   
-  def items
-    @items ||= begin
-      reset!
-      _items = []
-      each { |date| _items << date }
-      _items
-    end
+  def next
+    @event.next
   end
   
-  def items!
-    @items = nil
-    items
+  def next!
+    @event.next!
   end
   
-  def each(&block)
-    reset!
-    
-    loop do
-      date = @event.find_next!
+  def events
+    @events ||= begin
+      _events = []
       
-      if date.nil?
-        break
-      else
-        yield date
+      loop do
+        date = @event.next!
+
+        break if date.nil?
+        _events << date
       end
+      
+      _events
+    end
+  end
+  
+  def events!
+    reset!
+    events
+  end
+  
+  def each!(&block)
+    reset!
+    each(&block)
+  end
+  
+  def each(&block)
+    events.each do |item|
+      yield item
     end
   end
   

data/lib/recurrence/event.rb

@@ -1,96 +1,130 @@
 class Recurrence::Event
+  attr_accessor :date, :start_date, :options, :every
+  
   def initialize(every, options={})
-    @every = every
+    @every   = every
     @options = options
-    @started = false
-    reset!
+    @current = nil
+    @date    = options[:starts]
+    prepare!
+  end
+  
+  def prepare!
+    self.next!
+    @start_date = @date
+  end
+  
+  def next?
+    !!@next
   end
   
-  def find_next
+  def next!
+    # just continue if date object is null or 
+    # hasn't been initialized yet
+    return nil unless @date || !inited?
+    
+    # return the date if is the first interaction after
+    # initializing object
+    if inited? && !next?
+      @next = true
+      return @date
+    end
+    
     case @every
       when :day
-        date = find_next_day
+        @date = next_day
       when :week
-        date = find_next_week
+        @date = next_week
       when :month
-        date = find_next_month
+        @date = next_month
       when :year
-        date = find_next_year
+        @date = next_year
     end
     
-    date = nil unless date && date.to_date <= @options[:until].to_date
-    date
+    # if limit date has been reached just set the date 
+    # object to nil
+    @date = nil unless @date.to_date <= @options[:until].to_date
+    
+    @date
   end
   
-  def reset!
-    @date = @options[:starts]
+  def next
+    @date
   end
   
-  def find_next!
-    @date = find_next
+  def reset!
+    @date = @start_date
   end
   
   private
-    def started!
-      @started = true
-    end
-    
-    def started?
-      @started == true
+    def inited?
+      !!@start_date
     end
   
-    def find_next_day
-      if !started?
-        started!
-        date = @date
-      else
-        date = @date + @options[:interval].days
-      end
+    def next_day
+      date = @date
+      date = date + @options[:interval].days if inited? || @options[:interval] > 1
       
       date.to_date
     end
     
-    def find_next_week
-      if !started?
-        started!
-        date = @date
-        
-        unless date.wday == @options[:on]
-          date = date.next until @options[:on] == date.wday
-        end
-      else @options[:interval]
-        date = @date + @options[:interval].weeks
+    def next_week
+      date = @date
+      
+      if inited?
+        date = date + @options[:interval].weeks
+      elsif date.wday != @options[:on]
+        date = date.next until @options[:on] == date.wday && date > @options[:starts]
+        date = date + (@options[:interval] - 1).weeks
       end
       
       date.to_date
     end
     
-    def find_next_month
-      if !started?
-        started!
-        date = @date
+    def next_month
+      date = @date
+      
+      if inited?
+        date = advance_to_month(date)
       else
-        date = @date.beginning_of_month + @options[:interval].months
+        day = [options[:on], Time.days_in_month(date.month, date.year)].min
+        date = Date.new(date.year, date.month, day)
+        date = advance_to_month(date) if @date.day > day
       end
-      
-      day = [@options[:on], Time.days_in_month(date.month, date.year)].min
-      date = Date.new(date.year, date.month, day)
+
       date.to_date
     end
     
-    def find_next_year
-      if !started?
-        started!
-        date = @date
+    def advance_to_month(date)
+      date = date.beginning_of_month + @options[:interval].months
+      day = [options[:on], Time.days_in_month(date.month, date.year)].min
+      
+      if date.day != day && date.day < day
+        date = date.to_date.next until date.day == day
+      end
+      
+      date
+    end
+    
+    def next_year
+      date = @date
+      
+      if inited?
+        date = advance_to_year(date)
       else
-        date = @date.beginning_of_month + @options[:interval].years
+        day = [options[:on].last, Time.days_in_month(options[:on].first, date.year)].min
+        date = Date.new(date.year, options[:on].first, day)
+        date = advance_to_year(date) if @date.month > date.month || @options[:on].last < @date.day
       end
       
+      date.to_date
+    end
+    
+    def advance_to_year(date)
+      date = date.beginning_of_month + @options[:interval].years
       day = [Time.days_in_month(@options[:on].first, date.year), @options[:on].last].min
       year = date.year
-      
-      year += 1 if @options[:on].first < date.month
-      
-      Date.new(year, @options[:on].first, day)
+    
+      date = Date.new(year, @options[:on].first, day)
     end
-end
+end

data/recurrence.gemspec

@@ -2,28 +2,26 @@
 # RUN : 'rake gem:update_gemspec'
 
 Gem::Specification.new do |s|
-  s.date = "Mon Sep 22 21:17:41 -0300 2008"
   s.authors = ["Nando Vieira"]
+  s.require_paths = ["lib"]
   s.required_rubygems_version = ">= 0"
-  s.version = "0.0.3"
+  s.has_rdoc = false
   s.files = ["init.rb",
  "Rakefile",
  "recurrence.gemspec",
  "History.txt",
  "License.txt",
  "README.markdown",
- "TODO.txt",
  "lib/recurrence",
  "lib/recurrence/base.rb",
  "lib/recurrence/event.rb",
  "lib/recurrence.rb"]
-  s.has_rdoc = false
   s.email = ["fnando.vieira@gmail.com"]
-  s.name = "recurrence"
-  s.bindir = "bin"
+  s.version = "0.0.6"
   s.homepage = "http://github.com/fnando/recurrence"
+  s.name = "recurrence"
   s.summary = "A simples library that handles recurring events"
   s.add_dependency "rubigen", ">= 0"
-  s.add_dependency "activesupport", ">= 0"
-  s.require_paths = ["lib"]
+  s.add_dependency "activesupport", ">= 2.1.1"
+  s.bindir = "bin"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fnando-recurrence
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.6
 platform: ruby
 authors: 
 - Nando Vieira
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-22 17:17:41 -07:00
+date: 2008-12-22 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,7 +28,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 2.1.1
     version: 
 description: 
 email: 
@@ -46,7 +46,6 @@ files:
 - History.txt
 - License.txt
 - README.markdown
-- TODO.txt
 - lib/recurrence
 - lib/recurrence/base.rb
 - lib/recurrence/event.rb