EPUB import (v2) #13217

InAnYan · 2025-06-02T15:35:57Z

Closes #12457.

Changes:

EPUB importer.
EPUB importer tests.
Various utils for handling EPUB files.
Moved OptionalObjectProperty to JabLib (it was in JabGui previously).

Steps to test

Import EPUB to library from JabGui.
Run EPUB importer tests.

Mandatory checks

I own the copyright of the code submitted and I license 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 (if change is visible to the user)
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.

jabgui/src/main/java/org/jabref/gui/LibraryTab.java

jabgui/src/main/java/org/jabref/gui/StateManager.java

jabgui/src/main/java/org/jabref/gui/externalfiles/ImportHandler.java

jabgui/src/main/java/org/jabref/gui/preferences/keybindings/KeyBindingsTabViewModel.java

jabgui/src/test/java/org/jabref/gui/sidepane/SidePaneViewModelTest.java

jablib/src/main/java/org/jabref/logic/externalfiles/ExternalFilesContentImporter.java

jablib/src/main/java/org/jabref/logic/importer/fileformat/EpubImporter.java

jablib/src/main/java/org/jabref/logic/util/StandardFileType.java

jablib/src/main/java/org/jabref/model/strings/StringUtil.java

jablib/src/test/java/org/jabref/logic/importer/fileformat/EpubImporterFilesTest.java

jablib/src/test/java/org/jabref/logic/importer/fileformat/EpubImporterTest.java

InAnYan · 2025-06-03T16:03:40Z

Trag bot actually gave good comments

jabref-machine · 2025-06-03T16:35:40Z

Your pull request needs to link an issue correctly.

To ease organizational workflows, please link this pull-request to the issue with syntax as described in https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue:

Linking a pull request to an issue using a keyword

You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message.

Examples

✅ Fixes #xyz links pull-request to issue. Merging the PR will close the issue.
✅ Fixes https://github.com/JabRef/jabref/issues/xyz links pull-request to issue. Merging the PR will close the issue.
✅ Fixes https://github.com/Koppor/jabref/issues/xyz links pull-request to issue. Merging the PR will close the issue.
❌ Fixes [#xyz](https://github.com/JabRef/jabref/issues/xyz) links pull-request to issue. Merging the PR will NOT close the issue.

jabref-machine · 2025-06-03T16:37:46Z

JUnit tests of jablib are failing. You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. To see the test output, locate "Tests / Unit tests (pull_request)" and click on it.

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.

trag-bot · 2025-06-03T16:39:24Z

jablib/src/main/java/org/jabref/model/entry/BibEntry.java

@@ -963,6 +958,14 @@ public BibEntry withField(Field field, String value) {
        return this;
    }

+    public BibEntry withField(Field field, Optional<String> value) {


The method uses Objects.requireNonNull which should be replaced with @nonnull annotation as per the guidelines.

trag-bot · 2025-06-03T16:39:36Z

jablib/src/main/java/org/jabref/model/entry/BibEntry.java

@@ -997,6 +1000,12 @@ public BibEntry withUserComments(String commentsBeforeEntry) {
        return this;
    }

+    public BibEntry withKeywords(Collection<String> keywords, Character delimiter) {


The method uses Objects.requireNonNull which should be replaced with @nonnull annotation as per the guidelines.

InAnYan added 3 commits June 2, 2025 18:28

feat(importers): add EPUB importer

38fa34f

fix(tests): OptionalObjectProperty usage

bafce5f

chore(changelog): update CHANGELOG.md

f33a918

InAnYan mentioned this pull request Jun 2, 2025

EPUB import #12457

Closed

5 tasks