DateUtils 0.3 → 0.3.1

data/lib/date_utils.rb

@@ -18,7 +18,6 @@
 # 
 
 require 'date'
-require 'date_utils'
 
 
 # DateUils 
@@ -28,40 +27,7 @@ require 'date_utils'
 # * DateUtils::Year
 # * DateUtils::Month
 # * DateUtils::Week
-# * DateUtils::Day
-# for complete rdoc visit:
-# http://dateutils.rubyforge.org
 # 
-# _usage_:
-# 
-# year = DateUtils::Year.new(Date.parse('1977-10-18'))
-# pp year
-#<DateUtils::Year:0xb7c4e19c
-# @date=#<Date: 4886869/2,0,2299161>,
-# @first_day=#<Date: 4886289/2,0,2299161>,
-# @last_day=#<Date: 4887017/2,0,2299161>,
-# @year=1977>
-#
-# year.first_day.to_s
-# => "1977-01-01"
-# pp year.weeks.first
-#<DateUtils::Week:0xb7b37a60
-# @date=#<Date: 4886289/2,0,2299161>,
-# @first_day=#<Date: 4886279/2,0,2299161>,
-# @last_day=#<Date: 4886291/2,0,2299161>,
-# @month=
-#  #<DateUtils::Month:0xb7b37704
-#   @date=#<Date: 4886289/2,0,2299161>,
-#   @first_day=#<Date: 4886289/2,0,2299161>,
-#   @last_day=#<Date: 4886349/2,0,2299161>,
-#   @month=1,
-#   @num_days=31>,
-# @num_week=53>
-#
-# 
-# year.distance_to_now_in_words
-# => "29 years,10 months,5 days ago"
-#
 module DateUtils
   
   # common to Year/Month/Week
@@ -255,6 +221,8 @@ module DateUtils
       return Week.new(@last_day + 1)
     end
     
+    alias succ next
+    
     # returns new Week -instance one week before self
     # 
     def previous
@@ -262,11 +230,12 @@ module DateUtils
     end
     
     # returns collection of days as Date -instances
-    # 
-    def days
+    # or yields Day if block given
+    #
+    def days(&block)
       arr = []
       @first_day.upto(@last_day) { |date| arr << date }
-      arr
+      block_given? ? arr.each { |a| yield a } : arr
     end
     
     private
@@ -286,12 +255,14 @@ module DateUtils
       @date = date
     end
     
+    
   end
   
-  # Represents a 'Day'
-  # future usage to supply 'attributes' - e.g. calendar-events...
+  # future use of Day planned instead of regular 'Date'-instance
+  # when calling e.g. Month#days
   #
   class Day
+    # the regular 'Date'-instance of this 'Day'
     attr_reader :date
     
     def initialize(date=nil)
@@ -304,7 +275,7 @@ module DateUtils
   #  
   class Month
     include Common
-    
+
     # the initial / regular Date instance  
     attr_reader :date
       
@@ -357,7 +328,9 @@ module DateUtils
     def next
       return Month.new(@last_day + 1)
     end
-      
+     
+    alias succ next
+    
     # returns a new Month -instance one Month prior to self
     # 
     def previous
@@ -365,11 +338,11 @@ module DateUtils
     end
         
     # returns collection of days as Date -instances of self
-    #  
-    def days
+    # or yields Day if block given
+    def days(&block)
       arr = []
       @first_day.upto(@last_day) { |date| arr << date }
-      arr
+      block_given? ? arr.each { |a| yield a } : arr
     end
       
     private
@@ -393,7 +366,7 @@ module DateUtils
   # 
   class Year
     include Common
-    
+
     # the initial Date of the Year -instance 
     attr_reader :date
     
@@ -431,19 +404,21 @@ module DateUtils
     end
     
     # returns collection of Month -instances of self
-    # 
-    def months
+    # or yields Month if block given
+    #
+    def months(&block)
       arr = []
       for i in 1..12
         arr.push( Month.new(Date.civil(@year,i) ) )
       end
-      arr
+      block_given? ? arr.each { |a| yield a } : arr
     end
     
     # returns collection of Week -instances of self
     # neccessarily overlaps year boundarys
-    # 
-    def weeks
+    # yields Week if block given
+    #
+    def weeks(&block)
       d = Date.civil(@year)
       arr = []
       week = Week.new(d)
@@ -452,7 +427,7 @@ module DateUtils
         week = week.next
         arr.push(week)
       end
-      arr
+      block_given? ? arr.each { |a| yield a } : arr
     end
     
     # returns Week 'num' of self
@@ -477,6 +452,8 @@ module DateUtils
       end
     end
     
+    alias succ next
+    
     # returns new Year instance one year previous
     # 
     def previous

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.3
+rubygems_version: 0.9.4
 specification_version: 1
 name: DateUtils
 version: !ruby/object:Gem::Version 
-  version: "0.3"
-date: 2007-08-23 00:00:00 +02:00
+  version: 0.3.1
+date: 2007-08-25 00:00:00 +02:00
 summary: Some handy utils to deal with Date
 require_paths: 
 - lib