Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a new parseJabRefComment with unit test #12145

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Add a new parseJabRefComment with unit test #12145

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
56c1bef
add a new parseJabRefComment
leaf-soba Nov 4, 2024
b2646ae
fix logic check string contains a valid json
leaf-soba Nov 4, 2024
e12e655
read json as metadata
leaf-soba Nov 5, 2024
465d6cf
Merge branch 'main' into close-issue-10371
leaf-soba Nov 11, 2024
830e7e6
rewrite metaDataParser.parse
leaf-soba Nov 14, 2024
065a784
fix wrong input
leaf-soba Nov 15, 2024
3c4ee8f
follow the review fix code
leaf-soba Nov 20, 2024
fb161cf
fix the unittest to keep the PR small
leaf-soba Nov 28, 2024
ae98cdc
remove MetaData.parse
leaf-soba Nov 28, 2024
9cc8bbc
fix the unit test with a simple json
leaf-soba Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions src/main/java/org/jabref/logic/importer/fileformat/BibtexParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@
import com.dd.plist.BinaryPropertyListParser;
import com.dd.plist.NSDictionary;
import com.dd.plist.NSString;
import com.google.common.annotations.VisibleForTesting;
import com.google.gson.Gson;
import com.google.gson.JsonObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
Expand Down Expand Up @@ -354,8 +357,8 @@ private void parseJabRefComment(Map<String, String> meta) {
// We remove all line breaks in the metadata
// These have been inserted to prevent too long lines when the file was saved, and are not part of the data.
String comment = buffer.toString().replaceAll("[\\x0d\\x0a]", "");
if (comment.substring(0, Math.min(comment.length(), MetaData.META_FLAG.length())).equals(MetaData.META_FLAG)) {
if (comment.startsWith(MetaData.META_FLAG)) {

if (comment.startsWith(MetaData.META_FLAG)) {
String rest = comment.substring(MetaData.META_FLAG.length());

int pos = rest.indexOf(':');
Expand All @@ -366,9 +369,7 @@ private void parseJabRefComment(Map<String, String> meta) {
// meta comments are always re-written by JabRef and not stored in the file
dumpTextReadSoFarToString();
}
}
} else if (comment.substring(0, Math.min(comment.length(), MetaData.ENTRYTYPE_FLAG.length()))
.equals(MetaData.ENTRYTYPE_FLAG)) {
} else if (comment.startsWith(MetaData.ENTRYTYPE_FLAG)) {
// A custom entry type can also be stored in a
// "@comment"
Optional<BibEntryType> typ = MetaDataParser.parseCustomEntryType(comment);
Expand All @@ -389,6 +390,13 @@ private void parseJabRefComment(Map<String, String> meta) {
}
}

@VisibleForTesting
Optional<JsonObject> parseCommentToJson(String comment) {
String content = comment.substring(comment.indexOf(MetaData.META_FLAG_VERSION_010) + MetaData.META_FLAG_VERSION_010.length());
Gson gson = new Gson();
return Optional.ofNullable(gson.fromJson(content, JsonObject.class));
}

/**
* Adds BibDesk group entries to the JabRef database
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/jabref/logic/importer/util/MetaDataParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ public static Optional<BibEntryType> parseCustomEntryType(String comment) {
public MetaData parse(Map<String, String> data, Character keywordSeparator) throws ParseException {
return parse(new MetaData(), data, keywordSeparator);
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No additional spaces pleace

/**
* Parses the data map and changes the given {@link MetaData} instance respectively.
*
Expand Down
5 changes: 1 addition & 4 deletions src/main/java/org/jabref/model/metadata/MetaData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,12 @@
import com.google.common.eventbus.EventBus;
import com.tobiasdiez.easybind.optional.OptionalBinding;
import com.tobiasdiez.easybind.optional.OptionalWrapper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@AllowedToUseLogic("because it needs access to citation pattern and cleanups")
public class MetaData {

public static final String META_FLAG = "jabref-meta: ";
public static final String META_FLAG_VERSION_010 = "jabref-meta-0.1.0";
public static final String ENTRYTYPE_FLAG = "jabref-entrytype: ";
public static final String SAVE_ORDER_CONFIG = "saveOrderConfig"; // ToDo: Rename in next major version to saveOrder, adapt testbibs
public static final String SAVE_ACTIONS = "saveActions";
Expand All @@ -58,8 +57,6 @@ public class MetaData {
public static final char SEPARATOR_CHARACTER = ';';
public static final String SEPARATOR_STRING = String.valueOf(SEPARATOR_CHARACTER);

private static final Logger LOGGER = LoggerFactory.getLogger(MetaData.class);

private final EventBus eventBus = new EventBus();
private final Map<EntryType, String> citeKeyPatterns = new HashMap<>(); // <BibType, Pattern>
private final Map<String, String> userFileDirectory = new HashMap<>(); // <User, FilePath>
Expand Down
40 changes: 40 additions & 0 deletions src/test/java/org/jabref/logic/importer/fileformat/BibtexParserTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@
import org.jabref.model.groups.WordKeywordGroup;
import org.jabref.model.metadata.SaveOrder;

import com.google.gson.JsonArray;
import com.google.gson.JsonObject;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
Expand Down Expand Up @@ -2238,4 +2240,42 @@ void parseInvalidBibDeskFilesResultsInWarnings() throws IOException {

assertEquals(List.of(firstEntry, secondEntry), result.getDatabase().getEntries());
}

@Test
void parseCommentToJson() {
String entries =
"""
@Comment{jabref-meta-0.1.0
{
"saveActions" :
{
"state": true,
"date": ["normalize_date", "action2"],
"pages" : ["normalize_page_numbers"],
"month" : ["normalize_month"]
}
}
""";
BibtexParser parser = new BibtexParser(importFormatPreferences);
Optional<JsonObject> actualJson = parser.parseCommentToJson(entries);
assertEquals(actualJson, Optional.of(getExpectedJson()));
}

private JsonObject getExpectedJson() {
JsonObject saveActions = new JsonObject();
saveActions.addProperty("state", true);
JsonArray dateArray = new JsonArray();
dateArray.add("normalize_date");
dateArray.add("action2");
saveActions.add("date", dateArray);
JsonArray pagesArray = new JsonArray();
pagesArray.add("normalize_page_numbers");
saveActions.add("pages", pagesArray);
JsonArray monthArray = new JsonArray();
monthArray.add("normalize_month");
saveActions.add("month", monthArray);
JsonObject expectedJson = new JsonObject();
expectedJson.add("saveActions", saveActions);
return expectedJson;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reads very ugly.

According to https://stackoverflow.com/a/4696873/873282 it can be easier

Can you try with var?

var expected = new Object() {
...

Another thought: Just simplify the contained object.

you are testing the JSON reading - then put a simple JSON inside. Test one thing in one test :-)

Reason: The searialization of saveActions will probalby changed. Especially state will be called enabled for sure (because state has a different meaning)

Copy link
Contributor Author

@leaf-soba leaf-soba Dec 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried using the var expected = new Object() {} style, but since Gson's JsonObject is declared as final, it throws an exception like Cannot inherit from final 'com.google.gson.JsonObject' when attempting this code:

var expectedJson = new JsonObject() {{
    add("saveActions", new JsonObject() {{
        addProperty("state", true);
    }});
}};

P.S.: I had a bike accident and got injured, but I’ve finally fully recovered. Apologies for disappearing for such a long time!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Im sorry to hear, I hope it wasn't too bad and you are well again. Don't worry about time, better slow and steady instead of rushing things in bad quality and never appearing again.

}
}
Loading