Support for exporting to YAML format #7007

joethei · 2020-10-12T14:35:17Z

Support for exporting to YAML , fixes Alternative serialization format as core data file (e.g. YAML in addition to BibTeX) #6974
Fixed deleteBlankLines parameter in TemplateExporter not working.
Enabled deleteBlankLines for the RIS Exporter, which used to have that enabled.
Change in CHANGELOG.md described (if applicable)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (for UI changes)
Checked documentation: Is the information available and up to date? If not created an issue at https://github.com/JabRef/user-documentation/issues or, even better, submitted a pull request to the documentation repository.

koppor

Looks good. Some nitpicks remaining. The empty line fix should have gone in a separate PR as discussions on regular expressions typically take more time. Let's see if it goes well, here.

Could you also add a test case for the example at #6974? I think, there could be issues at the date export. - Maybe good for a follow-jup PR?

src/main/java/org/jabref/logic/exporter/TemplateExporter.java

koppor · 2020-10-12T20:52:55Z

src/main/java/org/jabref/logic/exporter/TemplateExporter.java

@@ -278,8 +269,12 @@ public void export(final BibDatabaseContext databaseContext, final Path file,
 // Write the entry
 if (layout != null) {
 if (deleteBlankLines) {
- String withoutBlankLines = BLANK_LINE_MATCHER.matcher(layout.doLayout(entry, databaseContext.getDatabase())).replaceAll("");
- ps.write(withoutBlankLines);
+ String[] lines = layout.doLayout(entry, databaseContext.getDatabase()).split("\n");


Double check: Does this work on Windows and Linux equally well? Mayybe OS.NEW_LINE should be used?

The alternative implementation could have been to update the regular expression. I am really not sure why it stopped working.

Interestingly enough when using OS.NEW_LINE on Windows its breaks.
need to do an test on linux though, currently having problems running my vm.

Maybe it should check both? We don't know which line endings the user has in the template files (if modified)

src/main/resources/resource/layout/yaml.layout

src/test/java/org/jabref/logic/exporter/YamlExporterTest.java

Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

koppor · 2020-10-14T09:18:44Z

I see the unit tests failing:

  Test exportCorrectContent(Path) FAILED

  org.opentest4j.AssertionFailedError: expected: <[---, references:, - id: test,   author:,   - literal: "Test Author",   title: "Test Title",   issued: 2020,   url: http://example.com, ---]> but was: <[---, references:, - id: test  author:  - literal: "Test Author"  title: "Test Title"  issued: 2020  url: http://example.com---]>
      at org.jabref.logic.exporter.YamlExporterTest.exportCorrectContent(YamlExporterTest.java:77)

Could you please check what's going wrong there?

joethei · 2020-10-14T09:34:29Z

I see the unit tests failing:

  Test exportCorrectContent(Path) FAILED

  org.opentest4j.AssertionFailedError: expected: <[---, references:, - id: test,   author:,   - literal: "Test Author",   title: "Test Title",   issued: 2020,   url: http://example.com, ---]> but was: <[---, references:, - id: test  author:  - literal: "Test Author"  title: "Test Title"  issued: 2020  url: http://example.com---]>
      at org.jabref.logic.exporter.YamlExporterTest.exportCorrectContent(YamlExporterTest.java:77)

Could you please check what's going wrong there?

I already fixed that issue in my local branch, currently testing the blank line deletion.

fixed blank line removal

calixtus

Got three nitpicks.
Thanks for the good work so far.

CHANGELOG.md

src/main/java/org/jabref/logic/exporter/TemplateExporter.java

wrap comments correctly

…o yaml-exporter

calixtus

LGTM! Thank you!

koppor

Sorry for delay. Hope, you are still in the context. I have some micro comments...

koppor · 2020-10-20T21:19:35Z

src/main/java/org/jabref/logic/exporter/BlankLineBehaviour.java

+package org.jabref.logic.exporter;
+
+/**
+ this enum represents the behaviour for blank lines in {@link TemplateExporter}


Full JavaDoc 😇

Suggested change

this enum represents the behaviour for blank lines in {@link TemplateExporter}

* This enum represents the behaviour for blank lines in {@link TemplateExporter}

koppor · 2020-10-20T21:20:00Z

src/main/java/org/jabref/logic/exporter/TemplateExporter.java

 private static final String LAYOUT_EXTENSION = ".layout";
 private static final String FORMATTERS_EXTENSION = ".formatters";
 private static final String BEGIN_INFIX = ".begin";
 private static final String END_INFIX = ".end";

+


Please do not add two empty lines - I wonder why checkstyle did not complain

koppor · 2020-10-20T21:24:18Z

src/main/java/org/jabref/logic/layout/format/CSLType.java

+ @Override
+ public String format(String value) {
+ Map<String, String> map = Map.of(StandardEntryType.Article.getDisplayName(), "article",
+ StandardEntryType.Book.getDisplayName(), "book",


A simple switch was not possible

return switch(value) { case StandardEntryType.Article.getDisplayName() -> "article", ... case StandardEntryType.Conference.getDisplayName() -> "paper-conference", ... default -> "no-type"; }

koppor · 2020-10-22T01:13:26Z

Thank you for the patience @joethei

joethei and others added 4 commits October 12, 2020 14:48

added support for exporting CSL in YAML format.

6da7c05

added changes in Changelog

4c40d59

Merge branch 'master' into yaml-exporter

9b15386

Update CHANGELOG.md

0482593

joethei marked this pull request as draft October 12, 2020 17:08

remove one trailing space

34545cb

joethei marked this pull request as ready for review October 12, 2020 17:24

koppor requested changes Oct 12, 2020

View reviewed changes

joethei and others added 4 commits October 13, 2020 07:31

Update src/test/java/org/jabref/logic/exporter/YamlExporterTest.java

fd22cba

Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

Update src/test/java/org/jabref/logic/exporter/YamlExporterTest.java

27dce7e

Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

Update src/main/java/org/jabref/logic/exporter/TemplateExporter.java

977bc6e

Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

Merge branch 'master' into yaml-exporter

6a38c66

tobiasdiez mentioned this pull request Oct 13, 2020

Alternative serialization format as core data file (e.g. YAML in addition to BibTeX) #6974

Closed

joethei added 2 commits October 15, 2020 11:18

added conversion from bibtex entrytype to csl type

58eea46

fixed blank line removal

Merge branch 'master' into yaml-exporter

55481e5

Siedlerchr approved these changes Oct 15, 2020

View reviewed changes

Siedlerchr added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Oct 17, 2020

calixtus requested changes Oct 18, 2020

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

src/main/java/org/jabref/logic/exporter/TemplateExporter.java Outdated Show resolved Hide resolved

src/main/java/org/jabref/logic/exporter/TemplateExporter.java Outdated Show resolved Hide resolved

joethei and others added 3 commits October 19, 2020 16:46

change deleteBlankLines boolean to use new enum BlankLineBehaviour

92e4501

wrap comments correctly

Merge branch 'yaml-exporter' of https://github.com/joethei/jabref int…

baf000b

…o yaml-exporter

Update BlankLineBehaviour.java

12a366a

calixtus approved these changes Oct 19, 2020

View reviewed changes

Merge branch 'master' into yaml-exporter

0c3636d

koppor requested changes Oct 20, 2020

View reviewed changes

small updates

a1107ed

koppor changed the title ~~support for exporting to YAML format.~~ Support for exporting to YAML format Oct 22, 2020

koppor merged commit 7f4c36c into JabRef:master Oct 22, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for exporting to YAML format #7007

Support for exporting to YAML format #7007

joethei commented Oct 12, 2020 •

edited by Siedlerchr

Loading

koppor left a comment

koppor Oct 12, 2020

koppor Oct 12, 2020

joethei Oct 13, 2020

Siedlerchr Oct 13, 2020

koppor commented Oct 14, 2020

joethei commented Oct 14, 2020

calixtus left a comment

calixtus left a comment

koppor left a comment

koppor Oct 20, 2020

koppor Oct 20, 2020

koppor Oct 20, 2020

koppor commented Oct 22, 2020

	this enum represents the behaviour for blank lines in {@link TemplateExporter}
	* This enum represents the behaviour for blank lines in {@link TemplateExporter}

Support for exporting to YAML format #7007

Support for exporting to YAML format #7007

Conversation

joethei commented Oct 12, 2020 • edited by Siedlerchr Loading

koppor left a comment

Choose a reason for hiding this comment

koppor Oct 12, 2020

Choose a reason for hiding this comment

koppor Oct 12, 2020

Choose a reason for hiding this comment

joethei Oct 13, 2020

Choose a reason for hiding this comment

Siedlerchr Oct 13, 2020

Choose a reason for hiding this comment

koppor commented Oct 14, 2020

joethei commented Oct 14, 2020

calixtus left a comment

Choose a reason for hiding this comment

calixtus left a comment

Choose a reason for hiding this comment

koppor left a comment

Choose a reason for hiding this comment

koppor Oct 20, 2020

Choose a reason for hiding this comment

koppor Oct 20, 2020

Choose a reason for hiding this comment

koppor Oct 20, 2020

Choose a reason for hiding this comment

koppor commented Oct 22, 2020

joethei commented Oct 12, 2020 •

edited by Siedlerchr

Loading