Allow Pyish serialization to be more efficient by passing along a string builder to new method appendPyishString(sb)

jasmith-hs · jasmith-hs · commit 4424f3d6ae61 · 2023-01-25T11:21:18.000-05:00
diff --git a/src/main/java/com/hubspot/jinjava/el/ext/NamedParameter.java b/src/main/java/com/hubspot/jinjava/el/ext/NamedParameter.java
@@ -26,7 +26,10 @@ public String toString() {
   }
 
   @Override
-  public String toPyishString() {
-    return name + "=" + PyishSerializable.writeValueAsString(value);
+  public StringBuilder appendPyishString(StringBuilder sb) {
+    return sb
+      .append(name)
+      .append('=')
+      .append(PyishSerializable.writeValueAsString(value));
   }
 }
diff --git a/src/main/java/com/hubspot/jinjava/interpret/LazyReference.java b/src/main/java/com/hubspot/jinjava/interpret/LazyReference.java
@@ -24,7 +24,7 @@ public void setReferenceKey(String referenceKey) {
   }
 
   @Override
-  public String toPyishString() {
+  public CharSequence toPyishString() {
     return getReferenceKey();
   }
 }
diff --git a/src/main/java/com/hubspot/jinjava/objects/Namespace.java b/src/main/java/com/hubspot/jinjava/objects/Namespace.java
@@ -20,7 +20,7 @@ public Namespace(Map<String, Object> map, int maxSize) {
   }
 
   @Override
-  public String toPyishString() {
-    return String.format("namespace(%s)", PyishSerializable.super.toPyishString());
+  public StringBuilder appendPyishString(StringBuilder sb) {
+    return PyishSerializable.super.appendPyishString(sb.append("namespace(")).append(')');
   }
 }
diff --git a/src/main/java/com/hubspot/jinjava/objects/date/PyishDate.java b/src/main/java/com/hubspot/jinjava/objects/date/PyishDate.java
@@ -158,11 +158,12 @@ public boolean equals(Object obj) {
   }
 
   @Override
-  public String toPyishString() {
-    return String.format(
-      "'%s'|strtotime(%s)",
-      strftime(FULL_DATE_FORMAT),
-      PyishObjectMapper.getAsPyishString(FULL_DATE_FORMAT)
-    );
+  public StringBuilder appendPyishString(StringBuilder sb) {
+    return sb
+      .append('\'')
+      .append(strftime(FULL_DATE_FORMAT))
+      .append("'|strtotime(")
+      .append(PyishObjectMapper.getAsPyishString(FULL_DATE_FORMAT))
+      .append(')');
   }
 }
diff --git a/src/main/java/com/hubspot/jinjava/objects/serialization/PyishSerializable.java b/src/main/java/com/hubspot/jinjava/objects/serialization/PyishSerializable.java
@@ -28,9 +28,24 @@ default CharSequence toPyishString() {
     return writeValueAsString(this);
   }
 
+  /**
+   * Allows for a class to append the custom string representation in Jinjava.
+   * This method can be overridden to append a custom representation.
+   * This method will be used by {@link #writeSelf(JsonGenerator, SerializerProvider)}
+   * to specify what will be written to the json generator.
+   * If the pyish string representation of this object is composed of several strings,
+   * it's recommended to override this method instead of {@link #toPyishString()}
+   * @param sb StringBuilder to append the pyish string representation to.
+   * @return The same StringBuilder sb with an appended result
+   */
+  default StringBuilder appendPyishString(StringBuilder sb) {
+    return sb.append(toPyishString());
+  }
+
   /**
    * Allows for a class to specify how its pyish string representation will
    * be written to the json generator.
+   *
    * If the pyish string representation of this object can be very large, it's recommended
    * to override this method instead of {@link #toPyishString()} so that jsonGenerator
    * can be written to multiple times, allowing multiple limit checks to occur.
@@ -40,7 +55,7 @@ default void writeSelf(
     SerializerProvider serializerProvider
   )
     throws IOException {
-    jsonGenerator.writeRawValue(toPyishString().toString());
+    jsonGenerator.writeRawValue(appendPyishString(new StringBuilder()).toString());
   }
 
   /**
diff --git a/src/test/java/com/hubspot/jinjava/lib/filter/RejectAttrFilterTest.java b/src/test/java/com/hubspot/jinjava/lib/filter/RejectAttrFilterTest.java
@@ -112,7 +112,7 @@ public String toString() {
     }
 
     @Override
-    public String toPyishString() {
+    public CharSequence toPyishString() {
       return toString();
     }
   }

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,10 @@ public String toString() {`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`@Override`
`29`		`- public String toPyishString() {`
`30`		`- return name + "=" + PyishSerializable.writeValueAsString(value);`
	`29`	`+ public StringBuilder appendPyishString(StringBuilder sb) {`
	`30`	`+ return sb`
	`31`	`+ .append(name)`
	`32`	`+ .append('=')`
	`33`	`+ .append(PyishSerializable.writeValueAsString(value));`
`31`	`34`	`}`
`32`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public void setReferenceKey(String referenceKey) {`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`@Override`
`27`		`- public String toPyishString() {`
	`27`	`+ public CharSequence toPyishString() {`
`28`	`28`	`return getReferenceKey();`
`29`	`29`	`}`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public Namespace(Map<String, Object> map, int maxSize) {`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`@Override`
`23`		`- public String toPyishString() {`
`24`		`- return String.format("namespace(%s)", PyishSerializable.super.toPyishString());`
	`23`	`+ public StringBuilder appendPyishString(StringBuilder sb) {`
	`24`	`+ return PyishSerializable.super.appendPyishString(sb.append("namespace(")).append(')');`
`25`	`25`	`}`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -158,11 +158,12 @@ public boolean equals(Object obj) {`
`158`	`158`	`}`
`159`	`159`
`160`	`160`	`@Override`
`161`		`- public String toPyishString() {`
`162`		`- return String.format(`
`163`		`- "'%s'\|strtotime(%s)",`
`164`		`- strftime(FULL_DATE_FORMAT),`
`165`		`- PyishObjectMapper.getAsPyishString(FULL_DATE_FORMAT)`
`166`		`- );`
	`161`	`+ public StringBuilder appendPyishString(StringBuilder sb) {`
	`162`	`+ return sb`
	`163`	`+ .append('\'')`
	`164`	`+ .append(strftime(FULL_DATE_FORMAT))`
	`165`	`+ .append("'\|strtotime(")`
	`166`	`+ .append(PyishObjectMapper.getAsPyishString(FULL_DATE_FORMAT))`
	`167`	`+ .append(')');`
`167`	`168`	`}`
`168`	`169`	`}`
Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ public String toString() {`
`112`	`112`	`}`
`113`	`113`
`114`	`114`	`@Override`
`115`		`- public String toPyishString() {`
	`115`	`+ public CharSequence toPyishString() {`
`116`	`116`	`return toString();`
`117`	`117`	`}`
`118`	`118`	`}`