refactor(transliteration): address review comments

Author: InAnYan

jablib/src/main/java/org/jabref/logic/bibtex/BibtexStandard.java

@@ -1,23 +1,22 @@
 package org.jabref.logic.citationkeypattern;
 
-import java.util.List;
-import java.util.Objects;
-import java.util.Optional;
-import java.util.function.Function;
-import java.util.regex.PatternSyntaxException;
-
-import org.jabref.logic.bibtex.BibtexStandard;
 import org.jabref.logic.util.strings.Transliteration;
 import org.jabref.model.FieldChange;
 import org.jabref.model.database.BibDatabase;
 import org.jabref.model.database.BibDatabaseContext;
 import org.jabref.model.entry.BibEntry;
 import org.jabref.model.entry.types.EntryType;
 import org.jabref.model.strings.StringUtil;
-
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.util.Arrays;
+import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.function.Function;
+import java.util.regex.PatternSyntaxException;
+
 /**
  * This is the utility class of the LabelPattern package.
  */
@@ -35,6 +34,10 @@ public class CitationKeyGenerator extends BracketedPattern {
     /// See also #DISALLOWED_CHARACTERS
     public static final String DEFAULT_UNWANTED_CHARACTERS = "?!;^`ʹ";
 
+    /// Source of disallowed characters: <https://tex.stackexchange.com/a/408548/9075>
+    /// These characters are disallowed in BibTeX keys.
+    public static final List<Character> DISALLOWED_CHARACTERS = Arrays.asList('{', '}', '(', ')', ',', '=', '\\', '"', '#', '%', '~', '\'');
+
     private static final Logger LOGGER = LoggerFactory.getLogger(CitationKeyGenerator.class);
 
     private final AbstractCitationKeyPatterns citeKeyPattern;
@@ -77,7 +80,7 @@ public static String removeDefaultUnwantedCharacters(String key) {
     public static String removeUnwantedCharacters(String key, String unwantedCharacters) {
         String newKey = key.chars()
                            .filter(c -> unwantedCharacters.indexOf(c) == -1)
-                           .filter(c -> !BibtexStandard.DISALLOWED_CHARACTERS.contains((char) c))
+                           .filter(c -> !DISALLOWED_CHARACTERS.contains((char) c))
                            .collect(StringBuilder::new,
                                    StringBuilder::appendCodePoint, StringBuilder::append)
                            .toString();

jablib/src/main/java/org/jabref/logic/citationkeypattern/CitationKeyGenerator.java

@@ -10,8 +10,6 @@
 
 import com.google.common.annotations.VisibleForTesting;
 
-import static org.jabref.logic.citationkeypattern.CitationKeyGenerator.DEFAULT_UNWANTED_CHARACTERS;
-
 public class CitationKeyPatternPreferences {
 
     public enum KeySuffix {
@@ -84,23 +82,6 @@ public CitationKeyPatternPreferences(boolean shouldTransliterateFields,
                 new SimpleObjectProperty<>(keywordDelimiter));
     }
 
-    @VisibleForTesting
-    public static CitationKeyPatternPreferences getInstanceForTesting() {
-        return new CitationKeyPatternPreferences(
-                true,
-                false,
-                false,
-                false,
-                CitationKeyPatternPreferences.KeySuffix.SECOND_WITH_A,
-                "",
-                "",
-                DEFAULT_UNWANTED_CHARACTERS,
-                GlobalCitationKeyPatterns.fromPattern("[auth][year]"),
-                "",
-                ','
-        );
-    }
-
     public boolean shouldTransliterateFields() {
         return shouldTransliterateFields.get();
     }

jablib/src/main/java/org/jabref/logic/citationkeypattern/CitationKeyPatternPreferences.java

@@ -650,7 +650,7 @@ public JabRefCliPreferences() {
 
         defaults.put(USE_OWNER, Boolean.FALSE);
         defaults.put(OVERWRITE_OWNER, Boolean.FALSE);
-        defaults.put(TRANSLITERATE_FIELDS, Boolean.TRUE);
+        defaults.put(TRANSLITERATE_FIELDS, Boolean.FALSE);
         defaults.put(AVOID_OVERWRITING_KEY, Boolean.FALSE);
         defaults.put(WARN_BEFORE_OVERWRITING_KEY, Boolean.TRUE);
         defaults.put(CONFIRM_LINKED_FILE_DELETE, Boolean.TRUE);

jablib/src/main/java/org/jabref/logic/preferences/JabRefCliPreferences.java

@@ -1,8 +1,7 @@
 package org.jabref.logic.util.strings;
 
-import org.jabref.logic.bibtex.BibtexStandard;
-
 import com.ibm.icu.text.Transliterator;
+import org.jabref.logic.citationkeypattern.CitationKeyGenerator;
 
 public class Transliteration {
 
@@ -18,7 +17,7 @@ public static String transliterate(String input) {
     private static String buildTransliteratorConfig() {
         StringBuilder pattern = new StringBuilder();
 
-        for (Character c : BibtexStandard.DISALLOWED_CHARACTERS) {
+        for (Character c : CitationKeyGenerator.DISALLOWED_CHARACTERS) {
             // Generally, only characters like `-` or `[` need to be escaped with a backslash,
             // but for future proofing we escape all characters.
             pattern.append("\\").append(c);

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

@@ -1,15 +1,11 @@
 package org.jabref.logic.citationkeypattern;
 
-import java.util.Optional;
-import java.util.stream.Stream;
-
 import org.jabref.logic.importer.ImportFormatPreferences;
 import org.jabref.logic.importer.ParseException;
 import org.jabref.logic.importer.fileformat.BibtexParser;
 import org.jabref.model.database.BibDatabase;
 import org.jabref.model.entry.BibEntry;
 import org.jabref.model.entry.field.StandardField;
-
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
@@ -18,6 +14,9 @@
 import org.junit.jupiter.params.provider.MethodSource;
 import org.mockito.Answers;
 
+import java.util.Optional;
+import java.util.stream.Stream;
+
 import static org.jabref.logic.citationkeypattern.CitationKeyGenerator.DEFAULT_UNWANTED_CHARACTERS;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertThrows;

jablib/src/test/java/org/jabref/logic/citationkeypattern/CitationKeyGeneratorTest.java

@@ -10,6 +10,7 @@
 import javafx.collections.FXCollections;
 
 import org.jabref.logic.JabRefException;
+import org.jabref.logic.citationkeypattern.CitationKeyGeneratorTestUtils;
 import org.jabref.logic.citationkeypattern.CitationKeyPatternPreferences;
 import org.jabref.logic.exporter.SaveConfiguration;
 import org.jabref.logic.exporter.SaveException;
@@ -60,7 +61,7 @@ class CrawlerTest {
     void setUp() throws GitAPIException, URISyntaxException {
         setUpRepository();
 
-        CitationKeyPatternPreferences citationKeyPatternPreferences = CitationKeyPatternPreferences.getInstanceForTesting();
+        CitationKeyPatternPreferences citationKeyPatternPreferences = CitationKeyGeneratorTestUtils.getInstanceForTesting();
 
         importFormatPreferences = mock(ImportFormatPreferences.class, Answers.RETURNS_DEEP_STUBS);
         importerPreferences = mock(ImporterPreferences.class);

jablib/src/test/java/org/jabref/logic/crawler/CrawlerTest.java

@@ -14,6 +14,7 @@
 import org.jabref.logic.JabRefException;
 import org.jabref.logic.LibraryPreferences;
 import org.jabref.logic.citationkeypattern.CitationKeyGenerator;
+import org.jabref.logic.citationkeypattern.CitationKeyGeneratorTestUtils;
 import org.jabref.logic.citationkeypattern.CitationKeyPatternPreferences;
 import org.jabref.logic.database.DatabaseMerger;
 import org.jabref.logic.exporter.SaveConfiguration;
@@ -70,7 +71,7 @@ void setUpMocks() throws IOException, URISyntaxException, JabRefException {
         saveConfiguration = mock(SaveConfiguration.class, Answers.RETURNS_DEEP_STUBS);
         importFormatPreferences = mock(ImportFormatPreferences.class, Answers.RETURNS_DEEP_STUBS);
         preferences = mock(CliPreferences.class, Answers.RETURNS_DEEP_STUBS);
-        citationKeyPatternPreferences = CitationKeyPatternPreferences.getInstanceForTesting();
+        citationKeyPatternPreferences = CitationKeyGeneratorTestUtils.getInstanceForTesting();
         when(preferences.getCitationKeyPatternPreferences()).thenReturn(citationKeyPatternPreferences);
         when(preferences.getImporterPreferences().getApiKeys()).thenReturn(FXCollections.emptyObservableSet());
         when(importFormatPreferences.bibEntryPreferences().getKeywordSeparator()).thenReturn(',');

jablib/src/test/java/org/jabref/logic/crawler/StudyRepositoryTest.java

@@ -9,7 +9,7 @@
 import java.util.stream.Stream;
 
 import org.jabref.logic.FilePreferences;
-import org.jabref.logic.citationkeypattern.CitationKeyPatternPreferences;
+import org.jabref.logic.citationkeypattern.CitationKeyGeneratorTestUtils;
 import org.jabref.logic.journals.JournalAbbreviationLoader;
 import org.jabref.model.database.BibDatabase;
 import org.jabref.model.database.BibDatabaseContext;
@@ -136,7 +136,7 @@ void entryIsUnchangedAfterChecks() {
 
         new IntegrityCheck(context,
                 mock(FilePreferences.class),
-                CitationKeyPatternPreferences.getInstanceForTesting(),
+                CitationKeyGeneratorTestUtils.getInstanceForTesting(),
                 JournalAbbreviationLoader.loadBuiltInRepository(),
                 false)
                 .check();
@@ -171,7 +171,7 @@ private void assertWrong(BibDatabaseContext context) {
 
         messages = new IntegrityCheck(context,
                 mock(FilePreferences.class),
-                CitationKeyPatternPreferences.getInstanceForTesting(),
+                CitationKeyGeneratorTestUtils.getInstanceForTesting(),
                 JournalAbbreviationLoader.loadBuiltInRepository(),
                 false)
                 .check();
@@ -186,7 +186,7 @@ private void assertCorrect(BibDatabaseContext context) {
 
         messages = new IntegrityCheck(context,
                 filePreferencesMock,
-                CitationKeyPatternPreferences.getInstanceForTesting(),
+                CitationKeyGeneratorTestUtils.getInstanceForTesting(),
                 JournalAbbreviationLoader.loadBuiltInRepository(),
                 false)
                 .check();