Add support for automatic ICORE conference ranking lookup [#13476]

jablib/src/main/java/org/jabref/logic/database/DuplicateCheck.java

@@ -289,9 +289,10 @@ public static double correlateByWords(final String s1, final String s2) {
         final String[] w1 = s1.split("\\s");
         final String[] w2 = s2.split("\\s");
         final int n = Math.min(w1.length, w2.length);
+        final StringSimilarity match = new StringSimilarity();
         int misses = 0;
         for (int i = 0; i < n; i++) {
-            double corr = similarity(w1[i], w2[i]);
+            double corr = match.similarity(w1[i], w2[i]);
             if (corr < 0.75) {
                 misses++;
             }
@@ -300,33 +301,6 @@ public static double correlateByWords(final String s1, final String s2) {
         return 1 - missRate;
     }
 
-    /**
-     * Calculates the similarity (a number within 0 and 1) between two strings.
-     * http://stackoverflow.com/questions/955110/similarity-string-comparison-in-java
-     */
-    private static double similarity(final String first, final String second) {
-        final String longer;
-        final String shorter;
-
-        if (first.length() < second.length()) {
-            longer = second;
-            shorter = first;
-        } else {
-            longer = first;
-            shorter = second;
-        }
-
-        final int longerLength = longer.length();
-        // both strings are zero length
-        if (longerLength == 0) {
-            return 1.0;
-        }
-        final double distanceIgnoredCase = new StringSimilarity().editDistanceIgnoreCase(longer, shorter);
-        final double similarity = (longerLength - distanceIgnoredCase) / longerLength;
-        LOGGER.trace("Longer string: {} Shorter string: {} Similarity: {}", longer, shorter, similarity);
-        return similarity;
-    }
-
     /**
      * Checks if the two entries represent the same publication.
      */

jablib/src/main/java/org/jabref/logic/util/strings/StringSimilarity.java

@@ -3,8 +3,12 @@
 import java.util.Locale;
 
 import info.debatty.java.stringsimilarity.Levenshtein;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 public class StringSimilarity {
+    private static final Logger LOGGER = LoggerFactory.getLogger(StringSimilarity.class);
+
     private final Levenshtein METRIC_DISTANCE = new Levenshtein();
     // edit distance threshold for entry title comparison
     private final int METRIC_THRESHOLD = 4;
@@ -24,4 +28,31 @@ public double editDistanceIgnoreCase(String a, String b) {
         // TODO: Locale is dependent on the language of the strings. English is a good denominator.
         return METRIC_DISTANCE.distance(a.toLowerCase(Locale.ENGLISH), b.toLowerCase(Locale.ENGLISH));
     }
+
+    /**
+     * Calculates the similarity (a number within 0 and 1) between two strings.
+     * http://stackoverflow.com/questions/955110/similarity-string-comparison-in-java
+     */
+    public double similarity(final String first, final String second) {
+        final String longer;
+        final String shorter;
+
+        if (first.length() < second.length()) {
+            longer = second;
+            shorter = first;
+        } else {
+            longer = first;
+            shorter = second;
+        }
+
+        final int longerLength = longer.length();
+        // both strings are zero length
+        if (longerLength == 0) {
+            return 1.0;
+        }
+        final double distanceIgnoredCase = editDistanceIgnoreCase(longer, shorter);
+        final double similarity = (longerLength - distanceIgnoredCase) / longerLength;
+        LOGGER.trace("Longer string: {} Shorter string: {} Similarity: {}", longer, shorter, similarity);
+        return similarity;
+    }
 }

jablib/src/test/java/org/jabref/logic/util/strings/StringSimilarityTest.java

@@ -1,11 +1,14 @@
 package org.jabref.logic.util.strings;
 
+import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.CsvSource;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 class StringSimilarityTest {
+    private final double EPSILON_SIMILARITY = 0.00001;
 
     private StringSimilarity similarityChecker = new StringSimilarity();
 
@@ -27,4 +30,64 @@ class StringSimilarityTest {
     void stringSimilarity(String a, String b, String expectedResult) {
         assertEquals(Boolean.valueOf(expectedResult), similarityChecker.isSimilar(a, b));
     }
+
+    @Test
+    void similarityReturnsOneForExactStrings() {
+        String a = "abcdef";
+        String b = "abcdef";
+        double expectedResult = 1.0;
+        double similarity = similarityChecker.similarity(a, b);
+
+        assertEquals(expectedResult, similarity, EPSILON_SIMILARITY);
+    }
+
+    @Test
+    void similarityReturnsZeroForNonMatchingStrings() {
+        String a = "abcdef";
+        String b = "uvwxyz";
+        double expectedResult = 0.0;
+        double similarity = similarityChecker.similarity(a, b);
+
+        assertEquals(expectedResult, similarity, EPSILON_SIMILARITY);
+    }
+
+    @Test
+    void similarityReturnsValueBetweenZeroAndOneForSimilarStrings() {
+        String a = "abc";
+        String b = "abcdefgh";
+        double exactMatch = 1.0;
+        double similarity = similarityChecker.similarity(a, b);
+
+        assertTrue(similarity >= EPSILON_SIMILARITY && similarity < exactMatch);
+    }
+
+    @Test
+    void similarityReturnsOneForEmptyStrings() {
+        String a = "";
+        String b = "";
+        double expectedResult = 1.0;
+        double similarity = similarityChecker.similarity(a, b);
+
+        assertEquals(expectedResult, similarity, EPSILON_SIMILARITY);
+    }
+
+    @Test
+    void similarityReturnsZeroWhenOneStringIsEmpty() {
+        String a = "abcdef";
+        String b = "";
+        double expectedResult = 0.0;
+        double similarity = similarityChecker.similarity(a, b);
+
+        assertEquals(expectedResult, similarity, EPSILON_SIMILARITY);
+    }
+
+    @Test
+    void similarityIsCaseInsensitive() {
+        String a = "abcdef";
+        String b = "ABCDEF";
+        double expectedResult = 1.0;
+        double similarity = similarityChecker.similarity(a, b);
+
+        assertEquals(expectedResult, similarity, EPSILON_SIMILARITY);
+    }
 }