Add support for LTWA (issue #12276) #12880

Yubo-Cao · 2025-04-03T04:34:15Z

Closes #12273

I have modified the src/main/java/org/jabref/gui/journals to handle the UI logics.
I have added the LTWARepository class and integrated it as a part of the JournalAbbreviationRepository to handle the LTWA abbreviation logics. I am not exactly sure if it would be appropriate to change the abbreviation class since that class appears to be largely a data class, and I am hesitant to add business logics to it.

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.

src/main/java/org/jabref/cli/LtwaListMvGenerator.java

src/main/java/org/jabref/gui/journals/AbbreviationType.java

src/main/java/org/jabref/logic/journals/JournalAbbreviationLoader.java

src/main/java/org/jabref/logic/journals/JournalAbbreviationRepository.java

src/main/java/org/jabref/logic/journals/ltwa/LtwaParser.java

src/main/java/org/jabref/logic/journals/ltwa/LtwaRepository.java

src/main/java/org/jabref/logic/journals/ltwa/PrefixTree.java

src/test/java/org/jabref/logic/journals/LtwaRepositoryTest.java

src/main/java/org/jabref/cli/LtwaListMvGenerator.java

calixtus · 2025-04-03T10:25:15Z

src/main/java/org/jabref/logic/journals/JournalAbbreviationLoader.java

+        try (InputStream resourceAsStream = JournalAbbreviationRepository.class.getResourceAsStream("/journals/ltwa-list.mv")) {
+            if (resourceAsStream == null) {
+                LOGGER.warn("There is no ltwa-list.mv. We cannot load the LTWA repository.");
+                return null;


I changed it to make it throw instead of null and let the public method take care of that.

src/main/java/org/jabref/logic/journals/ltwa/Lexer.java

src/main/java/org/jabref/logic/journals/ltwa/LtwaParser.java

src/main/java/org/jabref/gui/journals/UndoableAbbreviator.java

Yubo-Cao · 2025-04-05T04:02:35Z

I have updated the implementation to use Antlr. I am not sure if this issue is reproducible: whenever I tried to use the Antlr-generated source to develop on my local machine after the initial gradlew clean build, the build failed with undefined symbol errors.

src/main/java/org/jabref/logic/journals/ltwa/LtwaRepository.java

src/main/java/org/jabref/logic/journals/ltwa/NormalizeUtils.java

src/main/java/org/jabref/logic/journals/ltwa/PrefixTree.java

src/test/java/org/jabref/logic/journals/LtwaRepositoryTest.java

src/main/java/org/jabref/cli/LtwaListMvGenerator.java

src/main/java/org/jabref/logic/journals/ltwa/LtwaRepository.java

src/main/java/org/jabref/logic/journals/ltwa/LtwaTsvParser.java

src/main/java/org/jabref/logic/journals/ltwa/NormalizeUtils.java

…r-issue-12273 # Conflicts: # src/main/java/org/jabref/cli/LtwaListMvGenerator.java # src/main/java/org/jabref/gui/journals/UndoableAbbreviator.java # src/main/java/org/jabref/logic/journals/ltwa/LtwaRepository.java # src/main/java/org/jabref/logic/journals/ltwa/LtwaTsvParser.java # src/main/java/org/jabref/logic/journals/ltwa/NormalizeUtils.java # src/test/java/org/jabref/logic/journals/LtwaRepositoryTest.java

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

src/main/java/org/jabref/logic/journals/ltwa/PrefixTree.java

Yubo-Cao · 2025-04-03T12:44:52Z

src/main/java/org/jabref/logic/journals/ltwa/PrefixTree.java

+        }
+
+        SearchState state = new SearchState(node, index);
+        if (visited.contains(state)) {


I'm unsure where I nest the logic inside the "else" branches; this method is recursive.

Yubo-Cao · 2025-04-03T12:53:19Z

src/main/java/org/jabref/logic/journals/JournalAbbreviationLoader.java

+        try (InputStream resourceAsStream = JournalAbbreviationRepository.class.getResourceAsStream("/journals/ltwa-list.mv")) {
+            if (resourceAsStream == null) {
+                LOGGER.warn("There is no ltwa-list.mv. We cannot load the LTWA repository.");
+                return null;


I changed it to make it throw instead of null and let the public method take care of that.

src/main/java/org/jabref/logic/journals/ltwa/LtwaParser.java

Yubo-Cao · 2025-04-06T00:25:43Z

src/main/java/org/jabref/logic/journals/ltwa/LtwaTsvParser.java

+                var languageStr = matcher.group(3);
+
+                word = NormalizeUtils.normalize(ANNOTATION.matcher(word).replaceAll("").strip());
+                var abbreviation = abbreviationStr.equals("n.a.") ? null : abbreviationStr;


I would like to acknowledge that it's not possible to serialize Optional, and I figured it would be unwise to store an extra field called isAbbreviationPresent and store something arbitary in the actual abbreviation. As such, I left it null.

src/main/java/org/jabref/gui/journals/UndoableAbbreviator.java

src/main/java/org/jabref/logic/journals/ltwa/LtwaTsvParser.java

src/main/java/org/jabref/cli/LtwaListMvGenerator.java

Siedlerchr

Impressive! Works

trag-bot · 2025-04-07T20:32:54Z

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

Integrate journal abbreviation toggle functionality (JabRef#12880) with the LTWA repository support from main branch. Resolve conflicts in JournalAbbreviationRepository, JournalAbbreviationLoader, and MainMenu to ensure both features work correctly together. The combined functionality allows users to enable/disable specific journal abbreviation sources while maintaining LTWA abbreviation support.

* Implement LTWA abbreviation * Create LTWA resource download in the gradle tasks * Connected the LTWA logic with the GUI * Updated the CHANGELOG.md * Fix according to Trag * Reimplement with Antlr * Fix errors from previous PR * Use Optional as Trag suggested * Fix the locale translation issue --------- Co-authored-by: Christoph <[email protected]>

Yubo-Cao added 4 commits April 2, 2025 23:05

Implement LTWA abbreviation

305d271

Create LTWA resource download in the gradle tasks

a0b732d

Connected the LTWA logic with the GUI

0d4d9f9

Updated the CHANGELOG.md

507016e

trag-bot bot reviewed Apr 3, 2025

View reviewed changes

src/main/java/org/jabref/cli/LtwaListMvGenerator.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 3, 2025

View reviewed changes

src/main/java/org/jabref/cli/LtwaListMvGenerator.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 3, 2025

View reviewed changes

src/main/java/org/jabref/gui/journals/AbbreviationType.java Show resolved Hide resolved

trag-bot bot reviewed Apr 3, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/JournalAbbreviationLoader.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 3, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/JournalAbbreviationRepository.java Show resolved Hide resolved

trag-bot bot reviewed Apr 3, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/JournalAbbreviationRepository.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 3, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/ltwa/LtwaParser.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 3, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/ltwa/LtwaParser.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 3, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/ltwa/LtwaParser.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 3, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/ltwa/LtwaRepository.java Show resolved Hide resolved

trag-bot bot reviewed Apr 3, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/ltwa/LtwaRepository.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 3, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/ltwa/PrefixTree.java Show resolved Hide resolved

trag-bot bot reviewed Apr 3, 2025

View reviewed changes

src/test/java/org/jabref/logic/journals/LtwaRepositoryTest.java Outdated Show resolved Hide resolved

calixtus reviewed Apr 3, 2025

View reviewed changes

src/main/java/org/jabref/cli/LtwaListMvGenerator.java Outdated Show resolved Hide resolved

calixtus reviewed Apr 3, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/ltwa/Lexer.java Outdated Show resolved Hide resolved

calixtus reviewed Apr 3, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/ltwa/LtwaParser.java Outdated Show resolved Hide resolved

calixtus changed the title ~~Fix for issue 12273~~ Add support for LTWA (issue #12276) Apr 3, 2025

Fix according to Trag

e4517a0

trag-bot bot reviewed Apr 3, 2025

View reviewed changes

src/main/java/org/jabref/gui/journals/UndoableAbbreviator.java Show resolved Hide resolved

trag-bot bot reviewed Apr 3, 2025

View reviewed changes

src/main/java/org/jabref/gui/journals/UndoableAbbreviator.java Outdated Show resolved Hide resolved

Reimplement with Antlr

5070c3e

trag-bot bot reviewed Apr 5, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/ltwa/LtwaRepository.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 5, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/ltwa/NormalizeUtils.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 5, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/ltwa/NormalizeUtils.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 5, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/ltwa/PrefixTree.java Show resolved Hide resolved

trag-bot bot reviewed Apr 5, 2025

View reviewed changes

src/test/java/org/jabref/logic/journals/LtwaRepositoryTest.java Outdated Show resolved Hide resolved

Yubo-Cao and others added 2 commits April 5, 2025 16:57

Merge branch 'JabRef:main' into fix-for-issue-12273

a378abc

Fix errors from previous PR

9003350

trag-bot bot reviewed Apr 6, 2025

View reviewed changes

src/main/java/org/jabref/cli/LtwaListMvGenerator.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 6, 2025

View reviewed changes

src/main/java/org/jabref/cli/LtwaListMvGenerator.java Show resolved Hide resolved

trag-bot bot reviewed Apr 6, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/ltwa/LtwaRepository.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Apr 6, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/ltwa/LtwaTsvParser.java Show resolved Hide resolved

trag-bot bot reviewed Apr 6, 2025

View reviewed changes

src/main/java/org/jabref/logic/journals/ltwa/NormalizeUtils.java Outdated Show resolved Hide resolved

Yubo-Cao added 3 commits April 5, 2025 21:48

Use Optional as Trag suggested

a847b8b

Fix the locale translation issue

913b33d

trag-bot bot reviewed Apr 6, 2025

View reviewed changes

src/main/java/org/jabref/gui/actions/StandardActions.java Show resolved Hide resolved

Yubo-Cao commented Apr 7, 2025

View reviewed changes

Siedlerchr previously approved these changes Apr 7, 2025

View reviewed changes

Merge branch 'main' into fix-for-issue-12273

8290d10

Siedlerchr dismissed their stale review via 8290d10 April 7, 2025 20:32

Siedlerchr added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Apr 7, 2025

Siedlerchr enabled auto-merge April 8, 2025 18:43

Siedlerchr approved these changes Apr 8, 2025

View reviewed changes

Siedlerchr added this pull request to the merge queue Apr 8, 2025

Merged via the queue into JabRef:main with commit 1a4e1f3 Apr 8, 2025
1 check passed

zikunz mentioned this pull request Apr 18, 2025

Add toggle functionality for journal abbreviation lists #12912

Open

7 tasks

GDeane mentioned this pull request Apr 20, 2025

Moved Journal Abbreviation from Quality Menu to Cleanup Entries Dialog #12835

Open

7 tasks

subhramit mentioned this pull request Apr 21, 2025

Enhance LTWA code #12977

Merged

3 tasks

Uh oh!

Add support for LTWA (issue #12276) #12880

Add support for LTWA (issue #12276) #12880

Uh oh!

Conversation

Yubo-Cao commented Apr 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Mandatory checks

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

calixtus Apr 3, 2025

Choose a reason for hiding this comment

Uh oh!

Yubo-Cao Apr 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Yubo-Cao commented Apr 5, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Yubo-Cao Apr 3, 2025

Choose a reason for hiding this comment

Uh oh!

Yubo-Cao Apr 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Yubo-Cao Apr 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Siedlerchr left a comment

Choose a reason for hiding this comment

Uh oh!

trag-bot bot commented Apr 7, 2025

Uh oh!

Uh oh!

Uh oh!

Yubo-Cao commented Apr 3, 2025 •

edited

Loading