recurrence 0.1.1 → 0.1.2

data/History.txt

@@ -1,55 +1,54 @@
 == 0.0.1 2008-09-21
 
-* 1 major enhancement:
-  * Initial release
+* Initial release
 
 == 0.0.2 2008-09-21
 
-* 1 minor enhancement:
-  * Added `items` and `items!` methods; returns an array with all events
+* 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
+* 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
+* 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
+* 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
+* Code refactoring
+* Added next and next! methods
+* Added more specs
+* Yearly interval now accepts symbols: jan-dec and january-december
 
 == 0.0.7 2009-01-06
 
-* 1 major enhancement:
-	* The events method now accepts :starts and :until dates
+* The events method now accepts :starts and :until dates
 
 == 0.0.8 2009-01-07
 
-* 1 small enhancement:
-	* The iteration is stopped when the :until is reached when limiting events
+* The iteration is stopped when the :until is reached when limiting events
 
 == 0.1.0 2009-07-18
 
-* 3 major enhancements:
-  * Allow monthly recurrences to occur by weekday:
-    Recurrence.new(:every => :month, :on => :first, :weekday => :thursday)
-  * Allow several weekdays to be given to weekly recurrence:
-    Recurrence.new(:every => :week, :on => [:monday, :wednesday, :friday])
-  * Added :daily, :weekly, :monthly and :yearly shortcuts to Recurrence.
+* Allow monthly recurrences to occur by weekday:
+  Recurrence.new(:every => :month, :on => :first, :weekday => :thursday)
+* Allow several weekdays to be given to weekly recurrence:
+  Recurrence.new(:every => :week, :on => [:monday, :wednesday, :friday])
+* Added :daily, :weekly, :monthly and :yearly shortcuts to Recurrence.
+
+== 0.1.1 2009-12-18
+
+* Removed ActiveSupport deprecation; should require active_support instead.
+
+== 0.1.2 2010-09-09
+
+* Refactor, refactor, refactor.
+* Using Recurrence as Rails plugin is now deprecated; install it as a gem instead.

data/README.markdown

@@ -12,45 +12,34 @@ A simple library to handle recurring events.
 INSTALLATION:
 -------------
 
-Recurrence can be installed as Rails plugin or gem. To install it as gem, just
-run the command 
+Recurrence can be installed by running
 
-	sudo gem install fnando-recurrence --source=http://gems.github.com
-
-Sometimes Github just won't build the gem. You can then do the following
-
-	git clone git://github.com/fnando/recurrence.git
-	cd recurrence
-	rake gem:install
-
-If you prefer it as a plugin, just run the command
-
-	script/plugin install git://github.com/fnando/recurrence.git
+	gem install recurrence
 
 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 => 5)
 	r = Recurrence.new(:every => :week, :on => :monday)
 	r = Recurrence.new(:every => :week, :on => [:monday, :friday])
 	r = Recurrence.new(:every => :week, :on => [:monday, :wednesday, :friday])
 	r = Recurrence.new(:every => :week, :on => :friday, :interval => 2)
-	
+
 	# Monthly by month day
 	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)
-	
+
 	# Monthly by week day
 	r = Recurrence.new(:every => :month, :on => :first, :weekday => :sunday)
 	r = Recurrence.new(:every => :month, :on => :third, :weekday => :monday)
