Rename the Review Tab into Comments Tab

CHANGELOG.md

@@ -12,6 +12,7 @@ We refer to [GitHub issues](https://github.com/JabRef/jabref/issues) by using `#
 ## [Unreleased]
 
 ### Changed
+- Changed order of items in context menu [#298] (https://github.com/koppor/jabref/issues/298)
 - Changed ID-based entry generator to store the last used fetcher. [#2796] (https://github.com/JabRef/jabref/issues/2796)
 - Reorganised annotation information on the right side of the "File annotations" tab. [#3109](https://github.com/JabRef/jabref/issues/3109)
 - We now show a small notification icon in the entry editor when we detect data inconsistency or other problems. [#3145](https://github.com/JabRef/jabref/issues/3145)
@@ -23,6 +24,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)
 - We changed the default dialog option when removing a [file link](http://help.jabref.org/en/FileLinks#adding-external-links-to-an-entry) from an entry.

src/main/java/org/jabref/JabRefGUI.java

@@ -18,7 +18,7 @@
 import org.jabref.gui.BasePanel;
 import org.jabref.gui.GUIGlobals;
 import org.jabref.gui.JabRefFrame;
-import org.jabref.gui.autosaveandbackup.BackupUIManager;
+import org.jabref.gui.dialogs.BackupUIManager;
 import org.jabref.gui.importer.ParserResultWarningDialog;
 import org.jabref.gui.importer.actions.OpenDatabaseAction;
 import org.jabref.gui.shared.SharedDatabaseUIManager;
@@ -301,5 +301,4 @@ public static JabRefFrame getMainFrame() {
     public static void setMainFrame(JabRefFrame mainFrame) {
         JabRefGUI.mainFrame = mainFrame;
     }
-
 }

src/main/java/org/jabref/gui/JabRefFrame.java

@@ -78,11 +78,11 @@
 import org.jabref.gui.actions.OpenBrowserAction;
 import org.jabref.gui.actions.SearchForUpdateAction;
 import org.jabref.gui.actions.SortTabsAction;
-import org.jabref.gui.autosaveandbackup.AutosaveUIManager;
 import org.jabref.gui.bibtexkeypattern.BibtexKeyPatternDialog;
 import org.jabref.gui.copyfiles.CopyFilesAction;
 import org.jabref.gui.customentrytypes.EntryCustomizationDialog;
 import org.jabref.gui.dbproperties.DatabasePropertiesDialog;
+import org.jabref.gui.dialogs.AutosaveUIManager;
 import org.jabref.gui.documentviewer.ShowDocumentViewerAction;
 import org.jabref.gui.exporter.ExportAction;
 import org.jabref.gui.exporter.ExportCustomizationDialog;

src/main/java/org/jabref/gui/PreviewPanel.java

@@ -139,8 +139,8 @@ private ContextMenu createPopupMenu() {
         menu.getItems().add(copyPreview);
         menu.getItems().add(printEntryPreview);
         menu.getItems().add(new SeparatorMenuItem());
-        menu.getItems().add(previousPreviewLayout);
         menu.getItems().add(nextPreviewLayout);
+        menu.getItems().add(previousPreviewLayout);
         return menu;
     }
 

src/main/java/org/jabref/gui/autosaveandbackup/AutosaveUIManager.java → src/main/java/org/jabref/gui/dialogs/AutosaveUIManager.java

@@ -1,4 +1,4 @@
-package org.jabref.gui.autosaveandbackup;
+package org.jabref.gui.dialogs;
 
 import org.jabref.gui.BasePanel;
 import org.jabref.gui.exporter.SaveDatabaseAction;

src/main/java/org/jabref/gui/autosaveandbackup/BackupUIManager.java → src/main/java/org/jabref/gui/dialogs/BackupUIManager.java

@@ -1,4 +1,4 @@
-package org.jabref.gui.autosaveandbackup;
+package org.jabref.gui.dialogs;
 
 import java.nio.file.Path;
 

src/main/java/org/jabref/gui/dialogs/MergeReviewIntoCommentUIManager.java

@@ -0,0 +1,31 @@
+package org.jabref.gui.dialogs;
+
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+import javax.swing.JOptionPane;
+
+import org.jabref.logic.l10n.Localization;
+import org.jabref.model.entry.BibEntry;
+
+public class MergeReviewIntoCommentUIManager {
+
+    public boolean askUserForMerge(List<BibEntry> conflicts) {
+        List<String> bibKeys = conflicts.stream()
+                .map(BibEntry::getCiteKeyOptional)
+                .filter(Optional::isPresent)
+                .map(Optional::get)
+                .collect(Collectors.toList());
+
+        int answer = JOptionPane.showConfirmDialog(
+                null,
+                String.join(",\n", bibKeys) + " " +
+                        Localization.lang("has/have both a 'Comment' and a 'Review' field.") + "\n" +
+                        Localization.lang("Since the 'Review' field was deprecated in JabRef 4.2, these two fields are about to be merged into the 'Comment' field.") + "\n" +
+                        Localization.lang("By clicking 'Yes' the conflicting fields of these entries will be merged into the 'Comment' field."),
+                Localization.lang("Review Field Migration"), JOptionPane.YES_NO_OPTION, JOptionPane.WARNING_MESSAGE);
+
+        return 0 == answer;
+    }
+}

src/main/java/org/jabref/gui/exporter/SaveDatabaseAction.java

@@ -16,9 +16,9 @@
 import org.jabref.gui.DialogService;
 import org.jabref.gui.FXDialogService;
 import org.jabref.gui.JabRefFrame;
-import org.jabref.gui.autosaveandbackup.AutosaveUIManager;
 import org.jabref.gui.collab.ChangeScanner;
 import org.jabref.gui.collab.FileUpdatePanel;
+import org.jabref.gui.dialogs.AutosaveUIManager;
 import org.jabref.gui.util.DefaultTaskExecutor;
 import org.jabref.gui.util.FileDialogConfiguration;
 import org.jabref.gui.worker.AbstractWorker;

src/main/java/org/jabref/gui/importer/actions/OpenDatabaseAction.java

@@ -26,7 +26,7 @@
 import org.jabref.gui.IconTheme;
 import org.jabref.gui.JabRefFrame;
 import org.jabref.gui.actions.MnemonicAwareAction;
-import org.jabref.gui.autosaveandbackup.BackupUIManager;
+import org.jabref.gui.dialogs.BackupUIManager;
 import org.jabref.gui.importer.ParserResultWarningDialog;
 import org.jabref.gui.keyboard.KeyBinding;
 import org.jabref.gui.shared.SharedDatabaseUIManager;

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

@@ -6,11 +6,12 @@
 import java.util.List;
 
 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.l10n.Localization;
 import org.jabref.logic.specialfields.SpecialFieldsUtils;
 import org.jabref.logic.util.io.FileBasedLock;
+import org.jabref.migrations.ConvertLegacyExplicitGroups;
+import org.jabref.migrations.MergeReviewIntoComment;
+import org.jabref.migrations.PostOpenMigration;
 import org.jabref.model.entry.BibEntry;
 import org.jabref.model.util.FileUpdateMonitor;
 
@@ -81,16 +82,17 @@ public static ParserResult loadDatabase(File fileToOpen, ImportFormatPreferences
             LOGGER.debug("Synchronized special fields based on keywords");
         }
 
-        applyPostActions(result);
+        performLoadDatabaseMigrations(result);
 
         return result;
     }
 
-    private static void applyPostActions(ParserResult parserResult) {
-        List<PostOpenAction> actions = Arrays.asList(new ConvertLegacyExplicitGroups());
+    private static void performLoadDatabaseMigrations(ParserResult parserResult) {
 
-        for (PostOpenAction action : actions) {
-            action.performAction(parserResult);
+        List<PostOpenMigration> postOpenMigrations = Arrays.asList(new ConvertLegacyExplicitGroups(), new MergeReviewIntoComment());
+
+        for (PostOpenMigration migration : postOpenMigrations) {
+            migration.performMigration(parserResult);
         }
     }
 }

src/main/java/org/jabref/logic/importer/util/ConvertLegacyExplicitGroups.java → src/main/java/org/jabref/migrations/ConvertLegacyExplicitGroups.java

@@ -1,4 +1,4 @@
-package org.jabref.logic.importer.util;
+package org.jabref.migrations;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -13,10 +13,10 @@
  * Converts legacy explicit groups, where the group contained a list of assigned entries, to the new format,
  * where the entry stores a list of groups it belongs to.
  */
-public class ConvertLegacyExplicitGroups implements PostOpenAction {
+public class ConvertLegacyExplicitGroups implements PostOpenMigration {
 
     @Override
-    public void performAction(ParserResult parserResult) {
+    public void performMigration(ParserResult parserResult) {
         Objects.requireNonNull(parserResult);
         if (!parserResult.getMetaData().getGroups().isPresent()) {
             return;

src/main/java/org/jabref/migrations/MergeReviewIntoComment.java

@@ -0,0 +1,69 @@
+package org.jabref.migrations;
+
+import java.util.List;
+import java.util.Objects;
+import java.util.stream.Collectors;
+
+import javafx.collections.ObservableList;
+
+import org.jabref.gui.dialogs.MergeReviewIntoCommentUIManager;
+import org.jabref.logic.importer.ParserResult;
+import org.jabref.logic.l10n.Localization;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.FieldName;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class MergeReviewIntoComment implements PostOpenMigration {
+    public static final Logger LOGGER = LoggerFactory.getLogger(MergeReviewIntoComment.class);
+
+    @Override
+    public void performMigration(ParserResult parserResult) {
+        ObservableList<BibEntry> entries = Objects.requireNonNull(parserResult).getDatabase().getEntries();
+
+        // migrate non-conflicting entries first
+        entries.stream()
+                .filter(this::hasReviewField)
+                .filter(entry -> !this.hasCommentField(entry))
+                .forEach(this::migrate);
+
+        // determine conflicts
+        List<BibEntry> conflicts = entries.stream()
+                .filter(this::hasReviewField)
+                .filter(this::hasCommentField)
+                .collect(Collectors.toList());
+
+        // resolve conflicts if users agrees
+        if (!conflicts.isEmpty() && new MergeReviewIntoCommentUIManager().askUserForMerge(conflicts)) {
+            conflicts.stream()
+                    .filter(this::hasReviewField)
+                    .forEach(this::migrate);
+        }
+    }
+
+    private String mergeCommentFieldIfPresent(BibEntry entry, String review) {
+        if (entry.getField(FieldName.COMMENT).isPresent()) {
+            LOGGER.info(String.format("Both Comment and Review fields are present in %s! Merging them into the comment field.", entry.getAuthorTitleYear(150)));
+            return String.format("%s\n%s:\n%s", entry.getField(FieldName.COMMENT).get().trim(), Localization.lang("Review"), review.trim());
+        }
+        return review;
+    }
+
+    private boolean hasCommentField(BibEntry entry) {
+        return entry.getField(FieldName.COMMENT).isPresent();
+    }
+
+    private boolean hasReviewField(BibEntry entry) {
+        return entry.getField(FieldName.REVIEW).isPresent();
+    }
+
+    private void migrate(BibEntry entry) {
+        updateFields(entry, mergeCommentFieldIfPresent(entry, entry.getField(FieldName.REVIEW).get()));
+    }
+
+    private void updateFields(BibEntry entry, String review) {
+        entry.setField(FieldName.COMMENT, review);
+        entry.clearField(FieldName.REVIEW);
+    }
+}

src/main/java/org/jabref/migrations/PostOpenMigration.java

@@ -0,0 +1,7 @@
+package org.jabref.migrations;
+
+import org.jabref.logic.importer.ParserResult;
+
+public interface PostOpenMigration {
+    void performMigration(ParserResult parserResult);
+}

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

@@ -982,9 +982,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

@@ -148,6 +148,7 @@ Broken\ link=Broken link
 Browse=Browse
 
 by=by
+By\ clicking\ 'Yes'\ the\ conflicting\ fields\ of\ these\ entries\ will\ be\ merged\ into\ the\ 'Comment'\ field.=By clicking 'Yes' the conflicting fields of these entries will be merged into the 'Comment' field.
 
 Cancel=Cancel
 
@@ -210,7 +211,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
 
@@ -560,6 +561,7 @@ Get\ fulltext=Get fulltext
 Gray\ out\ non-hits=Gray out non-hits
 
 Groups=Groups
+has/have\ both\ a\ 'Comment'\ and\ a\ 'Review'\ field.=has/have both a 'Comment' and a 'Review' field.
 
 Have\ you\ chosen\ the\ correct\ package\ path?=Have you chosen the correct package path?
 
@@ -1004,10 +1006,9 @@ Resolve\ strings\ for\ all\ fields\ except=Resolve strings for all fields except
 Resolve\ strings\ for\ standard\ BibTeX\ fields\ only=Resolve strings for standard BibTeX fields only
 
 resolved=resolved
-
 Review=Review
-
 Review\ changes=Review changes
+Review\ Field\ Migration=Review Field Migration
 
 Right=Right
 
@@ -1100,6 +1101,7 @@ Show\ URL/DOI\ column=Show URL/DOI column
 Show\ validation\ messages=Show validation messages
 
 Simple\ HTML=Simple HTML
+Since\ the\ 'Review'\ field\ was\ deprecated\ in\ JabRef\ 4.2,\ these\ two\ fields\ are\ about\ to\ be\ merged\ into\ the\ 'Comment'\ field.=Since the 'Review' field was deprecated in JabRef 4.2, these two fields are about to be merged into the 'Comment' field.
 
 Size=Size
 

src/test/java/org/jabref/logic/importer/util/ConvertLegacyExplicitGroupsTest.java → src/test/java/org/jabref/migrations/ConvertLegacyExplicitGroupsTest.java

@@ -1,4 +1,4 @@
-package org.jabref.logic.importer.util;
+package org.jabref.migrations;
 
 import java.util.Collections;
 import java.util.Optional;
@@ -17,7 +17,7 @@
 
 public class ConvertLegacyExplicitGroupsTest {
 
-    private PostOpenAction action;
+    private PostOpenMigration action;
     private BibEntry entry;
     private ExplicitGroup group;
 
@@ -35,7 +35,7 @@ public void setUp() throws Exception {
     public void performActionWritesGroupMembershipInEntry() throws Exception {
         ParserResult parserResult = generateParserResult(GroupTreeNode.fromGroup(group));
 
-        action.performAction(parserResult);
+        action.performMigration(parserResult);
 
         assertEquals(Optional.of("TestGroup"), entry.getField("groups"));
     }
@@ -44,7 +44,7 @@ public void performActionWritesGroupMembershipInEntry() throws Exception {
     public void performActionClearsLegacyKeys() throws Exception {
         ParserResult parserResult = generateParserResult(GroupTreeNode.fromGroup(group));
 
-        action.performAction(parserResult);
+        action.performMigration(parserResult);
 
         assertEquals(Collections.emptyList(), group.getLegacyEntryKeys());
     }
@@ -56,7 +56,7 @@ public void performActionWritesGroupMembershipInEntryForComplexGroupTree() throw
         root.addSubgroup(group);
         ParserResult parserResult = generateParserResult(root);
 
-        action.performAction(parserResult);
+        action.performMigration(parserResult);
 
         assertEquals(Optional.of("TestGroup"), entry.getField("groups"));
     }