fix: applied fixes for PR remarks

mthmulders · Apr 10, 2023 · 778f50e · 778f50e
1 parent e74cb75
commit 778f50e
Show file tree

Hide file tree

Showing 15 changed files with 47 additions and 48 deletions.
diff --git a/src/main/java/it/mulders/mcs/cli/Cli.java b/src/main/java/it/mulders/mcs/cli/Cli.java
@@ -4,7 +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.CopyToClipboardConfiguration;
+import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfig;
 import picocli.CommandLine;
 
 import java.util.concurrent.Callable;
@@ -42,8 +42,8 @@ public ClassSearchCommand createClassSearchCommand() {
         return new ClassSearchCommand();
     }
 
-    private CopyToClipboardConfiguration createCopyToClipboardConfiguration(boolean copyToClipboard) {
-        return new CopyToClipboardConfiguration(
+    private CopyToClipboardConfig createCopyToClipboardConfiguration(boolean copyToClipboard) {
+        return new CopyToClipboardConfig(
                 COPY_SHORT_FLAG_NAME,
                 COPY_LONG_FLAG_NAME,
                 copyToClipboard);

diff --git a/src/main/java/it/mulders/mcs/search/SearchCommandHandler.java b/src/main/java/it/mulders/mcs/search/SearchCommandHandler.java
@@ -3,7 +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.CopyToClipboardConfiguration;
+import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfig;
 
 import static it.mulders.mcs.search.Constants.MAX_LIMIT;
 
@@ -25,7 +25,7 @@ public SearchCommandHandler(final OutputPrinter coordinateOutput) {
         this.outputPrinter = outputPrinter;
     }
 
-    public void search(final SearchQuery query, final CopyToClipboardConfiguration configuration) {
+    public void search(final SearchQuery query, final CopyToClipboardConfig configuration) {
         performSearch(query)
                 .map(response -> performAdditionalSearch(query, response))
                 .ifPresent(response -> printResponse(query, response, configuration));
@@ -66,7 +66,7 @@ private Result<SearchResponse.Response> performSearch(final SearchQuery query) {
     }
 
     private void printResponse(final SearchQuery query, final SearchResponse.Response response,
-                               final CopyToClipboardConfiguration configuration) {
+                               final CopyToClipboardConfig configuration) {
         outputPrinter.print(query, response, System.out, configuration);
     }
 }
diff --git a/src/main/java/it/mulders/mcs/search/printer/CoordinatePrinter.java b/src/main/java/it/mulders/mcs/search/printer/CoordinatePrinter.java
@@ -3,7 +3,7 @@
 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.CopyToClipboardConfiguration;
+import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfig;
 import it.mulders.mcs.search.printer.clipboard.CopyToClipboardPrinter;
 import it.mulders.mcs.search.printer.clipboard.SystemClipboard;
 
@@ -17,7 +17,7 @@ public sealed interface CoordinatePrinter extends OutputPrinter, CopyToClipboard
 
     @Override
     default void print(final SearchQuery query, final SearchResponse.Response response, final PrintStream stream,
-               final CopyToClipboardConfiguration copyToClipboardConfiguration) {
+               final CopyToClipboardConfig copyToClipboardConfig) {
         if (response.numFound() != 1) {
             throw new IllegalArgumentException("Search response with more than one result not expected here");
         }
@@ -29,10 +29,10 @@ default void print(final SearchQuery query, final SearchResponse.Response respon
         stream.println(coordinates);
         stream.println();
 
-        if (copyToClipboardConfiguration.copyOnClipboardEnabled()) {
+        if (copyToClipboardConfig.copyToClipboardEnabled()) {
             copyToClipboard(stream, new SystemClipboard(), coordinates);
         } else {
-            printCopyToClipboardHint(stream, copyToClipboardConfiguration);
+            printCopyToClipboardHint(stream, copyToClipboardConfig);
         }
 
         stream.println();
@@ -44,10 +44,10 @@ private static void copyToClipboard(PrintStream stream, Clipboard clipboard, Str
     }
 
     private static void printCopyToClipboardHint(PrintStream stream,
-                                                 CopyToClipboardConfiguration copyToClipboardConfiguration) {
+                                                 CopyToClipboardConfig copyToClipboardConfig) {
         stream.printf("(To directly copy this snippet to the clipboard, run mcs with the %s or %s flag.)%n",
-                copyToClipboardConfiguration.shortFlagName(),
-                copyToClipboardConfiguration.longFlagName());
+                copyToClipboardConfig.shortFlagName(),
+                copyToClipboardConfig.longFlagName());
     }
 
     private String first(final String... values) {

diff --git a/src/main/java/it/mulders/mcs/search/printer/DelegatingOutputPrinter.java b/src/main/java/it/mulders/mcs/search/printer/DelegatingOutputPrinter.java
@@ -2,7 +2,7 @@
 
 import it.mulders.mcs.search.SearchQuery;
 import it.mulders.mcs.search.SearchResponse;
-import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfiguration;
+import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfig;
 
 import java.io.PrintStream;
 
@@ -27,10 +27,10 @@ public DelegatingOutputPrinter(final OutputPrinter coordinateOutput) {
 
     @Override
     public void print(final SearchQuery query, final SearchResponse.Response response, final PrintStream stream,
-                      final CopyToClipboardConfiguration copyToClipboardConfiguration) {
+                      final CopyToClipboardConfig copyToClipboardConfig) {
         switch (response.numFound()) {
             case 0 -> noOutput.print(query, response, stream, null);
-            case 1 -> coordinateOutput.print(query, response, stream, copyToClipboardConfiguration);
+            case 1 -> coordinateOutput.print(query, response, stream, copyToClipboardConfig);
             default -> tabularSearchOutput.print(query, response, stream, null);
         }
     }

diff --git a/src/main/java/it/mulders/mcs/search/printer/NoOutputPrinter.java b/src/main/java/it/mulders/mcs/search/printer/NoOutputPrinter.java
@@ -2,14 +2,14 @@
 
 import it.mulders.mcs.search.SearchQuery;
 import it.mulders.mcs.search.SearchResponse;
-import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfiguration;
+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,
-                      final CopyToClipboardConfiguration configuration) {
+                      final CopyToClipboardConfig configuration) {
         if (response.numFound() != 0) {
             throw new IllegalArgumentException("Search response with any result not expected here");
         }

diff --git a/src/main/java/it/mulders/mcs/search/printer/OutputPrinter.java b/src/main/java/it/mulders/mcs/search/printer/OutputPrinter.java
@@ -2,13 +2,13 @@
 
 import it.mulders.mcs.search.SearchQuery;
 import it.mulders.mcs.search.SearchResponse;
-import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfiguration;
+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 CopyToClipboardConfiguration configuration);
+               final CopyToClipboardConfig configuration);
 }
diff --git a/src/main/java/it/mulders/mcs/search/printer/TabularOutputPrinter.java b/src/main/java/it/mulders/mcs/search/printer/TabularOutputPrinter.java
@@ -2,7 +2,7 @@
 
 import it.mulders.mcs.search.SearchQuery;
 import it.mulders.mcs.search.SearchResponse;
-import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfiguration;
+import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfig;
 import picocli.CommandLine;
 import picocli.CommandLine.Help;
 import picocli.CommandLine.Help.Ansi;
@@ -31,7 +31,7 @@ private String header(final SearchQuery query, final SearchResponse.Response res
     }
 
     public void print(final SearchQuery query, final SearchResponse.Response response, final PrintStream stream,
-                      final CopyToClipboardConfiguration configuration) {
+                      final CopyToClipboardConfig configuration) {
         stream.println(CommandLine.Help.Ansi.AUTO.string(header(query, response)));
 
         var colorScheme = Help.defaultColorScheme(Ansi.AUTO);

diff --git a/src/main/java/it/mulders/mcs/search/printer/clipboard/CopyToClipboardConfig.java b/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) {
+}
diff --git a/src/main/java/it/mulders/mcs/search/printer/clipboard/CopyToClipboardConfiguration.java b/src/main/java/it/mulders/mcs/search/printer/clipboard/CopyToClipboardConfiguration.java
diff --git a/src/main/java/it/mulders/mcs/search/printer/clipboard/CopyToClipboardPrinter.java b/src/main/java/it/mulders/mcs/search/printer/clipboard/CopyToClipboardPrinter.java
@@ -7,5 +7,5 @@
 
 public interface CopyToClipboardPrinter {
     void print(final SearchQuery query, final SearchResponse.Response response, final PrintStream stream,
-               final CopyToClipboardConfiguration copyToClipboardConfiguration);
+               final CopyToClipboardConfig copyToClipboardConfig);
 }
diff --git a/src/test/java/it/mulders/mcs/cli/CliTest.java b/src/test/java/it/mulders/mcs/cli/CliTest.java
@@ -3,7 +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.CopyToClipboardConfiguration;
+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;
@@ -74,7 +74,7 @@ void accepts_full_name_parameter() {
     }
 
     private void verifySearchExecution(SearchQuery query, String... args) {
-        var dontCopyToClipboard = new CopyToClipboardConfiguration(Cli.COPY_SHORT_FLAG_NAME, Cli.COPY_LONG_FLAG_NAME,
+        var dontCopyToClipboard = new CopyToClipboardConfig(Cli.COPY_SHORT_FLAG_NAME, Cli.COPY_LONG_FLAG_NAME,
                 false);
 
         try (MockedConstruction<SearchCommandHandler> mocked = Mockito.mockConstruction(SearchCommandHandler.class)) {

diff --git a/src/test/java/it/mulders/mcs/search/SearchCommandHandlerTest.java b/src/test/java/it/mulders/mcs/search/SearchCommandHandlerTest.java
@@ -2,7 +2,7 @@
 
 import it.mulders.mcs.common.Result;
 import it.mulders.mcs.search.printer.OutputPrinter;
-import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfiguration;
+import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfig;
 import org.assertj.core.api.WithAssertions;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.DisplayNameGeneration;
@@ -18,7 +18,7 @@
 @DisplayNameGeneration(DisplayNameGenerator.ReplaceUnderscores.class)
 class SearchCommandHandlerTest implements WithAssertions {
     private final OutputPrinter outputPrinter = mock(OutputPrinter.class);
-    private final CopyToClipboardConfiguration dontCopyToClipboard = new CopyToClipboardConfiguration(
+    private final CopyToClipboardConfig dontCopyToClipboard = new CopyToClipboardConfig(
             "-scht", "--search-command-handler-test", false);
     private final SearchResponse.Response wildcardResponse = new SearchResponse.Response(
             0,
@@ -57,7 +57,7 @@ class WildcardSearchTest {
         void should_invoke_search_client() {
             handler.search(SearchQuery.search("plexus-utils").build(), dontCopyToClipboard);
             verify(outputPrinter).print(any(WildcardSearchQuery.class), eq(wildcardResponse), any(),
-                    any(CopyToClipboardConfiguration.class));
+                    any(CopyToClipboardConfig.class));
         }
     }
 
@@ -74,15 +74,15 @@ void should_reject_search_terms_in_wrong_format() {
         void should_invoke_search_client_with_groupId_and_artifactId() {
             handler.search(SearchQuery.search("org.codehaus.plexus:plexus-utils").build(), dontCopyToClipboard);
             verify(outputPrinter).print(any(CoordinateQuery.class), eq(twoPartCoordinateResponse), any(),
-                    any(CopyToClipboardConfiguration.class));
+                    any(CopyToClipboardConfig.class));
         }
 
         @Test
         void should_invoke_search_client_with_groupId_and_artifactId_and_version() {
             handler.search(SearchQuery.search("org.codehaus.plexus:plexus-utils:3.4.1").build(),
                     dontCopyToClipboard);
             verify(outputPrinter).print(any(CoordinateQuery.class), eq(threePartCoordinateResponse), any(),
-                    any(CopyToClipboardConfiguration.class));
+                    any(CopyToClipboardConfig.class));
         }
     }
 }
diff --git a/src/test/java/it/mulders/mcs/search/printer/CoordinatePrinterTest.java b/src/test/java/it/mulders/mcs/search/printer/CoordinatePrinterTest.java
@@ -3,7 +3,7 @@
 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.CopyToClipboardConfiguration;
+import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfig;
 import it.mulders.mcs.search.printer.clipboard.SystemClipboard;
 import org.assertj.core.api.WithAssertions;
 import org.junit.jupiter.params.ParameterizedTest;
@@ -73,7 +73,7 @@ private static Stream<Arguments> coordinatePrinters() {
     @ParameterizedTest
     @MethodSource("coordinatePrinters")
     void should_print_snippet(CoordinatePrinter printer, String expected) {
-        var dontCopyToClipboard = new CopyToClipboardConfiguration(
+        var dontCopyToClipboard = new CopyToClipboardConfig(
                 "-cpt", "--coordinate-printer-test", false);
         printer.print(QUERY, RESPONSE, new PrintStream(buffer), dontCopyToClipboard);
         var xml = buffer.toString();
@@ -84,30 +84,29 @@ void should_print_snippet(CoordinatePrinter printer, String expected) {
     @ParameterizedTest
     @MethodSource("coordinatePrinters")
     void should_print_clipboard_hint(CoordinatePrinter printer, String expected) {
-        var dontCopyToClipboard = new CopyToClipboardConfiguration(
+        var dontCopyToClipboard = new CopyToClipboardConfig(
                 "-cpt", "--coordinate-printer-test", false);
         printer.print(QUERY, RESPONSE, new PrintStream(buffer), dontCopyToClipboard);
         var output = buffer.toString();
 
-        assertThat(output).containsIgnoringWhitespaces(String.format(
-                "(To directly copy this snippet to the clipboard, run mcs with the %s or %s flag.)",
-                dontCopyToClipboard.shortFlagName(), dontCopyToClipboard.longFlagName()));
+        assertThat(output).containsIgnoringWhitespaces("To directly copy this snippet to the clipboard");
+        assertThat(output).containsIgnoringWhitespaces("-cpt");
+        assertThat(output).containsIgnoringWhitespaces("--coordinate-printer-test");
+
         assertThat(output).doesNotContain("Snippet copied to clipboard.");
     }
 
     @ParameterizedTest
     @MethodSource("coordinatePrinters")
     void should_copy_to_clipboard_and_not_print_clipboard_hint(CoordinatePrinter printer, String expected) {
-        var copyToClipboard = new CopyToClipboardConfiguration(
+        var copyToClipboard = new CopyToClipboardConfig(
                 "-cpt", "--coordinate-printer-test", true);
         printer.print(QUERY, RESPONSE, new PrintStream(buffer), copyToClipboard);
         var output = buffer.toString();
 
         assertThat(clipboard.paste()).isEqualToIgnoringWhitespace(expected);
 
         assertThat(output).contains("Snippet copied to clipboard.");
-        assertThat(output).doesNotContain(String.format(
-                "(To directly copy this snippet to the clipboard, run mcs with the -%s or --%s flag.)",
-                copyToClipboard.shortFlagName(), copyToClipboard.longFlagName()));
+        assertThat(output).doesNotContain("To directly copy this snippet to the clipboard");
     }
 }
diff --git a/src/test/java/it/mulders/mcs/search/printer/DelegatingOutputPrinterTest.java b/src/test/java/it/mulders/mcs/search/printer/DelegatingOutputPrinterTest.java
@@ -2,7 +2,7 @@
 
 import it.mulders.mcs.search.SearchQuery;
 import it.mulders.mcs.search.SearchResponse;
-import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfiguration;
+import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfig;
 import org.apache.commons.io.output.NullOutputStream;
 import org.assertj.core.api.WithAssertions;
 import org.junit.jupiter.api.DisplayNameGeneration;
@@ -38,7 +38,7 @@ void no_results_delegate() {
 
     @Test
     void single_result_delegate() {
-        var configuration = new CopyToClipboardConfiguration("-dopt",
+        var configuration = new CopyToClipboardConfig("-dopt",
                 "--delegating-output-printer-test", true);
 
         printer.print(query, responseWithResult(1), outputStream, configuration);

diff --git a/src/test/java/it/mulders/mcs/search/printer/TabularOutputPrinterTest.java b/src/test/java/it/mulders/mcs/search/printer/TabularOutputPrinterTest.java
@@ -2,7 +2,7 @@
 
 import it.mulders.mcs.search.SearchQuery;
 import it.mulders.mcs.search.SearchResponse;
-import it.mulders.mcs.search.printer.clipboard.CopyToClipboardConfiguration;
+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;
@@ -18,7 +18,7 @@
 class TabularOutputPrinterTest implements WithAssertions {
     private final TabularOutputPrinter output = new TabularOutputPrinter();
     private final SearchQuery query = SearchQuery.search("org.codehaus.plexus:plexus-utils").build();
-    private final CopyToClipboardConfiguration dontCopyToClipboard = new CopyToClipboardConfiguration(
+    private final CopyToClipboardConfig dontCopyToClipboard = new CopyToClipboardConfig(
             "-topt", "--tabular-output-printer-test", false);
 
     @Test