Fixes #1: multiple calls to vardump() now just prints dumps from this call

WorkingDevel · WorkingDevel · commit 792bf8a2db13 · 2016-12-26T10:25:59.000+01:00
diff --git a/build.gradle b/build.gradle
@@ -1,10 +1,11 @@
 group 'net.workingdeveloper.java'
-version '0.0.1-SNAPSHOT'
+version '0.2.0'
 
 apply plugin: 'java'
 
 sourceCompatibility = 1.8
 
+
 repositories {
     mavenCentral()
 }
@@ -13,6 +14,10 @@ dependencies {
     compile 'org.apache.commons:commons-lang3:3+'
     compile 'org.slf4j:slf4j-api:1.7+'
     testCompile group: 'junit', name: 'junit', version: '4.+'
+    testCompile "org.hamcrest:hamcrest-core:1.+"
+    testCompile "org.hamcrest:hamcrest-library:1.+"
+    testCompile group: 'com.tngtech.java', name: 'junit-dataprovider', version: '1+'
+    testCompile "org.mockito:mockito-core:1.+"
 }
 
 task wrapper(type: Wrapper) {
diff --git a/src/main/java/net/workingdeveloper/java/vardump/AppendableFactory.java b/src/main/java/net/workingdeveloper/java/vardump/AppendableFactory.java
@@ -0,0 +1,15 @@
+package net.workingdeveloper.java.vardump;
+
+/**
+ * Created by Christoph Graupner on 2016-12-04.
+ *
+ * @author Christoph Graupner <ch.graupner@workingdeveloper.net>
+ */
+public interface AppendableFactory {
+    /**
+     * Every time it is called it gives a <b>new</b> instance of an Appendable implementation
+     *
+     * @return a new instance of an implementation of Appendable
+     */
+    Appendable createAppendable();
+}
diff --git a/src/main/java/net/workingdeveloper/java/vardump/IVarDumperFormatter.java b/src/main/java/net/workingdeveloper/java/vardump/IVarDumperFormatter.java
@@ -39,7 +39,9 @@ public interface IVarDumperFormatter {
 
     IVarDumperFormatter openObject(Object aName);
 
-    IVarDumperFormatter setStringBuffer(Appendable aBuffer);
+    IVarDumperFormatter reset();
+
+    IVarDumperFormatter setAppendableFactory(AppendableFactory aAppendableFactory);
 
     String toString();
 }
diff --git a/src/main/java/net/workingdeveloper/java/vardump/VarDumpFactory.java b/src/main/java/net/workingdeveloper/java/vardump/VarDumpFactory.java
@@ -27,7 +27,7 @@ public Predicate<Field> createFieldAcceptPredicate(String[] aExcludeFieldNames,
         return new FieldAcceptorPredicate(aExcludeFieldNames, aAppendStatics, aAppendTransients);
     }
 
-    public IVarDumperFormatter createIndentFormatter(Appendable aAppendable, int aIndent, boolean aShortClassNames) {
+    public IVarDumperFormatter createIndentFormatter(AppendableFactory aAppendable, int aIndent, boolean aShortClassNames) {
         return new VarDumperIndentFormatterImpl(aAppendable, aIndent, aShortClassNames);
     }
 
@@ -48,6 +48,10 @@ public IVarDumper createRecursiveDumper() {
                 getDefaultFormatter(), getDefaultFieldPredicate(), getDefaultCyclicRegistry());
     }
 
+    public AppendableFactory getDefaultAppendableFactory() {
+        return StringBuilder::new;
+    }
+
     public IVarDumperCyclicRegistry getDefaultCyclicRegistry() {
         return new VarDumperCyclicRegistryImpl();
     }
@@ -57,6 +61,10 @@ public Predicate<Field> getDefaultFieldPredicate() {
     }
 
     public IVarDumperFormatter getDefaultFormatter() {
-        return new VarDumperIndentFormatterImpl(new StringBuilder(), 2, false);
+        return new VarDumperIndentFormatterImpl(
+                getDefaultAppendableFactory(),
+                2,
+                false
+        );
     }
 }
