Merge placeholder-replacement

Author: nene

.editorconfig

@@ -1,6 +1,3 @@
-# EditorConfig helps developers define and maintain
-# consistent coding styles between different editors and IDEs.
-
 root = true
 
 [*]
@@ -11,5 +8,6 @@ insert_final_newline = true
 indent_style = space
 indent_size = 4
 
-[*.md]
-trim_trailing_whitespace = false
+[{package.json,.travis.yml}]
+indent_style = space
+indent_size = 2

README.md

@@ -45,6 +45,31 @@ Currently just two SQL dialects are supported:
 - **sql** - [Standard SQL][]
 - **n1ql** - [Couchbase N1QL][]
 
+### Placeholders replacement
+
+```js
+// Named placeholders
+sqlFormatter.format("SELECT * FROM tbl WHERE foo = @foo", {
+    params: {foo: "'bar'"}
+}));
+
+// Indexed placeholders
+sqlFormatter.format("SELECT * FROM tbl WHERE foo = ?", {
+    params: ["'bar'"]
+}));
+```
+
+Both result in:
+
+```
+SELECT
+  *
+FROM
+  tbl
+WHERE
+  foo = 'bar'
+```
+
 ## Usage without NPM
 
 If you don't use a module bundler, clone the repository, run `npm install` and grab a file from `/dist` directory to use inside a `<script>` tag.

src/core/Formatter.js

@@ -1,24 +1,27 @@
 import _ from "lodash";
-import sqlTokenTypes from "./tokenTypes";
+import tokenTypes from "./tokenTypes";
 import Indentation from "./Indentation";
 import InlineBlock from "./InlineBlock";
