Introduce replaceCloseQuote to support " type replacements

Author: Yaytay

query-engine/docs/query-engine-compose.yml

@@ -50,7 +50,7 @@ services:
     - 16686:16686
 
   query-engine:
-    image: ghcr.io/yaytay/query-engine-design-mode:0.0.70-3-main
+    image: ghcr.io/yaytay/query-engine-design-mode:0.0.71-main
     ports:
     - 2000:8080
     volumes:

query-engine/src/main/java/uk/co/spudsoft/query/defn/FormatDelimited.java

@@ -51,6 +51,7 @@ public class FormatDelimited implements Format {
   private final String openQuote;
   private final String closeQuote;
   private final String escapeCloseQuote;
+  private final String replaceCloseQuote;
   private final String newline;
 
   @Override
@@ -275,10 +276,13 @@ public String getCloseQuote() {
 
   /**
    * Value with which to prefix any occurrence of the {@link #closeQuote} string in an output string value.
+   * Do not set both this and replaceCloseQuote, this value will take preference.
    * @return the value with which to prefix any occurrence of the {@link #closeQuote} string in an output string value.
    */
   @Schema(description = """
                         If a string value contains the close quote string it will be prefixed by this string.
+                        <P>
+                        Do not set both this and replaceCloseQuote, this value will take preference.
                         """
           , defaultValue = "\""
           , requiredMode = Schema.RequiredMode.NOT_REQUIRED
@@ -287,6 +291,24 @@ public String getCloseQuote() {
   public String getEscapeCloseQuote() {
     return escapeCloseQuote;
   }
+
+  /**
+   * Value with which to replace any occurrence of the {@link #closeQuote} string in an output string value.
+   * Do not set both this and escapeCloseQuote, the value of escapeCloseQuote will take preference.
+   * @return the value with which to replace any occurrence of the {@link #closeQuote} string in an output string value.
+   */
+  @Schema(description = """
+                        If a string value contains the close quote string it will be replaced by this string.
+                        <P>
+                        Do not set both this and escapeCloseQuote, the value of escapeCloseQuote will take preference.
+                        """
+          , defaultValue = "\""
+          , requiredMode = Schema.RequiredMode.NOT_REQUIRED
+          , maxLength = 10
+  )
+  public String getReplaceCloseQuote() {
+    return replaceCloseQuote;
+  }
 
   /**
    * Value with which to suffix each row in the output.
@@ -321,7 +343,8 @@ public static class Builder {
     private String delimiter = ",";
     private String openQuote = "\"";
     private String closeQuote = "\"";
-    private String escapeCloseQuote = "\"";
+    private String escapeCloseQuote = "";
+    private String replaceCloseQuote = "";
     private String newline = "\r\n";
 
     private Builder() {
@@ -460,6 +483,16 @@ public Builder escapeCloseQuote(final String value) {
       return this;
     }
 
+    /**
+     * Set the {@link FormatDelimited#replaceCloseQuote} value in the builder.
+     * @param value The value for the {@link FormatDelimited#replaceCloseQuote}.
+     * @return this, so that this builder may be used in a fluent manner.
+     */
+    public Builder replaceCloseQuote(final String value) {
+      this.replaceCloseQuote = value;
+      return this;
+    }
+
     /**
      * Set the {@link FormatDelimited#newline} value in the builder.
      * @param value The value for the {@link FormatDelimited#newline}.
@@ -475,7 +508,7 @@ public Builder newline(final String value) {
      * @return a new instance of the FormatDelimited class.
      */
     public FormatDelimited build() {
-      return new FormatDelimited(type, name, description, extension, filename, mediaType, hidden, bom, headerRow, delimiter, openQuote, closeQuote, escapeCloseQuote, newline);
+      return new FormatDelimited(type, name, description, extension, filename, mediaType, hidden, bom, headerRow, delimiter, openQuote, closeQuote, escapeCloseQuote, replaceCloseQuote, newline);
     }
   }
 
@@ -500,6 +533,7 @@ private FormatDelimited(final FormatType type
           , final String openQuote
           , final String closeQuote
           , final String escapeCloseQuote
+          , final String replaceCloseQuote
           , final String newline          
   ) {
     validateType(FormatType.Delimited, type);
@@ -516,6 +550,7 @@ private FormatDelimited(final FormatType type
     this.openQuote = openQuote;
     this.closeQuote = closeQuote;
     this.escapeCloseQuote = escapeCloseQuote;
+    this.replaceCloseQuote = replaceCloseQuote;
     this.newline = newline;
   }
 

query-engine/src/main/java/uk/co/spudsoft/query/exec/fmts/text/FormatDelimitedInstance.java

@@ -24,6 +24,7 @@
 import io.vertx.core.buffer.Buffer;
 import io.vertx.core.streams.WriteStream;
 import java.util.concurrent.atomic.AtomicBoolean;
+import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -147,10 +148,8 @@ private Future<Void> outputRow(DataRow row) {
             case String:
             default:
               outputRow.append(defn.getOpenQuote());
-              String string = v.toString();
-              if (!Strings.isNullOrEmpty(defn.getCloseQuote()) && !Strings.isNullOrEmpty(defn.getEscapeCloseQuote())) {
-                string = string.replaceAll(Pattern.quote(defn.getCloseQuote()), defn.getEscapeCloseQuote() + defn.getCloseQuote());
-              }
+              String string = v.toString();              
+              string = encodeCloseQuote(defn, string);
               outputRow.append(string);
               outputRow.append(defn.getCloseQuote());
               break;
@@ -164,6 +163,22 @@ private Future<Void> outputRow(DataRow row) {
     return outputStream.write(Buffer.buffer(outputRow.toString()));
   }
 
+  static String encodeCloseQuote(FormatDelimited defn, String string) {
+    if (!Strings.isNullOrEmpty(defn.getCloseQuote())) {
+      String replacement = null;
+      if (!Strings.isNullOrEmpty(defn.getEscapeCloseQuote())) {
+        replacement = defn.getEscapeCloseQuote() + defn.getCloseQuote();
+      } else if (!Strings.isNullOrEmpty(defn.getReplaceCloseQuote())) {
+        replacement = defn.getReplaceCloseQuote();
+      }
+      if (replacement != null) {
+        replacement = Matcher.quoteReplacement(replacement);
+        string = string.replaceAll(Pattern.quote(defn.getCloseQuote()), replacement);
+      }
+    }
+    return string;
+  }
+  
   @Override
   public Future<Void> initialize(PipelineExecutor executor, PipelineInstance pipeline, ReadStreamWithTypes input) {
     this.types = input.getTypes();

query-engine/src/main/java/uk/co/spudsoft/query/main/Version.java

@@ -34,7 +34,7 @@ public final class Version {
   /**
    * The project version, as set in the Maven pom.xml.
    */
-  public static final String MAVEN_PROJECT_VERSION = "0.0.70-3-main";
+  public static final String MAVEN_PROJECT_VERSION = "0.0.71-main";
 
   private Version() {
   }

query-engine/src/test/java/uk/co/spudsoft/query/defn/FormatDelimitedTest.java

@@ -41,8 +41,11 @@ public void testBuilder() {
     assertEquals("\"", FormatDelimited.builder().build().getCloseQuote());
     assertEquals("$", FormatDelimited.builder().closeQuote("$").build().getCloseQuote());
 
-    assertEquals("\"", FormatDelimited.builder().build().getEscapeCloseQuote());
+    assertEquals("", FormatDelimited.builder().build().getEscapeCloseQuote());
     assertEquals("$", FormatDelimited.builder().escapeCloseQuote("$").build().getEscapeCloseQuote());
+
+    assertEquals("", FormatDelimited.builder().build().getReplaceCloseQuote());
+    assertEquals("$", FormatDelimited.builder().replaceCloseQuote("$").build().getReplaceCloseQuote());
   }
 
   @Test

query-engine/src/test/java/uk/co/spudsoft/query/exec/fmts/text/FormatDelimitedInstanceTest.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright (C) 2025 njt
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package uk.co.spudsoft.query.exec.fmts.text;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import org.junit.jupiter.api.Test;
+import uk.co.spudsoft.query.defn.FormatDelimited;
+
+/**
+ *
+ * @author njt
+ */
+public class FormatDelimitedInstanceTest {
+  
+  @Test
+  public void testEncodeCloseQuote() {
+    assertEquals("bob", FormatDelimitedInstance.encodeCloseQuote(FormatDelimited.builder().build(), "bob"));
+    assertEquals("\\\"bob\\\"", FormatDelimitedInstance.encodeCloseQuote(FormatDelimited.builder().escapeCloseQuote("\\").build(), "\"bob\""));
+    assertEquals("&quot;bob&quot;", FormatDelimitedInstance.encodeCloseQuote(FormatDelimited.builder().replaceCloseQuote("&quot;").build(), "\"bob\""));    
+  }
+  
+}