add: CAYW endpoint formats

[josephyim]

Closes #13578

Added formatters mentioned in the issue and http tests on org.jabref.http.server.CAYWResource

Steps to test

Follow the guideline on https://devdocs.jabref.org/code-howtos/http-server.html#start-http-server to start the server.
Examples of command to run are:

curl http://localhost:23119/better-bibtex/cayw?format=natbib
curl http://localhost:23119/better-bibtex/cayw?format=pandoc
curl "http://localhost:23119/better-bibtex/cayw?format=citet&command=abc"

Mandatory checks

• I own the copyright of the code submitted and I license it under the MIT license
• I manually tested my changes in running JabRef (always required)
• I added JUnit tests for changes (if applicable)
• I added screenshots in the PR description (if change is visible to the user)
• I described the change in CHANGELOG.md in a way that is understandable for the average user (if change is visible to the user)
• I checked the user 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 updating file(s) in https://github.com/JabRef/user-documentation/tree/main/en.

[josephyim]

@palukku Hi Philip, I made a mess in commit history on my remote branch, so asked AI what to do. At the end, the commit history looks good now, I pushed with force and the test failed. What can I do to resolve this?
Thank you.

[palukku]

Is there a specific reason on why you switched from the map and registry approach to the new switch/case approach?

I'm fine with both but I'm curious what your thoughts behind this were

[josephyim]

latex, cite, citep and citet are alias of natbib, so they share the same output format. However, if command is not specified, the default value of each format is:

Format	Default command
latex cite natbib	cite
citep	citep
citet	citet

At first, I tried to keep the registry approach by doing below in, for example, NatbibFormatter:

// Replace CAYWFormatter#getFormatName by below method
@Override
public List<String> getFormatNames() {
    return List.of("natbib", "latex", "cite", "citep", "citet");
}

@Override
public String format(CAYWQueryParams queryParams, List<CAYWEntry> caywEntries) {
    String command = queryParams.getCommand().orElseGet(() -> {
        String format = queryParams.getFormat();
        switch (format) {
            case "natbib":
            case "latex":
            case "cite":
                return "cite";
            case "citep":
                return "citep";
            case "citet":
                return "citet";
            default:
                return "cite";
        }
    });
    ...
}

In this way, I have 2 concerns:

1. queryParams.getFormat() in theory will not be null, but I can't 100% feel safe about this. Just in case it is null, I don't have a nice way of handling it.
2. If we have a new format using the same Formatter, then we need to add the new format in both getFormatNames and format.
   Because of above, I put the the new switch/case approach in the FormatterService.java class. I am happy to edit if this is not a good approach. Thanks.

[palukku]

@palukku Hi Philip, I made a mess in commit history on my remote branch, so asked AI what to do. At the end, the commit history looks good now, I pushed with force and the test failed. What can I do to resolve this? Thank you.

No need to worry, next time just add new commits it does not matter if you have changes later on on things you also have in an earlier commit because as the bot already wrote will get squashed anyway.

[palukku]

Currently I have very limited time, I will do a full review on thursday evening.

[palukku]

Maybe we should use the full cite command (example there: #cite(<arrgh>)) also think about:
If your source name contains certain characters such as slashes, which are not recognized by the <> syntax, you can explicitly call label instead.

[josephyim]

Thank you for the review. I updated the code to use #cite(label("arrgh")), just in case slash is used.

[palukku]

I would like it to only add the label thing when there is a slash present, so it is only used when necessary.

[josephyim]

I modified such that when there are multiple keys, only the ones containing slash will be formatted with the label thing, and the other keys will use the @ thing. Please see whether this is what you intend. Thanks.

[palukku]

This comment and the othere smells like ai? Also please remove, adds nothing meaningful to the code.

[josephyim]

Yes, I did use AI to generate the tests, then I checked the code. Sorry that I overlooked this.

[palukku]

For this it's okay, but don't rely too much on ai when coding and always double check what the ai suggests.

Also delete the comments here: https://github.com/JabRef/jabref/pull/13785/files#diff-d3db9dc636031d931c6fe5cdfe69aff341619cda38fa586964c3b3bf6bc1d674R53-R56

[palukku]

Looks good to me

[palukku]

Now it should work and looks good

[palukku]

I should avoid committing things on my phone next time

[trag-bot]

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