Added a test case in CitationKeyGeneratorTest.java file #12194

yoyounik · 2024-11-16T10:47:01Z

Add test case for LaTeX command stripping in filename generation

Description
This PR adds a new test case to verify that LaTeX commands are correctly stripped from fields used for filename generation. Specifically, it checks if the generated filename removes commands like \mkbibquote while retaining the meaningful text.

The test case I added (testLatexCommandsAreStrippedFromCitationKey) verifies that LaTeX commands are stripped from the citation key when generating filenames. This aligns with the expected behavior described in the issue.

I could not run the test cases due to a dependency issue in my local setup.

Request: Please verify and run the test case to ensure it behaves as intended.
If the current solution does not fully address the issue, feel free to make necessary corrections.

NOTE -
This PR addresses this issue: #12188 (comment)

I own the copyright of the code submitted and I licence 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 (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.

yoyounik · 2024-11-16T10:52:05Z

hey @koppor
I could not run the test cases due to a dependency issue in my local setup.

Request: Please verify and run the test case to ensure it behaves as intended.
If the current solution does not fully address the issue, feel free to make necessary corrections and tell me if any changes i could make.

github-actions

Your code currently does not meet JabRef's code guidelines.
We use OpenRewrite to ensure "modern" Java coding practices.
The issues found can be automatically fixed.
Please execute the gradle task rewriteRun, check the results, commit, and push.

You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "OpenRewrite".

koppor · 2024-11-16T10:58:33Z

src/test/java/org/jabref/logic/citationkeypattern/CitationKeyGeneratorTest.java

@@ -18,6 +18,7 @@
 import org.junit.jupiter.params.provider.MethodSource;
 import org.mockito.Answers;

+import static org.jabref.gui.search.TextFlowEqualityHelper.assertEquals;


Wrong import

koppor · 2024-11-16T11:03:07Z

@yoyounik Please reference the issue this PR addresses.

koppor · 2024-11-16T11:04:36Z

src/test/java/org/jabref/logic/citationkeypattern/CitationKeyGeneratorTest.java

+    void testLatexCommandsAreStrippedFromCitationKey() throws ParseException {
+        BibEntry entry = new BibEntry()
+                .withField(StandardField.TITLE, "Building \\mkbibquote{Community}");
+        String pattern = "[title]";


Did you read the issue? Did your LLM fail? Which tool.did you use?

[bibtexkey] - [fulltitle]

Yes, I read the issue and understood the problem about LaTeX commands not being stripped correctly from fields used in filename generation.
I used an AI assistant to refine my understanding of the issue and help structure the PR. However, the final implementation and test case were written based on my own understanding. If there is any discrepancy, I take full responsibility for the work.
I used ChatGPT as a supporting tool to draft and clarify ideas.

I quoted the most important part of the issue above. Please adapt the test case accordingly.

Hey @koppor
i guess i need to read the documentation and little more about this to work on this currently.

Hey @koppor
i guess i need to read the documentation and little more about this to work on this currently.

You need to change a single line in your test case. Instead of [title] use the pattern reported by the user

Thanks @koppor , have updated the pattern reported by the user by [bibtexkey] - [fulltitle]

But i guess there is more to the issue

The import order does not match so i guess i will check it once, and some more unit test issue which i am going throw again

Hey @koppor i have made some changes accordingly, but still the OpenRewrite and UnitTest error is remaining, i will be checking it once again by tomorrow. If you have any hint please provide it , Thanks :)

Click on details to see the exact cause of the failure

github-actions

Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.

github-actions

Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.

github-actions

Your code currently does not meet JabRef's code guidelines.
We use OpenRewrite to ensure "modern" Java coding practices.
The issues found can be automatically fixed.
Please execute the gradle task rewriteRun, check the results, commit, and push.

You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "OpenRewrite".

github-actions

Your code currently does not meet JabRef's code guidelines.
We use OpenRewrite to ensure "modern" Java coding practices.
The issues found can be automatically fixed.
Please execute the gradle task rewriteRun, check the results, commit, and push.

You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "OpenRewrite".

koppor · 2024-11-17T21:43:44Z

src/main/java/org/jabref/logic/citationkeypattern/CitationKeyGenerator.java

@@ -105,7 +105,7 @@ public String generateKey(BibEntry entry) {
        String currentKey = entry.getCitationKey().orElse(null);

        String newKey = createCitationKeyFromPattern(entry);
-        newKey = replaceWithRegex(newKey);
+        newKey = newKey.replaceAll("\\\\[a-zA-Z]+\\{([^}]+)\\}", "$1");


No. Please try to understand the comment #12188 (comment).

github-actions

Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.

github-actions

Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.

github-actions

Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.

Added a test case in CitationKeyGeneratorTest.java file

c407a30

yoyounik mentioned this pull request Nov 16, 2024

Sanitization of generated filenames (remove LaTeX commands) #12188

Open

github-actions bot reviewed Nov 16, 2024

View reviewed changes

koppor requested changes Nov 16, 2024

View reviewed changes

removed the wrong import

581fb61

koppor requested changes Nov 16, 2024

View reviewed changes

github-actions bot reviewed Nov 16, 2024

View reviewed changes

Updated the pattern

8f66b40

github-actions bot reviewed Nov 17, 2024

View reviewed changes

Reorganized import

df2d656

github-actions bot reviewed Nov 17, 2024

View reviewed changes

Remove LaTeX commands (e.g., \mkbibquote{}) using regex.

f2559e5

github-actions bot reviewed Nov 17, 2024

View reviewed changes

koppor reviewed Nov 17, 2024

View reviewed changes

Updated with RemoveLatexCommandsFormatter in CitationKeyGenerator.java

f845041

github-actions bot reviewed Nov 18, 2024

View reviewed changes

Added the import for RemoveLatexCommandsFormatter

dd1f97f

github-actions bot reviewed Nov 18, 2024

View reviewed changes

Added imports for removing OpenRewrite issue

3b1eda2

github-actions bot reviewed Nov 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added a test case in CitationKeyGeneratorTest.java file #12194

Added a test case in CitationKeyGeneratorTest.java file #12194

yoyounik commented Nov 16, 2024 •

edited

Loading

yoyounik commented Nov 16, 2024

github-actions bot left a comment

koppor Nov 16, 2024

koppor commented Nov 16, 2024

koppor Nov 16, 2024

yoyounik Nov 16, 2024

koppor Nov 16, 2024

yoyounik Nov 17, 2024

koppor Nov 17, 2024

yoyounik Nov 17, 2024

yoyounik Nov 17, 2024

yoyounik Nov 17, 2024

yoyounik Nov 17, 2024

Siedlerchr Nov 17, 2024

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

koppor Nov 17, 2024

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

Added a test case in CitationKeyGeneratorTest.java file #12194

Are you sure you want to change the base?

Added a test case in CitationKeyGeneratorTest.java file #12194

Conversation

yoyounik commented Nov 16, 2024 • edited Loading

yoyounik commented Nov 16, 2024

github-actions bot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

koppor commented Nov 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

yoyounik commented Nov 16, 2024 •

edited

Loading