Fix CypherShellTest and unify LinePrinter + Logger

Author: fickludd

cypher-shell/src/integration-test/java/org/neo4j/shell/StringLinePrinter.java

@@ -8,7 +8,7 @@ public class StringLinePrinter implements LinePrinter {
     private StringBuilder sb = new StringBuilder();
 
     @Override
-    public void println(String line) {
+    public void printOut(String line) {
         sb.append(line).append(OutputFormatter.NEWLINE);
     }
 

cypher-shell/src/main/java/org/neo4j/shell/log/AnsiLogger.java

@@ -109,11 +109,6 @@ public void printOut(@Nonnull final String msg) {
         out.println(Ansi.ansi().render(msg).toString());
     }
 
-    @Override
-    public void println(String line) {
-        printOut(line);
-    }
-
     /**
      * Interpret the cause of a Bolt exception and translate it into a sensible error message.
      */

cypher-shell/src/main/java/org/neo4j/shell/log/Logger.java

@@ -34,13 +34,6 @@ public interface Logger extends LinePrinter {
      */
     void printError(@Nonnull String text);
 
-    /**
-     * Print the designated text to configured output stream.
-     *
-     * @param text to print to the output stream
-     */
-    void printOut(@Nonnull String text);
-
     /**
      * @return the current format of the logger
      */

cypher-shell/src/main/java/org/neo4j/shell/prettyprint/LinePrinter.java

@@ -5,5 +5,11 @@
  */
 @FunctionalInterface
 public interface LinePrinter {
-    void println( String line );
+
+    /**
+     * Print the designated line to configured output stream.
+     *
+     * @param line to print to the output stream
+     */
+    void printOut(String line );
 }

cypher-shell/src/main/java/org/neo4j/shell/prettyprint/PrettyPrinter.java

@@ -24,10 +24,10 @@ public void format(@Nonnull final BoltResult result, LinePrinter linePrinter) {
 
         if (capabilities.contains(OutputFormatter.Capablities.result)) outputFormatter.format(result, linePrinter);
 
-        if (capabilities.contains(OutputFormatter.Capablities.info)) linePrinter.println(outputFormatter.formatInfo(result.getSummary()));
-        if (capabilities.contains(OutputFormatter.Capablities.plan)) linePrinter.println(outputFormatter.formatPlan(result.getSummary()));
-        if (capabilities.contains(OutputFormatter.Capablities.footer)) linePrinter.println(outputFormatter.formatFooter(result));
-        if (capabilities.contains(OutputFormatter.Capablities.statistics)) linePrinter.println(statisticsCollector.collect(result.getSummary()));
+        if (capabilities.contains(OutputFormatter.Capablities.info)) linePrinter.printOut(outputFormatter.formatInfo(result.getSummary()));
+        if (capabilities.contains(OutputFormatter.Capablities.plan)) linePrinter.printOut(outputFormatter.formatPlan(result.getSummary()));
+        if (capabilities.contains(OutputFormatter.Capablities.footer)) linePrinter.printOut(outputFormatter.formatFooter(result));
+        if (capabilities.contains(OutputFormatter.Capablities.statistics)) linePrinter.printOut(statisticsCollector.collect(result.getSummary()));
     }
 
     // Helper for testing

cypher-shell/src/main/java/org/neo4j/shell/prettyprint/SimpleOutputFormatter.java

@@ -19,10 +19,10 @@ public void format(@Nonnull BoltResult result, @Nonnull LinePrinter output) {
         Iterator<Record> records = result.iterate();
         if (records.hasNext()) {
             Record firstRow = records.next();
-            output.println(String.join(COMMA_SEPARATOR, firstRow.keys()));
-            output.println(formatRecord(firstRow));
+            output.printOut(String.join(COMMA_SEPARATOR, firstRow.keys()));
+            output.printOut(formatRecord(firstRow));
             while (records.hasNext()) {
-                output.println(formatRecord(records.next()));
+                output.printOut(formatRecord(records.next()));
             }
         }
     }

cypher-shell/src/main/java/org/neo4j/shell/prettyprint/TableOutputFormatter.java

@@ -59,17 +59,17 @@ private void formatResult(String[] columns,
         int lineWidth = totalWidth - 2;
         String dashes = "+" + OutputFormatter.repeat('-', lineWidth) + "+";
 
-        output.println(dashes);
-        output.println(headerLine);
-        output.println(dashes);
+        output.printOut(dashes);
+        output.printOut(headerLine);
+        output.printOut(dashes);
 
         for (Record record : topRecords) {
-            output.println(formatRecord(builder, columnSizes, record));
+            output.printOut(formatRecord(builder, columnSizes, record));
         }
         while (records.hasNext()) {
-            output.println(formatRecord(builder, columnSizes, records.next()));
+            output.printOut(formatRecord(builder, columnSizes, records.next()));
         }
-        output.println(dashes);
+        output.printOut(dashes);
     }
 
     private int[] calculateColumnSizes(@Nonnull String[] columns, @Nonnull List<Record> data) {

cypher-shell/src/test/java/org/neo4j/shell/CypherShellTest.java

@@ -176,7 +176,7 @@ public void executeShouldPrintResult() throws CommandException {
 
         when(boltStateHandler.isConnected()).thenReturn(true);
         when(boltStateHandler.runCypher(anyString(), anyMap())).thenReturn(Optional.of(result));
-        doAnswer((a) -> { ((LinePrinter)a.getArguments()[1]).println("999"); return null;}).when(mockedPrettyPrinter).format(any(BoltResult.class), anyObject());
+        doAnswer((a) -> { ((LinePrinter)a.getArguments()[1]).printOut("999"); return null;}).when(mockedPrettyPrinter).format(any(BoltResult.class), anyObject());
         when(mockedDriver.session()).thenReturn(session);
 
         OfflineTestShell shell = new OfflineTestShell(logger, boltStateHandler, mockedPrettyPrinter);
@@ -190,7 +190,7 @@ public void commitShouldPrintResult() throws CommandException {
 
         BoltStateHandler boltStateHandler = mock(BoltStateHandler.class);
 
-        doAnswer((a) -> { ((LinePrinter)a.getArguments()[1]).println("999"); return null;}).when(mockedPrettyPrinter).format(any(BoltResult.class), anyObject());
+        doAnswer((a) -> { ((LinePrinter)a.getArguments()[1]).printOut("999"); return null;}).when(mockedPrettyPrinter).format(any(BoltResult.class), anyObject());
         when(boltStateHandler.commitTransaction()).thenReturn(Optional.of(asList(result)));
 
         OfflineTestShell shell = new OfflineTestShell(logger, boltStateHandler, mockedPrettyPrinter);

cypher-shell/src/test/java/org/neo4j/shell/prettyprint/TableOutputFormatterTest.java

@@ -286,9 +286,9 @@ public void wrapContent()
         // GIVEN
         StatementResult result = mockResult( asList( "c1"), "a", "bb","ccc","dddd","eeeee" );
         // WHEN
-        StringBuilder sb = new StringBuilder();
-        new TableOutputFormatter(true, 2).format(new ListBoltResult(result.list(), result.summary()), (s) -> sb.append(s).append("\n"));
-        String table = sb.toString();
+        ToStringLinePrinter printer = new ToStringLinePrinter();
+        new TableOutputFormatter(true, 2).format(new ListBoltResult(result.list(), result.summary()), printer);
+        String table = printer.result();
         // THEN
         assertThat(table, is(
                 "+------+\n" +
@@ -311,9 +311,9 @@ public void truncateContent()
         // GIVEN
         StatementResult result = mockResult( asList( "c1"), "a", "bb","ccc","dddd","eeeee" );
         // WHEN
-        StringBuilder sb = new StringBuilder();
-        new TableOutputFormatter(false, 2).format(new ListBoltResult(result.list(), result.summary()), (s) -> sb.append(s).append("\n"));
-        String table = sb.toString();
+        ToStringLinePrinter printer = new ToStringLinePrinter();
+        new TableOutputFormatter(false, 2).format(new ListBoltResult(result.list(), result.summary()), printer);
+        String table = printer.result();
         // THEN
         assertThat(table, is(
                 "+------+\n" +

cypher-shell/src/test/java/org/neo4j/shell/prettyprint/ToStringLinePrinter.java

@@ -11,7 +11,7 @@ public ToStringLinePrinter() {
     }
 
     @Override
-    public void println(String line) {
+    public void printOut(String line) {
         sb.append(line);
         sb.append(OutputFormatter.NEWLINE);
     }