Assorted Fixes #5 (#1715)

* refactor: Merge REPLACE into UPSERT

fixes #1706

* feat: `DROP TEMPORARY TABLE ...`

fixes #1712

* build: PMD compliance

* ci: Merge master

* feat: Configurable backslash `\` escaping

- Enables `\` as escape character in String Literals (beside SQL:2016 compliant `'`)
- Default is OFF (since its not SQL:2016 compliant)
- Activate per Parser Feature
- Fixes #1638
- Fixes #1209
- Fixes #1173
- Fixes #1172
- Fixes #832
- Fixes #827
- Fixes #578

BREAKING-CHANGE: Backslash Escaping needs to be activated explicitly or else Backslash won't work as Escape Character.

* style: Checkstyle

* style: remove dead code

* style: PMD compliance

* style: Checkstyle, unused import

* feat: allow `S_CHAR_LITERAL` to break lines

- fixes #875

Author: manticore-projects

build.gradle

@@ -180,15 +180,12 @@ spotbugs {
 
 pmd {
     consoleOutput = false
-    toolVersion = "6.46.0"
-    
     sourceSets = [sourceSets.main]
 
     // clear the ruleset in order to use configured rules only
     ruleSets = []
 
     //rulesMinimumPriority = 1
-    
     ruleSetFiles = files("config/pmd/ruleset.xml")
 
     pmdMain {

config/pmd/ruleset.xml

@@ -48,8 +48,8 @@ under the License.
 	<rule ref="category/java/codestyle.xml/UnnecessaryReturn" />
 	<rule ref="category/java/codestyle.xml/UselessParentheses" />
 	<rule ref="category/java/codestyle.xml/UselessQualifiedThis" />
-    
-		<!-- for Codazy -->
+
+	<!-- for Codazy -->
 	<rule ref="category/java/codestyle.xml/MethodNamingConventions">
 		<properties>
 			<property name="methodPattern" value="[a-z][a-zA-Z0-9]*" />

pom.xml

@@ -131,7 +131,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-pmd-plugin</artifactId>
-                <version>3.14.0</version>
+                <version>3.19.0</version>
                 <configuration>
                     <rulesets>
                         <!-- Custom local file system rule set -->
@@ -218,7 +218,7 @@
                     <dependency>
                         <groupId>net.java.dev.javacc</groupId>
                         <artifactId>javacc</artifactId>
-                        <version>7.0.11</version>
+                        <version>7.0.12</version>
                     </dependency>
                 </dependencies>
             </plugin>
@@ -418,92 +418,11 @@
                 <version>3.3.0</version>
             </plugin>
 
-            <!-- Cobertura is broken with Java 1.8 and there is not fix
-            please refer to https://github.com/cobertura/cobertura/issues/248
-            
-            <plugin>
-                <groupId>org.codehaus.mojo</groupId>
-                <artifactId>cobertura-maven-plugin</artifactId>
-                <version>2.7</version>
-                <configuration>
-                    <aggregate>true</aggregate>
-                    <outputDirectory>${project.reporting.outputDirectory}/cobertura</outputDirectory>
-                </configuration>
-            </plugin>
-            -->
-            
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>findbugs-maven-plugin</artifactId>
                 <version>3.0.5</version>
             </plugin>
-            
-            <!-- Obsolete or Unused
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-checkstyle-plugin</artifactId>
-                <configuration>
-                    <configLocation>config/sun_checks.xml</configLocation>
-                </configuration>
-            </plugin>
-            -->
-            
-            <!-- JJDoc report generating the BNF documentation -->
-            <plugin>
-                <groupId>org.javacc.plugin</groupId>
-                <artifactId>javacc-maven-plugin</artifactId>
-                <version>3.0.3</version>
-                <configuration>
-                    <!-- 
-                    /**
-                    * A flag to specify the output format for the generated documentation. If set to <code>true</code>, JJDoc will
-                    * generate a plain text description of the BNF. Some formatting is done via tab characters, but the intention is to
-                    * leave it as plain as possible. Specifying <code>false</code> causes JJDoc to generate a hyperlinked HTML document
-                    * unless the parameter {@link #bnf} has been set to <code>true</code>. Default value is <code>false</code>.
-                    * 
-                    * @parameter expression="${text}"
-                    */
-                    -->
-                    <text>false</text>
-                    
-                    <!--
-                    /**
-                    * A flag whether to generate a plain text document with the unformatted BNF. Note that setting this option to
-                    * <code>true</code> is only effective if the parameter {@link #text} is <code>false</code>. Default value is
-                    * <code>false</code>.
-                    * 
-                    * @parameter expression="${bnf}"
-                    * @since 2.6
-                    */
-                    -->
-                    <bnf>false</bnf>
-                    
-                    <!--
-                    /**
-                    * This option controls the structure of the generated HTML output. If set to <code>true</code>, a single HTML
-                    * table for the entire BNF is generated. Setting it to <code>false</code> will produce one table for every
-                    * production in the grammar.
-                    * 
-                    * @parameter expression="${oneTable}" default-value=true
-                    */
-                    -->
-                    <oneTable>false</oneTable>
-                    
-                    <!--
-                    /**
-                    * The hypertext reference to an optional CSS file for the generated HTML documents. If specified, this CSS file
-                    * will be included via a <code>&lt;link&gt;</code> element in the HTML documents. Otherwise, the default style will
-                    * be used.
-                    * 
-                    * @parameter expression="${cssHref}"
-                    * @since 2.5
-                    */            
-                    -->
-                    <!-- <cssHref></cssHref> -->
-                    
-                    <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
-                </configuration>
-            </plugin>
         </plugins>
     </reporting>
 
@@ -628,7 +547,7 @@
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <pmdVersion>6.46.0</pmdVersion>
+        <pmdVersion>6.53.0</pmdVersion>
     </properties>
 
     <description>JSqlParser parses an SQL statement and translate it into a hierarchy of Java classes.

src/main/java/net/sf/jsqlparser/parser/AbstractJSqlParser.java

@@ -36,6 +36,10 @@ public P withUnsupportedStatements(boolean allowUnsupportedStatements) {
     public P withTimeOut(int timeOutMillSeconds) {
         return withFeature(Feature.timeOut, timeOutMillSeconds);
     }
+
+    public P withBackslashEscapeCharacter(boolean allowBackslashEscapeCharacter) {
+        return withFeature(Feature.allowBackslashEscapeCharacter, allowBackslashEscapeCharacter);
+    }
 
     public P withFeature(Feature f, boolean enabled) {
         getConfiguration().setValue(f, enabled);

src/main/java/net/sf/jsqlparser/parser/feature/Feature.java

@@ -21,8 +21,8 @@
 import net.sf.jsqlparser.statement.DeclareStatement;
 import net.sf.jsqlparser.statement.DescribeStatement;
 import net.sf.jsqlparser.statement.ExplainStatement;
-import net.sf.jsqlparser.statement.SetStatement;
 import net.sf.jsqlparser.statement.ResetStatement;
+import net.sf.jsqlparser.statement.SetStatement;
 import net.sf.jsqlparser.statement.ShowColumnsStatement;
 import net.sf.jsqlparser.statement.ShowStatement;
 import net.sf.jsqlparser.statement.UseStatement;
@@ -447,6 +447,7 @@ public enum Feature {
      *
      * @see Replace
      */
+    @Deprecated
     replace,
     /**
      * SQL "DROP" statement is allowed
@@ -758,7 +759,12 @@ public enum Feature {
      */
     allowUnsupportedStatements(false),
 
-    timeOut( 6000)
+    timeOut( 6000),
+
+    /**
+     * allows Backslash '\' as Escape Character
+     */
+    allowBackslashEscapeCharacter(false),
     ;
 
     private Object value;

src/main/java/net/sf/jsqlparser/statement/drop/Drop.java

@@ -30,6 +30,8 @@ public class Drop implements Statement {
     private boolean ifExists = false;
     private boolean materialized = false;
 
+    private boolean isUsingTemporary;
+
     @Override
     public void accept(StatementVisitor statementVisitor) {
         statementVisitor.visit(this);
@@ -67,6 +69,19 @@ public void setIfExists(boolean ifExists) {
         this.ifExists = ifExists;
     }
 
+    public boolean isUsingTemporary() {
+        return isUsingTemporary;
+    }
+
+    public void setUsingTemporary(boolean useTemporary) {
+        this.isUsingTemporary=useTemporary;
+    }
+
+    public Drop withUsingTemporary(boolean useTemporary) {
+        setUsingTemporary(useTemporary);
+        return this;
+    }
+
     public boolean isMaterialized() {
         return materialized;
     }
@@ -85,7 +100,8 @@ public void setTypeToParameters(Map<String, List<String>> typeToParameters) {
 
     @Override
     public String toString() {
-        String sql = "DROP " 
+        String sql = "DROP "
+                + (isUsingTemporary ? "TEMPORARY " : "")
                 + (materialized ? "MATERIALIZED " : "")
                 + type + " "
                 + (ifExists ? "IF EXISTS " : "") + name.toString();