feature: Copy snippet to clipboard in case of single result

.github/workflows/build.yml

@@ -29,5 +29,7 @@ jobs:
         path: ~/.m2
         key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
         restore-keys: ${{ runner.os }}-m2
+    - name: Install xvfb for headless unit tests
+      run: sudo apt install xvfb
     - name: Build with Maven
-      run: mvn -B verify
+      run: xvfb-run mvn -B verify

README.md

@@ -59,7 +59,7 @@ This setup does not touch your computer - as soon as you close your browser tab,
 
 ## Ideas for future development
 * [ ] Proper support for multiple classifiers at a particular coordinate.
-* [ ] Immediately copy the pom.xml snippet to the clipboard.
+* [x] Immediately copy the pom.xml snippet to the clipboard.
 * [x] Show the coordinates in a different form (Ivy, Gradle, SBT).
 
 

src/main/java/it/mulders/mcs/cli/Cli.java

@@ -4,6 +4,7 @@
 import it.mulders.mcs.search.SearchCommandHandler;
 import it.mulders.mcs.search.SearchQuery;
 import it.mulders.mcs.search.printer.CoordinatePrinter;
+import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfig;
 import picocli.CommandLine;
 
 import java.util.concurrent.Callable;
@@ -15,6 +16,8 @@
         versionProvider = ClasspathVersionProvider.class
 )
 public class Cli {
+    final static String COPY_SHORT_FLAG_NAME = "-c";
+    final static String COPY_LONG_FLAG_NAME = "--copy";
 
     @CommandLine.Option(
             names = { "-V", "--version" },
@@ -39,6 +42,13 @@ public ClassSearchCommand createClassSearchCommand() {
         return new ClassSearchCommand();
     }
 
+    private CopyToClipboardConfig createCopyToClipboardConfiguration(boolean copyToClipboard) {
+        return new CopyToClipboardConfig(
+                COPY_SHORT_FLAG_NAME,
+                COPY_LONG_FLAG_NAME,
+                copyToClipboard);
+    }
+
     @CommandLine.Command(
             name = "search",
             description = "Search artifacts in Maven Central by coordinates",
@@ -55,6 +65,14 @@ public class SearchCommand implements Callable<Integer> {
         )
         private String[] query;
 
+        @CommandLine.Option(
+                names = { COPY_SHORT_FLAG_NAME, COPY_LONG_FLAG_NAME },
+                negatable = true,
+                arity = "0",
+                description = "Copy dependency definition to the clipboard when a single result is found"
+        )
+        private boolean copyToClipboard;
+
         @CommandLine.Option(
                 names = { "-l", "--limit" },
                 description = "Show <count> results",
@@ -83,7 +101,7 @@ public Integer call() {
 
             CoordinatePrinter coordinatePrinter = FormatType.providePrinter(responseFormat);
             var searchCommandHandler = new SearchCommandHandler(coordinatePrinter);
-            searchCommandHandler.search(searchQuery);
+            searchCommandHandler.search(searchQuery, createCopyToClipboardConfiguration(copyToClipboard));
             return 0;
         }
     }
@@ -102,6 +120,14 @@ public class ClassSearchCommand implements Callable<Integer> {
         )
         private String query;
 
+        @CommandLine.Option(
+                names = { COPY_SHORT_FLAG_NAME, COPY_LONG_FLAG_NAME },
+                negatable = true,
+                arity = "0",
+                description = "Copy dependency definition to the clipboard when a single result is found"
+        )
+        private boolean copyToClipboard;
+
         @CommandLine.Option(
                 names = { "-f", "--full-name" },
                 negatable = true,
@@ -125,7 +151,7 @@ public Integer call() {
                     .withLimit(limit)
                     .build();
             var searchCommandHandler = new SearchCommandHandler();
-            searchCommandHandler.search(searchQuery);
+            searchCommandHandler.search(searchQuery, createCopyToClipboardConfiguration(copyToClipboard));
             return 0;
         }
     }

src/main/java/it/mulders/mcs/search/SearchCommandHandler.java

@@ -3,6 +3,7 @@
 import it.mulders.mcs.common.Result;
 import it.mulders.mcs.search.printer.DelegatingOutputPrinter;
 import it.mulders.mcs.search.printer.OutputPrinter;
+import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfig;
 
 import static it.mulders.mcs.search.Constants.MAX_LIMIT;
 
@@ -24,10 +25,10 @@ public SearchCommandHandler(final OutputPrinter coordinateOutput) {
         this.outputPrinter = outputPrinter;
     }
 
-    public void search(final SearchQuery query) {
+    public void search(final SearchQuery query, final CopyToClipboardConfig configuration) {
         performSearch(query)
                 .map(response -> performAdditionalSearch(query, response))
-                .ifPresent(response -> printResponse(query, response));
+                .ifPresent(response -> printResponse(query, response, configuration));
     }
 
     private SearchResponse.Response performAdditionalSearch(final SearchQuery query,
@@ -64,7 +65,8 @@ private Result<SearchResponse.Response> performSearch(final SearchQuery query) {
                 .map(SearchResponse::response);
     }
 
-    private void printResponse(final SearchQuery query, final SearchResponse.Response response) {
-        outputPrinter.print(query, response, System.out);
+    private void printResponse(final SearchQuery query, final SearchResponse.Response response,
+                               final CopyToClipboardConfig configuration) {
+        outputPrinter.print(query, response, System.out, configuration);
     }
 }

src/main/java/it/mulders/mcs/search/printer/CoordinatePrinter.java

@@ -2,27 +2,54 @@
 
 import it.mulders.mcs.search.SearchQuery;
 import it.mulders.mcs.search.SearchResponse;
+import it.mulders.mcs.search.printer.clipboard.Clipboard;
+import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfig;
+import it.mulders.mcs.search.printer.clipboard.CopyToClipboardPrinter;
+import it.mulders.mcs.search.printer.clipboard.SystemClipboard;
 
 import java.io.PrintStream;
 
-public sealed interface CoordinatePrinter extends OutputPrinter
+public sealed interface CoordinatePrinter extends OutputPrinter, CopyToClipboardPrinter
         permits BuildrOutput, GradleGroovyOutput, GradleGroovyShortOutput, GradleKotlinOutput, GrapeOutput,
         IvyXmlOutput, LeiningenOutput, PomXmlOutput, SbtOutput {
 
     String provideCoordinates(final String group, final String artifact, final String version);
 
     @Override
-    default void print(final SearchQuery query, final SearchResponse.Response response, final PrintStream stream) {
+    default void print(final SearchQuery query, final SearchResponse.Response response, final PrintStream stream,
+               final CopyToClipboardConfig copyToClipboardConfig) {
         if (response.numFound() != 1) {
             throw new IllegalArgumentException("Search response with more than one result not expected here");
         }
 
         var doc = response.docs()[0];
+        String coordinates = provideCoordinates(doc.g(), doc.a(), first(doc.v(), doc.latestVersion()));
+
+        stream.println();
+        stream.println(coordinates);
         stream.println();
-        stream.println(provideCoordinates(doc.g(), doc.a(), first(doc.v(), doc.latestVersion())));
+
+        if (copyToClipboardConfig.copyToClipboardEnabled()) {
+            copyToClipboard(stream, new SystemClipboard(), coordinates);
+        } else {
+            printCopyToClipboardHint(stream, copyToClipboardConfig);
+        }
+
         stream.println();
     }
 
+    private static void copyToClipboard(PrintStream stream, Clipboard clipboard, String coordinates) {
+        clipboard.copy(coordinates);
+        stream.println("Snippet copied to clipboard.");
+    }
+
+    private static void printCopyToClipboardHint(PrintStream stream,
+                                                 CopyToClipboardConfig copyToClipboardConfig) {
+        stream.printf("(To directly copy this snippet to the clipboard, run mcs with the %s or %s flag.)%n",
+                copyToClipboardConfig.shortFlagName(),
+                copyToClipboardConfig.longFlagName());
+    }
+
     private String first(final String... values) {
         for (var value : values) {
             if (value != null) {

src/main/java/it/mulders/mcs/search/printer/DelegatingOutputPrinter.java

@@ -2,6 +2,7 @@
 
 import it.mulders.mcs.search.SearchQuery;
 import it.mulders.mcs.search.SearchResponse;
+import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfig;
 
 import java.io.PrintStream;
 
@@ -25,11 +26,12 @@ public DelegatingOutputPrinter(final OutputPrinter coordinateOutput) {
     }
 
     @Override
-    public void print(final SearchQuery query, final SearchResponse.Response response, final PrintStream stream) {
+    public void print(final SearchQuery query, final SearchResponse.Response response, final PrintStream stream,
+                      final CopyToClipboardConfig copyToClipboardConfig) {
         switch (response.numFound()) {
-            case 0 -> noOutput.print(query, response, stream);
-            case 1 -> coordinateOutput.print(query, response, stream);
-            default -> tabularSearchOutput.print(query, response, stream);
+            case 0 -> noOutput.print(query, response, stream, null);
+            case 1 -> coordinateOutput.print(query, response, stream, copyToClipboardConfig);
+            default -> tabularSearchOutput.print(query, response, stream, null);
         }
     }
 }

src/main/java/it/mulders/mcs/search/printer/NoOutputPrinter.java

@@ -2,12 +2,14 @@
 
 import it.mulders.mcs.search.SearchQuery;
 import it.mulders.mcs.search.SearchResponse;
+import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfig;
 
 import java.io.PrintStream;
 
 public class NoOutputPrinter implements OutputPrinter {
     @Override
-    public void print(final SearchQuery query, final SearchResponse.Response response, final PrintStream stream) {
+    public void print(final SearchQuery query, final SearchResponse.Response response, final PrintStream stream,
+                      final CopyToClipboardConfig configuration) {
         if (response.numFound() != 0) {
             throw new IllegalArgumentException("Search response with any result not expected here");
         }

src/main/java/it/mulders/mcs/search/printer/OutputPrinter.java

@@ -2,11 +2,13 @@
 
 import it.mulders.mcs.search.SearchQuery;
 import it.mulders.mcs.search.SearchResponse;
+import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfig;
 
 import java.io.PrintStream;
 
 public interface OutputPrinter {
     void print(final SearchQuery query,
                final SearchResponse.Response response,
-               final PrintStream stream);
+               final PrintStream stream,
+               final CopyToClipboardConfig configuration);
 }

src/main/java/it/mulders/mcs/search/printer/TabularOutputPrinter.java

@@ -2,6 +2,7 @@
 
 import it.mulders.mcs.search.SearchQuery;
 import it.mulders.mcs.search.SearchResponse;
+import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfig;
 import picocli.CommandLine;
 import picocli.CommandLine.Help;
 import picocli.CommandLine.Help.Ansi;
@@ -29,7 +30,8 @@ private String header(final SearchQuery query, final SearchResponse.Response res
                 response.numFound(), additionalMessage);
     }
 
-    public void print(final SearchQuery query, final SearchResponse.Response response, final PrintStream stream) {
+    public void print(final SearchQuery query, final SearchResponse.Response response, final PrintStream stream,
+                      final CopyToClipboardConfig configuration) {
         stream.println(CommandLine.Help.Ansi.AUTO.string(header(query, response)));
 
         var colorScheme = Help.defaultColorScheme(Ansi.AUTO);

src/main/java/it/mulders/mcs/search/printer/clipboard/Clipboard.java

@@ -0,0 +1,7 @@
+package it.mulders.mcs.search.printer.clipboard;
+
+public sealed interface Clipboard permits SystemClipboard {
+    void copy(String text);
+    String paste();
+}
+

src/main/java/it/mulders/mcs/search/printer/clipboard/CopyToClipboardConfig.java

@@ -0,0 +1,4 @@
+package it.mulders.mcs.search.printer.clipboard;
+
+public record CopyToClipboardConfig(String shortFlagName, String longFlagName, boolean copyToClipboardEnabled) {
+}

src/main/java/it/mulders/mcs/search/printer/clipboard/CopyToClipboardPrinter.java

@@ -0,0 +1,11 @@
+package it.mulders.mcs.search.printer.clipboard;
+
+import it.mulders.mcs.search.SearchQuery;
+import it.mulders.mcs.search.SearchResponse;
+
+import java.io.PrintStream;
+
+public interface CopyToClipboardPrinter {
+    void print(final SearchQuery query, final SearchResponse.Response response, final PrintStream stream,
+               final CopyToClipboardConfig copyToClipboardConfig);
+}

src/main/java/it/mulders/mcs/search/printer/clipboard/SystemClipboard.java

@@ -0,0 +1,40 @@
+package it.mulders.mcs.search.printer.clipboard;
+
+import java.awt.Toolkit;
+import java.awt.datatransfer.StringSelection;
+import java.awt.datatransfer.Transferable;
+import java.awt.datatransfer.UnsupportedFlavorException;
+import java.io.IOException;
+
+import static java.awt.datatransfer.DataFlavor.stringFlavor;
+
+public final class SystemClipboard implements Clipboard {
+    java.awt.datatransfer.Clipboard systemClipboard;
+
+    public SystemClipboard() {
+        this.systemClipboard = Toolkit.getDefaultToolkit().getSystemClipboard();
+    }
+
+    @Override
+    public void copy(String text) {
+        var clipboardData = new StringSelection(text);
+        systemClipboard.setContents(clipboardData, clipboardData);
+    }
+
+    @Override
+    public String paste() {
+        Transferable clipboardData = systemClipboard.getContents(null);
+        String text = "";
+        boolean hasTransferableText = clipboardData != null && clipboardData.isDataFlavorSupported(stringFlavor);
+
+        if (hasTransferableText) {
+            try {
+                text = (String) clipboardData.getTransferData(stringFlavor);
+            } catch (IOException | UnsupportedFlavorException e) {
+                throw new RuntimeException(e);
+            }
+        }
+
+        return text;
+    }
+}

src/test/java/it/mulders/mcs/cli/CliTest.java

@@ -3,6 +3,7 @@
 import it.mulders.mcs.search.Constants;
 import it.mulders.mcs.search.SearchCommandHandler;
 import it.mulders.mcs.search.SearchQuery;
+import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfig;
 import org.assertj.core.api.WithAssertions;
 import org.junit.jupiter.api.DisplayNameGeneration;
 import org.junit.jupiter.api.DisplayNameGenerator;
@@ -73,11 +74,14 @@ void accepts_full_name_parameter() {
     }
 
     private void verifySearchExecution(SearchQuery query, String... args) {
+        var dontCopyToClipboard = new CopyToClipboardConfig(Cli.COPY_SHORT_FLAG_NAME, Cli.COPY_LONG_FLAG_NAME,
+                false);
+
         try (MockedConstruction<SearchCommandHandler> mocked = Mockito.mockConstruction(SearchCommandHandler.class)) {
             program.execute(args);
             assertThat(mocked.constructed()).hasSize(1);
             SearchCommandHandler searchCommandHandler = mocked.constructed().get(0);
-            verify(searchCommandHandler).search(query);
+            verify(searchCommandHandler).search(query, dontCopyToClipboard);
         }
     }
 }