Add ICORE Ranking support #13512

asifebrahim · 2025-07-08T20:09:31Z

This is the PR request for issue no #13476

Steps to test

In the General field at the very bottom there sthe icoranking lookup fiield there one can search using a acronym and get the details about the conference.

NOTE

-The Abbreviation tests were failing before i added any code so there were a total of 76 failed test case sand after my addition it is still 76 and all of them are NullPointerException and I didn't fix that

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.

trag-bot · 2025-07-08T20:11:22Z

jabgui/src/main/java/module-info.java

@@ -11,6 +11,7 @@
    requires java.sql.rowset;

    // region JavaFX
+    requires javafx.swing;


The module requires both Swing and JavaFX dependencies, which violates the architectural decision to use only JavaFX for UI components. Swing dependencies should be removed.

remove the dep here

trag-bot · 2025-07-08T20:13:37Z

jabgui/src/test/java/org/jabref/gui/fieldeditors/FieldEditorsTest.java

+
+    @Test
+    void testEditorCreationDoesNotCrash() {
+        assertNotNull(FieldEditors.class);


According to modern testing practices, should assert specific contents/behavior rather than just checking for non-null conditions.

Remove this test - it is always true

trag-bot · 2025-07-08T20:14:33Z

jablib/src/main/java/org/jabref/logic/icore/ConferenceRankingEntry.java

+    public final String title;
+    public final String acronym;
+    public final String source;
+    public final String rank;
+    public final String note;
+    public final String dblp;
+    public final String primaryFor;
+    public final String comments;
+    public final String averageRating;


Class fields are declared as public, violating encapsulation principles. They should be private with getter methods to maintain proper encapsulation and control over data access.

Convert the class to record

trag-bot · 2025-07-08T20:16:59Z

jablib/src/test/java/org/jabref/logic/icore/ICoreRankingRepositoryTest.java

+        assertTrue(repo.getRankingFor("NON_EXISTENT").isEmpty());
+    }
+    @Test
+    public void test1(){


Test method name is not descriptive enough. It should clearly indicate what is being tested, such as 'testFuzzyMatchForInternationalConferenceOnSoftwareEngineering'.

trag-bot · 2025-07-08T20:17:34Z

jablib/src/test/java/org/jabref/logic/util/ConferenceUtilsTest.java

+        assertEquals(Optional.empty(), ConferenceUtil.extractAcronym(title));
+    }
+    @Test
+    void test1(){


Test method name is not descriptive enough and doesn't indicate what is being tested. Should describe the test scenario like 'testExtractAcronymFromConferenceWithParentheses'.

trag-bot · 2025-07-08T20:17:36Z

jablib/src/test/java/org/jabref/logic/util/ConferenceUtilsTest.java

+        assertEquals(Optional.of("ICSE"),ConferenceUtil.extractAcronym(title));
+    }
+    @Test
+    void test2(){


Test method name is not descriptive enough and doesn't indicate what is being tested. Should describe the test scenario like 'testExtractAcronymFromConferenceWithoutParentheses'.

koppor · 2025-07-09T01:36:32Z

jabgui/src/test/java/org/jabref/gui/fieldeditors/FieldEditorsTest.java

+
+    @Test
+    void testEditorCreationDoesNotCrash() {
+        assertNotNull(FieldEditors.class);


Remove this test - it is always true

koppor · 2025-07-09T01:36:58Z

jabgui/src/main/java/org/jabref/gui/fieldeditors/ICoreRankingEditor.java

+    public void bindToEntry(BibEntry entry) {
+        this.currentEntry = entry;
+
+//        System.out.println("ENTRY booktitle = " + entry.getField(StandardField.BOOKTITLE).orElse("none"));


Use LOGGER.debug - see https://devdocs.jabref.org/code-howtos/logging.html

koppor · 2025-07-09T01:37:22Z

jabgui/src/main/java/org/jabref/gui/fieldeditors/ICoreRankingEditor.java

+    Optional<String> acronym = ConferenceUtil.extractAcronym(rawInput); // Extracting the acronym from our input field
+    Optional<ConferenceRankingEntry> result = acronym.flatMap(repo::getFullEntry)
+            .or(() -> repo.getFullEntry(rawInput));  // Finding if any matching entry present in csv file
+// If present then print the info


Reformat the comments -- starting at column 1 is not ok

koppor · 2025-07-09T01:37:59Z

jabgui/src/main/java/org/jabref/gui/fieldeditors/ICoreRankingEditor.java

+        this.setSpacing(10);
+    }
+
+    // Deprecated method it only shows rank by puttin the acronym in the text field


Not sure what this code does.

I think, this should be removed -- it is part of some logic in all cases.

koppor · 2025-07-09T01:39:03Z

jablib/src/main/java/org/jabref/logic/icore/ConferenceRankingEntry.java

+            Primary FoR: %s
+            Comments: %s
+            Average Rating: %s
+            """, title, acronym, source, rank, note, dblp, primaryFor, comments, averageRating);


It is OK to have an additional way of showing the contents...

However, in future, use IntelliJ's feature to create a toString method

koppor · 2025-07-09T01:49:18Z

jablib/src/main/java/org/jabref/logic/icore/ICoreRankingRepository.java

+
+        try (BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8))) {
+            reader.lines().skip(1).forEach(line -> {
+                String[] parts = line.split(",(?=(?:[^\"]*\"[^\"]*\")*[^\"]*$)", -1);


No.

There are libraries for this. In JabRef, we use https://commons.apache.org/proper/commons-csv/

koppor · 2025-07-09T01:50:23Z

jablib/src/main/java/org/jabref/logic/icore/ICoreRankingRepository.java

+        LOGGER.info("Fuzzy match fallback triggered for: " + key);
+        return nameToRank.entrySet().stream()
+                .filter(e -> similarity.editDistanceIgnoreCase(e.getKey(), key) < 0.01)
+                .peek(e -> LOGGER.info("Fuzzy match candidate: " + e.getKey()))


Wrong logger format - use {} as place holder. See other code in JabRef.

(also applies for all other logger statements)

jablib/src/main/resources/ICORE.csv

koppor · 2025-07-09T01:52:14Z

jablib/src/main/java/org/jabref/logic/icore/ConferenceRankingEntry.java

+    public final String title;
+    public final String acronym;
+    public final String source;
+    public final String rank;
+    public final String note;
+    public final String dblp;
+    public final String primaryFor;
+    public final String comments;
+    public final String averageRating;


Convert the class to record

koppor · 2025-07-09T01:53:54Z

-The Abbreviation tests were failing before i

Maybe, you did not check out JabRef correctly. Execute git submodule update on the command line.

koppor · 2025-07-09T06:46:04Z

Regarding the output information

1: Should be link -- See other places in JabRef how to open a browser
2: Remove - this information is not useful

koppor · 2025-07-09T06:49:26Z

@asifebrahim You screenshort shows Icoranking as field name. It is ICORE, which should be rendered as Icoreranking in JabRef. You missed two letters. Also in your title in this PR, you missed two letters. Please engineer properly 😅.

koppor · 2025-07-09T06:50:09Z

Even though the larger button is more accessible - the current JabRef style is to use icons. Please use the same button style as in the DOI

koppor · 2025-07-09T06:59:38Z

You also need to do a preference migration - icoreranking needs to be added to general

Add a new method to org.jabref.migrations.PreferencesMigrations
Method is similar to org.jabref.migrations.PreferencesMigrations#removeCommentsFromCustomEditorTabs
Method has to check if the current content is General:doi;crossref;keywords;eprint;url;file;groups;owner;timestamp;printed;priority;qualityassured;ranking;readstatus;relevance. If yes, change it to doi;icoreranking;...

Also add the field directly after DOI to org.jabref.model.entry.field.FieldFactory#getDefaultGeneralFields.

koppor · 2025-07-10T10:15:20Z

@asifebrahim Before requesting a review, please fix the tests. Although it seems, I have endless time, in reality, I don't. I like automation and that machines can support us all in making good code. Thus, please, look at the failing tests.

koppor · 2025-07-10T10:17:47Z

jablib/src/main/java/org/jabref/logic/util/ConferenceUtil.java

+
+public class ConferenceUtil {
+    public static Optional<String> extractAcronym(String title) {
+        Matcher matcher = Pattern.compile("\\((.*?)\\)").matcher(title);


Pattern needs to be a private static final variable to be really speed saving

jabref-machine · 2025-07-10T10:18:23Z

You committed your code on the main brach of your fork. This is a bad practice. The right way is to branch out from main, work on your patch/feature in that new branch, and then get that branch merged via the pull request (see GitHub flow).

For this pull request, this is OK. For subsequent pull requests, please start with a different branch with a proper branch name. See CONTRIBUTING.md for more details.

jabref-machine · 2025-07-10T10:18:23Z

Note that your PR will not be reviewed/accepted until you have gone through the mandatory checks in the description and marked each of them them exactly in the format of [x] (done), [ ] (not done yet) or [/] (not applicable).

koppor

Please adress my review comments - and also the commetns by trag-bot.

Expecially:

There are libraries for this. In JabRef, we use commons.apache.org/proper/commons-csv

jabref-machine · 2025-07-10T20:15:22Z

Hey, we noticed that you force-pushed your changes. Force pushing is a 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.

In future, please avoid that. For now, you can continue working.

trag-bot · 2025-07-10T20:16:56Z

jabgui/src/main/java/org/jabref/gui/fieldeditors/ICoreRankingEditor.java

+
+        this.textField.setPromptText("Enter or lookup ICORE rank");
+
+//        Button lookupButton = new Button("Lookup Rank");


Commented code should be removed as it serves no purpose and clutters the codebase. Version control should be used to track code history instead.

trag-bot · 2025-07-10T20:16:57Z

jabgui/src/main/java/org/jabref/gui/fieldeditors/ICoreRankingEditor.java

+        alert.setTitle("ICORE Ranking Info");
+        alert.setHeaderText("Found Conference Details");


UI text uses title case instead of sentence case as required by project guidelines for consistency in the user interface.

trag-bot · 2025-07-10T20:18:09Z

jabgui/src/main/java/org/jabref/migrations/PreferencesMigrations.java

 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

 public class PreferencesMigrations {

    private static final Logger LOGGER = LoggerFactory.getLogger(PreferencesMigrations.class);
+    private JabRefGuiPreferences preferences;


Instance field introduces unnecessary state to what should be a utility class. This violates the principle of keeping utility classes stateless and thread-safe.

trag-bot · 2025-07-10T20:18:11Z

jabgui/src/main/java/org/jabref/migrations/PreferencesMigrations.java

-import java.util.List;
-import java.util.Map;
-import java.util.Optional;
+import java.util.*;


Using wildcard imports instead of specific imports reduces code readability and can lead to naming conflicts. Each import should be explicitly declared.

trag-bot · 2025-07-10T20:19:13Z

jablib/src/main/java/org/jabref/logic/icore/ConferenceRankingEntry.java

@@ -0,0 +1,26 @@
+package org.jabref.logic.icore;
+
+public record ConferenceRankingEntry(


The record lacks input validation for required fields. Some fields like title or acronym should not be null. Consider adding compact constructor with validation.

trag-bot · 2025-07-10T20:19:50Z

jablib/src/main/java/org/jabref/logic/icore/ICoreRankingRepository.java

+    final Map<String, String> acronymToRank = new HashMap<>();
+    private Map<String, String> nameToRank = new HashMap<>();
+    private Map<String, ConferenceRankingEntry> acronymMap = new HashMap<>();
+    private Map<String, ConferenceRankingEntry> nameMap = new HashMap<>();


Use modern Java data structures. HashMap initialization can be replaced with more concise Map.of() for empty maps, following modern Java practices.

trag-bot · 2025-07-10T20:19:53Z

jablib/src/main/java/org/jabref/logic/icore/ICoreRankingRepository.java

+//            System.out.println("Loaded entries:");
+//            acronymToRank.forEach((key, val) -> System.out.println("Acronym: " + key + " -> " + val));
+//            nameToRank.forEach((key, val) -> System.out.println("Name: " + key + " -> " + val));
+        } catch (NullPointerException | IOException e) {


NullPointerException should not be caught explicitly as it indicates a programming error. Additionally, only logging debug for a critical data loading failure is insufficient.

trag-bot · 2025-07-10T20:21:08Z

jablib/src/main/java/org/jabref/model/entry/field/FieldFactory.java

@@ -231,7 +231,7 @@ private static Set<Field> getAllFields() {
     * separate preferences object
     */
    public static List<Field> getDefaultGeneralFields() {
-        List<Field> defaultGeneralFields = new ArrayList<>(Arrays.asList(StandardField.DOI, StandardField.CROSSREF, StandardField.KEYWORDS, StandardField.EPRINT, StandardField.URL, StandardField.FILE, StandardField.GROUPS, StandardField.OWNER, StandardField.TIMESTAMP));
+        List<Field> defaultGeneralFields = new ArrayList<>(Arrays.asList(StandardField.DOI, StandardField.ICORERANKING, StandardField.CROSSREF, StandardField.KEYWORDS, StandardField.EPRINT, StandardField.URL, StandardField.FILE, StandardField.GROUPS, StandardField.OWNER, StandardField.TIMESTAMP));


Using ArrayList with Arrays.asList is an outdated pattern. Modern Java practices suggest using List.of() for creating immutable lists, which is more concise and efficient.

jabref-machine · 2025-07-10T20:21:57Z

JUnit tests of jablib are failing. You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. To see the test output, locate "Tests / Unit tests (pull_request)" and click on it.

You can then run these tests in IntelliJ to reproduce the failing tests locally. We offer a quick test running howto in the section Final build system checks in our setup guide.

trag-bot · 2025-07-10T20:22:17Z

jablib/src/main/java/org/jabref/model/entry/field/StandardField.java

+    MODIFICATIONDATE("modificationdate", FieldProperty.DATE),
+    ICORERANKING("icoreranking");


Extra blank line added between fields without adding new statements, which violates code formatting consistency within the enum declaration.

koppor

The more we iterate the more non-working AI-generated code seems to come in.

Please, either take this as programming exercise or free the issue for someone else making the impression wanting to learn how to craft high-quality java code. - At least, we would like to have the impression that this is taken serious.

koppor · 2025-07-11T02:10:19Z

jabgui/src/main/java/org/jabref/gui/fieldeditors/ICoreRankingEditor.java

+        ConferenceRankingEntry entry = result.get();
+
+        // Show in new dialog
+        javafx.scene.control.Alert alert = new javafx.scene.control.Alert(javafx.scene.control.Alert.AlertType.INFORMATION);


I think, this is for debugging and can be removed?

koppor · 2025-07-11T02:11:18Z

jabgui/src/main/java/org/jabref/gui/fieldeditors/ICoreRankingEditor.java

+    Optional<String> icoreField = currentEntry.getField(StandardField.ICORERANKING);
+    Optional<String> bookTitle = currentEntry.getFieldOrAlias(StandardField.BOOKTITLE);
+    if (bookTitle.isEmpty()) {
+        bookTitle = currentEntry.getField(StandardField.JOURNAL);


also getFieldOrAlias

koppor · 2025-07-11T02:11:38Z

jabgui/src/main/java/org/jabref/gui/fieldeditors/ICoreRankingEditor.java

+        bookTitle = currentEntry.getField(StandardField.JOURNAL);
+    }
+
+    Optional<String> finalBookTitle = bookTitle;


What is this?

koppor · 2025-07-11T02:12:04Z

jabgui/src/main/java/org/jabref/migrations/PreferencesMigrations.java

@@ -562,7 +557,21 @@ static void moveApiKeysToKeyring(JabRefCliPreferences preferences) {
     * The tab "Comments" is hard coded using {@link CommentsTab} since v5.10 (and thus hard-wired in {@link org.jabref.gui.entryeditor.EntryEditor#createTabs()}.
     * Thus, the configuration ih the preferences is obsolete
     */
+


Some AI tool always adds an empty line above the method - which AI tool is this?

This is wrong!

koppor · 2025-07-11T02:13:09Z

jablib/src/test/java/org/jabref/logic/icore/ICoreRankingRepositoryTest.java

+    @Test
+    public void printAllAcronyms() {
+        ICoreRankingRepository repo = new ICoreRankingRepository();
+        repo.acronymToRank.forEach((key, value) -> System.out.println(key + " => " + value));


This is NOT a test

Added the feature of IcoRanking

dc90043

trag-bot bot reviewed Jul 8, 2025

View reviewed changes

koppor requested changes Jul 9, 2025

View reviewed changes

asifebrahim force-pushed the main branch from 8a94233 to eb18adf Compare July 9, 2025 16:49

asifebrahim requested a review from koppor July 9, 2025 16:51

koppor reviewed Jul 10, 2025

View reviewed changes

koppor requested changes Jul 10, 2025

View reviewed changes

Fixed all the unnecessary things

a318676

asifebrahim force-pushed the main branch from 11738ef to a318676 Compare July 10, 2025 20:13

trag-bot bot reviewed Jul 10, 2025

View reviewed changes

koppor changed the title ~~Added the feature of IcoRanking~~ Add ICORE Ranking support Jul 11, 2025

koppor requested changes Jul 11, 2025

View reviewed changes


		this.textField.setPromptText("Enter or lookup ICORE rank");

		// Button lookupButton = new Button("Lookup Rank");

		alert.setTitle("ICORE Ranking Info");
		alert.setHeaderText("Found Conference Details");

		@@ -0,0 +1,26 @@
		package org.jabref.logic.icore;

		public record ConferenceRankingEntry(

		MODIFICATIONDATE("modificationdate", FieldProperty.DATE),
		ICORERANKING("icoreranking");

Uh oh!

Add ICORE Ranking support #13512

Are you sure you want to change the base?

Add ICORE Ranking support #13512

Conversation

asifebrahim commented Jul 8, 2025 • edited by Siedlerchr Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Steps to test

NOTE

Mandatory checks

Uh oh!

trag-bot bot Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Jul 8, 2025

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!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

koppor commented Jul 9, 2025

Uh oh!

koppor commented Jul 9, 2025

Uh oh!

koppor commented Jul 9, 2025

Uh oh!

koppor commented Jul 9, 2025

Uh oh!

koppor commented Jul 9, 2025

Uh oh!

koppor commented Jul 10, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jabref-machine commented Jul 10, 2025

Uh oh!

jabref-machine commented Jul 10, 2025

Uh oh!

koppor left a comment

Choose a reason for hiding this comment

Uh oh!

jabref-machine commented Jul 10, 2025

Uh oh!

trag-bot bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Jul 10, 2025

Choose a reason for hiding this comment

asifebrahim commented Jul 8, 2025 •

edited by Siedlerchr

Loading