+import Params from "./Params";
 
 export default class Formatter {
     /**
      * @param {Object} cfg
-     *  @param {Object} cfg.indent
+     *   @param {Object} cfg.indent
+     *   @param {Object} cfg.params
      * @param {Tokenizer} tokenizer
      */
     constructor(cfg, tokenizer) {
         this.cfg = cfg || {};
         this.indentation = new Indentation(this.cfg.indent);
         this.inlineBlock = new InlineBlock();
+        this.params = new Params(this.cfg.params);
         this.tokenizer = tokenizer;
         this.previousReservedWord = {};
     }
 
     /**
-     * Format the whitespace in a SQL string to make it easier to read.
+     * Formats whitespaces in a SQL string to make it easier to read.
      *
      * @param {String} query The SQL query string
      * @return {String} formatted query
@@ -34,33 +37,36 @@ export default class Formatter {
         let formattedQuery = "";
 
         tokens.forEach((token, index) => {
-            if (token.type === sqlTokenTypes.WHITESPACE) {
+            if (token.type === tokenTypes.WHITESPACE) {
                 return;
             }
-            else if (token.type === sqlTokenTypes.LINE_COMMENT) {
+            else if (token.type === tokenTypes.LINE_COMMENT) {
                 formattedQuery = this.formatLineComment(token, formattedQuery);
             }
-            else if (token.type === sqlTokenTypes.BLOCK_COMMENT) {
+            else if (token.type === tokenTypes.BLOCK_COMMENT) {
                 formattedQuery = this.formatBlockComment(token, formattedQuery);
             }
-            else if (token.type === sqlTokenTypes.RESERVED_TOPLEVEL) {
+            else if (token.type === tokenTypes.RESERVED_TOPLEVEL) {
                 formattedQuery = this.formatToplevelReservedWord(token, formattedQuery);
                 this.previousReservedWord = token;
             }
-            else if (token.type === sqlTokenTypes.RESERVED_NEWLINE) {
+            else if (token.type === tokenTypes.RESERVED_NEWLINE) {
                 formattedQuery = this.formatNewlineReservedWord(token, formattedQuery);
                 this.previousReservedWord = token;
             }
-            else if (token.type === sqlTokenTypes.RESERVED) {
+            else if (token.type === tokenTypes.RESERVED) {
                 formattedQuery = this.formatWithSpaces(token, formattedQuery);
                 this.previousReservedWord = token;
             }
-            else if (token.type === sqlTokenTypes.OPEN_PAREN) {
+            else if (token.type === tokenTypes.OPEN_PAREN) {
                 formattedQuery = this.formatOpeningParentheses(tokens, index, formattedQuery);
             }
-            else if (token.type === sqlTokenTypes.CLOSE_PAREN) {
+            else if (token.type === tokenTypes.CLOSE_PAREN) {
                 formattedQuery = this.formatClosingParentheses(token, formattedQuery);
             }
+            else if (token.type === tokenTypes.PLACEHOLDER) {
+                formattedQuery = this.formatPlaceholder(token, formattedQuery);
+            }
             else if (token.value === ",") {
                 formattedQuery = this.formatComma(token, formattedQuery);
             }
@@ -113,7 +119,7 @@ export default class Formatter {
     formatOpeningParentheses(tokens, index, query) {
         // Take out the preceding space unless there was whitespace there in the original query or another opening parens
         const previousToken = tokens[index - 1];
-        if (previousToken && previousToken.type !== sqlTokenTypes.WHITESPACE && previousToken.type !== sqlTokenTypes.OPEN_PAREN) {
+        if (previousToken && previousToken.type !== tokenTypes.WHITESPACE && previousToken.type !== tokenTypes.OPEN_PAREN) {
             query = _.trimEnd(query);
         }
         query += tokens[index].value;
@@ -139,6 +145,10 @@ export default class Formatter {
         }
     }
 
+    formatPlaceholder(token, query) {
+        return query + this.params.get(token) + " ";
+    }
+
     // Commas start a new line (unless within inline parentheses or SQL "LIMIT" clause)
     formatComma(token, query) {
         query = _.trimEnd(query) + token.value + " ";

src/core/InlineBlock.js

@@ -1,4 +1,4 @@
-import sqlTokenTypes from "./tokenTypes";
+import tokenTypes from "./tokenTypes";
 
 const INLINE_MAX_LENGTH = 50;
 
@@ -63,10 +63,10 @@ export default class InlineBlock {
                 return false;
             }
 
-            if (token.type === sqlTokenTypes.OPEN_PAREN) {
+            if (token.type === tokenTypes.OPEN_PAREN) {
                 level++;
             }
-            else if (token.type === sqlTokenTypes.CLOSE_PAREN) {
+            else if (token.type === tokenTypes.CLOSE_PAREN) {
                 level--;
                 if (level === 0) {
                     return true;
@@ -83,10 +83,10 @@ export default class InlineBlock {
     // Reserved words that cause newlines, comments and semicolons
     // are not allowed inside inline parentheses block
     isForbiddenToken({type, value}) {
-        return type === sqlTokenTypes.RESERVED_TOPLEVEL ||
-            type === sqlTokenTypes.RESERVED_NEWLINE ||
-            type === sqlTokenTypes.COMMENT ||
-            type === sqlTokenTypes.BLOCK_COMMENT ||
+        return type === tokenTypes.RESERVED_TOPLEVEL ||
+            type === tokenTypes.RESERVED_NEWLINE ||
+            type === tokenTypes.COMMENT ||
+            type === tokenTypes.BLOCK_COMMENT ||
             value === ";";
     }
 }

src/core/Params.js

@@ -0,0 +1,29 @@
+/**
+ * Handles placeholder replacement with given params.
+ */
+export default class Params {
+    /**
+     * @param {Object} params
+     */
+    constructor(params) {
+        this.params = params;
+        this.index = 0;
+    }
+
+    /**
+     * Returns param value that matches given placeholder with param key.
+     * @param {Object} token
+     *   @param {String} token.key Placeholder key
+     *   @param {String} token.value Placeholder value
+     * @return {String} param or token.value when params are missing
+     */
+    get({key, value}) {
+        if (!this.params) {
+            return value;
+        }
+        if (key) {
+            return this.params[key];
+        }
+        return this.params[this.index ++];
+    }
+}