feat: add ability to alias identifier list members

gajus · Feb 28, 2019 · 0e2c475 · 0e2c475
1 parent 5771710
commit 0e2c475
Show file tree

Hide file tree

Showing 4 changed files with 78 additions and 7 deletions.
diff --git a/.README/VALUE_PLACEHOLDERS.md b/.README/VALUE_PLACEHOLDERS.md
@@ -275,7 +275,38 @@ Produces:
 
 ```js
 {
-  sql: 'SELECT 1 FROM "bar"."bar", "qux"."quux"',
+  sql: 'SELECT 1 FROM "bar"."baz", "qux"."quux"',
+  values: []
+}
+
+```
+
+#### Identifier aliases
+
+A member of the identifier list can be aliased:
+
+```js
+sql`
+  SELECT 1
+  FROM ${sql.identifierList([
+    {
+      alias: 'qux',
+      identifier: ['bar', 'baz']
+    },
+    {
+      alias: 'corge',
+      identifier: ['quux', 'quuz']
+    }
+  ])}
+`;
+
+```
+
+Produces:
+
+```js
+{
+  sql: 'SELECT 1 FROM "bar"."baz" "qux", "quux"."quuz" "corge"',
   values: []
 }
 

diff --git a/src/sqlFragmentFactories/createIdentifierListSqlFragment.js b/src/sqlFragmentFactories/createIdentifierListSqlFragment.js
@@ -10,16 +10,29 @@ import {
 
 export default (token: IdentifierListTokenType): SqlFragmentType => {
   const sql = token.identifiers
-    .map((names) => {
-      return names
+    .map((identifier) => {
+      if (Array.isArray(identifier)) {
+        return identifier
+          .map((identifierName) => {
+            if (typeof identifierName !== 'string') {
+              throw new TypeError('Identifier name must be a string.');
+            }
+
+            return escapeIdentifier(identifierName);
+          })
+          .join('.');
+      }
+
+      return identifier
+        .identifier
         .map((identifierName) => {
           if (typeof identifierName !== 'string') {
             throw new TypeError('Identifier name must be a string.');
           }
 
           return escapeIdentifier(identifierName);
         })
-        .join('.');
+        .join('.') + ' ' + escapeIdentifier(identifier.alias);
     })
     .join(', ');
 

diff --git a/src/types.js b/src/types.js
@@ -215,8 +215,14 @@ export type IdentifierTokenType = {|
   +type: typeof IdentifierTokenSymbol
 |};
 
+type IdentifierListMemberType = $ReadOnlyArray<string> |
+  {|
+    +alias: string,
+    +identifier: $ReadOnlyArray<string>
+  |};
+
 export type IdentifierListTokenType = {|
-  +identifiers: $ReadOnlyArray<$ReadOnlyArray<string>>,
+  +identifiers: $ReadOnlyArray<IdentifierListMemberType>,
   +type: typeof IdentifierListTokenSymbol
 |};
 

diff --git a/test/slonik/templateTags/sql/identifierList.js b/test/slonik/templateTags/sql/identifierList.js
@@ -6,7 +6,7 @@ import {
   SqlTokenSymbol
 } from '../../../../src/symbols';
 
-test('creates an object describing a query with inlined identifiers', (t) => {
+test('creates an object describing a query with identifiers', (t) => {
   const query = sql`SELECT ${'foo'} FROM ${sql.identifierList([['bar'], ['baz']])}`;
 
   t.deepEqual(query, {
@@ -18,7 +18,28 @@ test('creates an object describing a query with inlined identifiers', (t) => {
   });
 });
 
-test('creates an object describing a query with inlined identifiers (specifier)', (t) => {
+test('creates an object describing a query with aliased identifiers', (t) => {
+  const query = sql`SELECT ${'foo'} FROM ${sql.identifierList([
+    {
+      alias: 'baz',
+      identifier: ['bar']
+    },
+    {
+      alias: 'quux',
+      identifier: ['qux']
+    }
+  ])}`;
+
+  t.deepEqual(query, {
+    sql: 'SELECT $1 FROM "bar" "baz", "qux" "quux"',
+    type: SqlTokenSymbol,
+    values: [
+      'foo'
+    ]
+  });
+});
+
+test('creates an object describing a query with identifiers (specifier)', (t) => {
   const query = sql`SELECT ${'foo'} FROM ${sql.identifierList([
     ['bar', 'baz'],
     ['qux', 'quux']