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.

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 6 commits into
base: main
Choose a base branch
from

Conversation

leaf-soba
Copy link
Contributor

Mandatory checks

  • I own the copyright of the code submitted and I licence it under the MIT license
  • Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
  • Tests created for changes (if applicable)
  • Manually tested changed features in running JabRef (always required)
  • Screenshots added in PR description (for UI changes)
  • Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
  • Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

@leaf-soba leaf-soba marked this pull request as draft November 4, 2024 08:34
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.

fix logic check string contains a valid json
@leaf-soba leaf-soba marked this pull request as ready for review November 4, 2024 08:52
Copy link
Member

@koppor koppor left a comment

Choose a reason for hiding this comment

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

Please do differently.

I highlighted the idea using the diff:

image

Check for jabref-meta-0.1.0string at the beginning of the comment. Then remove that line. The remainder of the comment is the complete JSON.

Do NOT read the JSON as BibEntry. It is NOT a BibEntry. It is META data for JabRef. E.g., preferences etc.

Background: JabRef displys BibEntrys in the main table - and settings in dialog. We do not render settings in the main table.

@koppor koppor added the status: changes required Pull requests that are not yet complete label Nov 4, 2024
Comment on lines 408 to 409
} catch (
JsonSyntaxException e) {
Copy link
Member

Choose a reason for hiding this comment

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

Checkstyle is somewhat broken, please reduce to one line.

1. read json as metadata
2. small refactor to remove a not in use `LOGGER` in `MetaData`
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

JUnit tests are failing. In the area "Some checks were not successful", locate "Tests / Unit tests (pull_request)" and click on "Details". This brings you to the test output.

You can then run these tests in IntelliJ to reproduce the failing tests locally. We offer a quick test running howto in the section Final build system checks in our setup guide.

@leaf-soba leaf-soba requested a review from koppor November 6, 2024 00:56
@@ -339,7 +342,7 @@ private void parseAndAddEntry(String type) {
}
}

private void parseJabRefComment(Map<String, String> meta) {
void parseJabRefComment(Map<String, String> meta) {
Copy link
Member

Choose a reason for hiding this comment

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

This needs @VisibileForTesting?

}
}

private void parseCommentToJson(String comment, Map<String, String> meta) {
Copy link
Member

Choose a reason for hiding this comment

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

No - it should return the JSOn object.

The following call should be rewritten:

            MetaData metaData = metaDataParser.parse(
                    meta,
                    importFormatPreferences.bibEntryPreferences().getKeywordSeparator());

meta should be a record of

  • Map<String, String> v5metaData
  • JsonObject v6metaData

And then be handled accordingliny in org.jabref.logic.importer.fileformat.BibtexParser#metaDataParser.


@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_010 = "jabref-meta-0.1.0";
Copy link
Member

Choose a reason for hiding this comment

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

Include the string Version in the constant name:

Suggested change
public static final String META_FLAG_010 = "jabref-meta-0.1.0";
public static final String META_FLAG_VERSION_010 = "jabref-meta-0.1.0";

rewrite metaDataParser.parse
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.

fix wrong input
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: changes required Pull requests that are not yet complete
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants