qorbani added support for simple start of line comments

I needed to change where the comments were removed.  Also added a test and included the LCOV coverage file - which is not generated in github

Author: demmings

coverage/tests.lcov

@@ -935,7 +935,7 @@ class TableExtract {
         if (typeof ast.SELECT === 'undefined')
             return;
 
-       ast.SELECT.forEach(term => this.extractAstTables(term.subQuery, tableSet));
+        ast.SELECT.forEach(term => this.extractAstTables(term.subQuery, tableSet));
     }
 }
 
@@ -5619,10 +5619,12 @@ class SqlParse {
 
     /**
      * Parse a query
-     * @param {String} query 
+     * @param {String} sqlStatement 
      * @returns {Object}
      */
-    static sql2ast(query) {
+    static sql2ast(sqlStatement) {
+        const query = SqlParse.filterCommentsFromStatement(sqlStatement)
+
         // Define which words can act as separator
         const myKeyWords = SqlParse.generateUsedKeywordList(query);
         const [parts_name, parts_name_escaped] = SqlParse.generateSqlSeparatorWords(myKeyWords);
@@ -5668,6 +5670,20 @@ class SqlParse {
         return result;
     }
 
+    /**
+     * Remove comments from SQL statement.
+     * @param {String} statement 
+     * @returns {String}
+     */
+    static filterCommentsFromStatement(statement) {
+        // Remove comments with lines starting with '--' and join lines together.
+        // If comment is within a STRING on a newline, it will fail ...
+        // We leave inline comments and multi-line /* */ comments for another day.
+        const filteredStatement = statement.split('\n').filter(line => !line.trim().startsWith('--')).join(' ');
+
+        return filteredStatement;
+    }
+
     /**
     * 
     * @param {String} logic 
@@ -7382,6 +7398,12 @@ class ScriptSettings {      //  skipcq: JS-0128
         /** @type {PropertyData} */
         const myPropertyData = JSON.parse(myData);
 
+        if (PropertyData.isExpired(myPropertyData))
+        {
+            this.delete(propertyKey);
+            return null;
+        }
+
         return PropertyData.getData(myPropertyData);
     }
 

dist/gssql.js

@@ -1,6 +1,6 @@
 {
   "name": "@demmings/gssql",
-  "version": "1.3.44",
+  "version": "1.3.45",
   "description": "Google Sheets QUERY function replacement using real SQL select syntax.",
   "main": "testGsSql.js",
   "files": ["./src", "src", "img", "dist"],

package-lock.json

@@ -36,6 +36,12 @@ class ScriptSettings {      //  skipcq: JS-0128
         /** @type {PropertyData} */
         const myPropertyData = JSON.parse(myData);
 
+        if (PropertyData.isExpired(myPropertyData))
+        {
+            this.delete(propertyKey);
+            return null;
+        }
+
         return PropertyData.getData(myPropertyData);
     }
 

package.json

@@ -34,10 +34,12 @@ class SqlParse {
 
     /**
      * Parse a query
-     * @param {String} query 
+     * @param {String} sqlStatement 
      * @returns {Object}
      */
-    static sql2ast(query) {
+    static sql2ast(sqlStatement) {
+        const query = SqlParse.filterCommentsFromStatement(sqlStatement)
+
         // Define which words can act as separator
         const myKeyWords = SqlParse.generateUsedKeywordList(query);
         const [parts_name, parts_name_escaped] = SqlParse.generateSqlSeparatorWords(myKeyWords);
@@ -83,6 +85,20 @@ class SqlParse {
         return result;
     }
 
+    /**
+     * Remove comments from SQL statement.
+     * @param {String} statement 
+     * @returns {String}
+     */
+    static filterCommentsFromStatement(statement) {
+        // Remove comments with lines starting with '--' and join lines together.
+        // If comment is within a STRING on a newline, it will fail ...
+        // We leave inline comments and multi-line /* */ comments for another day.
+        const filteredStatement = statement.split('\n').filter(line => !line.trim().startsWith('--')).join(' ');
+
+        return filteredStatement;
+    }
+
     /**
     * 
     * @param {String} logic 

src/ScriptSettings.js

@@ -949,7 +949,7 @@ class TableExtract {
         if (typeof ast.SELECT === 'undefined')
             return;
 
-       ast.SELECT.forEach(term => this.extractAstTables(term.subQuery, tableSet));
+        ast.SELECT.forEach(term => this.extractAstTables(term.subQuery, tableSet));
     }
 }
 

src/SimpleParser.js

@@ -4270,6 +4270,28 @@ class SqlTester {
         return this.isEqual("selectSumMinusSum", data, expected);
     }
 
+    innerSelectWithComments() {
+        let stmt = "SELECT *, customers.name FROM bookSales " +
+            "\n -- We join books to customers\n" +
+            "LEFT JOIN customers ON bookSales.customer_ID = customers.ID " +
+            "\n-- We only want the highest booksales\n" +
+            "WHERE bookSales.quantity > (select AVG(quantity) from booksales)";
+
+        let data = new TestSql()
+            .addTableData("bookSales", this.bookSalesTable())
+            .addTableData("customers", this.customerTable())
+            .enableColumnTitle(true)
+            .execute(stmt);
+
+        let expected = [["BOOKSALES.INVOICE", "BOOKSALES.BOOK_ID", "BOOKSALES.CUSTOMER_ID", "BOOKSALES.QUANTITY", "BOOKSALES.PRICE", "BOOKSALES.DATE", "CUSTOMERS.ID", "CUSTOMERS.NAME", "CUSTOMERS.ADDRESS", "CUSTOMERS.CITY", "CUSTOMERS.PHONE", "CUSTOMERS.EMAIL", "customers.name"],
+        ["I7204", "2", "C4", 100, 65.49, "05/03/2022", "C4", "ForMe Resellers", "40 Four St", "FourtNight City", "2894441234", "fourtimes@hotmail.com", "ForMe Resellers"],
+        ["I7204", "3", "C4", 150, 24.95, "05/03/2022", "C4", "ForMe Resellers", "40 Four St", "FourtNight City", "2894441234", "fourtimes@hotmail.com", "ForMe Resellers"],
+        ["I7204", "4", "C4", 50, 19.99, "05/03/2022", "C4", "ForMe Resellers", "40 Four St", "FourtNight City", "2894441234", "fourtimes@hotmail.com", "ForMe Resellers"],
+        ["I7206", "7", "C2", 100, 17.99, "05/04/2022", "C2", "Dewy Tuesdays", "202 Second St.", "Second City", "4162022222", "twoguys@gmail.com", "Dewy Tuesdays"]];
+
+        return this.isEqual("innerSelectWithComments", data, expected);
+    }
+
     //  S T A R T   O T H E R   T E S T S
     removeTrailingEmptyRecords() {
         let authors = this.authorsTable();
@@ -5465,6 +5487,7 @@ function testerSql() {
     result = result && tester.selectAddDateLastDay();
     result = result && tester.selectCalculatedFieldNotInSelectFieldsWitinGroupBY();
     result = result && tester.selectLocate();
+    result = result && tester.innerSelectWithComments();
     //  Not supported (yet)
     // result = result && tester.selectSumMinusSum();