OpenOffice refactoring- subtask: Break down large methods like guiActionInsertEntry() by anuv-bit · Pull Request #15380 · JabRef/jabref

anuv-bit · 2026-03-20T21:07:07Z

Related issues and pull requests

PR Description

This PR focuses on the subtask of breaking down the large methods guiActionInsertEntry() and guiActionUpdateDocument() in OOBibBase.java. Next steps would be making sure changes line up with the guidelines.

Checklist

I own the copyright of the code submitted and I license it under the MIT license
I manually tested my changes in running JabRef (always required)
[/] I added JUnit tests for changes (if applicable)
[/] I added screenshots in the PR description (if change is visible to the user)
[/] I added a screenshot in the PR description showing a library with a single entry with me as author and as title the issue number
[/] I described the change in CHANGELOG.md in a way that can be understood by the average user (if change is visible to the user)
[/] I checked the user documentation for up to dateness and submitted a pull request to our user documentation repository

…ability

…adability

…s-for-issue-11829

subhramit · 2026-03-27T20:29:59Z

jabgui/src/main/java/org/jabref/gui/openoffice/OOBibBase.java


    public void guiActionSelectDocument(boolean autoSelectForSingle) throws WrappedTargetException, NoSuchElementException {
-        final String errorTitle = Localization.lang("Problem connecting");
+        final String connectionError = Localization.lang("Problem connecting");


Please revert these renamings - since they are function-local, they needn't be more specific

Understood, I reverted them. Are there more magic strings that you would like replaced with constants (that I have not already replaced)? My understanding was that not every single string needed to be replaced with a constant, especially in cases where the string is unique and is only used once.

Thank you!

These above were not magic strings. They were already constants.
Yes, ideally we extract constants for strings used more than once.
But there is one other case - when the string reduces readability of the code, or is long.

Thank you for the confirmation! To clarify: I was referring to changes made in a previous commit in which I did replace magic strings with constants, not this commit which was just renaming the existing constants.

subhramit · 2026-03-27T20:30:39Z

jabgui/src/main/java/org/jabref/gui/openoffice/OOBibBase.java

+    /// @param citationType       Indicates whether it is an in-text citation, a citation in parenthesis or an invisible citation.
+    /// @param citationStyle      Indicates style, name and path of citation
+    /// @param syncOptions        Indicates whether in-text citations should be refreshed in the document. Optional.empty() indicates no refresh. Otherwise, provides options for refreshing the reference list.
+    public void guiActionCSLCitationHandler(List<BibEntry> entries, XTextDocument doc, CitationType citationType, CitationStyle citationStyle,


These are more like class names - please use names denoting actions for methods

…s-for-issue-11829

…s-for-issue-11829 # Conflicts: # jabgui/src/main/java/org/jabref/gui/openoffice/OOBibBase.java

pluto-han · 2026-03-28T12:00:40Z

jabgui/src/main/java/org/jabref/gui/openoffice/OOBibBase.java

-            LOGGER.error("Could not insert entry", e);
-            OOError.fromMisc(e).setTitle(errorTitle).showErrorDialog(dialogService);
+            throw new RuntimeException(e);


Shouldn't this still use OOError.fromMisc?

Yes
@anuv-bit why was this changed?

pluto-han · 2026-03-28T12:41:20Z

Could you please also extract methods for JStyle and CSL in guiActionUpdateDocument like the way you did in guiActionInsertEntry?

…ame methods for clarity

testlens-app · 2026-03-28T15:45:55Z

✅ All tests passed ✅

🏷️ Commit: 0751f17
▶️ Tests: 10206 executed
⚪️ Checks: 52/52 completed

Learn more about TestLens at testlens.app.

amanda-d-e · 2026-03-28T15:52:21Z

Could you please also extract methods for JStyle and CSL in guiActionUpdateDocument like the way you did in guiActionInsertEntry?

Thank you for the guidance @pluto-han. I extracted a 'performPreUpdateChecks()' method similar to the 'performPreInsertionChecks()' method extracted from guiActionInsertEntry. Is this what you were looking for, or would you like me to also restructure the try/catch blocks inside guiActionUpdateDocument to match guiActionInsertEntry?

subhramit · 2026-03-28T16:54:27Z

Could you please also extract methods for JStyle and CSL in guiActionUpdateDocument like the way you did in guiActionInsertEntry?

Thank you for helping in reviews @pluto-han!

pluto-han · 2026-03-28T18:19:41Z

would you like me to also restructure the try/catch blocks inside guiActionUpdateDocument to match guiActionInsertEntry?

For me, I would prefer include try-catch as well for more readability, but I am not maintainer cannot simply decide it.
@subhramit Should try-catch be included in the extracted method?

sam-r914 and others added 3 commits March 20, 2026 13:21

Refactor: extracted 3 methods from guiActionInsertEntry for file read…

7cdc3af

…ability

Refactor: extracted two methods from guiActionUpdateDocument() for re…

48f8eb4

…adability

Merge remote-tracking branch 'origin/fixes-for-issue-11829' into fixe…

5870f9d

…s-for-issue-11829

anuv-bit changed the title ~~Fix-for-issue #11829- subtask: Break down large methods like guiActionInsertEntry()~~ OpenOffice refactoring- subtask: Break down large methods like guiActionInsertEntry() Mar 20, 2026

github-actions bot added the component: libre-office label Mar 20, 2026

Refactor: fixed file formatting

de7dd85

github-actions bot mentioned this pull request Mar 20, 2026

Project: Refactor and unify JabRef OO components #11829

Open

9 tasks

github-actions bot added status: changes-required Pull requests that are not yet complete status: no-bot-comments and removed status: changes-required Pull requests that are not yet complete labels Mar 20, 2026