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 subtasks, such as breaking down the large methods guiActionInsertEntry() and guiActionUpdateDocument() in OOBibBase.java. It also focuses on the use of more constants instead of magic strings. Also addresses the subtask of using modern Java features(streams and Optional chaining). 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

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?

Honestly no clue when or why that happened. Might have been a IDE suggestion change in another area that affected this. I can assure you it was not intentional.

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

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?

…cePanel

pluto-han · 2026-03-31T12:45:02Z

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

        }

-        syncOptions.map(e -> e.setAlwaysAddCitedOnPages(openOfficePreferences.getAlwaysAddCitedOnPages()));
+        syncOptions.ifPresent(e -> e.setAlwaysAddCitedOnPages(openOfficePreferences.getAlwaysAddCitedOnPages()));


Since syncOptions has already been checked in if, you can move syncOptions.ifPresent(e -> e.setAlwaysAddCitedOnPages(openOfficePreferences.getAlwaysAddCitedOnPages())); into if block

pluto-han · 2026-03-31T13:09:39Z

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

+            List<BibEntry> citedEntries = databases.stream()
+                                                   .flatMap(database -> database.getEntries().stream())
+                                                   .filter(cslCitationOOAdapter::isCitedEntry)
+                                                   .toList();


This makes citedEntries an immutable list. Modifying (e.g. CSLCitationOOAdapter#L206: entries.sort()) the list throws an exception.

pluto-han · 2026-03-31T13:18:39Z

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

+        // Found one, no need to look further for now
+
+        boolean emptyKeys = entries.stream()


No empty lines please

testlens-app · 2026-03-31T16:46:26Z

✅ All tests passed ✅

🏷️ Commit: ed2a2a2
▶️ Tests: 10212 executed
⚪️ Checks: 49/49 completed

Learn more about TestLens at testlens.app.

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

This comment has been minimized.

Sign in to view

Refactor: replaced magic strings with constants

33689a4

This comment has been minimized.

Sign in to view

Refactor: Replaced duplicated string content with associated variable

f518aac

This comment has been minimized.

Sign in to view

amanda-d-e added 2 commits March 25, 2026 10:13

Refactor: replaced magic strings with constants

e5e218a

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

3e5877c

…s-for-issue-11829

This comment has been minimized.

Sign in to view

Merge branch 'JabRef:main' into fixes-for-issue-11829

ca13ca0

This comment has been minimized.

Sign in to view

Merge branch 'main' into fixes-for-issue-11829

93a78a6

This comment has been minimized.

Sign in to view

Merge branch 'JabRef:main' into fixes-for-issue-11829

1ab2595

This comment has been minimized.

Sign in to view

Refactor: replaced magic strings with constants

16ba9e8

This comment has been minimized.

Sign in to view

subhramit reviewed Mar 27, 2026

View reviewed changes

amanda-d-e and others added 2 commits March 27, 2026 13:55

Merge branch 'JabRef:main' into fixes-for-issue-11829

13c7f4d

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

618a6b4

…s-for-issue-11829

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

pluto-han reviewed Mar 28, 2026

View reviewed changes

Merge branch 'JabRef:main' into fixes-for-issue-11829

6b2de1f

This comment has been minimized.

Sign in to view

Refactor: revert missed errorTitle

d08ed3d

This comment has been minimized.

Sign in to view

Refactor: extract additional method from guiActionUpdateDocument, ren…

734bf9d

…ame methods for clarity

This comment has been minimized.

Sign in to view

Merge branch 'JabRef:main' into fixes-for-issue-11829

0751f17

This comment has been minimized.

Sign in to view

Refactor: revert runtime exception back to OOError statement

c552f58

This comment has been minimized.

Sign in to view

Merge branch 'JabRef:main' into fixes-for-issue-11829

2d0e663

This comment has been minimized.

Sign in to view

Refactor: use streams and Optional chaining in OOBibBase and OpenOffi…

ff016c5

…cePanel

This comment has been minimized.

Sign in to view

pluto-han reviewed Mar 31, 2026

View reviewed changes

Refactor: adjust position of syncOptions statement into if block

13f49ab

This comment has been minimized.

Sign in to view

Merge branch 'JabRef:main' into fixes-for-issue-11829

59bc3ec

This comment has been minimized.

Sign in to view

Fix immutable list issue and fixed line space

ed2a2a2

		// Found one, no need to look further for now

		boolean emptyKeys = entries.stream()

Uh oh!

Conversation

anuv-bit commented Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related issues and pull requests

PR Description

Checklist

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pluto-han commented Mar 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

amanda-d-e commented Mar 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

subhramit commented Mar 28, 2026

Uh oh!

pluto-han commented Mar 28, 2026

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

This comment has been minimized.

testlens-app bot commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ All tests passed ✅

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

anuv-bit commented Mar 20, 2026 •

edited

Loading

pluto-han commented Mar 28, 2026 •

edited

Loading

amanda-d-e commented Mar 28, 2026 •

edited

Loading

testlens-app bot commented Mar 31, 2026 •

edited

Loading