Merge pull request #45 from paustint/feature-39

added formatting options

Author: paustint

README.md

@@ -9,7 +9,7 @@ SOQL Parser JS will parse a SOQL query string into an object that is easy to wor
 
 This works in the browser as long as npm is used to install the package with dependencies and the browser supports ES6 or a transpiler is used.
 
-*Warning*: antlr4 is a very large library and is required for the parser to function, so be aware of this prior to including in your browser bundles.
+*Warning*: antlr4 is a large library and is required for the parser to function, use in the browser with care.
 
 ## Examples
 For an example of the parser, check out the [example application](https://paustint.github.io/soql-parser-js/).
@@ -134,6 +134,12 @@ Options:
 export interface SoqlComposeConfig {
   logging: boolean; // default=false
   format: boolean; // default=false
+  formatOptions?: {
+    numIndent?: number; // default=1
+    fieldMaxLineLen?: number; // default=60
+    fieldSubqueryParensOnOwnLine?: boolean; // default=true
+    whereClauseOperatorsIndented?: boolean; // default=false
+  }
 }
 ```
 
@@ -188,6 +194,86 @@ This yields an object with the following structure:
 SELECT UserId, COUNT(Id) from LoginHistory WHERE LoginTime > 2010-09-20T22:16:30.000Z AND LoginTime < 2010-09-21T22:16:30.000Z GROUP BY UserId
 ```
 
+### Format Query
+This function is provided as a convenience and will parse a query and compose the query with formatting options provided.
+```typescript
+import { formatQuery } from 'soql-parser-js';
+
+const query = `SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue, BillingAddress, BillingCity, BillingCountry, BillingGeocodeAccuracy, ShippingStreet, Sic, SicDesc, Site, SystemModstamp, TickerSymbol, Type, Website, (SELECT Id, Name, AccountId, Amount, CampaignId, CloseDate, CreatedById, Type FROM Opportunities), (SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue, BillingAddress, Website FROM ChildAccounts) FROM Account WHERE Name LIKE 'a%' OR Name LIKE 'b%' OR Name LIKE 'c%'`;
+
+const formattedQuery1 = formatQuery(query);
+const formattedQuery2 = formatQuery(query, { fieldMaxLineLen: 20, fieldSubqueryParensOnOwnLine: false, whereClauseOperatorsIndented: true });
+const formattedQuery3 = formatQuery(query, { fieldSubqueryParensOnOwnLine: true, whereClauseOperatorsIndented: true });
+
+
+```
+
+```sql
+-- formattedQuery1
+SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue,
+	BillingAddress, BillingCity, BillingCountry, BillingGeocodeAccuracy,
+	ShippingStreet, Sic, SicDesc, Site, SystemModstamp, TickerSymbol, Type,
+	Website,
+	(
+		SELECT Id, Name, AccountId, Amount, CampaignId, CloseDate,
+			CreatedById, Type
+		FROM Opportunities
+	),
+	(
+		SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue,
+			BillingAddress, Website
+		FROM ChildAccounts
+	)
+FROM Account
+WHERE Name LIKE 'a%'
+OR Name LIKE 'b%'
+OR Name LIKE 'c%'
+
+-- formattedQuery2
+SELECT Id, Name,
+	AccountNumber, AccountSource,
+	AnnualRevenue, BillingAddress,
+	BillingCity, BillingCountry,
+	BillingGeocodeAccuracy, ShippingStreet,
+	Sic, SicDesc, Site,
+	SystemModstamp, TickerSymbol, Type,
+	Website,
+	(SELECT Id, Name,
+		AccountId, Amount, CampaignId,
+		CloseDate, CreatedById, Type
+	FROM Opportunities),
+	(SELECT Id, Name,
+		AccountNumber, AccountSource,
+		AnnualRevenue, BillingAddress,
+		Website
+	FROM ChildAccounts)
+FROM Account
+WHERE Name LIKE 'a%'
+	OR Name LIKE 'b%'
+	OR Name LIKE 'c%'
+
+
+-- formattedQuery3
+SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue,
+	BillingAddress, BillingCity, BillingCountry, BillingGeocodeAccuracy,
+	ShippingStreet, Sic, SicDesc, Site, SystemModstamp, TickerSymbol, Type,
+	Website,
+	(
+		SELECT Id, Name, AccountId, Amount, CampaignId, CloseDate,
+			CreatedById, Type
+		FROM Opportunities
+	),
+	(
+		SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue,
+			BillingAddress, Website
+		FROM ChildAccounts
+	)
+FROM Account
+WHERE Name LIKE 'a%'
+	OR Name LIKE 'b%'
+	OR Name LIKE 'c%'
+```
+
 ### Options
 
 ```typescript
@@ -199,6 +285,16 @@ export interface SoqlQueryConfig {
 
 export interface SoqlComposeConfig {
   logging: boolean; // default=false
+  format: boolean; // default=false
+  formatOptions?: FormatOptions;
+}
+
+export interface FormatOptions {
+  numIndent?: number; // default=1
+  fieldMaxLineLen?: number; // default=60
+  fieldSubqueryParensOnOwnLine?: boolean; // default=true
+  whereClauseOperatorsIndented?: boolean; // default=false
+  logging?: boolean; // default=false
 }
 ```
 

debug/test.js

@@ -1,14 +1,32 @@
 var soqlParserJs = require('./lib');
 
 const query = `
-SELECT Id, Name, Foo, Bar, Baz, Bax, aaa, bbb, ccc, ddd, Id, Name, Foo, Bar, Baz, Bax, aaa, bbb, ccc, ddd, Id, Name, Foo, Bar, Baz, Bax, aaa, bbb, ccc, ddd, Account.Name, (SELECT Id, Name, Foo, Bar, Baz, Bax, aaa, bbb, ccc, ddd, Id, Name, Foo, Bar, Baz, Bax, aaa, bbb, ccc, ddd, Contact.LastName FROM Account.Contacts) FROM Account
+SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue, BillingAddress, BillingCity, BillingCountry, BillingGeocodeAccuracy, ShippingStreet, Sic, SicDesc, Site, SystemModstamp, TickerSymbol, Type, Website, (SELECT Id, Name, AccountId, Amount, CampaignId, CloseDate, CreatedById, Type FROM Opportunities), (SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue, BillingAddress, Website FROM ChildAccounts) FROM Account WHERE Name LIKE 'a%' OR Name LIKE 'b%' OR Name LIKE 'c%'
 `;
-
+// SELECT Id, Name, Foo, Bar, Baz, Bax, aaa, bbb, ccc, ddd, Id, Name, Foo, Bar, Baz, Bax, aaa, bbb, ccc, ddd, Id, Name, Foo, Bar, Baz, Bax, aaa, bbb, ccc, ddd, Account.Name, (SELECT Id, Name, Foo, Bar, Baz, Bax, aaa, bbb, ccc, ddd, Id, Name, Foo, Bar, Baz, Bax, aaa, bbb, ccc, ddd, Contact.LastName FROM Account.Contacts), baz, (SELECT Id FROM account WHERE Boo.baz = 'bar'), bax, bar FROM Account
 const parsedQuery = soqlParserJs.parseQuery(query, { logging: true });
 console.log(JSON.stringify(parsedQuery, null, 2));
 
-const composedQuery = soqlParserJs.composeQuery(parsedQuery, { logging: true, format: true });
-console.log(composedQuery);
+// const composedQuery = soqlParserJs.composeQuery(parsedQuery, {
+//   logging: true,
+//   format: true,
+//   formatOptions: { fieldMaxLineLen: 20, fieldSubqueryParensOnOwnLine: true, whereClauseOperatorsIndented: true },
+// });
+// console.log(composedQuery);
+// soqlParserJs.formatQuery(parsedQuery);
+const formattedQuery1 = soqlParserJs.formatQuery(query);
+const formattedQuery3 = soqlParserJs.formatQuery(query, {
+  fieldMaxLineLen: 20,
+  fieldSubqueryParensOnOwnLine: false,
+  whereClauseOperatorsIndented: true,
+});
+const formattedQuery2 = soqlParserJs.formatQuery(query, {
+  fieldSubqueryParensOnOwnLine: true,
+  whereClauseOperatorsIndented: true,
+});
+console.log(formattedQuery1);
+console.log(formattedQuery3);
+console.log(formattedQuery2);
 
 // SELECT Id, Name FROM Account WHERE Id IN (SELECT AccountId FROM Opportunity WHERE StageName = 'Closed Lost')
 // SELECT Id FROM Account WHERE Id NOT IN (SELECT AccountId FROM Opportunity WHERE IsClosed = false)

lib/SoqlComposer.ts

@@ -10,11 +10,12 @@ import {
   WithDataCategoryClause,
 } from './models/SoqlQuery.model';
 import * as utils from './utils';
-import { FieldData, Formatter } from './SoqlFormatter';
+import { FieldData, Formatter, FormatOptions } from './SoqlFormatter';
 
 export interface SoqlComposeConfig {
   logging: boolean; // default=false
   format: boolean; // default=false
+  formatOptions?: FormatOptions;
 }
 
 export function composeQuery(soql: Query, config: Partial<SoqlComposeConfig> = {}): string {
@@ -49,9 +50,9 @@ export class Compose {
     this.format = config.format;
     this.query = '';
 
-    this.formatter = new Formatter({
-      active: this.format,
+    this.formatter = new Formatter(this.format, {
       logging: this.logging,
+      ...config.formatOptions,
     });
 
     this.start();
@@ -88,7 +89,7 @@ export class Compose {
           subquery => subquery.sObjectRelationshipName === field.text.replace(this.subqueryFieldReplaceRegex, '')
         );
         if (subquery) {
-          fieldData.fields[i].text = `(${this.parseQuery(subquery, true)})`;
+          fieldData.fields[i].text = this.formatter.formatSubquery(this.parseQuery(subquery, true));
           fieldData.fields[i].isSubquery = true;
         }
       }
@@ -101,7 +102,7 @@ export class Compose {
       output += `${field.prefix}${field.text}${field.suffix}`;
     });
 
-    output += this.formatter.formatClause('FROM', isSubquery);
+    output += this.formatter.formatClause('FROM');
 
     if (query.sObjectRelationshipName) {
       const sObjectPrefix = query.sObjectPrefix || [];
@@ -113,56 +114,56 @@ export class Compose {
     this.log(output);
 
     if (query.where) {
-      output += this.formatter.formatClause('WHERE', isSubquery);
-      output += ` ${this.parseWhereClause(query.where, isSubquery)}`;
+      output += this.formatter.formatClause('WHERE');
+      output += ` ${this.parseWhereClause(query.where)}`;
       this.log(output);
     }
 
     // TODO: add WITH support https://github.com/paustint/soql-parser-js/issues/18
 
     if (query.groupBy) {
-      output += this.formatter.formatClause('GROUP BY', isSubquery);
+      output += this.formatter.formatClause('GROUP BY');
       output += ` ${this.parseGroupByClause(query.groupBy)}`;
       this.log(output);
       if (query.having) {
-        output += this.formatter.formatClause('HAVING', isSubquery);
+        output += this.formatter.formatClause('HAVING');
         output += ` ${this.parseHavingClause(query.having)}`;
         this.log(output);
       }
     }
 
     if (query.orderBy) {
-      output += this.formatter.formatClause('ORDER BY', isSubquery);
+      output += this.formatter.formatClause('ORDER BY');
       output += ` ${this.parseOrderBy(query.orderBy)}`;
       this.log(output);
     }
 
     if (utils.isNumber(query.limit)) {
-      output += this.formatter.formatClause('LIMIT', isSubquery);
+      output += this.formatter.formatClause('LIMIT');
       output += ` ${query.limit}`;
       this.log(output);
     }
 
     if (utils.isNumber(query.offset)) {
-      output += this.formatter.formatClause('OFFSET', isSubquery);
+      output += this.formatter.formatClause('OFFSET');
       output += ` ${query.offset}`;
       this.log(output);
     }
 
     if (query.withDataCategory) {
-      output += this.formatter.formatClause('WITH DATA CATEGORY', isSubquery);
+      output += this.formatter.formatClause('WITH DATA CATEGORY');
       output += ` ${this.parseWithDataCategory(query.withDataCategory)}`;
       this.log(output);
     }
 
     if (query.for) {
-      output += this.formatter.formatClause('FOR', isSubquery);
+      output += this.formatter.formatClause('FOR');
       output += ` ${query.for}`;
       this.log(output);
     }
 
     if (query.update) {
-      output += this.formatter.formatClause('UPDATE', isSubquery);
+      output += this.formatter.formatClause('UPDATE');
       output += ` ${query.update}`;
       this.log(output);
     }
@@ -207,7 +208,7 @@ export class Compose {
     return `${(fn.text || '').replace(/,/g, ', ')} ${fn.alias || ''}`.trim();
   }
 
-  private parseWhereClause(where: WhereClause, isSubquery: boolean): string {
+  private parseWhereClause(where: WhereClause): string {
     let output = '';
     if (where.left) {
       output +=
@@ -218,17 +219,22 @@ export class Compose {
       output += where.left.fn ? this.parseFn(where.left.fn) : where.left.field;
       output += ` ${where.left.operator} `;
       output += where.left.valueQuery
-        ? `(${this.parseQuery(where.left.valueQuery, true)})`
+        ? this.formatter.formatSubquery(this.parseQuery(where.left.valueQuery), 1, true)
         : utils.getAsArrayStr(where.left.value);
       output +=
         utils.isNumber(where.left.closeParen) && where.left.closeParen > 0
           ? new Array(where.left.closeParen).fill(')').join('')
           : '';
     }
     if (where.right) {
-      return `${output}${this.formatter.formatAddNewLine(' ', isSubquery)}${utils.get(
-        where.operator
-      )} ${this.parseWhereClause(where.right, isSubquery)}`.trim();
+      const formattedData = this.formatter.formatWhereClauseOperators(
+        utils.get(where.operator),
+        this.parseWhereClause(where.right)
+      );
+      return `${output}${formattedData}`.trim();
+      // return `${output}${this.formatter.formatAddNewLine(' ')}${utils.get(where.operator)} ${this.parseWhereClause(
+      //   where.right
+      // )}`.trim();
     } else {
       return output.trim();
     }
@@ -259,7 +265,7 @@ export class Compose {
 
   private parseOrderBy(orderBy: OrderByClause | OrderByClause[]): string {
     if (Array.isArray(orderBy)) {
-      return orderBy.map(ob => this.parseOrderBy(ob)).join(', ');
+      return this.formatter.formatOrderByArray(orderBy.map(ob => this.parseOrderBy(ob)));
     } else {
       let output = `${utils.get(orderBy.field, ' ')}`;
       output += orderBy.fn ? this.parseFn(orderBy.fn) : '';