[SAK-40018] increase precision of timestamps, and minor fixes to readme file

Author: plukasew

calendar/calendar-impl/impl/src/test/org/sakaiproject/calendar/impl/DbCalendarServiceSerializationTest.java

@@ -456,6 +456,16 @@ public String shortLocalizedTimestamp(Instant instant, Locale locale) {
 			public String shortLocalizedDate(LocalDate date, Locale locale) {
 				return null;
 			}
+
+			@Override
+			public String shortPreciseLocalizedTimestamp(Instant instant, TimeZone timezone, Locale locale) {
+				return null;
+			}
+
+			@Override
+			public String shortPreciseLocalizedTimestamp(Instant instant, Locale locale) {
+				return null;
+			}
 		};
 		services = new HashMap<String,Object>();
 		services.put("sqlservice", sqlService);

kernel/api/src/main/java/org/sakaiproject/time/api/UserTimeService.java

@@ -46,7 +46,7 @@ public interface UserTimeService {
 
     /**
      * Formats a point in time, in the given time zone, for display to the user in a concise way that still presents all relevant information
-     * including date, time, and time zone.
+     * including date, time (to the minute), and time zone.
      *
      * @param instant the instant in time
      * @param timezone the time zone to use when displaying the date
@@ -55,15 +55,36 @@ public interface UserTimeService {
      */
     public String shortLocalizedTimestamp(Instant instant, TimeZone timezone, Locale locale);
 
+    /**
+     * Formats a point in time, in the given time zone, for display to the user in a concise way that still presents all relevant information
+     * including date, time (to the second), and time zone.
+     *
+     * @param instant the instant in time
+     * @param timezone the time zone to use when displaying the date
+     * @param locale the locale to use when formatting the date for display
+     * @return a formatted date/time for presentation to the user
+     */
+    public String shortPreciseLocalizedTimestamp(Instant instant, TimeZone timezone, Locale locale);
+
     /**
      * Formats a point in time, in the user's time zone, for display to the user in a concise way that still presents all relevant information
-     * including date, time, and time zone.
+     * including date, time (to the minute), and time zone.
      *
      * @param instant the instant in time
      * @param locale the locale to use when formatting the date for display
      * @return a formatted date/time for presentation to the user
      */
+
     public String shortLocalizedTimestamp(Instant instant, Locale locale);
+    /**
+     * Formats a point in time, in the user's time zone, for display to the user in a concise way that still presents all relevant information
+     * including date, time (to the second), and time zone.
+     *
+     * @param instant the instant in time
+     * @param locale the locale to use when formatting the date for display
+     * @return a formatted date/time for presentation to the user
+     */
+    public String shortPreciseLocalizedTimestamp(Instant instant, Locale locale);
 
     /**
      * Formats a date (month/day/year) in a concise but easily understood format for the given locale.

kernel/kernel-impl/src/main/java/org/sakaiproject/content/impl/serialize/impl/conversion/ConversionTimeService.java

@@ -213,4 +213,14 @@ public String shortLocalizedTimestamp(Instant instant, Locale locale) {
 	public String shortLocalizedDate(LocalDate date, Locale locale) {
 		throw new UnsupportedOperationException("This class is only to be used for conversion purposes");
 	}
+
+	@Override
+	public String shortPreciseLocalizedTimestamp(Instant instant, TimeZone timezone, Locale locale) {
+		throw new UnsupportedOperationException("This class is only to be used for conversion purposes");
+	}
+
+	@Override
+	public String shortPreciseLocalizedTimestamp(Instant instant, Locale locale) {
+		throw new UnsupportedOperationException("This class is only to be used for conversion purposes");
+	}
 }

kernel/kernel-impl/src/main/java/org/sakaiproject/time/impl/BasicTimeService.java

@@ -1037,4 +1037,14 @@ public String shortLocalizedTimestamp(Instant instant, Locale locale) {
 	public String shortLocalizedDate(LocalDate date, Locale locale) {
 		return userTimeService.shortLocalizedDate(date, locale);
 	}
+
+	@Override
+	public String shortPreciseLocalizedTimestamp(Instant instant, TimeZone timezone, Locale locale) {
+		return userTimeService.shortPreciseLocalizedTimestamp(instant, timezone, locale);
+	}
+
+	@Override
+	public String shortPreciseLocalizedTimestamp(Instant instant, Locale locale) {
+		return userTimeService.shortPreciseLocalizedTimestamp(instant, getLocalTimeZone(), locale);
+	}
 }

kernel/kernel-impl/src/main/java/org/sakaiproject/time/impl/UserTimeServiceImpl.java

@@ -126,21 +126,33 @@ public String  dateTimeFormatLong(Date date, Locale locale) {
     @Override
     public String shortLocalizedTimestamp(Instant instant, TimeZone timezone, Locale locale) {
         ZonedDateTime userDate = ZonedDateTime.ofInstant(instant, timezone.toZoneId());
-        DateTimeFormatter userFormatter = new DateTimeFormatterBuilder()
-                .appendLocalized(FormatStyle.MEDIUM, FormatStyle.SHORT)
-                .appendLiteral(" ").appendZoneText(TextStyle.SHORT)
-                .toFormatter(locale);
-        return userDate.format(userFormatter);
+        return userDate.format(buildTimestampFormatter(FormatStyle.MEDIUM, FormatStyle.SHORT, TextStyle.SHORT, locale));
     }
 
     @Override
     public String shortLocalizedTimestamp(Instant instant, Locale locale) {
         return shortLocalizedTimestamp(instant, getLocalTimeZone(), locale);
     }
 
+    @Override
+    public String shortPreciseLocalizedTimestamp(Instant instant, TimeZone timezone, Locale locale) {
+        ZonedDateTime userDate = ZonedDateTime.ofInstant(instant, timezone.toZoneId());
+        return userDate.format(buildTimestampFormatter(FormatStyle.MEDIUM, FormatStyle.MEDIUM, TextStyle.SHORT, locale));
+    }
+
+    @Override
+    public String shortPreciseLocalizedTimestamp(Instant instant, Locale locale) {
+        return shortPreciseLocalizedTimestamp(instant, getLocalTimeZone(), locale);
+    }
+
     @Override
     public String shortLocalizedDate(LocalDate date, Locale locale) {
         DateTimeFormatter df = DateTimeFormatter.ofLocalizedDate(FormatStyle.MEDIUM).withLocale(locale);
         return date.format(df);
     }
+
+    private DateTimeFormatter buildTimestampFormatter(FormatStyle dateStyle, FormatStyle timeStyle, TextStyle zoneStyle, Locale locale) {
+        return new DateTimeFormatterBuilder().appendLocalized(dateStyle, timeStyle)
+                .appendLiteral(" ").appendZoneText(zoneStyle).toFormatter(locale);
+    }
 }

kernel/kernel-impl/src/test/java/org/sakaiproject/content/impl/serialize/impl/test/MockTimeService.java

@@ -232,4 +232,14 @@ public String shortLocalizedTimestamp(Instant instant, Locale locale) {
 	public String shortLocalizedDate(LocalDate date, Locale locale) {
 		return null;
 	}
+
+	@Override
+	public String shortPreciseLocalizedTimestamp(Instant instant, TimeZone timezone, Locale locale) {
+		return null;
+	}
+
+	@Override
+	public String shortPreciseLocalizedTimestamp(Instant instant, Locale locale) {
+		return null;
+	}
 }

sitestats/USER_ACTIVITY_README.md

@@ -83,7 +83,7 @@ Users should not be able to see information that they could not see in the tool'
 permissions and be aware of any special visibility restrictions in the tool. To that end:
 
 * In cases where the tool's service layer does not include permission checks, additional permission checks are performed
-by User Activity. User Activity errs on the side of caution here and requires maintainer-levels permissions since it will
+by User Activity. User Activity errs on the side of caution here and requires maintainer-level permissions since it will
 grant access to details for any event from the tool. This is not the ideal scenario but is required for some tools.
 * User Activity is aware that several tools have a concept of anonymity, and tries to not reveal details that would
 compromise anonymity. For example, the details for an assignment submission event will not identify the assignment if
@@ -107,7 +107,7 @@ At a high level
 
 * New Sakai events are recorded automatically by the Collection layer
 * Users invoke the Query layer to perform searches against these events by submitting the form on the User Activity page
-* Users may click the "show more" link for an individual event in the query results, invoking the Resolver layer
+* Users may click the "show more" button for an individual event in the query results, invoking the Resolver layer
 which uses Sakai services to get additional details about that particular event
 * The Presentation layer converts the specific details about the event into a form suitable for presentation
 back to the user, which is then displayed inline in the query results table.
@@ -172,7 +172,7 @@ ResolvedEventData objects representing error states can be returned instead of t
 
 ### Presentation layer
 
-When presenting the details or a particular event to the user, the ResolvedEventData must be first be transformed into
+When presenting the details of a particular event to the user, the ResolvedEventData must be first be transformed into
 a presentable format.
 
 Transformation, which includes localization, is done by a Transformer, of which there is one for each tool. For example,
@@ -183,18 +183,18 @@ EventDetail objects are simply localized key/value pairs. The value can be eithe
 a submission to a normal assignment called "Assignment 1" would be transformed into a single key/value pair of
 "Title"/"Assignment 1" (if user language was English). However, Transformers do more than simply localize each property
 of the ResolvedEventData. They contain logic that determines how to present the data. To continue the "Assignment 1"
-example, if the assignment has been deleted since the submission occurred, the Transformer would read both the "title"
+example, if the assignment has been deleted since the submission occurred, the Transformer would read both the "title" and
 "deleted" properties of the AssignmentEventData and present the value as "Assignment 1 \[deleted\]" (if the user language
 was English of course).
 
 The current implementation uses a one-size-fits-all Wicket panel to present the list of EventDetail objects
 in the same way no matter which event they are for.
 
-### Responsive Design
+#### Responsive Design
 
 User Activity has a content-specific CSS breakpoint set at 640px that makes the following changes to the presentation:
 
 - the search form switches to a column orientation
-- the table switches to a "CardTable" layout the presents each table row as a separate "card", allowing the user
+- the table switches to a "CardTable" layout that presents each table row as a separate "card", allowing the user
 to see all the data in the row at once even on a narrow device
 

sitestats/sitestats-tool/src/java/org/sakaiproject/sitestats/tool/wicket/components/useractivity/UserTrackingResultsPanel.java

@@ -15,8 +15,10 @@
  */
 package org.sakaiproject.sitestats.tool.wicket.components.useractivity;
 
+import java.time.Instant;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Locale;
 
 import org.apache.wicket.extensions.markup.html.repeater.data.grid.ICellPopulator;
 import org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn;
@@ -90,8 +92,8 @@ protected IModel createLabelModel(IModel rowModel)
 			{
 				// Get the event date
 				DetailedEvent event = (DetailedEvent) rowModel.getObject();
-				String dateStr = Locator.getFacade().getUserTimeService().shortLocalizedTimestamp(event.getEventDate().toInstant(), getSession().getLocale());
-				return new Model<>(dateStr);
+				Instant time = event.getEventDate().toInstant();
+				return Model.of(Locator.getFacade().getUserTimeService().shortPreciseLocalizedTimestamp(time, getSession().getLocale()));
 			}
 		});