From 357109c5a5518db5925f49a6700a87e7ed30ca14 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Wed, 28 Dec 2011 16:19:29 -0500
Subject: [PATCH] Unit testing. Documentation.
---
src/com/gitblit/utils/TimeUtils.java | 171 ++++++++++++++++++++++++++++++++++++++++++++++----------
1 files changed, 139 insertions(+), 32 deletions(-)
diff --git a/src/com/gitblit/utils/TimeUtils.java b/src/com/gitblit/utils/TimeUtils.java
index 44f51a5..6cc4dcb 100644
--- a/src/com/gitblit/utils/TimeUtils.java
+++ b/src/com/gitblit/utils/TimeUtils.java
@@ -15,9 +15,16 @@
*/
package com.gitblit.utils;
+import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
+/**
+ * Utility class of time functions.
+ *
+ * @author James Moger
+ *
+ */
public class TimeUtils {
public static final long MIN = 1000 * 60L;
@@ -29,17 +36,37 @@
public static final long ONEYEAR = ONEDAY * 365L;
+ /**
+ * Returns true if date is today.
+ *
+ * @param date
+ * @return true if date is today
+ */
public static boolean isToday(Date date) {
- return (System.currentTimeMillis() - date.getTime()) < ONEDAY;
+ return (System.currentTimeMillis() - date.getTime()) < ONEDAY;
}
+ /**
+ * Returns true if date is yesterday.
+ *
+ * @param date
+ * @return true if date is yesterday
+ */
public static boolean isYesterday(Date date) {
Calendar cal = Calendar.getInstance();
- cal.setTime(date);
- cal.add(Calendar.DATE, 1);
- return (System.currentTimeMillis() - cal.getTimeInMillis()) < ONEDAY;
+ cal.setTime(new Date());
+ cal.add(Calendar.DATE, -1);
+ SimpleDateFormat df = new SimpleDateFormat("yyyyMMdd");
+ return df.format(cal.getTime()).equals(df.format(date));
}
+ /**
+ * Returns the string representation of the duration as days, months and/or
+ * years.
+ *
+ * @param days
+ * @return duration as string in days, months, and/or years
+ */
public static String duration(int days) {
if (days <= 60) {
return days + (days > 1 ? " days" : " day");
@@ -69,6 +96,15 @@
}
}
+ /**
+ * Returns the number of minutes ago between the start time and the end
+ * time.
+ *
+ * @param date
+ * @param endTime
+ * @param roundup
+ * @return difference in minutes
+ */
public static int minutesAgo(Date date, long endTime, boolean roundup) {
long diff = endTime - date.getTime();
int mins = (int) (diff / MIN);
@@ -78,10 +114,24 @@
return mins;
}
+ /**
+ * Return the difference in minutes between now and the date.
+ *
+ * @param date
+ * @param roundup
+ * @return minutes ago
+ */
public static int minutesAgo(Date date, boolean roundup) {
return minutesAgo(date, System.currentTimeMillis(), roundup);
}
+ /**
+ * Return the difference in hours between now and the date.
+ *
+ * @param date
+ * @param roundup
+ * @return hours ago
+ */
public static int hoursAgo(Date date, boolean roundup) {
long diff = System.currentTimeMillis() - date.getTime();
int hours = (int) (diff / ONEHOUR);
@@ -91,25 +141,50 @@
return hours;
}
- public static int daysAgo(Date date, boolean roundup) {
- long diff = System.currentTimeMillis() - date.getTime();
+ /**
+ * Return the difference in days between now and the date.
+ *
+ * @param date
+ * @return days ago
+ */
+ public static int daysAgo(Date date) {
+ long today = ONEDAY * (System.currentTimeMillis()/ONEDAY);
+ long day = ONEDAY * (date.getTime()/ONEDAY);
+ long diff = today - day;
int days = (int) (diff / ONEDAY);
- if (roundup && (diff % ONEDAY) > 0) {
- days++;
- }
return days;
}
+ /**
+ * Returns the string representation of the duration between now and the
+ * date.
+ *
+ * @param date
+ * @return duration as a string
+ */
public static String timeAgo(Date date) {
return timeAgo(date, false);
}
+ /**
+ * Returns the CSS class for the date based on its age from Now.
+ *
+ * @param date
+ * @return the css class
+ */
public static String timeAgoCss(Date date) {
return timeAgo(date, true);
}
+ /**
+ * Returns the string representation of the duration OR the css class for
+ * the duration.
+ *
+ * @param date
+ * @param css
+ * @return the string representation of the duration OR the css class
+ */
private static String timeAgo(Date date, boolean css) {
- String ago = null;
if (isToday(date) || isYesterday(date)) {
int mins = minutesAgo(date, true);
if (mins >= 120) {
@@ -118,52 +193,84 @@
}
int hours = hoursAgo(date, true);
if (hours > 23) {
- ago = "yesterday";
+ return "yesterday";
} else {
- ago = hours + " hours ago";
+ return hours + " hours ago";
}
- } else {
- if (css) {
- return "age0";
- }
- ago = mins + " min" + (mins > 1 ? "s" : "") + " ago";
}
+ if (css) {
+ return "age0";
+ }
+ return mins + " min" + (mins > 1 ? "s" : "") + " ago";
} else {
if (css) {
return "age2";
}
- int days = daysAgo(date, true);
+ int days = daysAgo(date);
if (days < 365) {
if (days <= 30) {
- ago = days + " days ago";
+ return days + " days ago";
} else if (days <= 90) {
int weeks = days / 7;
if (weeks == 12) {
- ago = "3 months ago";
+ return "3 months ago";
} else {
- ago = weeks + " weeks ago";
+ return weeks + " weeks ago";
}
- } else if (days > 90) {
- int months = days / 30;
- int weeks = (days % 30) / 7;
- if (weeks >= 2) {
- months++;
- }
- ago = months + " months ago";
}
+ int months = days / 30;
+ int weeks = (days % 30) / 7;
+ if (weeks >= 2) {
+ months++;
+ }
+ return months + " months ago";
} else if (days == 365) {
- ago = "1 year ago";
+ return "1 year ago";
} else {
int yr = days / 365;
days = days % 365;
int months = (yr * 12) + (days / 30);
if (months > 23) {
- ago = yr + " years ago";
+ return yr + " years ago";
} else {
- ago = months + " months ago";
+ return months + " months ago";
}
}
}
- return ago;
+ }
+
+ /**
+ * Convert a frequency string into minutes.
+ *
+ * @param frequency
+ * @return minutes
+ */
+ public static int convertFrequencyToMinutes(String frequency) {
+ // parse the frequency
+ frequency = frequency.toLowerCase();
+ int mins = 60;
+ if (!StringUtils.isEmpty(frequency)) {
+ try {
+ String str = frequency.trim();
+ if (frequency.indexOf(' ') > -1) {
+ str = str.substring(0, str.indexOf(' ')).trim();
+ }
+ mins = (int) Float.parseFloat(str);
+ } catch (NumberFormatException e) {
+ }
+ if (mins < 5) {
+ mins = 5;
+ }
+ }
+ if (frequency.indexOf("day") > -1) {
+ // convert to minutes
+ mins *= 1440;
+ } else if (frequency.indexOf("hour") > -1) {
+ // convert to minutes
+ mins *= 60;
+ } else if (frequency.indexOf("min") > -1) {
+ // default mins
+ }
+ return mins;
}
}
--
Gitblit v1.9.1