Rename the Review Tab into Comments Tab

CHANGELOG.md

@@ -21,6 +21,7 @@ We refer to [GitHub issues](https://github.com/JabRef/jabref/issues) by using `#
 - We improved the export of the `address` and `location` field to the MS-Office XML fields. If the address field does not contain a comma, it is treated as single value and exported to the field `city`. [#1750, comment](https://github.com/JabRef/jabref/issues/1750#issuecomment-357539167) 
 For more details refer to the [field mapping help page](http://help.jabref.org/en/MsOfficeBibFieldMapping)
 - We added Facebook and Twitter icons in the toolbar to link to our [Facebook](https://www.facebook.com/JabRef/) and [Twitter](https://twitter.com/jabref_org) pages.
+- Renamed the _Review_ Tab into _Comments_ Tab
 - We no longer print empty lines when exporting an entry in RIS format [#3634](https://github.com/JabRef/jabref/issues/3634)
 - We improved file saving so that hard links are now preserved when a save is performed [#2633](https://github.com/JabRef/jabref/issues/2633)
 

src/main/java/org/jabref/logic/importer/OpenDatabase.java

@@ -8,6 +8,7 @@
 import org.jabref.logic.importer.fileformat.BibtexImporter;
 import org.jabref.logic.importer.util.ConvertLegacyExplicitGroups;
 import org.jabref.logic.importer.util.PostOpenAction;
+import org.jabref.logic.importer.util.RenameReviewToComment;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.logic.specialfields.SpecialFieldsUtils;
 import org.jabref.logic.util.io.FileBasedLock;
@@ -87,7 +88,8 @@ public static ParserResult loadDatabase(File fileToOpen, ImportFormatPreferences
     }
 
     private static void applyPostActions(ParserResult parserResult) {
-        List<PostOpenAction> actions = Arrays.asList(new ConvertLegacyExplicitGroups());
+
+        List<PostOpenAction> actions = Arrays.asList(new ConvertLegacyExplicitGroups(), new RenameReviewToComment());
 
         for (PostOpenAction action : actions) {
             action.performAction(parserResult);

src/main/java/org/jabref/logic/importer/util/RenameReviewToComment.java

@@ -0,0 +1,39 @@
+package org.jabref.logic.importer.util;
+
+import java.util.Objects;
+
+import org.jabref.logic.importer.ParserResult;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.FieldName;
+
+public class RenameReviewToComment implements PostOpenAction {
+
+    @Override
+    public void performAction(ParserResult parserResult) {
+        Objects.requireNonNull(parserResult);
+
+        for (BibEntry entry : parserResult.getDatabase().getEntries()) {
+            if (entry.getField(FieldName.REVIEW).isPresent()) {
+                String review = entry.getField(FieldName.REVIEW).get();
+                review = concatCommentFieldIfPresent(entry, review);
+                updateFields(entry, review);
+            }
+        }
+    }
+
+    private String concatCommentFieldIfPresent(BibEntry entry, String review) {
+        if (entry.getField(FieldName.COMMENT).isPresent()) {
+            String comment = entry.getField(FieldName.COMMENT).get().trim();
+            if (!comment.isEmpty()) {
+                review = String.format("%s\nReview:\n%s", comment, review.trim());
+            }
+        }
+
+        return review;
+    }
+
+    private void updateFields(BibEntry entry, String review) {
+        entry.setField(FieldName.COMMENT, review);
+        entry.clearField(FieldName.REVIEW);
+    }
+}

src/main/java/org/jabref/model/entry/InternalBibtexFields.java

@@ -22,10 +22,10 @@
  * config files -> simple extension and definition of new fields
  *
  * TODO:
- *  - handling of identically fields with different names (https://github.com/JabRef/jabref/issues/521)
- *    e.g. LCCN = lib-congress, journaltitle = journal
- *  - group id for each fields, e.g. standard, jurabib, bio, ...
- *  - add a additional properties functionality into the BibtexSingleField class
+ * - handling of identically fields with different names (https://github.com/JabRef/jabref/issues/521)
+ * e.g. LCCN = lib-congress, journaltitle = journal
+ * - group id for each fields, e.g. standard, jurabib, bio, ...
+ * - add a additional properties functionality into the BibtexSingleField class
  */
 public class InternalBibtexFields {
 
@@ -35,7 +35,7 @@ public class InternalBibtexFields {
      *
      * A user can change them. The change is currently stored in the preferences only and not explicitley exposed as separte 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.COMMENT, FieldName.OWNER, FieldName.TIMESTAMP);
+    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);
 
     // Lists of fields with special properties
     private static final List<String> INTEGER_FIELDS = Arrays.asList(FieldName.CTLMAX_NAMES_FORCED_ETAL,
@@ -382,7 +382,6 @@ public static void setNumericFields(List<String> numFields) {
             field.setNumeric(true);
             InternalBibtexFields.RUNTIME.fieldSet.put(fieldName, field);
         }
-
     }
 
     public static Set<FieldProperty> getFieldProperties(String name) {

src/main/java/org/jabref/preferences/JabRefPreferences.java

@@ -974,9 +974,9 @@ public void setLanguageDependentDefaultValues() {
         defaults.put(CUSTOM_TAB_FIELDS + "_def1", FieldName.ABSTRACT);
         defaults.put(CUSTOM_TAB_NAME + "_def1", Localization.lang("Abstract"));
 
-        // Entry editor tab 2: Review Field - used for research comments, etc.
-        defaults.put(CUSTOM_TAB_FIELDS + "_def2", FieldName.REVIEW);
-        defaults.put(CUSTOM_TAB_NAME + "_def2", Localization.lang("Review"));
+        // Entry editor tab 2: Comments Field - used for research comments, etc.
+        defaults.put(CUSTOM_TAB_FIELDS + "_def2", FieldName.COMMENT);
+        defaults.put(CUSTOM_TAB_NAME + "_def2", Localization.lang("Comments"));
 
         defaults.put(EMAIL_SUBJECT, Localization.lang("References"));
     }

src/main/resources/l10n/JabRef_en.properties

@@ -210,7 +210,7 @@ Color\ for\ marking\ incomplete\ entries=Color for marking incomplete entries
 Column\ width=Column width
 
 Command\ line\ id=Command line id
-
+Comments=Comments
 
 Contained\ in=Contained in
 
@@ -1004,8 +1004,6 @@ Resolve\ strings\ for\ standard\ BibTeX\ fields\ only=Resolve strings for standa
 
 resolved=resolved
 
-Review=Review
-
 Review\ changes=Review changes
 
 Right=Right

src/test/java/org/jabref/logic/importer/util/RenameReviewToCommentTest.java

@@ -0,0 +1,86 @@
+package org.jabref.logic.importer.util;
+
+import java.util.Collections;
+
+import org.jabref.logic.importer.ParserResult;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.FieldName;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+class RenameReviewToCommentTest {
+
+    private RenameReviewToComment action;
+
+    @BeforeEach
+    void setUp() {
+        action = new RenameReviewToComment();
+    }
+
+    @Test
+    void noFields() {
+        BibEntry entry = createMinimalBibEntry();
+        ParserResult actualParserResult = new ParserResult(Collections.singletonList(entry));
+
+        action.performAction(actualParserResult);
+
+        assertEquals(new ParserResult(Collections.singletonList(entry)).getDatabase().getEntryByKey("Entry1"),
+                actualParserResult.getDatabase().getEntryByKey("Entry1"));
+    }
+
+    @Test
+    void reviewField() {
+        BibEntry actualEntry = createMinimalBibEntry();
+        actualEntry.setField(FieldName.REVIEW, "My Review");
+        ParserResult actualParserResult = new ParserResult(Collections.singletonList(actualEntry));
+
+        BibEntry expectedEntry = createMinimalBibEntry();
+        expectedEntry.setField(FieldName.COMMENT, "My Review");
+
+        action.performAction(actualParserResult);
+
+        assertEquals(new ParserResult(Collections.singletonList(expectedEntry)).getDatabase().getEntryByKey("Entry1"),
+                actualParserResult.getDatabase().getEntryByKey("Entry1"));
+    }
+
+    @Test
+    void commentField() {
+        BibEntry entry = createMinimalBibEntry();
+        entry.setField(FieldName.COMMENT, "My Comment");
+        ParserResult actualParserResult = new ParserResult(Collections.singletonList(entry));
+
+        action.performAction(actualParserResult);
+
+        assertEquals(new ParserResult(Collections.singletonList(entry)).getDatabase().getEntryByKey("Entry1"),
+                actualParserResult.getDatabase().getEntryByKey("Entry1"));
+    }
+
+
+    @Test
+    void reviewAndCommentField() {
+        BibEntry actualEntry = createMinimalBibEntry();
+        actualEntry.setField(FieldName.REVIEW, "My Review");
+        actualEntry.setField(FieldName.COMMENT, "My Comment");
+
+        ParserResult actualParserResult = new ParserResult(Collections.singletonList(actualEntry));
+
+        BibEntry expectedEntry = createMinimalBibEntry();
+        expectedEntry.setField(FieldName.COMMENT, "My Comment\nReview:\nMy Review");
+
+        action.performAction(actualParserResult);
+
+        assertEquals(new ParserResult(Collections.singletonList(expectedEntry)).getDatabase().getEntryByKey("Entry1"),
+                actualParserResult.getDatabase().getEntryByKey("Entry1"));
+    }
+
+    private BibEntry createMinimalBibEntry() {
+        BibEntry entry = new BibEntry();
+        entry.setCiteKey("Entry1");
+        entry.setField(FieldName.TITLE, "A random entry!");
+        entry.setField(FieldName.AUTHOR, "JabRef DEVELOPERS");
+        return entry;
+    }
+}