SAK-44495 use the kernel UserSortNameComparator (sakaiproject#8702)

Author: ottenhoff

gradebookng/tool/src/java/org/sakaiproject/gradebookng/business/GradebookNgBusinessService.java

@@ -119,6 +119,7 @@
 import org.sakaiproject.user.api.UserNotDefinedException;
 import org.sakaiproject.util.ResourceLoader;
 import org.sakaiproject.util.api.FormattedText;
+import org.sakaiproject.util.comparator.UserSortNameComparator;
 
 /**
  * Business service for GradebookNG
@@ -324,7 +325,7 @@ public List<String> getGradeableUsers(final String siteId, final GbGroup groupFi
 	public List<User> getUsers(final List<String> userUuids) throws GbException {
 		try {
 			final List<User> users = this.userDirectoryService.getUsers(userUuids);
-			Collections.sort(users, new LastNameComparator()); // default sort // TODO: remove this sort, it causes double sorting in various scenarios
+			Collections.sort(users, new UserSortNameComparator()); // TODO: remove this sort, it causes double sorting in various scenarios
 			return users;
 		} catch (final RuntimeException e) {
 			// an LDAP exception can sometimes be thrown here, catch and rethrow
@@ -1161,7 +1162,7 @@ public List<GbUser> getGbUsersForUiSettings(List<String> userUuids, GradebookUiS
 		List<User> users = getUsers(userUuids);
 		List<GbUser> gbUsers = new ArrayList<>(users.size());
 		if (settings.getStudentSortOrder() != null) {
-			Comparator<User> comp = GbStudentNameSortOrder.FIRST_NAME == settings.getNameSortOrder() ? new FirstNameComparator() : new LastNameComparator();
+			Comparator<User> comp = GbStudentNameSortOrder.FIRST_NAME == settings.getNameSortOrder() ? new FirstNameComparator() : new UserSortNameComparator();
 			if (SortDirection.DESCENDING == settings.getStudentSortOrder()) {
 				comp = Collections.reverseOrder(comp);
 			}

gradebookng/tool/src/java/org/sakaiproject/gradebookng/business/LastNameComparator.java

@@ -68,4 +68,38 @@ public void underscoreCompare() {
         assertEquals(-1, comparator.compare(userB, userA));
         assertEquals(0, comparator.compare(userB, userB));
     }
-}
+
+    @Test
+    public void namesWithSpacesCompare() {
+        UserSortNameComparator comparator = new UserSortNameComparator();
+        User userA = Mockito.mock(User.class);
+        when(userA.getSortName()).thenReturn("Dekfort, Apple");
+        User userB = Mockito.mock(User.class);
+        when(userB.getSortName()).thenReturn("Del Fintino, Pear");
+        User userC = Mockito.mock(User.class);
+        when(userC.getSortName()).thenReturn("Dekford", "Orange");
+        User userD = Mockito.mock(User.class);
+        when(userD.getSortName()).thenReturn("De'Leon", "Cactus");
+        User userE = Mockito.mock(User.class);
+        when(userE.getSortName()).thenReturn("Deleverde", "Mango");
+
+        assertEquals(-1, comparator.compare(userA, userB));
+        assertEquals(1, comparator.compare(userB, userA));
+        assertEquals(0, comparator.compare(userB, userB));
+        assertEquals(-1, comparator.compare(userD, userC));
+        assertEquals(-1, comparator.compare(userD, userE));
+    }
+
+    @Test
+    public void fullnamesWithSpacesCompare() {
+        // Given two students, whose lastnames are "Martinez Torcal" and "Martin Troncoso", the logical alphabetical order 
+        // is first "Martin Troncoso" and after "Martinez Torcal", just because the blank space is counted as a character.
+        UserSortNameComparator comparator = new UserSortNameComparator();
+        User userA = Mockito.mock(User.class);
+        when(userA.getSortName()).thenReturn("Martinez Torcal, Apple");
+        User userB = Mockito.mock(User.class);
+        when(userB.getSortName()).thenReturn("Martin Troncoso, X");
+
+        assertEquals(1, comparator.compare(userA, userB));
+    }
+}