add new formatters and cayw resource tests

jinchat-joseph-yim · jinchat-joseph-yim · commit fbbb325fa4be · 2025-08-30T21:46:08.000+08:00
diff --git a/jabsrv/src/main/java/org/jabref/http/server/cayw/CAYWQueryParams.java b/jabsrv/src/main/java/org/jabref/http/server/cayw/CAYWQueryParams.java
@@ -22,7 +22,6 @@ public class CAYWQueryParams {
     private String clipboard;
 
     @QueryParam("command")
-    @DefaultValue("autocite")
     private String command;
 
     @QueryParam("minimize")
@@ -46,8 +45,8 @@ public class CAYWQueryParams {
     @QueryParam("application")
     private String application;
 
-    public String getCommand() {
-        return command;
+    public Optional<String> getCommand() {
+        return Optional.ofNullable(command);
     }
 
     public boolean isClipboard() {
diff --git a/jabsrv/src/main/java/org/jabref/http/server/cayw/CAYWResource.java b/jabsrv/src/main/java/org/jabref/http/server/cayw/CAYWResource.java
@@ -74,7 +74,7 @@ public Response getCitation(
         if (queryParams.isProbe()) {
             return Response.ok("ready").build();
         }
-        
+
         BibDatabaseContext databaseContext = getBibDatabaseContext(queryParams);
 
         // Selected parameter handling
@@ -127,7 +127,7 @@ public Response getCitation(
 
         // Push to Application parameter handling
         if (queryParams.getApplication().isPresent()) {
-            CitationCommandString citationCmd = new CitationCommandString("\\".concat(queryParams.getCommand()).concat("{"), ",", "}");
+            CitationCommandString citationCmd = new CitationCommandString("\\".concat(queryParams.getCommand().orElse("autocite")).concat("{"), ",", "}");
             PushToApplications.getApplication(queryParams.getApplication().get(), LOGGER::info, preferences.getPushToApplicationPreferences().withCitationCommand(citationCmd))
                               .ifPresent(application -> application.pushEntries(searchResults.stream().map(CAYWEntry::bibEntry).toList()));
         }
diff --git a/jabsrv/src/main/java/org/jabref/http/server/cayw/format/BibLatexFormatter.java b/jabsrv/src/main/java/org/jabref/http/server/cayw/format/BibLatexFormatter.java
@@ -1,6 +1,7 @@
 package org.jabref.http.server.cayw.format;
 
 import java.util.List;
+import java.util.Optional;
 import java.util.stream.Collectors;
 
 import org.jabref.http.server.cayw.CAYWQueryParams;
@@ -13,9 +14,11 @@
 @Service
 public class BibLatexFormatter implements CAYWFormatter {
 
-    @Override
-    public String getFormatName() {
-        return "biblatex";
+    private final String defaultCommand;
+
+    public BibLatexFormatter(String defaultCommand) {
+        super();
+        this.defaultCommand = defaultCommand;
     }
 
     @Override
@@ -25,15 +28,16 @@ public MediaType getMediaType() {
 
     @Override
     public String format(CAYWQueryParams queryParams, List<CAYWEntry> caywEntries) {
-        String command = queryParams.getCommand();
+        String command = queryParams.getCommand().orElse(defaultCommand);
 
         List<BibEntry> bibEntries = caywEntries.stream()
                 .map(CAYWEntry::bibEntry)
                 .toList();
 
         return "\\%s{%s}".formatted(command,
                 bibEntries.stream()
-                          .map(entry -> entry.getCitationKey().orElse(""))
+                          .map(BibEntry::getCitationKey)
+                          .flatMap(Optional::stream)
                           .collect(Collectors.joining(",")));
     }
 }
diff --git a/jabsrv/src/main/java/org/jabref/http/server/cayw/format/CAYWFormatter.java b/jabsrv/src/main/java/org/jabref/http/server/cayw/format/CAYWFormatter.java
@@ -9,8 +9,6 @@
 
 public interface CAYWFormatter {
 
-    String getFormatName();
-
     MediaType getMediaType();
 
     String format(CAYWQueryParams caywQueryParams, List<CAYWEntry> caywEntries);
diff --git a/jabsrv/src/main/java/org/jabref/http/server/cayw/format/FormatterService.java b/jabsrv/src/main/java/org/jabref/http/server/cayw/format/FormatterService.java
@@ -1,7 +1,6 @@
 package org.jabref.http.server.cayw.format;
 
-import java.util.HashMap;
-import java.util.Map;
+import java.util.Locale;
 
 import org.jabref.http.server.cayw.CAYWQueryParams;
 
@@ -10,20 +9,32 @@
 @Service
 public class FormatterService {
 
-    private static final String DEFAULT_FORMATTER = "biblatex";
-    private final Map<String, CAYWFormatter> formatters;
-
     public FormatterService() {
-        this.formatters = new HashMap<>();
-        registerFormatter(new SimpleJsonFormatter());
-        registerFormatter(new BibLatexFormatter());
-    }
-
-    public void registerFormatter(CAYWFormatter formatter) {
-        formatters.putIfAbsent(formatter.getFormatName(), formatter);
     }
 
     public CAYWFormatter getFormatter(CAYWQueryParams queryParams) {
-        return formatters.getOrDefault(queryParams.getFormat().toLowerCase(), formatters.get(DEFAULT_FORMATTER));
+        String format = queryParams.getFormat().toLowerCase(Locale.ROOT);
+
+        switch (format) {
+            case "natbib":
+            case "latex":
+            case "cite":
+                return new NatbibFormatter("cite");
+            case "citep":
+                return new NatbibFormatter("citep");
+            case "citet":
+                return new NatbibFormatter("citet");
+            case "mmd":
+                return new MMDFormatter();
+            case "pandoc":
+                return new PandocFormatter();
+            case "simple-json":
+                return new SimpleJsonFormatter();
+            case "typst":
+                return new TypstFormatter();
+            case "biblatex":
+            default:
+                return new BibLatexFormatter("autocite");
+        }
     }
 }
diff --git a/jabsrv/src/main/java/org/jabref/http/server/cayw/format/MMDFormatter.java b/jabsrv/src/main/java/org/jabref/http/server/cayw/format/MMDFormatter.java
@@ -0,0 +1,31 @@
+package org.jabref.http.server.cayw.format;
+
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+import org.jabref.http.server.cayw.CAYWQueryParams;
+import org.jabref.http.server.cayw.gui.CAYWEntry;
+import org.jabref.model.entry.BibEntry;
+
+import jakarta.ws.rs.core.MediaType;
+
+public class MMDFormatter implements CAYWFormatter {
+
+    @Override
+    public MediaType getMediaType() {
+        return MediaType.TEXT_PLAIN_TYPE;
+    }
+
+    @Override
+    public String format(CAYWQueryParams queryParams, List<CAYWEntry> caywEntries) {
+        List<BibEntry> bibEntries = caywEntries.stream()
+                                               .map(CAYWEntry::bibEntry)
+                                               .toList();
+
+        return bibEntries.stream()
+                         .map(entry -> entry.getCitationKey().map("[#%s][]"::formatted))
+                         .flatMap(Optional::stream)
+                         .collect(Collectors.joining(""));
+    }
+}
diff --git a/jabsrv/src/main/java/org/jabref/http/server/cayw/format/NatbibFormatter.java b/jabsrv/src/main/java/org/jabref/http/server/cayw/format/NatbibFormatter.java
@@ -0,0 +1,42 @@
+package org.jabref.http.server.cayw.format;
+
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+import org.jabref.http.server.cayw.CAYWQueryParams;
+import org.jabref.http.server.cayw.gui.CAYWEntry;
+import org.jabref.model.entry.BibEntry;
+
+import jakarta.ws.rs.core.MediaType;
+import org.jvnet.hk2.annotations.Service;
+
+@Service
+public class NatbibFormatter implements CAYWFormatter {
+
+    private final String defaultCommand;
+
+    public NatbibFormatter(String defaultCommand) {
+        this.defaultCommand = defaultCommand;
+    }
+
+    @Override
+    public MediaType getMediaType() {
+        return MediaType.TEXT_PLAIN_TYPE;
+    }
+
+    @Override
+    public String format(CAYWQueryParams queryParams, List<CAYWEntry> caywEntries) {
+        String command = queryParams.getCommand().orElse(defaultCommand);
+
+        List<BibEntry> bibEntries = caywEntries.stream()
+                                               .map(CAYWEntry::bibEntry)
+                                               .toList();
+
+        return "\\%s{%s}".formatted(command,
+                bibEntries.stream()
+                          .map(BibEntry::getCitationKey)
+                          .flatMap(Optional::stream)
+                          .collect(Collectors.joining(",")));
+    }
+}
diff --git a/jabsrv/src/main/java/org/jabref/http/server/cayw/format/PandocFormatter.java b/jabsrv/src/main/java/org/jabref/http/server/cayw/format/PandocFormatter.java
@@ -0,0 +1,31 @@
+package org.jabref.http.server.cayw.format;
+
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+import org.jabref.http.server.cayw.CAYWQueryParams;
+import org.jabref.http.server.cayw.gui.CAYWEntry;
+import org.jabref.model.entry.BibEntry;
+
+import jakarta.ws.rs.core.MediaType;
+
+public class PandocFormatter implements CAYWFormatter {
+
+    @Override
+    public MediaType getMediaType() {
+        return MediaType.TEXT_PLAIN_TYPE;
+    }
+
+    @Override
+    public String format(CAYWQueryParams queryParams, List<CAYWEntry> caywEntries) {
+        List<BibEntry> bibEntries = caywEntries.stream()
+                                               .map(CAYWEntry::bibEntry)
+                                               .toList();
+
+        return "[%s]".formatted(bibEntries.stream()
+                                          .map(entry -> entry.getCitationKey().map("@%s"::formatted))
+                                          .flatMap(Optional::stream)
+                                          .collect(Collectors.joining("; ")));
+    }
+}
diff --git a/jabsrv/src/main/java/org/jabref/http/server/cayw/format/SimpleJsonFormatter.java b/jabsrv/src/main/java/org/jabref/http/server/cayw/format/SimpleJsonFormatter.java
@@ -20,11 +20,6 @@ public SimpleJsonFormatter() {
         this.gson = new GsonFactory().provide();
     }
 
-    @Override
-    public String getFormatName() {
-        return "simple-json";
-    }
-
     @Override
     public MediaType getMediaType() {
         return MediaType.APPLICATION_JSON_TYPE;
diff --git a/jabsrv/src/main/java/org/jabref/http/server/cayw/format/TypstFormatter.java b/jabsrv/src/main/java/org/jabref/http/server/cayw/format/TypstFormatter.java
@@ -0,0 +1,31 @@
+package org.jabref.http.server.cayw.format;
+
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+import org.jabref.http.server.cayw.CAYWQueryParams;
+import org.jabref.http.server.cayw.gui.CAYWEntry;
+import org.jabref.model.entry.BibEntry;
+
+import jakarta.ws.rs.core.MediaType;
+
+public class TypstFormatter implements CAYWFormatter {
+
+    @Override
+    public MediaType getMediaType() {
+        return MediaType.TEXT_PLAIN_TYPE;
+    }
+
+    @Override
+    public String format(CAYWQueryParams queryParams, List<CAYWEntry> caywEntries) {
+        List<BibEntry> bibEntries = caywEntries.stream()
+                                               .map(CAYWEntry::bibEntry)
+                                               .toList();
+
+        return bibEntries.stream()
+                         .map(entry -> entry.getCitationKey().map("@%s"::formatted))
+                         .flatMap(Optional::stream)
+                         .collect(Collectors.joining(" "));
+    }
+}
diff --git a/jabsrv/src/test/java/org/jabref/http/server/ServerTest.java b/jabsrv/src/test/java/org/jabref/http/server/ServerTest.java
@@ -3,14 +3,18 @@
 import java.util.EnumSet;
 import java.util.List;
 
+import javafx.collections.FXCollections;
+
 import org.jabref.http.JabRefSrvStateManager;
 import org.jabref.http.SrvStateManager;
 import org.jabref.http.dto.GlobalExceptionMapper;
 import org.jabref.http.dto.GsonFactory;
+import org.jabref.http.server.cayw.format.FormatterService;
 import org.jabref.http.server.services.FilesToServe;
 import org.jabref.logic.bibtex.FieldPreferences;
 import org.jabref.logic.importer.ImportFormatPreferences;
 import org.jabref.logic.preferences.CliPreferences;
+import org.jabref.logic.preferences.LastFilesOpenedPreferences;
 import org.jabref.model.entry.BibEntryPreferences;
 
 import com.google.gson.Gson;
@@ -32,7 +36,7 @@
  * </ul>
  * <p>More information on testing with Jersey is available at <a href="https://eclipse-ee4j.github.io/jersey.github.io/documentation/latest/test-framework.html">the Jersey's testing documentation</a></p>.
  */
-abstract class ServerTest extends JerseyTest {
+public abstract class ServerTest extends JerseyTest {
 
     private static CliPreferences preferences;
 
@@ -81,6 +85,15 @@ protected void configure() {
     }
 
     protected void addPreferencesToResourceConfig(ResourceConfig resourceConfig) {
+        resourceConfig.register(new AbstractBinder() {
+            @Override
+            protected void configure() {
+                bind(new FormatterService()).to(FormatterService.class);
+            }
+        });
+    }
+
+    protected void addFormatterServiceToResourceConfig(ResourceConfig resourceConfig) {
         resourceConfig.register(new AbstractBinder() {
             @Override
             protected void configure() {
@@ -111,6 +124,10 @@ private static void initializePreferencesService() {
         FieldPreferences fieldContentFormatterPreferences = new FieldPreferences(false, List.of(), List.of());
         // used twice, once for reading and once for writing
         when(importFormatPreferences.fieldPreferences()).thenReturn(fieldContentFormatterPreferences);
+
+        LastFilesOpenedPreferences lastFilesOpenedPreferences = mock(LastFilesOpenedPreferences.class);
+        when(preferences.getLastFilesOpenedPreferences()).thenReturn(lastFilesOpenedPreferences);
+        when(lastFilesOpenedPreferences.getLastFilesOpened()).thenReturn(FXCollections.emptyObservableList());
     }
 
     protected void addGlobalExceptionMapperToResourceConfig(ResourceConfig resourceConfig) {
diff --git a/jabsrv/src/test/java/org/jabref/http/server/cayw/CAYWResourceTest.java b/jabsrv/src/test/java/org/jabref/http/server/cayw/CAYWResourceTest.java
diff --git a/jabsrv/src/test/java/org/jabref/http/server/cayw/format/CAYWFormattersTest.java b/jabsrv/src/test/java/org/jabref/http/server/cayw/format/CAYWFormattersTest.java
