Add suggested jabref groups #12997

luks-santos · 2025-04-24T22:38:28Z

I've implemented a new "Add JabRef suggested groups" context menu entry that appears only in the "All entries" group's context menu. When clicked, it adds two predefined search groups if they don't already exist:

"Entries without linked files"
"Entries without groups"

What was implemented

Added a new context menu entry specifically for the "All entries" group
Implemented logic to check if the suggested groups already exist before adding them
Created two search groups with predefined search queries:
1. A group to find entries without any attached files
2. A group to find entries that don't belong to any group

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.

Implements a new context menu entry for the "All entries" group to add two predefined groups if they don't already exist: - "Entries without linked files" - A search group that finds entries with no file links - "Entries without groups" - A search group that finds entries not assigned to any group The menu item is disabled automatically when both suggested groups already exist in the library. The implementation includes: - A utility class with factory methods for creating the suggested groups - Logic to check for existence of similar groups before adding Fixes JabRef#12659

- Test that root node has no suggested groups by default - Test addition of all suggested groups when none exist - Test addition of only missing suggested groups - Test that no groups are added when all suggested groups already exist

src/main/java/org/jabref/gui/groups/GroupNodeViewModel.java

src/main/java/org/jabref/gui/groups/GroupTreeViewModel.java

src/test/java/org/jabref/gui/groups/GroupTreeViewModelTest.java

…subgroups

…-suggested-jabref-groups-12659

trag-bot · 2025-04-29T23:22:07Z

@trag-bot didn't find any issues in the code! ✅✨

trag-bot · 2025-04-29T23:29:34Z

jabgui/src/main/java/org/jabref/gui/actions/StandardActions.java

@@ -201,6 +201,7 @@ public enum StandardActions implements Action {
    GROUP_EDIT(Localization.lang("Edit group")),
    GROUP_GENERATE_SUMMARIES(Localization.lang("Generate summaries for entries in the group")),
    GROUP_GENERATE_EMBEDDINGS(Localization.lang("Generate embeddings for linked files in the group")),
+    GROUP_SUGGESTED_GROUPS_ADD(Localization.lang("Add JabRef suggested groups")),


The new string 'Add JabRef suggested groups' should be consistent with existing strings and grouped semantically. Consider reusing existing strings if possible.

trag-bot · 2025-04-29T23:30:12Z

jabgui/src/main/java/org/jabref/gui/groups/GroupNodeViewModel.java

@@ -412,6 +412,22 @@ public boolean hasSubgroups() {
        return !getChildren().isEmpty();
    }

+    public boolean isAllEntriesGroup() {


The method isAllEntriesGroup() returns a boolean, which is not consistent with the special instruction to use Optional for new public methods instead of returning null. Consider using Optional.

trag-bot · 2025-04-29T23:30:14Z

jabgui/src/main/java/org/jabref/gui/groups/GroupNodeViewModel.java

+        return groupNode.getGroup() instanceof AllEntriesGroup;
+    }
+
+    public boolean hasSimilarSearchGroup(SearchGroup searchGroup) {


The method hasSimilarSearchGroup() returns a boolean, which is not consistent with the special instruction to use Optional for new public methods instead of returning null. Consider using Optional.

trag-bot · 2025-04-29T23:30:17Z

jabgui/src/main/java/org/jabref/gui/groups/GroupNodeViewModel.java

+                            .anyMatch(group -> group.equals(searchGroup));
+    }
+
+    public boolean hasAllSuggestedGroups() {


The method hasAllSuggestedGroups() returns a boolean, which is not consistent with the special instruction to use Optional for new public methods instead of returning null. Consider using Optional.

trag-bot · 2025-04-29T23:31:23Z

jabgui/src/main/java/org/jabref/gui/groups/GroupTreeViewModel.java

+     *
+     * @param parent The "All Entries" parent node.
+     */
+    public void addSuggestedGroups(GroupNodeViewModel parent) {


The method 'addSuggestedGroups' is public and should not return null. It should use Optional to handle cases where no groups are added.

trag-bot · 2025-04-29T23:31:27Z

jabgui/src/main/java/org/jabref/gui/groups/GroupTreeViewModel.java

+    public void addSuggestedGroups(GroupNodeViewModel parent) {
+        currentDatabase.ifPresent(database -> {
+            GroupTreeNode rootNode = parent.getGroupNode();
+            List<GroupTreeNode> newSuggestedSubgroups = new ArrayList<>();


Use modern Java data structures. Prefer using List.of() for creating empty lists instead of new ArrayList<>.

trag-bot · 2025-04-29T23:31:28Z

jabgui/src/main/java/org/jabref/gui/groups/GroupTreeViewModel.java

+            selectedGroups.setAll(newSuggestedSubgroups
+                    .stream()
+                    .map(newSubGroup -> new GroupNodeViewModel(database, stateManager, taskExecutor, newSubGroup, localDragboard, preferences))
+                    .toList());


When using Stream API to create a list, use toList() directly instead of more complex constructs like collect(Collectors.toList()).

trag-bot · 2025-04-29T23:31:53Z

jabgui/src/main/java/org/jabref/gui/groups/JabRefSuggestedGroups.java

+
+    public static SearchGroup createWithoutFilesGroup() {
+        return new SearchGroup(
+                Localization.lang("Entries without linked files"),


The label 'Entries without linked files' should be in sentence case, not title case, to maintain consistency with other labels.

trag-bot · 2025-04-29T23:31:54Z

jabgui/src/main/java/org/jabref/gui/groups/JabRefSuggestedGroups.java

+
+    public static SearchGroup createWithoutGroupsGroup() {
+        return new SearchGroup(
+                Localization.lang("Entries without groups"),


The label 'Entries without groups' should be in sentence case, not title case, to maintain consistency with other labels.

trag-bot · 2025-04-29T23:32:43Z

jabgui/src/test/java/org/jabref/gui/groups/GroupTreeViewModelTest.java

+    @Test
+    void rootNodeShouldNotHaveSuggestedGroupsByDefault() {
+        GroupNodeViewModel rootGroup = groupTree.rootGroupProperty().getValue();
+        assertFalse(rootGroup.hasAllSuggestedGroups());


The test uses assertFalse to check a boolean condition. It should assert the contents of objects using assertEquals for better clarity and precision.

trag-bot · 2025-04-29T23:32:45Z

jabgui/src/test/java/org/jabref/gui/groups/GroupTreeViewModelTest.java

+        model.addSuggestedGroups(rootGroup);
+
+        assertEquals(2, rootGroup.getChildren().size());
+        assertTrue(rootGroup.hasAllSuggestedGroups());


The test uses assertTrue to check a boolean condition. It should assert the contents of objects using assertEquals for better clarity and precision.

luks-santos added 3 commits April 24, 2025 18:47

Add entry in changelog for suggested groups feature

902c1c2