allow the transform function to be a promise

CHANGELOG.md

@@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [0.0.4] - 2018-02-08
+
+### Changed
+- Allow the transform function to be a promise
 
 
 ## [0.0.3] - 2018-02-08

package.json

@@ -1,6 +1,6 @@
 {
   "name": "adonis-bumblebee",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Api Transformer Provider for AdonisJs Framework",
   "main": "index.js",
   "scripts": {

src/Bumblebee/Scope.js

@@ -41,7 +41,7 @@ class Scope {
   async _item (data, transformer) {
     let transformerInstance = this._getTransformerInstance(transformer)
 
-    let transformed = transformerInstance.transform(await data, this._ctx)
+    let transformed = await transformerInstance.transform(await data, this._ctx)
 
     let includeData = await transformerInstance.processIncludedResources(this, await data)
 

src/Bumblebee/TransformerAbstract.js

@@ -41,7 +41,7 @@ class TransformerAbstract {
     const Scope = require('./Scope')
 
     for (let include of this.defaultInclude()) {
-      let resource = this.callIncludeFunction(include, data)
+      let resource = await this.callIncludeFunction(include, data)
 
       let childScope = new Scope(parentScope._manager, resource, parentScope._ctx)
 
@@ -51,7 +51,7 @@ class TransformerAbstract {
     return includeData
   }
 
-  callIncludeFunction (include, data) {
+  async callIncludeFunction (include, data) {
     let includeName = `include${include.charAt(0).toUpperCase()}${include.slice(1)}`
 
     return this[includeName](data)

test/promise.spec.js

@@ -0,0 +1,82 @@
+'use strict'
+
+/**
+ * adonis-bumblebee
+ *
+ * (c) Ralph Huwiler <ralph@huwiler.rocks>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+*/
+
+const test = require('japa')
+const { ioc } = require('@adonisjs/fold')
+
+const setup = require('./setup')
+const TransformerAbstract = require('../src/Bumblebee/TransformerAbstract')
+
+class BookTransformer extends TransformerAbstract {
+  defaultInclude () {
+    return [
+      'author'
+    ]
+  }
+
+  async transform (book) {
+    return {
+      id: book.id,
+      title: book.title,
+      year: book.yr
+    }
+  }
+
+  async includeAuthor (book) {
+    return this.item(book.author, author => ({name: author.name}))
+  }
+}
+
+test.group('Promise', (group) => {
+  group.before(async () => {
+    await setup()
+  })
+
+  test('data can be a promise and will resolve before transforming', async (assert) => {
+    const Context = ioc.use('Adonis/Src/HttpContext')
+    const {transform} = new Context()
+
+    let data = new Promise((resolve, reject) => {
+      setTimeout(resolve, 1, {item_id: 3})
+    })
+
+    let transformed = await transform
+    .item(data, model => ({id: model.item_id}))
+
+    assert.equal(transformed.id, 3)
+  })
+
+  test('the transform function can be a promise', async (assert) => {
+    const Context = ioc.use('Adonis/Src/HttpContext')
+    const {transform} = new Context()
+
+    let data = {
+      id: 1,
+      title: 'A Game of Thrones',
+      yr: 1996,
+      author: {
+        name: 'George R. R. Martin'
+      }
+    }
+
+    let transformed = await transform
+    .item(data, BookTransformer)
+
+    assert.deepEqual(transformed, {
+      id: 1,
+      title: 'A Game of Thrones',
+      year: 1996,
+      author: {
+        name: 'George R. R. Martin'
+      }
+    })
+  })
+})