Added writer for a quick summary of all matchers.

joeretro · joeretro · commit 642908f56b34 · 2006-12-14T16:54:42.000Z
diff --git a/src/generator/org/hamcrest/generator/QuickReferenceWriter.java b/src/generator/org/hamcrest/generator/QuickReferenceWriter.java
@@ -0,0 +1,68 @@
+package org.hamcrest.generator;
+
+import org.hamcrest.generator.FactoryWriter;
+import org.hamcrest.generator.FactoryMethod;
+
+import java.io.PrintStream;
+import java.io.IOException;
+
+/**
+ * Dumps a quick list of factory methods. Designed to be read by users, as a cheatsheet.
+ *
+ * @author Joe Walnes
+ */
+public class QuickReferenceWriter implements FactoryWriter {
+
+    private final PrintStream out;
+    private int columnPosition = 14;
+
+    public QuickReferenceWriter(PrintStream out) {
+        this.out = out;
+    }
+
+    public QuickReferenceWriter() {
+        this(System.out);
+    }
+
+    public void setColumnPosition(int columnPosition) {
+        this.columnPosition = columnPosition;
+    }
+    
+    public void writeHeader() throws IOException {
+    }
+
+    public void writeMethod(String generatedMethodName, FactoryMethod factoryMethod) throws IOException {
+        String actsOn = removePackageNames(factoryMethod.getGenerifiedType());
+        for (int i = actsOn.length(); i < columnPosition; i++) {
+            out.append(' ');
+        }
+        out.append('[').append(actsOn).append("] ");
+        out.append(generatedMethodName);
+        out.append('(');
+        boolean seenFirst = false;
+        for (FactoryMethod.Parameter parameter : factoryMethod.getParameters()) {
+            if (seenFirst) {
+                out.append(", ");
+            } else {
+                seenFirst = true;
+            }
+            out.append(removePackageNames(parameter.getType()));
+        }
+        out.append(')');
+        out.println();
+    }
+
+    private String removePackageNames(String in) {
+        // Simplify fully qualified names (allowing for trailing '...').
+        return in == null ? "" : in.replaceAll("[^<>]*\\.([^\\.])", "$1");
+    }
+
+    public void writeFooter() throws IOException {
+    }
+
+    public void close() throws IOException {
+    }
+
+    public void flush() throws IOException {
+    }
+}
diff --git a/src/unit-test/org/hamcrest/generator/QuickReferenceWriterTest.java b/src/unit-test/org/hamcrest/generator/QuickReferenceWriterTest.java
@@ -0,0 +1,56 @@
+package org.hamcrest.generator;
+
+import junit.framework.TestCase;
+
+import java.io.PrintStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+
+public class QuickReferenceWriterTest extends TestCase {
+
+    private ByteArrayOutputStream actualBuffer;
+    private ByteArrayOutputStream expectedBuffer;
+    private PrintStream expected;
+    private QuickReferenceWriter writer;
+
+    protected void setUp() throws Exception {
+        super.setUp();
+        actualBuffer = new ByteArrayOutputStream();
+        writer = new QuickReferenceWriter(new PrintStream(actualBuffer));
+
+        expectedBuffer = new ByteArrayOutputStream();
+        expected = new PrintStream(expectedBuffer);
+    }
+
+    public void testWritesSimplifiedSummaryOfMatchers() throws IOException {
+        FactoryMethod namedMethod = new FactoryMethod("SomeClass", "someMethod");
+        namedMethod.addParameter("Cheese", "a");
+        namedMethod.addParameter("int", "b");
+        namedMethod.setGenerifiedType("String");
+        writer.writeMethod("namedMethod", namedMethod);
+
+        FactoryMethod anotherMethod = new FactoryMethod("SomeClass", "anotherMethod");
+        anotherMethod.setGenerifiedType("int");
+        writer.writeMethod("anotherMethod", anotherMethod);
+
+        expected.println("        [String] namedMethod(Cheese, int)");
+        expected.println("           [int] anotherMethod()");
+        verify();
+    }
+
+    public void testRemovesPackageNames() throws IOException {
+        FactoryMethod namedMethod = new FactoryMethod("SomeClass", "someMethod");
+        namedMethod.addParameter("com.blah.Foo", "a");
+        namedMethod.addParameter("com.foo.Cheese<x.y.Zoo>", "b");
+        namedMethod.setGenerifiedType("java.lang.Cheese");
+        writer.writeMethod("namedMethod", namedMethod);
+
+        expected.println("        [Cheese] namedMethod(Foo, Cheese<Zoo>)");
+        verify();
+    }
+
+    private void verify() {
+        assertEquals(new String(expectedBuffer.toByteArray()), new String(actualBuffer.toByteArray()));
+    }
+
+}
