New fix/new entry preferences #14427

rahulkarru · 2025-11-25T14:02:08Z

Closes #14416
I have extracted the NewEntryPreferences logic from the main JabRefPreferences class into its own dedicated class. This reduces the size of the main preferences class and groups related settings together.

Specific implementation details:

Created NewEntryPreferences with a private constructor for hardcoded defaults.
Updated JabRefPreferences to read/write from this new object.
Imports & Types: In the new class constructor, I switched to using StandardEntryType objects directly (instead of parsing Strings) to ensure better type safety for the default values. This required adding the necessary imports for EntryType and NewEntryDialogTab.

Steps to test

Run JabRef.
Go to Options > Preferences.
Check the Entry or New Entry settings (e.g., change "Generate key on import" or "Default entry type").
Save and Close JabRef.
Reopen JabRef and verify that the settings were remembered.
Try resetting the preferences to default to ensure the hardcoded defaults work correctly.

Mandatory checks

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 (not applicable, pure refactoring)
[/] I added screenshots in the PR description (UI did not change)
[/] I described the change in CHANGELOG.md (Internal refactoring, not visible to user)
[/] I checked the user documentation (No behavior change)

github-actions · 2025-11-25T14:02:18Z

Hey @rahulkarru!

Thank you for contributing to JabRef! Your help is truly appreciated ❤️

We have automated checks in place, based on which you will soon get feedback if any of them are failing. In a while, maintainers will also review your contribution. Once that happens, you can go through their comments in the "Files changed" tab and act on them, or reply to the conversation if you have further inputs.

Please re-check our contribution guide in case of any other doubts related to our contribution workflow.

koppor

Why is so much code moved? Is this AI-generated?

koppor · 2025-11-25T19:50:19Z

jabgui/src/main/java/org/jabref/gui/newentry/NewEntryPreferences.java

+                NewEntryDialogTab.CHOOSE_ENTRY_TYPE,
+
+                true,
+
+                false,
+
+                true,
+
+                StandardEntryType.Article,
+
+                true,
+
+                DoiFetcher.NAME,
+
+                PlainCitationParserChoice.RULE_BASED_GENERAL.getLocalizedName()


Fix empty lines - and add comments - as outlined in the issue description

calixtus · 2025-11-25T21:23:34Z

jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java

                getStringList(SELECTED_SLR_CATALOGS));
    }

+    private NewEntryPreferences getNewEntryPreferencesFromLowLevelApi(NewEntryPreferences defaults) {


Rename ti XXXFromBackingStore

calixtus · 2025-11-25T21:24:54Z

jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java

                getStringList(SELECTED_SLR_CATALOGS));
    }

