CSL4LibreOffice - D [GSoC '24] #11636

subhramit · 2024-08-16T14:02:50Z

Test suite, refactoring and documentation for OO-CSL components

[PR - D of the GSoC '24 CSL4LibreOffice Project]
Follow-up to #11477, #11521, #11577 and #11604

Miscellaneous refactoring (majorly shifting of utility functions to a new class - CSLFormatUtils).
Documentation for all methods created as a part the project.
Tests for all the utility formatting methods, and a few extras (e.g. StAX parser for title and isNumericStyle implemented during the project).

Mandatory checks

~~Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)~~
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
~~Screenshots added in PR description (for UI changes)~~
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.

…-tests

Siedlerchr · 2024-08-16T18:06:43Z

src/test/java/org/jabref/logic/citationstyle/CitationStyleGeneratorTest.java

@@ -58,6 +57,22 @@ void aPACitation() {
        assertEquals(expected, citation);
    }

+    /**


just mark the test @disabled

The comment is IMHO helpful. For someone diving into it 1 year later.

Marked disabled and kept the comment.

subhramit · 2024-08-20T07:59:01Z

@Siedlerchr @koppor @ThiloteE Review changes are done.

subhramit · 2024-08-20T09:16:27Z

Also manually adapted as per upcoming best practices enforcement: #11643.
(PR can be merged independently).

koppor · 2024-08-21T02:19:06Z

src/test/java/org/jabref/logic/citationstyle/CitationStyleGeneratorTest.java

+        String expected = "[Smit2016]";
+
+        assertEquals(expected, inTextCitationText);


One-liners can be inlined

Suggested change

String expected = "[Smit2016]";

assertEquals(expected, inTextCitationText);

assertEquals("[Smit2016]", inTextCitationText);

koppor · 2024-08-21T02:19:48Z

src/test/java/org/jabref/logic/citationstyle/CitationStyleTest.java

        List<CitationStyle> styleList = CitationStyle.discoverCitationStyles();
        assertNotNull(styleList);
    }
+
+    @ParameterizedTest
+    @MethodSource("citationStyleProvider")


Typically, name the providing method the same as the testing method

@MethodSource

However, in your case, you are providing one source for multiple tests.

Please split up your test case in three:

Name the methods as follows:

citationStylePresent

titleMatches

numericPropertyMatches

Do NOT use explanations for assertEquals. All of your text can be read out of the code.

Maybe, you are searching for the name parameter of @ParamterizedTest (https://stackoverflow.com/a/57894201/873282)?

Maybe, you are searching for the name parameter of @ParamterizedTest (https://stackoverflow.com/a/57894201/873282)?

This was an interesting read. Right now, we don't need it but can come in handy sometime.

Updated: used same name for provider and test method uniformly throughout PR.

koppor · 2024-08-21T02:24:17Z