diff --git a/src/main/java/net/workingdeveloper/java/vardump/impl/AbstractVarDumperFormatter.java b/src/main/java/net/workingdeveloper/java/vardump/impl/AbstractVarDumperFormatter.java
@@ -1,5 +1,6 @@
 package net.workingdeveloper.java.vardump.impl;
 
+import net.workingdeveloper.java.vardump.AppendableFactory;
 import net.workingdeveloper.java.vardump.IVarDumperFormatter;
 
 import java.io.IOException;
@@ -12,8 +13,12 @@
  */
 abstract public class AbstractVarDumperFormatter extends BasicVarDumperFormatter implements IVarDumperFormatter {
 
-    public AbstractVarDumperFormatter(Appendable aBuffer, boolean aShortClassName) {
-        super(aBuffer, aShortClassName);
+    /**
+     * @param aAppendableFactory Could be a lamba like <code>StringBuilder::new</code>.
+     * @param aShortClassName    <em>true</em> if the outputted class name should be just the class itself without the package name.
+     */
+    public AbstractVarDumperFormatter(AppendableFactory aAppendableFactory, boolean aShortClassName) {
+        super(aAppendableFactory, aShortClassName);
     }
 
     @Override
diff --git a/src/main/java/net/workingdeveloper/java/vardump/impl/BasicVarDumperFormatter.java b/src/main/java/net/workingdeveloper/java/vardump/impl/BasicVarDumperFormatter.java
@@ -1,5 +1,6 @@
 package net.workingdeveloper.java.vardump.impl;
 
+import net.workingdeveloper.java.vardump.AppendableFactory;
 import net.workingdeveloper.java.vardump.IVarDumperFormatter;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -21,12 +22,17 @@ enum State {MAP, OBJECT, ARRAY, FIELD}
     protected Appendable fBuffer;
     Stack<State> fContextStack   = new Stack<>();
     boolean      fShortClassName = false;
+    private AppendableFactory fBufferFactory;
     private String fRefString = "REF>>";
     private Logger logger     = LoggerFactory.getLogger(VarDumperFormatterImpl.class);
 
-    public BasicVarDumperFormatter(Appendable aBuffer, boolean aShortClassName) {
-        fBuffer = aBuffer;
+    /**
+     * @param aAppendableFactory Could be a lamba like <code>StringBuilder::new</code>.
+     * @param aShortClassName    <em>true</em> if the outputted class name should be just the class itself without the package name.
+     */
+    public BasicVarDumperFormatter(AppendableFactory aAppendableFactory, boolean aShortClassName) {
         fShortClassName = aShortClassName;
+        setAppendableFactory(aAppendableFactory);
     }
 
     @Override
@@ -48,8 +54,15 @@ public IVarDumperFormatter appendString(String aName) {
     }
 
     @Override
-    public IVarDumperFormatter setStringBuffer(Appendable aBuffer) {
-        fBuffer = aBuffer;
+    public IVarDumperFormatter reset() {
+        fBuffer = fBufferFactory.createAppendable();
+        return this;
+    }
+
+    @Override
+    public IVarDumperFormatter setAppendableFactory(AppendableFactory aAppendableFactory) {
+        fBufferFactory = aAppendableFactory;
+        fBuffer = aAppendableFactory.createAppendable();
         return this;
     }
 
diff --git a/src/main/java/net/workingdeveloper/java/vardump/impl/RecursiveVarDumperImpl.java b/src/main/java/net/workingdeveloper/java/vardump/impl/RecursiveVarDumperImpl.java
@@ -65,6 +65,7 @@ public boolean isAppendTransients() {
 
     @Override
     public String vardump(final Object aObject, final IVarDumperFormatter aFormatter) {
+        reset();
         setFormatter(aFormatter);
         reflectionSwitch(aObject);
         return getFormatter().toString();
@@ -120,6 +121,10 @@ protected void reflectionSwitch(final Object aObject) {
         }
     }
 
+    private void reset() {
+        getFormatter().reset();
+    }
+
     private void reflectMap(Object aObject) {
         Map<?, ?>                      lMapObject = (Map<?, ?>) aObject;
         Set<? extends Map.Entry<?, ?>> lEntrySet  = lMapObject.entrySet();
diff --git a/src/main/java/net/workingdeveloper/java/vardump/impl/VarDumperFormatterImpl.java b/src/main/java/net/workingdeveloper/java/vardump/impl/VarDumperFormatterImpl.java
@@ -1,5 +1,6 @@
 package net.workingdeveloper.java.vardump.impl;
 
+import net.workingdeveloper.java.vardump.AppendableFactory;
 import net.workingdeveloper.java.vardump.IVarDumperFormatter;
 
 /**
@@ -11,7 +12,11 @@ public class VarDumperFormatterImpl
         extends AbstractVarDumperFormatter
         implements IVarDumperFormatter {
 
-    public VarDumperFormatterImpl(Appendable aBuffer, boolean aShortClassName) {
-        super(aBuffer, aShortClassName);
+    /**
+     * @param aAppendableFactory Could be a lamba like <code>StringBuilder::new</code>.
+     * @param aShortClassName    <em>true</em> if the outputted class name should be just the class itself without the package name.
+     */
+    public VarDumperFormatterImpl(AppendableFactory aAppendableFactory, boolean aShortClassName) {
+        super(aAppendableFactory, aShortClassName);
     }
 }
diff --git a/src/main/java/net/workingdeveloper/java/vardump/impl/VarDumperFormatterSimpleImpl.java b/src/main/java/net/workingdeveloper/java/vardump/impl/VarDumperFormatterSimpleImpl.java
@@ -1,5 +1,6 @@
 package net.workingdeveloper.java.vardump.impl;
 
+import net.workingdeveloper.java.vardump.AppendableFactory;
 import net.workingdeveloper.java.vardump.IVarDumperFormatter;
 
 /**
@@ -10,7 +11,7 @@
 public class VarDumperFormatterSimpleImpl
         extends AbstractVarDumperFormatter
         implements IVarDumperFormatter {
-    public VarDumperFormatterSimpleImpl(Appendable aBuffer, boolean aShortClassName) {
-        super(aBuffer, aShortClassName);
+    public VarDumperFormatterSimpleImpl(AppendableFactory aAppendableFactory, boolean aShortClassName) {
+        super(aAppendableFactory, aShortClassName);
     }
 }
diff --git a/src/main/java/net/workingdeveloper/java/vardump/impl/VarDumperIndentFormatterImpl.java b/src/main/java/net/workingdeveloper/java/vardump/impl/VarDumperIndentFormatterImpl.java
@@ -1,5 +1,6 @@
 package net.workingdeveloper.java.vardump.impl;
 
+import net.workingdeveloper.java.vardump.AppendableFactory;
 import net.workingdeveloper.java.vardump.IVarDumperFormatter;
 
 /**
@@ -11,7 +12,7 @@ public class VarDumperIndentFormatterImpl extends AbstractVarDumperFormatter imp
     private final int fIndentLevel;
     private       int fCurrentIndention;
 
-    public VarDumperIndentFormatterImpl(Appendable aBuffer, int aIndentLevel, boolean aShortClassName) {
+    public VarDumperIndentFormatterImpl(AppendableFactory aBuffer, int aIndentLevel, boolean aShortClassName) {
         super(aBuffer, aShortClassName);
         fIndentLevel = aIndentLevel;
     }
diff --git a/src/test/java/net/workingdeveloper/java/vardump/impl/RecursiveVarDumperImplTest.java b/src/test/java/net/workingdeveloper/java/vardump/impl/RecursiveVarDumperImplTest.java
@@ -5,6 +5,10 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import static net.workingdeveloper.java.vardump.test.VarDumpMatcher.matchesVarDump;
+import static org.hamcrest.Matchers.*;
+import static org.junit.Assert.assertThat;
+
 /**
  * Created by Christoph Graupner on 2016-10-17.
  *
@@ -46,7 +50,7 @@ public void testCyclic() throws Exception {
         TestCyclic lParent1 = new TestCyclic(lParent0);
         TestCyclic lChild   = new TestCyclic(lParent1);
         RecursiveVarDumperImpl lSut = new RecursiveVarDumperImpl(
-                new VarDumperFormatterImpl(new StringBuilder(), true),
+                new VarDumperFormatterImpl(StringBuilder::new, true),
                 field -> true,
                 new VarDumperCyclicRegistryImpl()
         );
@@ -58,7 +62,7 @@ public void testCyclic() throws Exception {
     @Test
     public void vardumpInheritedClasses() throws Exception {
         RecursiveVarDumperImpl lSut = new RecursiveVarDumperImpl(
-                new VarDumperFormatterImpl(new StringBuilder(), true),
+                new VarDumperFormatterImpl(StringBuilder::new, true),
                 field -> true,
                 new VarDumperCyclicRegistryImpl()
         );
@@ -71,7 +75,7 @@ public void vardumpInheritedClasses() throws Exception {
     @Test
     public void vardumpLists() throws Exception {
         RecursiveVarDumperImpl lSut = new RecursiveVarDumperImpl(
-                new VarDumperFormatterImpl(new StringBuilder(), true),
+                new VarDumperFormatterImpl(StringBuilder::new, true),
                 aField -> true,
                 new VarDumperCyclicRegistryImpl()
         );
@@ -84,22 +88,26 @@ public void vardumpLists() throws Exception {
     @Test
     public void vardumpPrimitives() throws Exception {
         RecursiveVarDumperImpl lSut = new RecursiveVarDumperImpl(
-                new VarDumperFormatterImpl(new StringBuilder(), true),
+                new VarDumperFormatterImpl(StringBuilder::new, true),
                 aField -> true,
                 new VarDumperCyclicRegistryImpl()
         );
-        System.out.println(lSut.vardump("hallo"));
-        System.out.println(lSut.vardump(1));
+        assertThat(lSut.vardump("hallo"), equalTo("(String)\"hallo\""));
+        assertThat(lSut.vardump(1), equalTo("(Integer)1"));
     }
 
     @Test
     public void vardumpSimpleClasses() throws Exception {
         RecursiveVarDumperImpl lSut = new RecursiveVarDumperImpl(
-                new VarDumperFormatterImpl(new StringBuilder(), true),
+                new VarDumperFormatterImpl(StringBuilder::new, true),
                 aField -> true,
                 new VarDumperCyclicRegistryImpl()
         );
         Object d1 = new TestEmpty();
+        assertThat(
+                lSut.vardump(d1),
+                matchesVarDump("TestEmpty@00000000 {this$0 = RecursiveVarDumperImplTest@00000000 {};}")
+        );
         System.out.println(lSut.vardump(d1));
         d1 = new TestPrimitives();
         System.out.println(lSut.vardump(d1));
diff --git a/src/test/java/net/workingdeveloper/java/vardump/test/VarDumpMatcher.java b/src/test/java/net/workingdeveloper/java/vardump/test/VarDumpMatcher.java
@@ -0,0 +1,33 @@
+package net.workingdeveloper.java.vardump.test;
+
+import org.hamcrest.Description;
+import org.hamcrest.TypeSafeMatcher;
+
+/**
+ * Created by Christoph Graupner on 2016-12-26.
+ *
+ * @author Christoph Graupner <ch.graupner@workingdeveloper.net>
+ */
+public class VarDumpMatcher extends TypeSafeMatcher<String> {
+    private static final String REPLACEMENT = "@00000000";
+    private static final String UNIFIER     = "@[A-Fa-f0-9]{4,}\\b";
+    final String fMatch;
+
+    public VarDumpMatcher(final String aMatch) {
+        fMatch = aMatch.replaceAll(UNIFIER, REPLACEMENT);
+    }
+
+    public static VarDumpMatcher matchesVarDump(final String aVarDump) {
+        return new VarDumpMatcher(aVarDump);
+    }
+
+    @Override
+    public void describeTo(Description description) {
+        description.appendText("matches regular expression=`" + fMatch + "`");
+    }
+
+    @Override
+    protected boolean matchesSafely(String item) {
+        return item.replaceAll(UNIFIER, REPLACEMENT).equals(fMatch);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,9 @@ public interface IVarDumperFormatter {`
`39`	`39`
`40`	`40`	`IVarDumperFormatter openObject(Object aName);`
`41`	`41`
`42`		`- IVarDumperFormatter setStringBuffer(Appendable aBuffer);`
	`42`	`+ IVarDumperFormatter reset();`
	`43`	`+`
	`44`	`+ IVarDumperFormatter setAppendableFactory(AppendableFactory aAppendableFactory);`
`43`	`45`
`44`	`46`	`String toString();`
`45`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ public Predicate<Field> createFieldAcceptPredicate(String[] aExcludeFieldNames,`
`27`	`27`	`return new FieldAcceptorPredicate(aExcludeFieldNames, aAppendStatics, aAppendTransients);`
`28`	`28`	`}`
`29`	`29`
`30`		`- public IVarDumperFormatter createIndentFormatter(Appendable aAppendable, int aIndent, boolean aShortClassNames) {`
	`30`	`+ public IVarDumperFormatter createIndentFormatter(AppendableFactory aAppendable, int aIndent, boolean aShortClassNames) {`
`31`	`31`	`return new VarDumperIndentFormatterImpl(aAppendable, aIndent, aShortClassNames);`
`32`	`32`	`}`
`33`	`33`
`@@ -48,6 +48,10 @@ public IVarDumper createRecursiveDumper() {`
`48`	`48`	`getDefaultFormatter(), getDefaultFieldPredicate(), getDefaultCyclicRegistry());`
`49`	`49`	`}`
`50`	`50`
	`51`	`+ public AppendableFactory getDefaultAppendableFactory() {`
	`52`	`+ return StringBuilder::new;`
	`53`	`+ }`
	`54`	`+`
`51`	`55`	`public IVarDumperCyclicRegistry getDefaultCyclicRegistry() {`
`52`	`56`	`return new VarDumperCyclicRegistryImpl();`
`53`	`57`	`}`
`@@ -57,6 +61,10 @@ public Predicate<Field> getDefaultFieldPredicate() {`
`57`	`61`	`}`
`58`	`62`
`59`	`63`	`public IVarDumperFormatter getDefaultFormatter() {`
`60`		`- return new VarDumperIndentFormatterImpl(new StringBuilder(), 2, false);`
	`64`	`+ return new VarDumperIndentFormatterImpl(`
	`65`	`+ getDefaultAppendableFactory(),`
	`66`	`+ 2,`
	`67`	`+ false`
	`68`	`+ );`
`61`	`69`	`}`
`62`	`70`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`package net.workingdeveloper.java.vardump.impl;`
`2`	`2`
	`3`	`+import net.workingdeveloper.java.vardump.AppendableFactory;`
`3`	`4`	`import net.workingdeveloper.java.vardump.IVarDumperFormatter;`
`4`	`5`
`5`	`6`	`/**`
`@@ -10,7 +11,7 @@`
`10`	`11`	`public class VarDumperFormatterSimpleImpl`
`11`	`12`	`extends AbstractVarDumperFormatter`
`12`	`13`	`implements IVarDumperFormatter {`
`13`		`- public VarDumperFormatterSimpleImpl(Appendable aBuffer, boolean aShortClassName) {`
`14`		`- super(aBuffer, aShortClassName);`
	`14`	`+ public VarDumperFormatterSimpleImpl(AppendableFactory aAppendableFactory, boolean aShortClassName) {`
	`15`	`+ super(aAppendableFactory, aShortClassName);`
`15`	`16`	`}`
`16`	`17`	`}`