Add suggested jabref groups 12659 #12975

luks-santos · 2025-04-21T00:25:46Z

This PR implements 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"

This is currently a draft PR and I'm looking for feedback on the approach, particularly regarding the method I've implemented to check if similar groups already exist. I've added a hasSimilarSearchGroup() method that compares SearchGroup objects based on their properties.

Next Steps:

Add any additional refinements based on feedback
Implement unit tests for the group checking and addition logic
Improve JavaDoc documentation
Add missing CHANGELOG.md entry

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 - UI integration with proper localization Fixes JabRef#12659

trag-bot · 2025-04-21T00:28:19Z

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() is a new public method and should not return null. It should return a boolean value directly.

trag-bot · 2025-04-21T00:28:22Z

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

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


The method hasSimilarSearchGroup() is a new public method and should not return null. It should return a boolean value directly.

trag-bot · 2025-04-21T00:28:25Z

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

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


The method hasAllSuggestedGroups() is a new public method and should not return null. It should return a boolean value directly.

trag-bot · 2025-04-21T00:30:26Z

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

+
+            // 1. Create "Entries without linked files" group if it doesn't exist
+            SearchGroup withoutFilesGroup = JabRefSuggestedGroups.createWithoutFilesGroup();
+            if (!parent.hasSimilarSearchGroup(withoutFilesGroup)) {


The code does not follow the fail-fast principle. It should return early if the condition is false, instead of nesting the logic inside an if statement.

trag-bot · 2025-04-21T00:30:27Z

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

+
+            // 2. Create "Entries without groups" group if it doesn't exist
+            SearchGroup withoutGroupsGroup = JabRefSuggestedGroups.createWithoutGroupsGroup();
+            if (!parent.hasSimilarSearchGroup(withoutGroupsGroup)) {


The code does not follow the fail-fast principle. It should return early if the condition is false, instead of nesting the logic inside an if statement.

This commit adds unit tests for handling suggested groups in the GroupTreeViewModel: - 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

trag-bot · 2025-04-22T23:47:00Z

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 maintainability.

trag-bot · 2025-04-22T23:47:01Z

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 maintainability.

* Refine grammar in README.md * Fix grammar * Move FAQ to FAQs * Move getting-into-the-code/* into either /index.md or code-howtos/* * Fix markdown * Re-refinement * Fix link * Refine builds information --------- Co-authored-by: Subhramit Basu <[email protected]>

* Improve LTWA code Signed-off-by: subhramit <[email protected]> * Remove unused parameter Signed-off-by: subhramit <[email protected]> * Un-refactor `matchesInternal` Signed-off-by: subhramit <[email protected]> * Remove null check, better variable name Signed-off-by: subhramit <[email protected]> * Remove javadoc Signed-off-by: subhramit <[email protected]> * Remove equals and hashcode from record implementation Signed-off-by: subhramit <[email protected]> * Remove remaining vars Signed-off-by: subhramit <[email protected]> --------- Signed-off-by: subhramit <[email protected]>

… development environment (JabRef#12978)

Bumps [com.konghq:unirest-modules-gson](https://github.com/Kong/unirest-java) from 4.4.5 to 4.4.6. - [Release notes](https://github.com/Kong/unirest-java/releases) - [Changelog](https://github.com/Kong/unirest-java/blob/main/CHANGELOG.md) - [Commits](Kong/unirest-java@v4.4.5...v4.4.6) --- updated-dependencies: - dependency-name: com.konghq:unirest-modules-gson dependency-version: 4.4.6 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…f#12981) Bumps [src/main/resources/csl-styles](https://github.com/citation-style-language/styles) from `6167631` to `28ee0a5`. - [Release notes](https://github.com/citation-style-language/styles/releases) - [Commits](citation-style-language/styles@6167631...28ee0a5) --- updated-dependencies: - dependency-name: src/main/resources/csl-styles dependency-version: 28ee0a509ba772e44d3afbfe7811b7c1bad5ba14 dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…JabRef#12982) Bumps [org.junit.platform:junit-platform-launcher](https://github.com/junit-team/junit5) from 1.12.1 to 1.12.2. - [Release notes](https://github.com/junit-team/junit5/releases) - [Commits](https://github.com/junit-team/junit5/commits) --- updated-dependencies: - dependency-name: org.junit.platform:junit-platform-launcher dependency-version: 1.12.2 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…ef#12984) Bumps [src/main/resources/csl-locales](https://github.com/citation-style-language/locales) from `606fa26` to `76a834b`. - [Release notes](https://github.com/citation-style-language/locales/releases) - [Commits](citation-style-language/locales@606fa26...76a834b) --- updated-dependencies: - dependency-name: src/main/resources/csl-locales dependency-version: 76a834b876473a20536a8e07ad31c2d974fe35d7 dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…abRef#12985) Bumps [org.openrewrite.recipe:rewrite-recipe-bom](https://github.com/openrewrite/rewrite-recipe-bom) from 3.5.0 to 3.6.1. - [Release notes](https://github.com/openrewrite/rewrite-recipe-bom/releases) - [Commits](openrewrite/rewrite-recipe-bom@v3.5.0...v3.6.1) --- updated-dependencies: - dependency-name: org.openrewrite.recipe:rewrite-recipe-bom dependency-version: 3.6.1 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…2987) Bumps [org.kordamp.ikonli:ikonli-javafx](https://github.com/kordamp/ikonli) from 12.3.1 to 12.4.0. - [Release notes](https://github.com/kordamp/ikonli/releases) - [Changelog](https://github.com/kordamp/ikonli/blob/master/jreleaser.yml) - [Commits](kordamp/ikonli@v12.3.1...v12.4.0) --- updated-dependencies: - dependency-name: org.kordamp.ikonli:ikonli-javafx dependency-version: 12.4.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [de.undercouch:citeproc-java](https://github.com/michel-kraemer/citeproc-java) from 3.2.0 to 3.2.1. - [Release notes](https://github.com/michel-kraemer/citeproc-java/releases) - [Commits](michel-kraemer/citeproc-java@3.2.0...3.2.1) --- updated-dependencies: - dependency-name: de.undercouch:citeproc-java dependency-version: 3.2.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps com.konghq:unirest-java-core from 4.4.5 to 4.4.6. --- updated-dependencies: - dependency-name: com.konghq:unirest-java-core dependency-version: 4.4.6 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

….4.0 (JabRef#12986) * Bump org.kordamp.ikonli:ikonli-materialdesign2-pack Bumps [org.kordamp.ikonli:ikonli-materialdesign2-pack](https://github.com/kordamp/ikonli) from 12.3.1 to 12.4.0. - [Release notes](https://github.com/kordamp/ikonli/releases) - [Changelog](https://github.com/kordamp/ikonli/blob/master/jreleaser.yml) - [Commits](kordamp/ikonli@v12.3.1...v12.4.0) --- updated-dependencies: - dependency-name: org.kordamp.ikonli:ikonli-materialdesign2-pack dependency-version: 12.4.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * fix pdf icon https://pictogrammers.com/docs/library/mdi/releases/changelog/ --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Subhramit Basu <[email protected]> Co-authored-by: Siedlerchr <[email protected]>

Signed-off-by: subhramit <[email protected]>

Fixes https://github.com/JabRef/jabref-issue-melting-pot/issues/868

src/main/java/org/jabref/model/database/BibDatabase.java

src/main/java/org/jabref/model/database/KeyChangeListener.java

…-suggested-jabref-groups-12659

…m/luks-santos/jabref into add-suggested-jabref-groups-12659

trag-bot · 2025-04-23T00:03:33Z

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

jabref-machine · 2025-04-23T00:12:52Z

Do not force-push! Force pushing is a very bad practice when working together on a project (mainly because it is not supported well by GitHub itself). Commits are lost and comments on commits lose their context, thus making it harder to review changes. At the end, all commits will be squashed anyway before being merged into the main branch.

subhramit · 2025-04-24T04:15:41Z

@luks-santos hey, feel free to reopen the PR and work on it. The bot text was intended to guide, not scare off.
We are in the process of refining the text a bit.

subhramit · 2025-04-24T04:19:26Z

@luks-santos I think a new branch would be better, as somehow old commits seem to have been marked with your involvement:

This may have been the result of an improper rebase.
You can use normal push/pull to avoid this.
You can also reset this branch and do a fresh commit, if you know how to.

luks-santos · 2025-04-24T11:35:22Z

Thanks for the heads-up, @subhramit ! I’ll create a new branch and open a new PR, I think that’s the better.
I haven’t gotten around to it yet due to lack of time, but I should be able to take care of it today.

luks-santos added 2 commits April 20, 2025 21:05

Merge branch 'JabRef:main' into add-suggested-jabref-groups-12659

2610926

trag-bot bot reviewed Apr 21, 2025

View reviewed changes

trag-bot bot reviewed Apr 22, 2025

View reviewed changes

koppor and others added 15 commits April 22, 2025 20:49

docs: update documentation images and fix some spelling in setting up…

6f6ec48

… development environment (JabRef#12978)

Add test to PdfMergeMetadataImporterTest (JabRef#12976)

f26fb76

Use bibEntryTypesManager from constructor (JabRef#12983)

bb8300f

Signed-off-by: subhramit <[email protected]>

Fix NPE when no citekey available (JabRef#12991)

b996f90

Fixes https://github.com/JabRef/jabref-issue-melting-pot/issues/868

trag-bot bot reviewed Apr 22, 2025

View reviewed changes

src/main/java/org/jabref/model/database/BibDatabase.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 22, 2025

View reviewed changes

src/main/java/org/jabref/model/database/KeyChangeListener.java Outdated Show resolved Hide resolved

luks-santos added 2 commits April 22, 2025 20:56

Merge branch 'main' of https://github.com/luks-santos/jabref into add…

e1abc41

…-suggested-jabref-groups-12659

Merge branch 'add-suggested-jabref-groups-12659' of https://github.co…

5e0aa94

…m/luks-santos/jabref into add-suggested-jabref-groups-12659

luks-santos force-pushed the add-suggested-jabref-groups-12659 branch from 7fa84fe to 5e0aa94 Compare April 23, 2025 00:02

luks-santos closed this Apr 23, 2025

luks-santos deleted the add-suggested-jabref-groups-12659 branch April 23, 2025 00:38

koppor mentioned this pull request Apr 24, 2025

Refine no-force-push #12993

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add suggested jabref groups 12659 #12975

Add suggested jabref groups 12659 #12975

luks-santos commented Apr 21, 2025

trag-bot bot Apr 21, 2025

trag-bot bot Apr 21, 2025

trag-bot bot Apr 21, 2025

trag-bot bot Apr 21, 2025

trag-bot bot Apr 21, 2025

trag-bot bot Apr 22, 2025

trag-bot bot Apr 22, 2025

trag-bot bot commented Apr 23, 2025

jabref-machine commented Apr 23, 2025

subhramit commented Apr 24, 2025

subhramit commented Apr 24, 2025 •

edited

Loading

luks-santos commented Apr 24, 2025

Add suggested jabref groups 12659 #12975

Add suggested jabref groups 12659 #12975

Conversation

luks-santos commented Apr 21, 2025

Next Steps:

Mandatory checks

trag-bot bot Apr 21, 2025

Choose a reason for hiding this comment

trag-bot bot Apr 21, 2025

Choose a reason for hiding this comment

trag-bot bot Apr 21, 2025

Choose a reason for hiding this comment

trag-bot bot Apr 21, 2025

Choose a reason for hiding this comment

trag-bot bot Apr 21, 2025

Choose a reason for hiding this comment

trag-bot bot Apr 22, 2025

Choose a reason for hiding this comment

trag-bot bot Apr 22, 2025

Choose a reason for hiding this comment

trag-bot bot commented Apr 23, 2025

jabref-machine commented Apr 23, 2025

subhramit commented Apr 24, 2025

subhramit commented Apr 24, 2025 • edited Loading

luks-santos commented Apr 24, 2025

subhramit commented Apr 24, 2025 •

edited

Loading