Changeset 210 for trunk/grails-app/services/DateUtilService.groovy

Timestamp:

Dec 2, 2009, 5:26:54 AM (15 years ago)

Author:

gav

Message:

Make date calculations and formatting more groovy.

File:

• trunk/grails-app/services/DateUtilService.groovy (modified) (2 diffs)

trunk/grails-app/services/DateUtilService.groovy

@@ +1 @@
+import org.codehaus.groovy.runtime.TimeCategory
+// the above will be deprecated and replaced by: groovy.time.TimeCategory
+/// @todo: consider moving this to org.gnumims.DateUtil
+/// pros: easy to use in domain classes.
+/// cons: have to import so pulls in all referenced imports? Injection probably does that anyway.
+
+/**
+* Provides some convenience methods for working with dates.
+*/
 class DateUtilService {
 
@@ -4 +13 @@
     //static scope = "request"
 
+    /**
+    * Get the start of today.
+     * Can be call as dateUtilService.today or dateUtilService.getToday().
+     * @returns A Date object with today's date and all time fields set to 0.
+    */
     public static Date getToday() {
-        return setMidnight(new Date())
+        return getMidnight(new Date())
     }
 
+    /**
+    * Get the start of tomorrow.
+     * Can be call as dateUtilService.tomorrow or dateUtilService.getTomorrow().
+     * @returns A Date object with tomorrow's date and all time fields set to 0.
+    */
     public static Date getTomorrow() {
         return (getToday() + 1) as Date
     }
 
-    public static Date setMidnight(Date theDate) {
-        Calendar cal = Calendar.getInstance()
-        cal.setTime(theDate)
+    /**
+    * Get the start of yesterday.
+     * Can be call as dateUtilService.yesterday or dateUtilService.getYesterday().
+     * @returns A Date object with yesterday's date and all time fields set to 0.
+    */
+    public static Date getYesterday() {
+        return (getToday() - 1) as Date
+    }
+
+    /**
+    * Get the start of the day one week ago.
+     * Can be call as dateUtilService.oneWeekAgo or dateUtilService.getOneWeekAgo().
+     * @returns A Date object with the date one week ago and all time fields set to 0.
+    */
+    public static Date getOneWeekAgo() {
+        return (getToday() - 7) as Date
+    }
+
+    /**
+    * Get the start of the day one week ago.
+     * Can be call as dateUtilService.oneWeekAgo or dateUtilService.getOneWeekAgo().
+     * @returns A Date object with the date one week ago and all time fields set to 0.
+    */
+    public static Date getOneWeekFromNow() {
+        return (getToday() + 7) as Date
+    }
+
+    /**
+    * Get the start of a given date by setting all time fields to 0.
+    * The Calendar.getInstance() or Calendar.instance factory returns a new calendar instance, usually
+    * a Gregorian calendar but using Calendar we don't have to worry about those details.
+    * The time fields are then set to zero and cal.getTime() or cal.time returns a java.util.Date object.
+    * @param date The Date object to start with.
+    * @returns A Date object having the given date and all time fields set to 0, so the very start of the given day.
+    */
+    public static Date getMidnight(Date date) {
+        Calendar cal = Calendar.instance
+        cal.setTime(date)
         cal.set(Calendar.HOUR_OF_DAY, 0)
         cal.set(Calendar.MINUTE, 0)
         cal.set(Calendar.SECOND, 0)
         cal.set(Calendar.MILLISECOND, 0)
-        cal.getTime()
+        cal.time
     }