fnando-recurrence 0.0.3

data/History.txt

@@ -0,0 +1,15 @@
+== 0.0.1 2008-09-21
+
+* 1 major enhancement:
+  * Initial release
+
+== 0.0.2 2008-09-21
+
+* 1 minor enhancement:
+  * Added `items` and `items!` methods; returns an array with all events
+
+== 0.0.3 2008-09-22
+
+* 1 major enhancement:
+  * The recurrence now considers the starting date and its configurations
+  * Added lots of specs

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Nando Vieira
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,100 @@
+Recurrence
+==========
+
+* [http://github.com/fnando/recurrence](http://github.com/fnando/recurrence)
+
+DESCRIPTION:
+------------
+
+A simples library that handles recurring events.
+
+
+INSTALLATION:
+-------------
+
+Recurrence can be installed as Rails plugin or gem. To install it as gem, just
+run the command 
+
+	sudo gem install fnando-recurrence --source=http://gems.github.com
+
+If you prefer it as a plugin, just run the command
+
+	script/plugin install git://github.com/fnando/recurrence.git
+
+USAGE:
+------
+	
+	require 'rubygems'
+	require 'recurrence'
+	
+	# Daily
+	r = Recurrence.new(:every => :day)
+	r = Recurrence.new(:every => :day, :interval => 9)
+	
+	# Weekly
+	r = Recurrence.new(:every => :week, :on => :friday)
+	r = Recurrence.new(:every => :week, :on => 5)
+	r = Recurrence.new(:every => :week, :on => :friday, :interval => 2)
+	
+	# Monthly
+	r = Recurrence.new(:every => :month, :on => 15)
+	r = Recurrence.new(:every => :month, :on => 31)
+	r = Recurrence.new(:every => :month, :on => 7, :interval => 2)
+	
+	# Yearly
+	r = Recurrence.new(:every => :year, :on => [7, 4]) # => [month, day]
+	r = Recurrence.new(:every => :year, :on => [10, 31], :interval => 3)
+	
+	# 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
+	
+	# 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
+	
+	# Check if a date is included
+	r.include?(Date.today) # => true or false
+	r.include?('2008-09-21')
+
+TODO
+----	
+
+* Write the specs
+
+MAINTAINER
+----------
+ 
+* Nando Vieira ([http://simplesideias.com.br](http://simplesideias.com.br))
+
+LICENSE:
+--------
+
+(The MIT License)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,76 @@
+require 'rake'
+
+PKG_FILES = %w(init.rb Rakefile recurrence.gemspec History.txt License.txt README.markdown TODO.txt) + 
+  Dir["lib/**/*"]
+
+spec = Gem::Specification.new do |s|
+  s.name = "recurrence"
+  s.version = "0.0.3"
+  s.summary = "A simples library that handles recurring events"
+  s.authors = ["Nando Vieira"]
+  s.email = ["fnando.vieira@gmail.com"]
+  s.homepage = "http://github.com/fnando/recurrence"
+  s.description = ""
+  s.has_rdoc = false
+  s.files = PKG_FILES
+	
+  s.add_dependency "rubigen"
+  s.add_dependency "activesupport"
+end
+
+namespace :gem do
+  # Thanks to the Merb project for this code.
+  desc "Update Github Gemspec"
+  task :update_gemspec do
+    skip_fields = %w(new_platform original_platform specification_version loaded required_ruby_version rubygems_version platform )
+    
+    result = "# WARNING : RAKE AUTO-GENERATED FILE. DO NOT MANUALLY EDIT!\n"
+    result << "# RUN : 'rake gem:update_gemspec'\n\n"
+    result << "Gem::Specification.new do |s|\n"
+    
+    spec.instance_variables.each do |ivar|
+      value = spec.instance_variable_get(ivar)
+      name  = ivar.split("@").last
+      value = Time.now if name == "date"
+      
+      next if skip_fields.include?(name) || value.nil? || value == "" || (value.respond_to?(:empty?) && value.empty?)
+      if name == "dependencies"
+        value.each do |d|
+          dep, *ver = d.to_s.split(" ")
+          result <<  "  s.add_dependency #{dep.inspect}, #{ver.join(" ").inspect.gsub(/[()]/, "").gsub(", runtime", "")}\n"
+        end
+      else
+        case value
+        when Array
+          value =  name != "files" ? value.inspect : value.inspect.split(",").join(",\n")
+        when FalseClass
+        when TrueClass
+        when Fixnum
+        when String
+          value = value.inspect
+        else
+          value = value.to_s.inspect
+        end
+        result << "  s.#{name} = #{value}\n"
+      end
+    end
+    
+    result << "end"
+    File.open(File.join(File.dirname(__FILE__), "#{spec.name}.gemspec"), "w"){|f| f << result}
+  end
+  
+  desc "Build gem"
+  task :build => [:update_gemspec] do
+    system "gem build #{spec.instance_variable_get('@name')}.gemspec"
+  end
+  
+  desc "Install gem"
+  task :install => [:update_gemspec, :build] do
+    system "sudo gem install #{spec.instance_variable_get('@name')}"
+  end
+end
+
+desc "Execute specs"
+task :specs do
+  system "spec specs/recurrence_spec.rb -c -f s"
+end

data/init.rb

@@ -0,0 +1 @@
+require "recurrence"

data/lib/recurrence.rb

@@ -0,0 +1,6 @@
+require "rubygems"
+require "date"
+gem "activesupport", ">=2.1.1"
+require "activesupport"
+require File.dirname(__FILE__) + "/recurrence/base"
+require File.dirname(__FILE__) + "/recurrence/event"

data/lib/recurrence/base.rb

@@ -0,0 +1,93 @@
+class Recurrence
+  FREQUENCY = %w(day week month year)
+  DAYS = %w(sunday monday tuesday wednesday thursday friday saturday)
+  INTERVALS = {
+    :monthly => 1,
+    :bimonthly => 2,
+    :quarterly => 3,
+    :semestral => 6
+  }
+  
+  def initialize(options)
+    raise ArgumentError, ':every options 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
+    
+    @options = initialize_dates(options)
+    @options[:interval] ||= 1
+    
+    case @options[:every].to_sym
+      when :day then
+        @event = Recurrence::Event.new(:day, @options)
+      when :week then
+        raise ArgumentError, 'invalid day' if !DAYS.include?(@options[:on].to_s) && !(0..6).include?(@options[:on])
+        @options.merge!(:on => DAYS.index(@options[:on].to_s)) if DAYS.include?(@options[:on].to_s)
+        @event = Recurrence::Event.new(:week, @options)
+      when :month then
+        raise ArgumentError, 'invalid day' unless (1..31).include?(@options[:on])
+        @event = Recurrence::Event.new(:month, @options)
+      when :year then
+        raise ArgumentError, 'invalid month' unless (1..12).include?(@options[:on].first)
+        raise ArgumentError, 'invalid day' unless (1..31).include?(@options[:on].last)
+        @event = Recurrence::Event.new(:year, @options)
+    end
+  end
+  
+  def reset!
+    @event.reset!
+  end
+  
+  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]
+      false
+    else
+      each do |date|
+        return true if date == required_date
+      end
+    end
+    
+    return false
+  end
+  
+  def items
+    @items ||= begin
+      reset!
+      _items = []
+      each { |date| _items << date }
+      _items
+    end
+  end
+  
+  def items!
+    @items = nil
+    items
+  end
+  
+  def each(&block)
+    reset!
+    
+    loop do
+      date = @event.find_next!
+      
+      if date.nil?
+        break
+      else
+        yield date
+      end
+    end
+  end
+  
+  private
+    def initialize_dates(options)
+      [:starts, :until].each do |name|
+        options[name] = Date.parse(options[name]) if options[name].is_a?(String)
+      end
+      
+      options[:starts] ||= Date.today
+      options[:until] ||= Date.parse('2037-12-31')
+      
+      options
+    end
+end

data/lib/recurrence/event.rb

@@ -0,0 +1,96 @@
+class Recurrence::Event
+  def initialize(every, options={})
+    @every = every
+    @options = options
+    @started = false
+    reset!
+  end
+  
+  def find_next
+    case @every
+      when :day
+        date = find_next_day
+      when :week
+        date = find_next_week
+      when :month
+        date = find_next_month
+      when :year
+        date = find_next_year
+    end
+    
+    date = nil unless date && date.to_date <= @options[:until].to_date
+    date
+  end
+  
+  def reset!
+    @date = @options[:starts]
+  end
+  
+  def find_next!
+    @date = find_next
+  end
+  
+  private
+    def started!
+      @started = true
+    end
+    
+    def started?
+      @started == true
+    end
+  
+    def find_next_day
+      if !started?
+        started!
+        date = @date
+      else
+        date = @date + @options[:interval].days
+      end
+      
+      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
+      end
+      
+      date.to_date
+    end
+    
+    def find_next_month
+      if !started?
+        started!
+        date = @date
+      else
+        date = @date.beginning_of_month + @options[:interval].months
+      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
+      else
+        date = @date.beginning_of_month + @options[:interval].years
+      end
+      
+      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)
+    end
+end

data/recurrence.gemspec

@@ -0,0 +1,29 @@
+# WARNING : RAKE AUTO-GENERATED FILE. DO NOT MANUALLY EDIT!
+# 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.required_rubygems_version = ">= 0"
+  s.version = "0.0.3"
+  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.homepage = "http://github.com/fnando/recurrence"
+  s.summary = "A simples library that handles recurring events"
+  s.add_dependency "rubigen", ">= 0"
+  s.add_dependency "activesupport", ">= 0"
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: fnando-recurrence
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-22 17:17:41 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubigen
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: 
+- fnando.vieira@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+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
+has_rdoc: false
+homepage: http://github.com/fnando/recurrence
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A simples library that handles recurring events
+test_files: []
+