@Test
public void roundtripWithContentSelectorsAndUmlauts() throws IOException, SaveException {
String fileContent =
"% Encoding: UTF-8"
+ OS.NEWLINE
+ OS.NEWLINE
+ "@Comment{jabref-meta: selector_journal:Test {\\\\\"U}mlaut;}"
+ OS.NEWLINE;
Charset encoding = StandardCharsets.UTF_8;
ParserResult firstParse =
new BibtexParser(importFormatPreferences).parse(new StringReader(fileContent));
SavePreferences preferences =
new SavePreferences().withEncoding(encoding).withSaveInOriginalOrder(true);
BibDatabaseContext context =
new BibDatabaseContext(
firstParse.getDatabase(),
firstParse.getMetaData(),
new Defaults(BibDatabaseMode.BIBTEX));
StringSaveSession session =
databaseWriter.savePartOfDatabase(
context, firstParse.getDatabase().getEntries(), preferences);
assertEquals(fileContent, session.getStringValue());
}
@Test
public void reformatEntryIfAskedToDoSo() throws Exception {
BibEntry entry = new BibEntry();
entry.setType(BibtexEntryTypes.ARTICLE);
entry.setField("author", "Mr. author");
entry.setParsedSerialization("wrong serialization");
entry.setChanged(false);
database.insertEntry(entry);
SavePreferences preferences = new SavePreferences().withReformatFile(true);
StringSaveSession session =
databaseWriter.savePartOfDatabase(
bibtexContext, Collections.singletonList(entry), preferences);
assertEquals(
OS.NEWLINE
+ "@Article{,"
+ OS.NEWLINE
+ " author = {Mr. author},"
+ OS.NEWLINE
+ "}"
+ OS.NEWLINE
+ OS.NEWLINE
+ "@Comment{jabref-meta: databaseType:bibtex;}"
+ OS.NEWLINE,
session.getStringValue());
}
@Test
public void roundtripWithUserCommentAndEntryChange() throws Exception {
Path testBibtexFile = Paths.get("src/test/resources/testbib/bibWithUserComments.bib");
Charset encoding = StandardCharsets.UTF_8;
ParserResult result =
new BibtexParser(importFormatPreferences)
.parse(Importer.getReader(testBibtexFile, encoding));
BibEntry entry = result.getDatabase().getEntryByKey("1137631").get();
entry.setField("author", "Mr. Author");
SavePreferences preferences =
new SavePreferences().withEncoding(encoding).withSaveInOriginalOrder(true);
BibDatabaseContext context =
new BibDatabaseContext(
result.getDatabase(), result.getMetaData(), new Defaults(BibDatabaseMode.BIBTEX));
StringSaveSession session =
databaseWriter.savePartOfDatabase(context, result.getDatabase().getEntries(), preferences);
try (Scanner scanner =
new Scanner(
Paths.get("src/test/resources/testbib/bibWithUserCommentAndEntryChange.bib"),
encoding.name())) {
assertEquals(scanner.useDelimiter("\\A").next(), session.getStringValue());
}
}
@Test
public void roundtripWithUserCommentBeforeStringAndChange() throws Exception {
Path testBibtexFile = Paths.get("src/test/resources/testbib/complex.bib");
Charset encoding = StandardCharsets.UTF_8;
ParserResult result =
new BibtexParser(importFormatPreferences)
.parse(Importer.getReader(testBibtexFile, encoding));
for (BibtexString string : result.getDatabase().getStringValues()) {
// Mark them as changed
string.setContent(string.getContent());
}
SavePreferences preferences =
new SavePreferences().withEncoding(encoding).withSaveInOriginalOrder(true);
BibDatabaseContext context =
new BibDatabaseContext(
result.getDatabase(), result.getMetaData(), new Defaults(BibDatabaseMode.BIBTEX));
StringSaveSession session =
databaseWriter.savePartOfDatabase(context, result.getDatabase().getEntries(), preferences);
try (Scanner scanner = new Scanner(testBibtexFile, encoding.name())) {
assertEquals(scanner.useDelimiter("\\A").next(), session.getStringValue());
}
}
@Test
public void writeGroupsAndEncoding() throws Exception {
SavePreferences preferences = new SavePreferences().withEncoding(Charsets.US_ASCII);
GroupTreeNode groupRoot = GroupTreeNode.fromGroup(new AllEntriesGroup(""));
groupRoot.addChild(
GroupTreeNode.fromGroup(new ExplicitGroup("test", GroupHierarchyType.INCLUDING, ',')));
metaData.setGroups(groupRoot);
StringSaveSession session =
databaseWriter.savePartOfDatabase(bibtexContext, Collections.emptyList(), preferences);
// @formatter:off
assertEquals(
"% Encoding: US-ASCII"
+ OS.NEWLINE
+ OS.NEWLINE
+ "@Comment{jabref-meta: groupstree:"
+ OS.NEWLINE
+ "0 AllEntriesGroup:;"
+ OS.NEWLINE
+ "1 ExplicitGroup:test\\;2\\;;"
+ OS.NEWLINE
+ "}"
+ OS.NEWLINE,
session.getStringValue());
// @formatter:on
}
@Test
public void writeEntryWithCustomizedTypeAlsoWritesTypeDeclaration() throws Exception {
try {
EntryTypes.addOrModifyCustomEntryType(
new CustomEntryType("customizedType", "required", "optional"), BibDatabaseMode.BIBTEX);
BibEntry entry = new BibEntry();
entry.setType("customizedType");
database.insertEntry(entry);
StringSaveSession session =
databaseWriter.savePartOfDatabase(
bibtexContext, Collections.singletonList(entry), new SavePreferences());
assertEquals(
OS.NEWLINE
+ "@Customizedtype{,"
+ OS.NEWLINE
+ "}"
+ OS.NEWLINE
+ OS.NEWLINE
+ "@Comment{jabref-meta: databaseType:bibtex;}"
+ OS.NEWLINE
+ OS.NEWLINE
+ "@Comment{jabref-entrytype: Customizedtype: req[required] opt[optional]}"
+ OS.NEWLINE,
session.getStringValue());
} finally {
EntryTypes.removeAllCustomEntryTypes();
}
}
@Test
public void writeEntriesInOriginalOrderWhenNoSaveOrderConfigIsSetInMetadata() throws Exception {
BibEntry firstEntry = new BibEntry();
firstEntry.setType(BibtexEntryTypes.ARTICLE);
firstEntry.setField("author", "A");
firstEntry.setField("year", "2010");
BibEntry secondEntry = new BibEntry();
secondEntry.setType(BibtexEntryTypes.ARTICLE);
secondEntry.setField("author", "B");
secondEntry.setField("year", "2000");
BibEntry thirdEntry = new BibEntry();
thirdEntry.setType(BibtexEntryTypes.ARTICLE);
thirdEntry.setField("author", "A");
thirdEntry.setField("year", "2000");
database.insertEntry(firstEntry);
database.insertEntry(secondEntry);
database.insertEntry(thirdEntry);
SavePreferences preferences = new SavePreferences().withSaveInOriginalOrder(false);
StringSaveSession session =
databaseWriter.savePartOfDatabase(bibtexContext, database.getEntries(), preferences);
assertEquals(
OS.NEWLINE
+ "@Article{,"
+ OS.NEWLINE
+ " author = {A},"
+ OS.NEWLINE
+ " year = {2010},"
+ OS.NEWLINE
+ "}"
+ OS.NEWLINE
+ OS.NEWLINE
+ "@Article{,"
+ OS.NEWLINE
+ " author = {B},"
+ OS.NEWLINE
+ " year = {2000},"
+ OS.NEWLINE
+ "}"
+ OS.NEWLINE
+ OS.NEWLINE
+ "@Article{,"
+ OS.NEWLINE
+ " author = {A},"
+ OS.NEWLINE
+ " year = {2000},"
+ OS.NEWLINE
+ "}"
+ OS.NEWLINE
+ OS.NEWLINE
+ "@Comment{jabref-meta: databaseType:bibtex;}"
+ OS.NEWLINE,
session.getStringValue());
}
@Test
public void writeEncoding() throws Exception {
SavePreferences preferences = new SavePreferences().withEncoding(Charsets.US_ASCII);
StringSaveSession session =
databaseWriter.savePartOfDatabase(bibtexContext, Collections.emptyList(), preferences);
assertEquals("% Encoding: US-ASCII" + OS.NEWLINE, session.getStringValue());
}
@Test
public void writeString() throws Exception {
database.addString(new BibtexString("id", "name", "content"));
StringSaveSession session =
databaseWriter.savePartOfDatabase(
bibtexContext, Collections.emptyList(), new SavePreferences());
assertEquals(OS.NEWLINE + "@String{name = {content}}" + OS.NEWLINE, session.getStringValue());
}
@Test
public void writePreamble() throws Exception {
database.setPreamble("Test preamble");
StringSaveSession session =
databaseWriter.savePartOfDatabase(
bibtexContext, Collections.emptyList(), new SavePreferences());
assertEquals(OS.NEWLINE + "@Preamble{Test preamble}" + OS.NEWLINE, session.getStringValue());
}
@Test
public void writeSavedSerializationOfStringIfUnchanged() throws Exception {
BibtexString string = new BibtexString("id", "name", "content");
string.setParsedSerialization("serialization");
database.addString(string);
StringSaveSession session =
databaseWriter.savePartOfDatabase(
bibtexContext, Collections.emptyList(), new SavePreferences());
assertEquals("serialization", session.getStringValue());
}
@Test
public void writeStringAndEncoding() throws Exception {
SavePreferences preferences = new SavePreferences().withEncoding(Charsets.US_ASCII);
database.addString(new BibtexString("id", "name", "content"));
StringSaveSession session =
databaseWriter.savePartOfDatabase(bibtexContext, Collections.emptyList(), preferences);
assertEquals(
"% Encoding: US-ASCII" + OS.NEWLINE + OS.NEWLINE + "@String{name = {content}}" + OS.NEWLINE,
session.getStringValue());
}
@Test
public void reformatStringIfAskedToDoSo() throws Exception {
BibtexString string = new BibtexString("id", "name", "content");
string.setParsedSerialization("wrong serialization");
database.addString(string);
SavePreferences preferences = new SavePreferences().withReformatFile(true);
StringSaveSession session =
databaseWriter.savePartOfDatabase(bibtexContext, Collections.emptyList(), preferences);
assertEquals(OS.NEWLINE + "@String{name = {content}}" + OS.NEWLINE, session.getStringValue());
}
@Test
public void writeProtectedFlag() throws Exception {
metaData.markAsProtected();
StringSaveSession session =
databaseWriter.savePartOfDatabase(
bibtexContext, Collections.emptyList(), new SavePreferences());
assertEquals(
OS.NEWLINE + "@Comment{jabref-meta: protectedFlag:true;}" + OS.NEWLINE,
session.getStringValue());
}
@Test
public void writeBiblatexMode() throws Exception {
metaData.setMode(BibDatabaseMode.BIBLATEX);
StringSaveSession session =
databaseWriter.savePartOfDatabase(
bibtexContext, Collections.emptyList(), new SavePreferences());
assertEquals(
OS.NEWLINE + "@Comment{jabref-meta: databaseType:biblatex;}" + OS.NEWLINE,
session.getStringValue());
}
@Test
public void writeMetadata() throws Exception {
DatabaseBibtexKeyPattern bibtexKeyPattern = new DatabaseBibtexKeyPattern(prefs.getKeyPattern());
bibtexKeyPattern.setDefaultValue("test");
metaData.setCiteKeyPattern(bibtexKeyPattern);
StringSaveSession session =
databaseWriter.savePartOfDatabase(
bibtexContext, Collections.emptyList(), new SavePreferences());
assertEquals(
OS.NEWLINE + "@Comment{jabref-meta: keypatterndefault:test;}" + OS.NEWLINE,
session.getStringValue());
}
@Test
public void writeMetadataAndEncoding() throws Exception {
SavePreferences preferences = new SavePreferences().withEncoding(Charsets.US_ASCII);
DatabaseBibtexKeyPattern bibtexKeyPattern = new DatabaseBibtexKeyPattern(prefs.getKeyPattern());
bibtexKeyPattern.setDefaultValue("test");
metaData.setCiteKeyPattern(bibtexKeyPattern);
StringSaveSession session =
databaseWriter.savePartOfDatabase(bibtexContext, Collections.emptyList(), preferences);
assertEquals(
"% Encoding: US-ASCII"
+ OS.NEWLINE
+ OS.NEWLINE
+ "@Comment{jabref-meta: keypatterndefault:test;}"
+ OS.NEWLINE,
session.getStringValue());
}
@Test
public void writeFileDirectories() throws Exception {
metaData.setDefaultFileDirectory("\\Literature\\");
metaData.setUserFileDirectory("defaultOwner-user", "D:\\Documents");
StringSaveSession session =
databaseWriter.savePartOfDatabase(
bibtexContext, Collections.emptyList(), new SavePreferences());
assertEquals(
OS.NEWLINE
+ "@Comment{jabref-meta: fileDirectory:\\\\Literature\\\\;}"
+ OS.NEWLINE
+ OS.NEWLINE
+ "@Comment{jabref-meta: fileDirectory-defaultOwner-user:D:\\\\Documents;}"
+ OS.NEWLINE,
session.getStringValue());
}
@Test
public void writeSavedSerializationOfEntryIfUnchanged() throws Exception {
BibEntry entry = new BibEntry();
entry.setType(BibtexEntryTypes.ARTICLE);
entry.setField("author", "Mr. author");
entry.setParsedSerialization("presaved serialization");
entry.setChanged(false);
database.insertEntry(entry);
StringSaveSession session =
databaseWriter.savePartOfDatabase(
bibtexContext, Collections.singletonList(entry), new SavePreferences());
assertEquals(
"presaved serialization"
+ OS.NEWLINE
+ "@Comment{jabref-meta: databaseType:bibtex;}"
+ OS.NEWLINE,
session.getStringValue());
}
@Test
public void writeSaveOrderConfig() throws Exception {
SaveOrderConfig saveOrderConfig =
new SaveOrderConfig(
false,
new SaveOrderConfig.SortCriterion("author", false),
new SaveOrderConfig.SortCriterion("year", true),
new SaveOrderConfig.SortCriterion("abstract", false));
metaData.setSaveOrderConfig(saveOrderConfig);
StringSaveSession session =
databaseWriter.savePartOfDatabase(
bibtexContext, Collections.emptyList(), new SavePreferences());
assertEquals(
OS.NEWLINE
+ "@Comment{jabref-meta: saveOrderConfig:specified;author;false;year;true;abstract;false;}"
+ OS.NEWLINE,
session.getStringValue());
}
@Test
public void writeEntry() throws Exception {
BibEntry entry = new BibEntry();
entry.setType(BibtexEntryTypes.ARTICLE);
database.insertEntry(entry);
StringSaveSession session =
databaseWriter.savePartOfDatabase(
bibtexContext, Collections.singletonList(entry), new SavePreferences());
assertEquals(
OS.NEWLINE
+ "@Article{,"
+ OS.NEWLINE
+ "}"
+ OS.NEWLINE
+ OS.NEWLINE
+ "@Comment{jabref-meta: databaseType:bibtex;}"
+ OS.NEWLINE,
session.getStringValue());
}
@Test
public void writeSaveActions() throws Exception {
FieldFormatterCleanups saveActions =
new FieldFormatterCleanups(
true,
Collections.singletonList(
new FieldFormatterCleanup("title", new LowerCaseFormatter())));
metaData.setSaveActions(saveActions);
StringSaveSession session =
databaseWriter.savePartOfDatabase(
bibtexContext, Collections.emptyList(), new SavePreferences());
assertEquals(
OS.NEWLINE
+ "@Comment{jabref-meta: saveActions:enabled;"
+ OS.NEWLINE
+ "title[lower_case]"
+ OS.NEWLINE
+ ";}"
+ OS.NEWLINE,
session.getStringValue());
}
@Test(expected = NullPointerException.class)
public void writeWithNullPreferencesThrowsException() throws Exception {
databaseWriter.savePartOfDatabase(bibtexContext, Collections.emptyList(), null);
}
@Test(expected = NullPointerException.class)
public void writeWithNullEntriesThrowsException() throws Exception {
databaseWriter.savePartOfDatabase(bibtexContext, null, new SavePreferences());
}
@Test
public void writeEntriesSorted() throws Exception {
SaveOrderConfig saveOrderConfig =
new SaveOrderConfig(
false,
new SaveOrderConfig.SortCriterion("author", false),
new SaveOrderConfig.SortCriterion("year", true),
new SaveOrderConfig.SortCriterion("abstract", false));
metaData.setSaveOrderConfig(saveOrderConfig);
BibEntry firstEntry = new BibEntry();
firstEntry.setType(BibtexEntryTypes.ARTICLE);
firstEntry.setField("author", "A");
firstEntry.setField("year", "2000");
BibEntry secondEntry = new BibEntry();
secondEntry.setType(BibtexEntryTypes.ARTICLE);
secondEntry.setField("author", "A");
secondEntry.setField("year", "2010");
BibEntry thirdEntry = new BibEntry();
thirdEntry.setType(BibtexEntryTypes.ARTICLE);
thirdEntry.setField("author", "B");
thirdEntry.setField("year", "2000");
database.insertEntry(secondEntry);
database.insertEntry(thirdEntry);
database.insertEntry(firstEntry);
StringSaveSession session =
databaseWriter.savePartOfDatabase(
bibtexContext, database.getEntries(), new SavePreferences());
assertEquals(
OS.NEWLINE
+ "@Article{,"
+ OS.NEWLINE
+ " author = {A},"
+ OS.NEWLINE
+ " year = {2000},"
+ OS.NEWLINE
+ "}"
+ OS.NEWLINE
+ OS.NEWLINE
+ "@Article{,"
+ OS.NEWLINE
+ " author = {A},"
+ OS.NEWLINE
+ " year = {2010},"
+ OS.NEWLINE
+ "}"
+ OS.NEWLINE
+ OS.NEWLINE
+ "@Article{,"
+ OS.NEWLINE
+ " author = {B},"
+ OS.NEWLINE
+ " year = {2000},"
+ OS.NEWLINE
+ "}"
+ OS.NEWLINE
+ OS.NEWLINE
+ "@Comment{jabref-meta: databaseType:bibtex;}"
+ OS.NEWLINE
+ OS.NEWLINE
+ "@Comment{jabref-meta: saveOrderConfig:specified;author;false;year;true;abstract;false;}"
+ OS.NEWLINE,
session.getStringValue());
}
