Merge pull request #63 from lenhard/improve-test-coverage

simonharrer · simonharrer · commit c8017eb8f62e · 2015-07-21T15:06:04.000+02:00
Refactor Preferences
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,4 +1,5 @@
 [master]
+    - Refactored preferences
     - Remove local jgoodies dependency: replace SimpleInteralFrame with swingx JXTitledPanel and UIFSplitPane by JSplitPane
     - Fix several FindBugs warnings
     - Fix for bug #1276: OO styles do not consider editor fields anymore for sorting
diff --git a/src/main/java/net/sf/jabref/JabRefPreferences.java b/src/main/java/net/sf/jabref/JabRefPreferences.java
diff --git a/src/main/java/net/sf/jabref/KeyBinds.java b/src/main/java/net/sf/jabref/KeyBinds.java
@@ -0,0 +1,234 @@
+package net.sf.jabref;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+
+public class KeyBinds {
+
+    public static final String ABBREVIATE = "Abbreviate";
+    public static final String AUTOGENERATE_BIB_TE_X_KEYS = "Autogenerate BibTeX keys";
+    public static final String AUTOMATICALLY_LINK_FILES = "Automatically link files";
+    public static final String BACK = "Back";
+    public static final String BACK_HELP_DIALOG = "Back, help dialog";
+    public static final String CLEANUP = "Cleanup";
+    public static final String CLEAR_SEARCH = "Clear search";
+    public static final String CLOSE_DATABASE = "Close database";
+    public static final String CLOSE_DIALOG = "Close dialog";
+    public static final String CLOSE_ENTRY_EDITOR = "Close entry editor";
+    public static final String CLOSE_PREAMBLE_EDITOR = "Close preamble editor";
+    public static final String COPY = "Copy";
+    public static final String COPY_BIB_TE_X_KEY = "Copy BibTeX key";
+    public static final String COPY_BIB_TE_X_KEY_AND_TITLE = "Copy BibTeX key and title";
+    public static final String COPY_CITE_BIB_TE_X_KEY = "Copy \\cite{BibTeX key}";
+    public static final String CUT = "Cut";
+    public static final String DECREASE_TABLE_FONT_SIZE = "Decrease table font size";
+    public static final String DELETE = "Delete";
+    public static final String EDIT_ENTRY = "Edit entry";
+    public static final String EDIT_PREAMBLE = "Edit preamble";
+    public static final String EDIT_STRINGS = "Edit strings";
+    public static final String ENTRY_EDITOR_NEXT_ENTRY = "Entry editor, next entry";
+    public static final String ENTRY_EDITOR_NEXT_PANEL = "Entry editor, next panel";
+    public static final String ENTRY_EDITOR_NEXT_PANEL_2 = "Entry editor, next panel 2";
+    public static final String ENTRY_EDITOR_PREVIOUS_ENTRY = "Entry editor, previous entry";
+    public static final String ENTRY_EDITOR_PREVIOUS_PANEL = "Entry editor, previous panel";
+    public static final String ENTRY_EDITOR_PREVIOUS_PANEL_2 = "Entry editor, previous panel 2";
+    public static final String ENTRY_EDITOR_STORE_FIELD = "Entry editor, store field";
+    public static final String FETCH_AR_XIV_ORG = "Fetch ArXiv.org";
+    public static final String FETCH_INSPIRE = "Fetch INSPIRE";
+    public static final String FETCH_MEDLINE = "Fetch Medline";
+    public static final String FETCH_SPIRES = "Fetch SPIRES";
+    public static final String FILE_LIST_EDITOR_MOVE_ENTRY_DOWN = "File list editor, move entry down";
+    public static final String FILE_LIST_EDITOR_MOVE_ENTRY_UP = "File list editor, move entry up";
+    public static final String FOCUS_ENTRY_TABLE = "Focus entry table";
+    public static final String FORWARD = "Forward";
+    public static final String FORWARD_HELP_DIALOG = "Forward, help dialog";
+    public static final String HELP = "Help";
+    public static final String HIDE_SHOW_TOOLBAR = "Hide/show toolbar";
+    public static final String IMPORT_INTO_CURRENT_DATABASE = "Import into current database";
+    public static final String IMPORT_INTO_NEW_DATABASE = "Import into new database";
+    public static final String INCREASE_TABLE_FONT_SIZE = "Increase table font size";
+    public static final String INCREMENTAL_SEARCH = "Incremental search";
+    public static final String LOAD_SESSION = "Load session";
+    public static final String MARK_ENTRIES = "Mark entries";
+    public static final String MINIMIZE_TO_SYSTEM_TRAY = "Minimize to system tray";
+    public static final String NEW_ARTICLE = "New article";
+    public static final String NEW_BOOK = "New book";
+    public static final String NEW_ENTRY = "New entry";
+    public static final String NEW_FILE_LINK = "New file link";
+    public static final String NEW_FROM_PLAIN_TEXT = "New from plain text";
+    public static final String NEW_INBOOK = "New inbook";
+    public static final String NEW_MASTERSTHESIS = "New mastersthesis";
+    public static final String NEW_PHDTHESIS = "New phdthesis";
+    public static final String NEW_PROCEEDINGS = "New proceedings";
+    public static final String NEW_UNPUBLISHED = "New unpublished";
+    public static final String NEXT_TAB = "Next tab";
+    public static final String OPEN_DATABASE = "Open database";
+    public static final String OPEN_FILE = "Open file";
+    public static final String OPEN_FOLDER = "Open folder";
+    public static final String OPEN_PDF_OR_PS = "Open PDF or PS";
+    public static final String OPEN_SPIRES_ENTRY = "Open SPIRES entry";
+    public static final String OPEN_URL_OR_DOI = "Open URL or DOI";
+    public static final String PASTE = "Paste";
+    public static final String PREAMBLE_EDITOR_STORE_CHANGES = "Preamble editor, store changes";
+    public static final String PREVIOUS_TAB = "Previous tab";
+    public static final String PUSH_TO_APPLICATION = "Push to application";
+    public static final String PUSH_TO_LY_X = "Push to LyX";
+    public static final String PUSH_TO_WIN_EDT = "Push to WinEdt";
+    public static final String QUIT_JAB_REF = "Quit JabRef";
+    public static final String REDO = "Redo";
+    public static final String REFRESH_OO = "Refresh OO";
+    public static final String REPEAT_INCREMENTAL_SEARCH = "Repeat incremental search";
+    public static final String REPLACE_STRING = "Replace string";
+    public static final String RESOLVE_DUPLICATE_BIB_TE_X_KEYS = "Resolve duplicate BibTeX keys";
+    public static final String SAVE_ALL = "Save all";
+    public static final String SAVE_DATABASE = "Save database";
+    public static final String SAVE_DATABASE_AS = "Save database as ...";
+    public static final String SAVE_SESSION = "Save session";
+    public static final String SEARCH = "Search";
+    public static final String SEARCH_ACM_PORTAL = "Search ACM Portal";
+    public static final String SEARCH_ADS = "Search ADS";
+    public static final String SEARCH_IEEE_XPLORE = "Search IEEEXplore";
+    public static final String SEARCH_JSTOR = "Search JSTOR";
+    public static final String SEARCH_SCIENCE_DIRECT = "Search ScienceDirect";
+    public static final String SELECT_ALL = "Select all";
+    public static final String STRING_DIALOG_ADD_STRING = "String dialog, add string";
+    public static final String STRING_DIALOG_MOVE_STRING_DOWN = "String dialog, move string down";
+    public static final String STRING_DIALOG_MOVE_STRING_UP = "String dialog, move string up";
+    public static final String STRING_DIALOG_REMOVE_STRING = "String dialog, remove string";
+    public static final String SWITCH_PREVIEW_LAYOUT = "Switch preview layout";
+    public static final String SYNCHRONIZE_FILES = "Synchronize files";
+    public static final String SYNCHRONIZE_PDF = "Synchronize PDF";
+    public static final String SYNCHRONIZE_PS = "Synchronize PS";
+    public static final String TOGGLE_ENTRY_PREVIEW = "Toggle entry preview";
+    public static final String TOGGLE_GROUPS_INTERFACE = "Toggle groups interface";
+    public static final String UNABBREVIATE = "Unabbreviate";
+    public static final String UNDO = "Undo";
+    public static final String UNMARK_ENTRIES = "Unmark entries";
+    public static final String WRITE_XMP = "Write XMP";
+
+    private final HashMap<String, String> keyBindMap = new HashMap<String, String>();
+
+
+    public KeyBinds() {
+        keyBindMap.put(PUSH_TO_APPLICATION, "ctrl L");
+        keyBindMap.put(PUSH_TO_LY_X, "ctrl L");
+        keyBindMap.put(PUSH_TO_WIN_EDT, "ctrl shift W");
+        keyBindMap.put(QUIT_JAB_REF, "ctrl Q");
+        keyBindMap.put(OPEN_DATABASE, "ctrl O");
+        keyBindMap.put(SAVE_DATABASE, "ctrl S");
+        keyBindMap.put(SAVE_DATABASE_AS, "ctrl shift S");
+        keyBindMap.put(SAVE_ALL, "ctrl alt S");
+        keyBindMap.put(CLOSE_DATABASE, "ctrl W");
+        keyBindMap.put(NEW_ENTRY, "ctrl N");
+        keyBindMap.put(CUT, "ctrl X");
+        keyBindMap.put(COPY, "ctrl C");
+        keyBindMap.put(PASTE, "ctrl V");
+        keyBindMap.put(UNDO, "ctrl Z");
+        keyBindMap.put(REDO, "ctrl Y");
+        keyBindMap.put(HELP, "F1");
+        keyBindMap.put(NEW_ARTICLE, "ctrl shift A");
+        keyBindMap.put(NEW_BOOK, "ctrl shift B");
+        keyBindMap.put(NEW_PHDTHESIS, "ctrl shift T");
+        keyBindMap.put(NEW_INBOOK, "ctrl shift I");
+        keyBindMap.put(NEW_MASTERSTHESIS, "ctrl shift M");
+        keyBindMap.put(NEW_PROCEEDINGS, "ctrl shift P");
+        keyBindMap.put(NEW_UNPUBLISHED, "ctrl shift U");
+        keyBindMap.put(EDIT_STRINGS, "ctrl T");
+        keyBindMap.put(EDIT_PREAMBLE, "ctrl P");
+        keyBindMap.put(SELECT_ALL, "ctrl A");
+        keyBindMap.put(TOGGLE_GROUPS_INTERFACE, "ctrl shift G");
+        keyBindMap.put(AUTOGENERATE_BIB_TE_X_KEYS, "ctrl G");
+        keyBindMap.put(SEARCH, "ctrl F");
+        keyBindMap.put(INCREMENTAL_SEARCH, "ctrl shift F");
+        keyBindMap.put(REPEAT_INCREMENTAL_SEARCH, "ctrl shift F");
+        keyBindMap.put(CLOSE_DIALOG, "ESCAPE");
+        keyBindMap.put(CLOSE_ENTRY_EDITOR, "ESCAPE");
+        keyBindMap.put(CLOSE_PREAMBLE_EDITOR, "ESCAPE");
+        keyBindMap.put(BACK_HELP_DIALOG, "LEFT");
+        keyBindMap.put(FORWARD_HELP_DIALOG, "RIGHT");
+        keyBindMap.put(PREAMBLE_EDITOR_STORE_CHANGES, "alt S");
+        keyBindMap.put(CLEAR_SEARCH, "ESCAPE");
+        keyBindMap.put(ENTRY_EDITOR_NEXT_PANEL, "ctrl TAB");//"ctrl PLUS");//"shift Right");
+        keyBindMap.put(ENTRY_EDITOR_PREVIOUS_PANEL, "ctrl shift TAB");//"ctrl MINUS");
+        keyBindMap.put(ENTRY_EDITOR_NEXT_PANEL_2, "ctrl PLUS");//"ctrl PLUS");//"shift Right");
+        keyBindMap.put(ENTRY_EDITOR_PREVIOUS_PANEL_2, "ctrl MINUS");//"ctrl MINUS");
+        keyBindMap.put(ENTRY_EDITOR_NEXT_ENTRY, "ctrl shift DOWN");
+        keyBindMap.put(ENTRY_EDITOR_PREVIOUS_ENTRY, "ctrl shift UP");
+        keyBindMap.put(ENTRY_EDITOR_STORE_FIELD, "alt S");
+        keyBindMap.put(STRING_DIALOG_ADD_STRING, "ctrl N");
+        keyBindMap.put(STRING_DIALOG_REMOVE_STRING, "shift DELETE");
+        keyBindMap.put(STRING_DIALOG_MOVE_STRING_UP, "ctrl UP");
+        keyBindMap.put(STRING_DIALOG_MOVE_STRING_DOWN, "ctrl DOWN");
+        keyBindMap.put(SAVE_SESSION, "F11");
+        keyBindMap.put(LOAD_SESSION, "F12");
+        keyBindMap.put(COPY_CITE_BIB_TE_X_KEY, "ctrl K");
+        keyBindMap.put(COPY_BIB_TE_X_KEY, "ctrl shift K");
+        keyBindMap.put(COPY_BIB_TE_X_KEY_AND_TITLE, "ctrl shift alt K");
+        keyBindMap.put(NEXT_TAB, "ctrl PAGE_DOWN");
+        keyBindMap.put(PREVIOUS_TAB, "ctrl PAGE_UP");
+        keyBindMap.put(REPLACE_STRING, "ctrl R");
+        keyBindMap.put(DELETE, "DELETE");
+        keyBindMap.put(OPEN_FILE, "F4");
+        keyBindMap.put(OPEN_FOLDER, "ctrl shift O");
+        keyBindMap.put(OPEN_PDF_OR_PS, "shift F5");
+        keyBindMap.put(OPEN_URL_OR_DOI, "F3");
+        keyBindMap.put(OPEN_SPIRES_ENTRY, "ctrl F3");
+        keyBindMap.put(TOGGLE_ENTRY_PREVIEW, "ctrl F9");
+        keyBindMap.put(SWITCH_PREVIEW_LAYOUT, "F9");
+        keyBindMap.put(EDIT_ENTRY, "ctrl E");
+        keyBindMap.put(MARK_ENTRIES, "ctrl M");
+        keyBindMap.put(UNMARK_ENTRIES, "ctrl shift M");
+        keyBindMap.put(FETCH_MEDLINE, "F5");
+        keyBindMap.put(SEARCH_SCIENCE_DIRECT, "ctrl F5");
+        keyBindMap.put(SEARCH_ADS, "ctrl shift F6");
+        keyBindMap.put(NEW_FROM_PLAIN_TEXT, "ctrl shift N");
+        keyBindMap.put(SYNCHRONIZE_FILES, "ctrl F4");
+        keyBindMap.put(SYNCHRONIZE_PDF, "shift F4");
+        keyBindMap.put(SYNCHRONIZE_PS, "ctrl shift F4");
+        keyBindMap.put(FOCUS_ENTRY_TABLE, "ctrl shift E");
+        keyBindMap.put(ABBREVIATE, "ctrl alt A");
+        keyBindMap.put(UNABBREVIATE, "ctrl alt shift A");
+        keyBindMap.put(SEARCH_IEEE_XPLORE, "alt F8");
+        keyBindMap.put(SEARCH_ACM_PORTAL, "ctrl shift F8");
+        keyBindMap.put(FETCH_AR_XIV_ORG, "shift F8");
+        keyBindMap.put(SEARCH_JSTOR, "shift F9");
+        keyBindMap.put(CLEANUP, "ctrl shift F7");
+        keyBindMap.put(WRITE_XMP, "ctrl F7");
+        keyBindMap.put(NEW_FILE_LINK, "ctrl N");
+        keyBindMap.put(FETCH_SPIRES, "ctrl F8");
+        keyBindMap.put(FETCH_INSPIRE, "ctrl F2");
+        keyBindMap.put(BACK, "alt LEFT");
+        keyBindMap.put(FORWARD, "alt RIGHT");
+        keyBindMap.put(IMPORT_INTO_CURRENT_DATABASE, "ctrl I");
+        keyBindMap.put(IMPORT_INTO_NEW_DATABASE, "ctrl alt I");
+        keyBindMap.put(FindUnlinkedFilesDialog.ACTION_KEYBINDING_ACTION, "shift F7");
+        keyBindMap.put(INCREASE_TABLE_FONT_SIZE, "ctrl PLUS");
+        keyBindMap.put(DECREASE_TABLE_FONT_SIZE, "ctrl MINUS");
+        keyBindMap.put(AUTOMATICALLY_LINK_FILES, "alt F");
+        keyBindMap.put(RESOLVE_DUPLICATE_BIB_TE_X_KEYS, "ctrl shift D");
+        keyBindMap.put(REFRESH_OO, "ctrl alt O");
+        keyBindMap.put(FILE_LIST_EDITOR_MOVE_ENTRY_UP, "ctrl UP");
+        keyBindMap.put(FILE_LIST_EDITOR_MOVE_ENTRY_DOWN, "ctrl DOWN");
+        keyBindMap.put(MINIMIZE_TO_SYSTEM_TRAY, "ctrl alt W");
+        keyBindMap.put(HIDE_SHOW_TOOLBAR, "ctrl alt T");
+    }
+
+    public String get(String key) {
+        return keyBindMap.get(key);
+    }
+
+    public HashMap<String, String> getKeyBindings() {
+        return new HashMap<String, String>(Collections.unmodifiableMap(keyBindMap));
+    }
+
+    public void overwriteBindings(Map<String, String> newBindings) {
+        keyBindMap.clear();
+        keyBindMap.putAll(newBindings);
+    }
+
+    public void put(String key, String value) {
+        keyBindMap.put(key, value);
+    }
+
+}
diff --git a/src/test/java/net/sf/jabref/JabRefCLITest.java b/src/test/java/net/sf/jabref/JabRefCLITest.java
@@ -30,4 +30,13 @@ public void testCLIParsingShortOptions() {
         Assert.assertEquals("some/export/file", cli.getFileExport());
     }
 