@@ -58,47 +47,47 @@ USAGE:
 	r = Recurrence.new(:every => :month, :on => :last,  :weekday => :friday, :interval => 2)
 	r = Recurrence.new(:every => :month, :on => :last,  :weekday => :friday, :interval => :quarterly)
 	r = Recurrence.new(:every => :month, :on => :last,  :weekday => :friday, :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(: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.events.each {|date| puts date.to_s }  # => Memoized array
 	r.events!.each {|date| puts date.to_s } # => reset items cache and re-execute it
 	r.events(:starts => '2009-01-01').each {|date| puts date.to_s }
 	r.events(:until => '2009-01-10').each {|date| puts date.to_s }
 	r.events(:starts => '2009-01-05', :until => '2009-01-10').each {|date| puts date.to_s }
-	
+
 	# 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')
-	
+
 	# Get next available date
 	r.next 	# => Keep the original date object
 	r.next! # => Change the internal date object to the next available date
 
 MAINTAINER
 ----------
- 
+
 * Nando Vieira (<http://simplesideias.com.br/>)
 
 CONTRIBUTORS
 ------------
- 
+
 * José Valim (<http://josevalim.blogspot.com/>)
 
 LICENSE:

data/Rakefile

@@ -1,76 +1,26 @@
-require 'rake'
-
-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.1.1"
-  s.summary = "A simple library to handle 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 "activesupport", ">=2.1.1"
-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
-      next 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 "rm *.gem"
-    system "gem build #{spec.instance_variable_get('@name')}.gemspec"
+require "rspec/core/rake_task"
+require "lib/recurrence/version"
+
+RSpec::Core::RakeTask.new
+
+begin
+  require "jeweler"
+
+  JEWEL = Jeweler::Tasks.new do |gem|
+    gem.name = "recurrence"
+    gem.version = Recurrence::Version::STRING
+    gem.summary = "A simple library to handle recurring events"
+    gem.description = ""
+    gem.authors = ["Nando Vieira"]
+    gem.email = "fnando.vieira@gmail.com"
+    gem.homepage = "http://github.com/fnando/recurrence"
+    gem.has_rdoc = false
+    gem.files = FileList["History.txt", "init.rb", "License.txt", "Rakefile", "README.markdown", "recurrence.gemspec", "{lib,spec}/**/*"]
+    gem.add_development_dependency "rspec", ">= 2.0.0"
+    gem.add_dependency "activesupport"
   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 :spec do
-  system "spec spec/recurrence_spec.rb -c -f s"
+  Jeweler::GemcutterTasks.new
+rescue LoadError => e
+  puts "You don't have Jeweler installed, so you won't be able to build gems."
 end

data/init.rb

@@ -1 +1,2 @@
-require "recurrence"
+require "recurrence"
+warn "Using Recurrence as a Rails plugin is deprecated and won't be supported in future versions."

data/lib/recurrence.rb

@@ -1,17 +1,141 @@
-require 'rubygems'
-require 'date'
-require 'active_support'
-
-dirname = File.dirname(__FILE__)
-require dirname + '/recurrence/base'
-require dirname + '/recurrence/shortcuts'
-require dirname + '/recurrence/event'
-require dirname + '/recurrence/event/daily'
-require dirname + '/recurrence/event/weekly'
-require dirname + '/recurrence/event/monthly'
-require dirname + '/recurrence/event/yearly'
+require "date"
+require "active_support/all"
 
 class Recurrence
-  include Base
-  extend Shortcuts
+  autoload :Event, "recurrence/event"
+
+  FREQUENCY = %w(day week month year)
+
+  attr_reader :event
+
+  def self.default_until_date
+    @default_until_date ||= Date.new(2037, 12, 31)
+  end
+
+  def self.default_until_date=(date)
+    @default_until_date = if date.is_a?(String)
+      Date.parse(date)
+    else
+      date
+    end
+  end
+
+  def self.daily(options = {})
+    options[:every] = :day
+    new(options)
+  end
+
+  def self.weekly(options = {})
+    options[:every] = :week
+    new(options)
+  end
+
+  def self.monthly(options = {})
+    options[:every] = :month
+    new(options)
+  end
+
+  def self.yearly(options = {})
+    options[:every] = :year
+    new(options)
+  end
+
+  def initialize(options)
+    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
+
+    @event = case @options[:every].to_sym
+      when :day
+        Recurrence::Event::Daily.new(@options)
+      when :week
+        Recurrence::Event::Weekly.new(@options)
+      when :month
+        Recurrence::Event::Monthly.new(@options)
+      when :year
+        Recurrence::Event::Yearly.new(@options)
+    end
+  end
+
+  def reset!
+    @event.reset!
+    @events = nil
+  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 next
+    @event.next
+  end
+
+  def next!
+    @event.next!
+  end
+
+  def events(options={})
+    options[:starts] = Date.parse(options[:starts]) if options[:starts].is_a?(String)
+    options[:until]  = Date.parse(options[:until])  if options[:until].is_a?(String)
+
+    reset! if options[:starts] || options[:until]
+
+    @events ||= begin
+      _events = []
+
+      loop do
+        date = @event.next!
+
+        break if date.nil?
+
+        valid_start = options[:starts].nil? || date >= options[:starts]
+        valid_until = options[:until].nil?  || date <= options[:until]
+        _events << date if valid_start && valid_until
+
+        break if options[:until] && options[:until] <= date
+      end
+
+      _events
+    end
+  end
+
+  def events!(options={})
+    reset!
+    events(options)
+  end
+
+  def each!(&block)
+    reset!
+    each(&block)
+  end
+
+  def each(&block)
+    events.each do |item|
+      yield item
+    end
+  end
+
+  private
+  def initialize_dates(options) #:nodoc:
+    [:starts, :until].each do |name|
+      options[name] = Date.parse(options[name]) if options[name].is_a?(String)
+    end
+
+    options[:starts] ||= Date.today
+    options[:until]  ||= self.class.default_until_date
+
+    options
+  end
 end