Keyword Tooltip/Cleanup for MSC codes added to Keyword Editor #12914

JustinHennis1 · 2025-04-09T03:39:09Z

Created a JSON file to hold key-value pairs of MSC codes to their respective descriptions/classifications by parsing msc_2020.pdf (which was provided in link to zbmath).

Created MscCodeUtils.java class that implements a method to load a JSON file and converts said file into a Map object.

Created ConvertMSCCodesCleanupTest.java, added to panel, and when user selects preference to convert and saves, the codes are converted to descriptions. Alternatively, when unselected, descriptions are reverted back to code.

In KeywordsEditor.java I added a private variable, mscmap, that calls the above method. Using this map object, I added a condition in the create tag method to check if the label text matches any of the keys. If it does, then we initialize a Tooltip and call install onMouseEnter and uninstall onMouseExited.

ToolTip

Cleanup

Before:

After:

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.

Siedlerchr · 2025-04-09T19:06:19Z

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java

@@ -50,6 +55,8 @@ public class KeywordsEditor extends HBox implements FieldEditorFX {
    private static final Logger LOGGER = LoggerFactory.getLogger(KeywordsEditor.class);
    private static final PseudoClass FOCUSED = PseudoClass.getPseudoClass("focused");

+    private Map<String, String> mscmap = MscCodeUtils.loadMscCodesFromJson("../../resources/main/org/jabref/gui/fieldeditors/msccodes/msc_codes.json");


This won't work inside a jar, you need to use class.getResource

… URL object

…to ktooltip updates from jabref main

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java

src/main/java/org/jabref/gui/fieldeditors/msccodes/MscCodeUtils.java

…to ktooltip pulling changes from main to local

…till in progress

Siedlerchr · 2025-04-12T16:36:17Z

Please fix the failing tests before. This reduces the burden of us maintainers to review incomplete PRs

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java

src/main/java/org/jabref/gui/fieldeditors/msccodes/MscCodeUtils.java

…iptions, bug: error when trying to cleanup when editor is open

…er and special characters were added

trag-bot · 2025-04-14T19:04:18Z

src/main/java/org/jabref/gui/cleanup/CleanupAction.java

@@ -114,7 +114,8 @@ private boolean doCleanup(BibDatabaseContext databaseContext, CleanupPreferences
        CleanupWorker cleaner = new CleanupWorker(
                databaseContext,
                preferences.getFilePreferences(),
-                preferences.getTimestampPreferences()
+                preferences.getTimestampPreferences(),
+                preferences.getBibEntryPreferences()


The addition of preferences.getBibEntryPreferences() to the CleanupWorker constructor requires updating the JavaDoc for doCleanup method to reflect this change in parameters.

…till in progress

…to ktooltip Pulling changes from main

jabref-machine · 2025-04-16T00:10:57Z

Your pull request needs to link an issue.

To ease organizational workflows, please link this pull-request to the issue with syntax as described in https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue:

Linking a pull request to an issue using a keyword

You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message. The pull request must be on the default branch.

close

closes

closed

fix

fixes

fixed

resolve

resolves

resolved

If you use a keyword to reference a pull request comment in another pull request, the pull requests will be linked. Merging the referencing pull request also closes the referenced pull request.

The syntax for closing keywords depends on whether the issue is in the same repository as the pull request.

Examples

✅ Fixes #xyz links pull-request to issue. Merging the PR will close the issue.
✅ Fixes https://github.com/JabRef/jabref/issues/xyz links pull-request to issue. Merging the PR will close the issue.
✅ Fixes https://github.com/Koppor/jabref/issues/xyz links pull-request to issue. Merging the PR will close the issue.
❌ Fixes [#xyz](https://github.com/JabRef/jabref/issues/xyz) links pull-request to issue. Merging the PR will NOT close the issue.

src/test/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanupTest.java

… Test cases

src/main/java/org/jabref/logic/msc/JavaFXInitializer.java

src/main/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanup.java

src/test/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanupTest.java

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java

src/main/java/org/jabref/logic/cleanup/CleanupPreferences.java

src/main/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanup.java

trag-bot · 2025-04-16T23:53:16Z

src/main/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanup.java

+        URL resourceUrl = ConvertMSCCodesCleanup.class.getClassLoader().getResource("msc_codes.json");
+
+        if (resourceUrl == null) {
+            logger.error("Resource not found: msc_codes.json");


User-facing text should be localized using Localization.lang method to support multilingual capabilities.

trag-bot · 2025-04-16T23:53:19Z

src/main/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanup.java

+                    conversionPossible = false;
+                }
+            } catch (MscCodeLoadingException e) {
+                logger.error("Error loading MSC codes:", e);


User-facing text should be localized using Localization.lang method to support multilingual capabilities.

trag-bot · 2025-04-16T23:53:23Z

src/main/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanup.java

+    @Override
+    public List<FieldChange> cleanup(BibEntry entry) {
+        if (!conversionPossible) {
+            logger.error("MSC code conversion was attempted but is not possible because the codes file could not be loaded");


User-facing text should be localized using Localization.lang method to support multilingual capabilities.

src/main/java/org/jabref/logic/msc/MscCodeUtils.java

trag-bot · 2025-04-16T23:54:17Z

src/main/java/org/jabref/logic/msc/MscCodeUtils.java

+
+            return Optional.of(result);
+        } catch (JsonParseException | JsonMappingException e) {
+            LOGGER.error("Error parsing MSC codes from JSON", e);


The logging of exceptions is done correctly using the exception logging capabilities. Ensure this pattern is consistently applied across the codebase.

…to ktooltip adding changes from main

trag-bot · 2025-04-18T01:25:04Z

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

Siedlerchr · 2025-04-18T10:37:41Z

src/main/java/org/jabref/logic/cleanup/ConvertMSCCodesCleanup.java

+    private final boolean convertToDescriptions;
+
+    static {
+        Map<String, String> tempMap = new HashMap<>();


You could make use of Guavas BiMap that does the "reverse" mapping then for you

JustinHennis1 and others added 3 commits April 8, 2025 22:38

added msc codes, keyword tooltip feature

0f77aba

keyword tooltip feature#423, changelog updated

9cec66b

Merge branch 'main' into ktooltip

3a506b4

Siedlerchr reviewed Apr 9, 2025

View reviewed changes

JustinHennis1 added 4 commits April 9, 2025 21:11

uses getResource to find json/loadMscCodesFromJson overloaded to take…

a09718f

… URL object

Merge branch 'ktooltip' of https://github.com/JustinHennis1/jabref in…

1ce8ec0

…to ktooltip updates from jabref main

printstacktrace removed from MscCodeUtils

92d0f60

Switched from File to Path.of in loadMscFromJson

0d57263

JustinHennis1 closed this Apr 10, 2025

Merge branch 'JabRef:main' into ktooltip

f5f16b1

JustinHennis1 reopened this Apr 10, 2025

trag-bot bot reviewed Apr 10, 2025

View reviewed changes

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 10, 2025

View reviewed changes

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java Show resolved Hide resolved

trag-bot bot reviewed Apr 10, 2025

View reviewed changes

src/main/java/org/jabref/gui/fieldeditors/msccodes/MscCodeUtils.java Outdated Show resolved Hide resolved

JustinHennis1 added 3 commits April 10, 2025 01:15

checkstyle compliance

8d0af60

Merge branch 'ktooltip' of https://github.com/JustinHennis1/jabref in…

6d14ec9

…to ktooltip pulling changes from main to local

fixed markdown check

4fa4d10

JustinHennis1 requested a review from Siedlerchr April 11, 2025 04:55

Added logic for MSC code conversion cleanup. Actual cleanup() logic s…

24d5112

…till in progress

Siedlerchr reviewed Apr 12, 2025

View reviewed changes

src/main/java/org/jabref/gui/fieldeditors/KeywordsEditor.java Outdated Show resolved Hide resolved

Siedlerchr reviewed Apr 12, 2025

View reviewed changes

src/main/java/org/jabref/gui/fieldeditors/msccodes/MscCodeUtils.java Outdated Show resolved Hide resolved

added secondary cleanup to convert keywords in entries to their descr…

1ab572d

…iptions, bug: error when trying to cleanup when editor is open

JustinHennis1 closed this Apr 13, 2025

github-actions bot mentioned this pull request Apr 13, 2025

Clean up unsupported entrytype "other" or "conversion dialog" in JabRef 3.0+ #423

Closed

JustinHennis1 added 3 commits April 14, 2025 03:19

MSC code cleanup functional, msc_codes.json cleaned for comma delimit…

a1d0c92

…er and special characters were added

Cleaned msc json for extra commas

475c3b9

Tests updated for msc code conversion

b3e11f5

JustinHennis1 reopened this Apr 14, 2025

trag-bot bot reviewed Apr 14, 2025

View reviewed changes

JustinHennis1 added 3 commits April 15, 2025 19:09

localizations added, most tests pass, javafx issue with cleanuptest s…

339fb44

…till in progress

Merge branch 'ktooltip' of https://github.com/JustinHennis1/jabref in…

03eba4e

…to ktooltip Pulling changes from main

JavaFX initializes once for tests

430c1e0