OpenOffice Refactor subtasks 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 several subtasks, such as:

Break down large methods like guiActionInsertEntry() - the refactoring technique ‘extract method’ was used on long methods or repeated blocks of code in ‘OOBibBase’, ‘EditMerge’, ‘OOFrontend’, and ‘CSLCitationOOAdapter’ in order to increase readability and modifiability.

Using more constants instead of magic strings - this task focused on replacing repeated magic strings with named constants across OOBibBase.java, OpenOfficePanel.java, and EditMerge.java to improve readability and reduce duplicated elements.

Using modern Java features(streams and Optional chaining) - this task focused on replacing for loops with stream pipelines using flatMap(), filter(), and anyMatch(). Additionally, getBaseList() was refactored to use streams while preserving mutability.

Unification of error handling methods - Instead of throwing runtime exceptions, we standardized the use of logging combined with OOError dialogs, minimizing the use of throwing exceptions without being caught by some other area of code.

Additionally, this PR includes some minor refactorings such as removing unused parameters and duplicate methods.

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

subhramit · 2026-04-04T13:05:51Z

@anuv-bit @amanda-d-e can you tick "Allow maintainers to edit this pull request" on the right hand side?
We wish to finish the remaining changes and get this in.

subhramit

Some refactoring has changed semantics - need to double check

subhramit · 2026-04-04T13:10:31Z

jablib/src/main/java/org/jabref/logic/openoffice/action/EditMerge.java

-        /*
-         * Try to expand state.currentGroupCursor and state.cursorBetween by going right to reach
-         * rangeStart.
-         */


This comment should not be lost

subhramit · 2026-04-04T13:14:02Z

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

-            if (testDialog(errorTitle,
-                    odoc.asVoidResult(),
-                    styleIsRequired(jStyle),
-                    databaseIsRequired(databases, OOError::noDataBaseIsOpen))) {
-                return;
-            }
+
            XTextDocument doc = odoc.get();

            OOResult<FunctionalTextViewCursor, OOError> fcursor = getFunctionalTextViewCursor(doc, errorTitle);

-            if (testDialog(errorTitle,
-                    fcursor.asVoidResult(),
-                    checkStylesExistInTheDocument(jStyle, doc),
-                    checkIfOpenOfficeIsRecordingChanges(doc))) {
+            if (!performPreMergeSeparateChecks(databases, errorTitle, odoc, jStyle, fcursor, doc)) {


This changes semantics (the order of returning if checks at a particular stage fail)

subhramit · 2026-04-04T13:14:34Z

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

-            if (testDialog(errorTitle,
-                    odoc.asVoidResult(),
-                    styleIsRequired(jStyle),
-                    databaseIsRequired(databases, OOError::noDataBaseIsOpen))) {
-                return;
-            }

            XTextDocument doc = odoc.get();
+
            OOResult<FunctionalTextViewCursor, OOError> fcursor = getFunctionalTextViewCursor(doc, errorTitle);

-            if (testDialog(errorTitle,
-                    fcursor.asVoidResult(),
-                    checkStylesExistInTheDocument(jStyle, doc),
-                    checkIfOpenOfficeIsRecordingChanges(doc))) {
+            if (!performPreMergeSeparateChecks(databases, errorTitle, odoc, jStyle, fcursor, doc)) {


subhramit

Other cosmetic comments

subhramit · 2026-04-04T13:18:54Z

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

-                    // Release controller lock
-                    doc.unlockControllers();
-                }
+                insertCSLCitation(entries, doc, citationType, citationStyle, bibDatabaseContext, bibEntryTypesManager, cursor, syncOptions);


For >=4 arguments, each should go into a new line for readability

subhramit · 2026-04-04T13:19:20Z

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

+    public void insertCSLCitation(List<BibEntry> entries, XTextDocument doc, CitationType citationType, CitationStyle citationStyle,
+                                  BibDatabaseContext bibDatabaseContext, BibEntryTypesManager bibEntryTypesManager, OOResult<XTextCursor, OOError> cursor,
+                                  Optional<Update.SyncOptions> syncOptions) throws CreationException, com.sun.star.uno.Exception {


Each parameter in new line

subhramit · 2026-04-04T13:19:38Z

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

+    public void insertJStyleCitation(List<BibEntry> entries, XTextDocument doc, CitationType citationType, JStyle jStyle, OOResult<OOFrontend, OOError> frontend,
+                                     OOResult<XTextCursor, OOError> cursor, BibDatabaseContext bibDatabaseContext, Optional<Update.SyncOptions> syncOptions,
+                                     String pageInfo, OOResult<FunctionalTextViewCursor, OOError> fcursor)


Same as above

amanda-d-e · 2026-04-04T14:24:25Z

@anuv-bit @amanda-d-e can you tick "Allow maintainers to edit this pull request" on the right hand side? We wish to finish the remaining changes and get this in.

Hello @subhramit, I think that @anuv-bit has to allow maintainers to edit the pull request since she is the one who made it, so I will try to get in contact with her as soon as possible. Apologies for the inconvenience, and thank you for all of the feedback and guidance.

anuv-bit · 2026-04-04T15:02:42Z

@anuv-bit @amanda-d-e can you tick "Allow maintainers to edit this pull request" on the right hand side? We wish to finish the remaining changes and get this in.

Hey @subhramit, I clicked it.

jablib/src/main/java/org/jabref/logic/openoffice/oocsltext/CSLCitationOOAdapter.java

subhramit

One more iteration of comments. Thanks for keeping patience and following up so far.

jablib/src/main/java/org/jabref/logic/openoffice/oocsltext/CSLCitationOOAdapter.java

jablib/src/main/java/org/jabref/logic/openoffice/frontend/OOFrontend.java

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

subhramit · 2026-04-08T18:12:07Z

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

-                List<String> unresolvedKeys;
-                try {
-                    UnoUndo.enterUndoContext(doc, "Refresh bibliography");
+        if (!performPreUpdateChecks(errorTitle, odoc, style, getFrontend(doc), fcursor, doc)) {


As mentioned in an earlier comment, this changes semantics - for example, fcursor was earlier being fetched only if doc, odoc passed the earlier checks, etc.

Please revert.

Hello @subhramit, I have reverted the extracted method. I think that should be the last of the requested fixes, but please let me know if we are missing anything or if you would like anything else changed.

Thank you for your guidance. This has been a very valuable learning experience for my group and I, and we appreciate the opportunity to work on this issue.

…CitationOOAdapter.java Co-authored-by: Subhramit Basu <subhramit.bb@live.in>

Co-authored-by: Subhramit Basu <subhramit.bb@live.in>

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