Change location of some fields in the entry editor (#4448)

* Change location of some fields in the entry editor - Journal/Year/Month in biblatex mode -> Deprecated (if filled) - DOI/URL: General -> Optional - Internal fields like ranking, read status and priority: Other -> General - Moreover, empty deprecated fields are no longer shown * Fix tests * Change Review to Comment field
JabRef · Nov 16, 2018 · 2953849 · 2953849
1 parent 436f71c
commit 2953849
Show file tree

Hide file tree

Showing 8 changed files with 117 additions and 116 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,11 @@ We refer to [GitHub issues](https://github.com/JabRef/jabref/issues) by using `#
 ## [Unreleased]
 
 ### Changed
+- We changed the location of some fields in the entry editor (you might need to reset your preferences for these changes to come into effect)
+  - Journal/Year/Month in biblatex mode -> Deprecated (if filled)
+  - DOI/URL: General -> Optional
+  - Internal fields like ranking, read status and priority: Other -> General
+  - Moreover, empty deprecated fields are no longer shown
 - Added server timezone parameter when connecting to a shared database.
 - We updated the dialog for setting up general fields.
 - URL field formatting is updated. All whitespace chars, located at the beginning/ending of the url, are trimmed automatically

diff --git a/src/main/java/org/jabref/gui/entryeditor/DeprecatedFieldsTab.java b/src/main/java/org/jabref/gui/entryeditor/DeprecatedFieldsTab.java
@@ -1,6 +1,7 @@
 package org.jabref.gui.entryeditor;
 
 import java.util.Collection;
+import java.util.stream.Collectors;
 
 import javax.swing.undo.UndoManager;
 
@@ -25,6 +26,9 @@ public DeprecatedFieldsTab(BibDatabaseContext databaseContext, SuggestionProvide
 
     @Override
     protected Collection<String> determineFieldsToShow(BibEntry entry, EntryType entryType) {
-        return entryType.getDeprecatedFields();
+        return entryType.getDeprecatedFields()
+                        .stream()
+                        .filter(entry::hasField)
+                        .collect(Collectors.toList());
     }
 }
diff --git a/src/main/java/org/jabref/logic/integrity/NoBibtexFieldChecker.java b/src/main/java/org/jabref/logic/integrity/NoBibtexFieldChecker.java
@@ -10,7 +10,6 @@
 import org.jabref.model.entry.BiblatexEntryTypes;
 import org.jabref.model.entry.BibtexEntryTypes;
 import org.jabref.model.entry.FieldName;
-import org.jabref.model.entry.InternalBibtexFields;
 
 /**
  * This checker checks whether the entry does not contain any field appearing only in biblatex (and not in BibTeX)
@@ -20,23 +19,23 @@ public class NoBibtexFieldChecker implements Checker {
     private List<String> getAllBiblatexOnlyFields() {
         Set<String> allBibtexFields = BibtexEntryTypes.ALL.stream().flatMap(type -> type.getAllFields().stream()).collect(Collectors.toSet());
         return BiblatexEntryTypes.ALL.stream()
-                .flatMap(type -> type.getAllFields().stream())
-                .filter(fieldName -> !allBibtexFields.contains(fieldName))
-                // these fields are displayed by JabRef as default
-                .filter(fieldName -> !InternalBibtexFields.DEFAULT_GENERAL_FIELDS.contains(fieldName))
-                .filter(fieldName -> !fieldName.equals(FieldName.ABSTRACT))
-                .filter(fieldName -> !fieldName.equals(FieldName.REVIEW))
-                .sorted()
-                .collect(Collectors.toList());
+                                     .flatMap(type -> type.getAllFields().stream())
+                                     .filter(fieldName -> !allBibtexFields.contains(fieldName))
+                                     // these fields are displayed by JabRef as default
+                                     .filter(fieldName -> !fieldName.equals(FieldName.ABSTRACT))
+                                     .filter(fieldName -> !fieldName.equals(FieldName.COMMENT))
+                                     .filter(fieldName -> !fieldName.equals(FieldName.DOI))
+                                     .filter(fieldName -> !fieldName.equals(FieldName.URL))
+                                     .sorted()
+                                     .collect(Collectors.toList());
     }
 
     @Override
     public List<IntegrityMessage> check(BibEntry entry) {
         // non-static initalization of ALL_BIBLATEX_ONLY_FIELDS as the user can customize the entry types during runtime
         final List<String> allBiblatexOnlyFields = getAllBiblatexOnlyFields();
         return entry.getFieldNames().stream()
-                .filter(name ->  allBiblatexOnlyFields.contains(name))
-                .map(name -> new IntegrityMessage(Localization.lang("biblatex field only"), entry, name)).collect(Collectors.toList());
+                    .filter(allBiblatexOnlyFields::contains)
+                    .map(name -> new IntegrityMessage(Localization.lang("biblatex field only"), entry, name)).collect(Collectors.toList());
     }
-
 }
diff --git a/src/main/java/org/jabref/model/entry/BiblatexEntryTypes.java b/src/main/java/org/jabref/model/entry/BiblatexEntryTypes.java
diff --git a/src/main/java/org/jabref/model/entry/InternalBibtexFields.java b/src/main/java/org/jabref/model/entry/InternalBibtexFields.java
@@ -28,14 +28,8 @@
  * - add a additional properties functionality into the BibtexSingleField class
  */
 public class InternalBibtexFields {
-    /**
-     * These are the fields JabRef always displays as default
-     * {@link org.jabref.preferences.JabRefPreferences#setLanguageDependentDefaultValues()}
-     *
-     * A user can change them. The change is currently stored in the preferences only and not explicitly exposed as separate preferences object
-     */
-    public static final List<String> DEFAULT_GENERAL_FIELDS = Arrays.asList(
-            FieldName.CROSSREF, FieldName.KEYWORDS, FieldName.FILE, FieldName.DOI, FieldName.URL, FieldName.GROUPS, FieldName.OWNER, FieldName.TIMESTAMP
+    private static final List<String> DEFAULT_GENERAL_FIELDS = Arrays.asList(
+            FieldName.CROSSREF, FieldName.KEYWORDS, FieldName.FILE, FieldName.GROUPS, FieldName.OWNER, FieldName.TIMESTAMP
     );
 
     // Lists of fields with special properties
@@ -88,8 +82,10 @@ public class InternalBibtexFields {
 
     private static final List<String> SPECIAL_FIELDS = Arrays.asList(
             SpecialField.PRINTED.getFieldName(),
-            SpecialField.PRIORITY.getFieldName(), SpecialField.QUALITY.getFieldName(),
-            SpecialField.RANKING.getFieldName(), SpecialField.READ_STATUS.getFieldName(),
+            SpecialField.PRIORITY.getFieldName(),
+            SpecialField.QUALITY.getFieldName(),
+            SpecialField.RANKING.getFieldName(),
+            SpecialField.READ_STATUS.getFieldName(),
             SpecialField.RELEVANCE.getFieldName()
     );
 
@@ -473,6 +469,18 @@ public static List<String> getIEEETranBSTctlYesNoFields() {
         return YES_NO_FIELDS;
     }
 
+    /**
+     * These are the fields JabRef always displays as default {@link org.jabref.preferences.JabRefPreferences#setLanguageDependentDefaultValues()}
+     *
+     * A user can change them. The change is currently stored in the preferences only and not explicitly exposed as
+     * separate preferences object
+     */
+    public static List<String> getDefaultGeneralFields() {
+        List<String> defaultGeneralFields = new ArrayList<>(DEFAULT_GENERAL_FIELDS);
+        defaultGeneralFields.addAll(SPECIAL_FIELDS);
+        return defaultGeneralFields;
+    }
+
     /**
      * Insert a field into the internal list
      */

diff --git a/src/main/java/org/jabref/preferences/JabRefPreferences.java b/src/main/java/org/jabref/preferences/JabRefPreferences.java
@@ -988,7 +988,7 @@ public List<String> getCustomTabFieldNames() {
     public void setLanguageDependentDefaultValues() {
         // Entry editor tab 0:
         defaults.put(CUSTOM_TAB_NAME + "_def0", Localization.lang("General"));
-        String fieldNames = InternalBibtexFields.DEFAULT_GENERAL_FIELDS.stream().collect(Collectors.joining(";"));
+        String fieldNames = InternalBibtexFields.getDefaultGeneralFields().stream().collect(Collectors.joining(";"));
         defaults.put(CUSTOM_TAB_FIELDS + "_def0", fieldNames);
 
         // Entry editor tab 1:

diff --git a/src/test/java/org/jabref/logic/integrity/IntegrityCheckTest.java b/src/test/java/org/jabref/logic/integrity/IntegrityCheckTest.java
@@ -33,18 +33,18 @@
 import static org.mockito.Mockito.mock;
 
 @ExtendWith(TempDirectory.class)
-public class IntegrityCheckTest {
+class IntegrityCheckTest {
 
     @Test
-    public void testEntryTypeChecks() {
+    void testEntryTypeChecks() {
         assertCorrect(withMode(createContext("title", "sometitle", "article"), BibDatabaseMode.BIBTEX));
         assertWrong(withMode(createContext("title", "sometitle", "patent"), BibDatabaseMode.BIBTEX));
         assertCorrect((withMode(createContext("title", "sometitle", "patent"), BibDatabaseMode.BIBLATEX)));
         assertCorrect(withMode(createContext("title", "sometitle", "article"), BibDatabaseMode.BIBLATEX));
     }
 
     @Test
-    public void testUrlChecks() {
+    void testUrlChecks() {
         assertCorrect(createContext("url", "http://www.google.com"));
         assertCorrect(createContext("url", "file://c:/asdf/asdf"));
         assertCorrect(createContext("url", "http://scikit-learn.org/stable/modules/ensemble.html#random-forests"));
@@ -55,7 +55,7 @@ public void testUrlChecks() {
     }
 
     @Test
-    public void testYearChecks() {
+    void testYearChecks() {
         assertCorrect(createContext("year", "2014"));
         assertCorrect(createContext("year", "1986"));
         assertCorrect(createContext("year", "around 1986"));
@@ -74,7 +74,7 @@ public void testYearChecks() {
     }
 
     @Test
-    public void testEditionChecks() {
+    void testEditionChecks() {
         assertCorrect(withMode(createContext("edition", "Second"), BibDatabaseMode.BIBTEX));
         assertCorrect(withMode(createContext("edition", "Third"), BibDatabaseMode.BIBTEX));
         assertWrong(withMode(createContext("edition", "second"), BibDatabaseMode.BIBTEX));
@@ -89,7 +89,7 @@ public void testEditionChecks() {
     }
 
     @Test
-    public void testNoteChecks() {
+    void testNoteChecks() {
         assertCorrect(withMode(createContext("note", "Lorem ipsum"), BibDatabaseMode.BIBTEX));
         assertCorrect(withMode(createContext("note", "Lorem ipsum? 10"), BibDatabaseMode.BIBTEX));
         assertWrong(withMode(createContext("note", "lorem ipsum"), BibDatabaseMode.BIBTEX));
@@ -99,7 +99,7 @@ public void testNoteChecks() {
     }
 
     @Test
-    public void testHowpublishedChecks() {
+    void testHowpublishedChecks() {
         assertCorrect(withMode(createContext("howpublished", "Lorem ipsum"), BibDatabaseMode.BIBTEX));
         assertCorrect(withMode(createContext("howpublished", "Lorem ipsum? 10"), BibDatabaseMode.BIBTEX));
         assertWrong(withMode(createContext("howpublished", "lorem ipsum"), BibDatabaseMode.BIBTEX));
@@ -109,7 +109,7 @@ public void testHowpublishedChecks() {
     }
 
     @Test
-    public void testMonthChecks() {
+    void testMonthChecks() {
         assertCorrect(withMode(createContext("month", "#mar#"), BibDatabaseMode.BIBTEX));
         assertCorrect(withMode(createContext("month", "#dec#"), BibDatabaseMode.BIBTEX));
         assertWrong(withMode(createContext("month", "#bla#"), BibDatabaseMode.BIBTEX));
@@ -127,13 +127,13 @@ public void testMonthChecks() {
     }
 
     @Test
-    public void testJournaltitleChecks() {
+    void testJournaltitleChecks() {
         assertWrong(withMode(createContext("journaltitle", "A journal"), BibDatabaseMode.BIBLATEX));
         assertWrong(withMode(createContext("journaltitle", "A journal"), BibDatabaseMode.BIBTEX));
     }
 
     @Test
-    public void testBibtexkeyChecks() {
+    void testBibtexkeyChecks() {
         final BibDatabaseContext correctContext = createContext("bibtexkey", "Knuth2014");
         correctContext.getDatabase().getEntries().get(0).setField("author", "Knuth");
         correctContext.getDatabase().getEntries().get(0).setField("year", "2014");
@@ -146,7 +146,7 @@ public void testBibtexkeyChecks() {
     }
 
     @Test
-    public void testBracketChecks() {
+    void testBracketChecks() {
         assertCorrect(createContext("title", "x"));
         assertCorrect(createContext("title", "{x}"));
         assertCorrect(createContext("title", "{x}x{}x{{}}"));
@@ -156,7 +156,7 @@ public void testBracketChecks() {
     }
 
     @Test
-    public void testAuthorNameChecks() {
+    void testAuthorNameChecks() {
         for (String field : InternalBibtexFields.getPersonNameFields()) {
             // getPersonNameFields returns fields that are available in biblatex only
             // if run without mode, the NoBibtexFieldChecker will complain that "afterword" is a biblatex only field
@@ -173,7 +173,7 @@ public void testAuthorNameChecks() {
     }
 
     @Test
-    public void testTitleChecks() {
+    void testTitleChecks() {
         assertCorrect(withMode(createContext("title", "This is a title"), BibDatabaseMode.BIBTEX));
         assertWrong(withMode(createContext("title", "This is a Title"), BibDatabaseMode.BIBTEX));
         assertCorrect(withMode(createContext("title", "This is a {T}itle"), BibDatabaseMode.BIBTEX));
@@ -192,7 +192,7 @@ public void testTitleChecks() {
     }
 
     @Test
-    public void testAbbreviationChecks() {
+    void testAbbreviationChecks() {
         for (String field : Arrays.asList("booktitle", "journal")) {
             assertCorrect(createContext(field, "IEEE Software"));
             assertCorrect(createContext(field, ""));
@@ -201,13 +201,13 @@ public void testAbbreviationChecks() {
     }
 
     @Test
-    public void testJournalIsKnownInAbbreviationList() {
+    void testJournalIsKnownInAbbreviationList() {
         assertCorrect(createContext("journal", "IEEE Software"));
         assertWrong(createContext("journal", "IEEE Whocares"));
     }
 
     @Test
-    public void testFileChecks() {
+    void testFileChecks() {
         MetaData metaData = mock(MetaData.class);
         Mockito.when(metaData.getDefaultFileDirectory()).thenReturn(Optional.of("."));
         Mockito.when(metaData.getUserFileDirectory(any(String.class))).thenReturn(Optional.empty());
@@ -220,32 +220,32 @@ public void testFileChecks() {
     }
 
     @Test
-    public void fileCheckFindsFilesRelativeToBibFile(@TempDirectory.TempDir Path testFolder) throws IOException {
+    void fileCheckFindsFilesRelativeToBibFile(@TempDirectory.TempDir Path testFolder) throws IOException {
         Path bibFile = testFolder.resolve("lit.bib");
         Files.createFile(bibFile);
         Path pdfFile = testFolder.resolve("file.pdf");
         Files.createFile(pdfFile);
 
         BibDatabaseContext databaseContext = createContext("file", ":file.pdf:PDF");
-        databaseContext.setDatabaseFile(bibFile.toFile());
+        databaseContext.setDatabaseFile(bibFile);
 
         assertCorrect(databaseContext);
     }
 
     @Test
-    public void testTypeChecks() {
+    void testTypeChecks() {
         assertCorrect(createContext("pages", "11--15", "inproceedings"));
         assertWrong(createContext("pages", "11--15", "proceedings"));
     }
 
     @Test
-    public void testBooktitleChecks() {
+    void testBooktitleChecks() {
         assertCorrect(createContext("booktitle", "2014 Fourth International Conference on Digital Information and Communication Technology and it's Applications (DICTAP)", "proceedings"));
         assertWrong(createContext("booktitle", "Digital Information and Communication Technology and it's Applications (DICTAP), 2014 Fourth International Conference on", "proceedings"));
     }
 
     @Test
-    public void testPageNumbersChecks() {
+    void testPageNumbersChecks() {
         assertCorrect(createContext("pages", "1--2"));
         assertCorrect(createContext("pages", "12"));
         assertWrong(createContext("pages", "1-2"));
@@ -260,7 +260,7 @@ public void testPageNumbersChecks() {
     }
 
     @Test
-    public void testBiblatexPageNumbersChecks() {
+    void testBiblatexPageNumbersChecks() {
         assertCorrect(withMode(createContext("pages", "1--2"), BibDatabaseMode.BIBLATEX));
         assertCorrect(withMode(createContext("pages", "12"), BibDatabaseMode.BIBLATEX));
         assertCorrect(withMode(createContext("pages", "1-2"), BibDatabaseMode.BIBLATEX)); // only diff to bibtex
@@ -275,7 +275,7 @@ public void testBiblatexPageNumbersChecks() {
     }
 
     @Test
-    public void testBibStringChecks() {
+    void testBibStringChecks() {
         assertCorrect(createContext("title", "Not a single hash mark"));
         assertCorrect(createContext("month", "#jan#"));
         assertCorrect(createContext("author", "#einstein# and #newton#"));
@@ -284,7 +284,7 @@ public void testBibStringChecks() {
     }
 
     @Test
-    public void testHTMLCharacterChecks() {
+    void testHTMLCharacterChecks() {
         assertCorrect(createContext("title", "Not a single {HTML} character"));
         assertCorrect(createContext("month", "#jan#"));
         assertCorrect(createContext("author", "A. Einstein and I. Newton"));
@@ -295,7 +295,7 @@ public void testHTMLCharacterChecks() {
     }
 
     @Test
-    public void testISSNChecks() {
+    void testISSNChecks() {
         assertCorrect(createContext("issn", "0020-7217"));
         assertCorrect(createContext("issn", "1687-6180"));
         assertCorrect(createContext("issn", "2434-561x"));
@@ -304,7 +304,7 @@ public void testISSNChecks() {
     }
 
     @Test
-    public void testISBNChecks() {
+    void testISBNChecks() {
         assertCorrect(createContext("isbn", "0-201-53082-1"));
         assertCorrect(createContext("isbn", "0-9752298-0-X"));
         assertCorrect(createContext("isbn", "978-0-306-40615-7"));
@@ -314,15 +314,15 @@ public void testISBNChecks() {
     }
 
     @Test
-    public void testDOIChecks() {
+    void testDOIChecks() {
         assertCorrect(createContext("doi", "10.1023/A:1022883727209"));
         assertCorrect(createContext("doi", "10.17487/rfc1436"));
         assertCorrect(createContext("doi", "10.1002/(SICI)1097-4571(199205)43:4<284::AID-ASI3>3.0.CO;2-0"));
         assertWrong(createContext("doi", "asdf"));
     }
 
     @Test
-    public void testEntryIsUnchangedAfterChecks() {
+    void testEntryIsUnchangedAfterChecks() {
         BibEntry entry = new BibEntry();
 
         // populate with all known fields
@@ -349,7 +349,7 @@ public void testEntryIsUnchangedAfterChecks() {
     }
 
     @Test
-    public void testASCIIChecks() {
+    void testASCIIChecks() {
         assertCorrect(createContext("title", "Only ascii characters!'@12"));
         assertWrong(createContext("month", "Umlauts are nöt ällowed"));
         assertWrong(createContext("author", "Some unicode ⊕"));