+    @Test
+    public void testPreferencesExport() {
+        JabRefCLI cli = new JabRefCLI(new String[] {"-n", "-x=some/file"});
+
+        Assert.assertEquals("[]", Arrays.toString(cli.getLeftOver()));
+        Assert.assertEquals("some/file", cli.getPreferencesExport());
+        Assert.assertTrue(cli.isDisableGui());
+    }
+
 }
diff --git a/src/test/java/net/sf/jabref/JabRefPreferencesTest.java b/src/test/java/net/sf/jabref/JabRefPreferencesTest.java
@@ -0,0 +1,37 @@
+package net.sf.jabref;
+
+import static org.junit.Assert.assertEquals;
+
+import java.io.File;
+import java.io.IOException;
+
+import org.junit.Before;
+import org.junit.Test;
+
+public class JabRefPreferencesTest {
+
+    private JabRefPreferences prefs;
+
+
+    @Before
+    public void setUp() {
+        prefs = JabRefPreferences.getInstance();
+    }
+
+    @Test
+    public void testPreferencesImport() throws IOException {
+        // the primary sort field has been changed to "editor" in this case
+        File importFile = new File("src/test/resources/net/sf/jabref/customPreferences.xml");
+
+        prefs.importPreferences(importFile.getAbsolutePath());
+
+        String expected = "editor";
+        String actual = prefs.get(JabRefPreferences.SAVE_PRIMARY_SORT_FIELD);
+        
+        //clean up preferences to default state
+        prefs.put(JabRefPreferences.SAVE_PRIMARY_SORT_FIELD, "author");
+
+        assertEquals(expected, actual);
+    }
+
+}
diff --git a/src/test/resources/net/sf/jabref/customPreferences.xml b/src/test/resources/net/sf/jabref/customPreferences.xml

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`[master]`
	`2`	`+ - Refactored preferences`
`2`	`3`	`- Remove local jgoodies dependency: replace SimpleInteralFrame with swingx JXTitledPanel and UIFSplitPane by JSplitPane`
`3`	`4`	`- Fix several FindBugs warnings`
`4`	`5`	`- Fix for bug #1276: OO styles do not consider editor fields anymore for sorting`
Original file line number	Diff line number	Diff line change
`@@ -30,4 +30,13 @@ public void testCLIParsingShortOptions() {`
`30`	`30`	`Assert.assertEquals("some/export/file", cli.getFileExport());`
`31`	`31`	`}`
`32`	`32`
	`33`	`+ @Test`
	`34`	`+ public void testPreferencesExport() {`
	`35`	`+ JabRefCLI cli = new JabRefCLI(new String[] {"-n", "-x=some/file"});`
	`36`	`+`
	`37`	`+ Assert.assertEquals("[]", Arrays.toString(cli.getLeftOver()));`
	`38`	`+ Assert.assertEquals("some/file", cli.getPreferencesExport());`
	`39`	`+ Assert.assertTrue(cli.isDisableGui());`
	`40`	`+ }`
	`41`	`+`
`33`	`42`	`}`