+    private NewEntryPreferences getNewEntryPreferencesFromLowLevelApi(NewEntryPreferences defaults) {


Please move below getNewEntryPreferences

calixtus · 2025-11-25T21:25:39Z

jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java

+    private static List<String> getColumnNamesAsStringList(ColumnPreferences columnPreferences) {
+        return columnPreferences.getColumns().stream()
+                                .map(MainTableColumnModel::getName)
+                                .toList();
+    }
+
+    private static List<String> getColumnWidthsAsStringList(ColumnPreferences columnPreferences) {
+        return columnPreferences.getColumns().stream()
+                                .map(column -> column.widthProperty().getValue().toString())
+                                .toList();
+    }
+
+    private static List<String> getColumnSortTypesAsStringList(ColumnPreferences columnPreferences) {
+        return columnPreferences.getColumns().stream()
+                                .map(column -> column.sortTypeProperty().getValue().toString())
+                                .toList();
+    }
+
+    private static List<String> getColumnSortOrderAsStringList(ColumnPreferences columnPreferences) {
+        return columnPreferences.getColumnSortOrder().stream()
+                                .map(MainTableColumnModel::getName)
+                                .collect(Collectors.toList());
+    }
+


Please move back to original position in code. Reason: Keep together what belongs together in code. Makes understanding easier.

calixtus · 2025-11-25T21:30:59Z

jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java


-    // endregion
-
-    // region: Main table, main table column, and search dialog column preferences


Please keep region comments

calixtus · 2025-11-26T08:48:28Z

You forgot to add to clear and import methods

rahulkarru · 2025-11-26T12:58:46Z

rgot to add to clear and import methods

I guess I had added right could you specify that?

jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java

calixtus · 2025-11-26T21:59:46Z

jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java

+        int approachIndex = getInt("createEntryApproach", defaults.getLatestApproach().ordinal());
+        NewEntryDialogTab approach;
+        if (approachIndex >= 0 && approachIndex < NewEntryDialogTab.values().length) {
+            approach = NewEntryDialogTab.values()[approachIndex];
+        } else {
+            approach = defaults.getLatestApproach();
+        }


Why not the original logic? (which is btw now dead code in the getNewEntryPreferences() method)

calixtus · 2025-11-26T22:00:36Z

jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java

+        String typeName = get("createEntryImmediateType", defaults.getLatestImmediateType().getDisplayName());
+        EntryType immediateType = EntryTypeFactory.parse(typeName);


In the original logic, this was testing only for StandardTypes. Please provide at least some reasoning why this should also be tested for other types.

calixtus · 2025-11-26T22:00:55Z

jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java

        final int approachIndex = getInt(CREATE_ENTRY_APPROACH);
        NewEntryDialogTab approach = NewEntryDialogTab.values().length > approachIndex
                                     ? NewEntryDialogTab.values()[approachIndex]
                                     : NewEntryDialogTab.values()[0];

        final String immediateTypeName = get(CREATE_ENTRY_IMMEDIATE_TYPE);
        EntryType immediateType = StandardEntryType.Article;
        for (StandardEntryType type : StandardEntryType.values()) {
            if (type.getDisplayName().equals(immediateTypeName)) {
                immediateType = type;
                break;
            }
        }


Now dead code.

calixtus · 2025-11-26T22:01:10Z

jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java

+            approach = defaults.getLatestApproach();
+        }
+
+        String typeName = get("createEntryImmediateType", defaults.getLatestImmediateType().getDisplayName());


Please use the constants

calixtus · 2025-11-26T22:01:18Z

jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java

    }

