Candidates customized order lost when tabbing through candidates, fixes #763

Author: mattirn

reader/src/main/java/org/jline/reader/impl/LineReaderImpl.java

@@ -5076,18 +5076,19 @@ protected PostResult computePost(List<Candidate> possible, Candidate selection,
 
     protected PostResult computePost(List<Candidate> possible, Candidate selection, List<Candidate> ordered, String completed, Function<String, Integer> wcwidth, int width, boolean autoGroup, boolean groupName, boolean rowsFirst) {
         List<Object> strings = new ArrayList<>();
+        boolean customOrder = possible.stream().anyMatch(c -> c.sort() != 0);
         if (groupName) {
             Comparator<String> groupComparator = getGroupComparator();
-            Map<String, Map<String, Candidate>> sorted;
+            Map<String, Map<Object, Candidate>> sorted;
             sorted = groupComparator != null
                         ? new TreeMap<>(groupComparator)
                         : new LinkedHashMap<>();
             for (Candidate cand : possible) {
                 String group = cand.group();
                 sorted.computeIfAbsent(group != null ? group : "", s -> new LinkedHashMap<>())
-                        .put(cand.value(), cand);
+                        .put((customOrder ? cand.sort() : cand.value()), cand);
             }
-            for (Map.Entry<String, Map<String, Candidate>> entry : sorted.entrySet()) {
+            for (Map.Entry<String, Map<Object, Candidate>> entry : sorted.entrySet()) {
                 String group = entry.getKey();
                 if (group.isEmpty() && sorted.size() > 1) {
                     group = getOthersGroupName();
@@ -5102,13 +5103,13 @@ protected PostResult computePost(List<Candidate> possible, Candidate selection,
             }
         } else {
             Set<String> groups = new LinkedHashSet<>();
-            TreeMap<String, Candidate> sorted = new TreeMap<>();
+            TreeMap<Object, Candidate> sorted = new TreeMap<>();
             for (Candidate cand : possible) {
                 String group = cand.group();
                 if (group != null) {
                     groups.add(group);
                 }
-                sorted.put(cand.value(), cand);
+                sorted.put((customOrder ? cand.sort() : cand.value()), cand);
             }
             if (autoGroup) {
                 strings.addAll(groups);

…java/org/jline/reader/CandidateTest.java …reader/impl/CandidateCustomSortTest.javareader/src/test/java/org/jline/reader/CandidateTest.java renamed to reader/src/test/java/org/jline/reader/impl/CandidateCustomSortTest.java reader/src/test/java/org/jline/reader/CandidateTest.java renamed to reader/src/test/java/org/jline/reader/impl/CandidateCustomSortTest.java

@@ -6,8 +6,9 @@
  *
  * https://opensource.org/licenses/BSD-3-Clause
  */
-package org.jline.reader;
+package org.jline.reader.impl;
 
+import org.jline.reader.Candidate;
 import org.junit.Test;
 
 import java.util.Arrays;
@@ -16,7 +17,7 @@
 
 import static org.junit.Assert.assertEquals;
 
-public class CandidateTest {
+public class CandidateCustomSortTest extends ReaderTestSupport {
 
     @Test
     public void testCandidatesSortedByValue() {
@@ -73,4 +74,17 @@ public void testCandidatesSortedByCornerSortProps() {
         assertEquals("cand1", candidates.get(1).value());
         assertEquals("cand2", candidates.get(2).value());
     }
+
+    @Test
+    public void testCompletionSort() throws Exception {
+        reader.setCompleter(
+                (reader, line, candidates) -> {
+                    candidates.add(new Candidate("foo", "foo", null, null, null, null, true, 0));
+                    candidates.add(new Candidate("bar", "bar", null, null, null, null, true, 1));
+                    candidates.add(new Candidate("zoo", "zoo", null, null, null, null, true, 2));
+                });
+        assertBuffer("foo", new TestBuffer("").tab().tab());
+
+    }
+
 }