+    private NewEntryPreferences getNewEntryPreferencesFromBackingStore(NewEntryPreferences defaults) {
+        int approachIndex = getInt("createEntryApproach", defaults.getLatestApproach().ordinal());


Please use the constants

calixtus · 2025-11-26T22:01:53Z

rgot to add to clear and import methods

I guess I had added right could you specify that?

i overlooked that change. my fault.

…ferences # Conflicts: # jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java

koppor

There is no removal of defaults.put things - and some strange donation changes are in... Maybe, wrong PR conflict resolution

koppor · 2025-11-28T01:05:52Z

jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java

+        // region donation defaults
+        defaults.put(DONATION_NEVER_SHOW, Boolean.FALSE);
+        defaults.put(DONATION_LAST_SHOWN_EPOCH_DAY, -1);
+        // endregion


Something is broken here -- this PR does not touch donations.

Donations were handled at #14439

# Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.

calixtus · 2025-11-28T22:14:43Z

jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java

+
+    private NewEntryPreferences getNewEntryPreferencesFromBackingStore(NewEntryPreferences defaults) {
+        // moved the same snippet form public to private
        final int approachIndex = getInt(CREATE_ENTRY_APPROACH);


What about the default value?

calixtus · 2025-11-28T22:14:50Z

jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java

                                     ? NewEntryDialogTab.values()[approachIndex]
                                     : NewEntryDialogTab.values()[0];

        final String immediateTypeName = get(CREATE_ENTRY_IMMEDIATE_TYPE);


What about the default value?

…nto new-fix/new_entry_preferences

calixtus · 2025-11-30T20:25:00Z

jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java

+    }
+
+    private NewEntryPreferences getNewEntryPreferencesFromBackingStore(NewEntryPreferences defaults) {
+        // moved the same snippet form public to private


ai comments?

it' wasn't extremely an ai comment it was the comment written by myself to under stand for reviewer

but why would you put a comment like this into the production code. nobody would understand it, who does not know how the code looked previously.

calixtus · 2025-11-30T20:26:17Z

jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java

+                                     // if any values not match it assign this value
+                                     : defaults.getLatestApproach();


why change this?

calixtus · 2025-11-30T20:26:51Z

jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java

+                                     : defaults.getLatestApproach();
+
+        final String immediateTypeName = get(CREATE_ENTRY_IMMEDIATE_TYPE, defaults.getLatestImmediateType().getDisplayName());
+        // logic change to assign default values at the start


another ai comment

calixtus

Remove ai comments, reason for logic change

obsolete

rahulkarru added 2 commits November 25, 2025 19:19

Refactor: Extract NewEntryPreferences from JabRefPreferences

fe22fcb

Refactor: Extract NewEntryPreferences from JabRefPreferences

ed7dd21

github-actions bot added the first contrib label Nov 25, 2025

rahulkarru added 2 commits November 25, 2025 19:57

Formatting done

2222759

Fix Checkstyle errors

2863314

koppor requested changes Nov 25, 2025

View reviewed changes

github-actions bot added the status: changes-required Pull requests that are not yet complete label Nov 25, 2025

calixtus reviewed Nov 25, 2025

View reviewed changes

fixed-comments

44e0ed8

github-actions bot removed the status: changes-required Pull requests that are not yet complete label Nov 26, 2025

koppor added the status: changes-required Pull requests that are not yet complete label Nov 26, 2025

rahulkarru requested a review from koppor November 26, 2025 16:11

calixtus requested changes Nov 26, 2025

View reviewed changes

rahulkarru added 2 commits November 27, 2025 08:47

Addressed_the_comments_usage_of_constatants

086f955

Merge remote-tracking branch 'origin/main' into new-fix/new_entry_pre…

6c1a4dd

…ferences # Conflicts: # jabgui/src/main/java/org/jabref/gui/preferences/JabRefGuiPreferences.java

github-actions bot removed the status: changes-required Pull requests that are not yet complete label Nov 27, 2025

koppor previously requested changes Nov 28, 2025

View reviewed changes

github-actions bot added the status: changes-required Pull requests that are not yet complete label Nov 28, 2025

rahulkarru and others added 3 commits November 28, 2025 08:41

solving-comments

8c661a1

Merge branch 'main' into new-fix/new_entry_preferences

f70b95e

# Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.

Merge branch 'main' into new-fix/new_entry_preferences

3dd3ab7

koppor added status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers and removed status: changes-required Pull requests that are not yet complete labels Nov 28, 2025

calixtus added 2 commits November 28, 2025 23:10

Fix order

14e4476

Fix order for consistency with other preferences objects

88876b7

calixtus requested changes Nov 28, 2025

View reviewed changes

github-actions bot added status: changes-required Pull requests that are not yet complete and removed status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers labels Nov 28, 2025

calixtus and others added 3 commits November 28, 2025 23:25

whitespaces

0c469d0

added_defaults

ecf357e

Merge remote-tracking branch 'origin/new-fix/new_entry_preferences' i…

ff0b6d6

…nto new-fix/new_entry_preferences

github-actions bot removed the status: changes-required Pull requests that are not yet complete label Nov 29, 2025

calixtus reviewed Nov 30, 2025

View reviewed changes

calixtus requested changes Nov 30, 2025

View reviewed changes

github-actions bot added the status: changes-required Pull requests that are not yet complete label Nov 30, 2025

removed comments and adjusted the default values

5d03256

github-actions bot removed the status: changes-required Pull requests that are not yet complete label Dec 1, 2025

koppor requested a review from calixtus December 1, 2025 13:39

Remove newline

dfcc685

calixtus approved these changes Dec 1, 2025

View reviewed changes

calixtus enabled auto-merge December 1, 2025 22:21

calixtus added this pull request to the merge queue Dec 1, 2025

Merged via the queue into JabRef:main with commit 9331991 Dec 1, 2025
48 checks passed

github-actions bot mentioned this pull request Dec 1, 2025

Enable resetting of NewEntryPreferences #14416

Closed


		// endregion

		// region: Main table, main table column, and search dialog column preferences

		String typeName = get("createEntryImmediateType", defaults.getLatestImmediateType().getDisplayName());
		EntryType immediateType = EntryTypeFactory.parse(typeName);

		// if any values not match it assign this value
		: defaults.getLatestApproach();

Uh oh!

New fix/new entry preferences #14427

New fix/new entry preferences #14427

Conversation

rahulkarru commented Nov 25, 2025

Steps to test

Mandatory checks

Uh oh!

github-actions bot commented Nov 25, 2025

Hey @rahulkarru!

Uh oh!

koppor left a comment

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!

calixtus commented Nov 26, 2025

Uh oh!

rahulkarru commented Nov 26, 2025

Uh oh!

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!

calixtus commented Nov 26, 2025

Uh oh!

koppor left a comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

calixtus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants