Merge pull request #29 from RomainForks/feature/improvements

Feature/improvements

README.md

@@ -114,12 +114,12 @@ You can let bumblebee generate the transformer for you by running:
 adonis make:transformer User
 ```
 
-The class must extend `Adonis/Addons/Bumblebee/TransformerAbstract` and implement at least a `transform` method.
+The class must extend `BaseTransformer` and implement at least a `transform` method.
 
 ```js
-const TransformerAbstract = use('Adonis/Addons/Bumblebee/TransformerAbstract')
+const BaseTransformer = use('BaseTransformer')
 
-class UserTransformer extends TransformerAbstract {
+class UserTransformer extends BaseTransformer {
   transform (model) {
     return {
       id: model.id,
@@ -146,6 +146,8 @@ const users = await User.all()
 return transform.collection(users, UserTransformer)
 ```
 
+*Note:* You can also directly use the namespace of the transformer. `transform.collection(users, 'App/Transformers/UserTransformer')`
+
 *Note:* Passing the Transformer as the second argument will terminate the fluent interface. If you want to chain more methods after the call to `collection` or `item` you should only pass the first argument and then use the `transformWith` method to define the transformer. See [Fluent Interface](#fluent-interface)
 
 
@@ -158,7 +160,7 @@ Most of the time our data does not only consist of simple properties on the mode
 
 ```js
 class BookTransformer extends TransformerAbstract {
-  defaultInclude () {
+  static get defaultInclude () {
     return [
       'author'
     ]
@@ -180,9 +182,9 @@ class BookTransformer extends TransformerAbstract {
 module.exports = BookTransformer
 ```
 
-Includes defined in the `defaultInclude` method will always be included in the returned data.
+Includes defined in the `defaultInclude` getter will always be included in the returned data.
 
-You have to specify the name of the include by returning an array of all includes from the  `defaultInclude` method.
+You have to specify the name of the include by returning an array of all includes from the  `defaultInclude` getter.
 Then you create an additional Method for each include named like in the example: `include{Name}`
 
 The include method returns a new resource, that can either be an `item` or a `collection`.  See [Resources](#resources)
@@ -196,7 +198,7 @@ The include method returns a new resource, that can either be an `item` or a `co
 
 ```js
 class BookTransformer extends TransformerAbstract {
-  availableInclude () {
+  static get availableInclude () {
     return [
       'author'
     ]

providers/BumblebeeProvider.js

@@ -29,6 +29,8 @@ class BumblebeeProvider extends ServiceProvider {
     this.app.bind('Adonis/Addons/Bumblebee', app => {
       return Bumblebee
     })
+
+    this.app.alias('Adonis/Addons/Bumblebee/TransformerAbstract', 'BaseTransformer')
   }
 
   /**

src/Bumblebee/Scope.js

@@ -1,5 +1,7 @@
 'use strict'
 
+const { ioc } = require('@adonisjs/fold')
+
 const TransformerAbstract = require('./TransformerAbstract')
 const Resources = require('./Resources')
 
@@ -29,7 +31,7 @@ class Scope {
   /**
    * Passes the data through the transformers and serializers and returns the transformed data
    */
-  async toArray () {
+  async toJSON () {
     // run the transformation on the data
     let [rawData] = await this._executeResourceTransformers()
 
@@ -174,6 +176,11 @@ class Scope {
    * @param {*} Transformer
    */
   _getTransformerInstance (Transformer) {
+    // if the transformer is a string, use the IoC to fetch the instance.
+    if (typeof Transformer === 'string') {
+      return ioc.use(Transformer)
+    }
+
     // if the transformer is a class, create a new instance
     if (Transformer && Transformer.prototype instanceof TransformerAbstract) {
       return new Transformer()
@@ -199,8 +206,8 @@ class Scope {
    * @param {*} Transformer
    */
   _transformerHasIncludes (Transformer) {
-    let defaultInclude = Transformer.defaultInclude()
-    let availableInclude = Transformer.availableInclude()
+    let defaultInclude = Transformer.constructor.defaultInclude
+    let availableInclude = Transformer.constructor.availableInclude
 
     return defaultInclude.length > 0 || availableInclude.length > 0
   }

src/Bumblebee/TransformerAbstract.js

@@ -12,14 +12,14 @@ class TransformerAbstract {
   /*
    * Resources that can be included if requested
   */
-  availableInclude () {
+  static get availableInclude () {
     return []
   }
 
   /*
    * List of resources to automatically include
   */
-  defaultInclude () {
+  static get defaultInclude () {
     return []
   }
 
@@ -82,7 +82,7 @@ class TransformerAbstract {
 
       // if the include uses a resource, run the data through the transformer chain
       if (resource instanceof Resources.ResourceAbstract) {
-        includeData[include] = await this._createChildScopeFor(parentScope, resource, include).toArray()
+        includeData[include] = await this._createChildScopeFor(parentScope, resource, include).toJSON()
       } else {
         // otherwise, return the data as is
         includeData[include] = resource
@@ -115,9 +115,9 @@ class TransformerAbstract {
    * @param {*} parentScope
    */
   _figureOutWhichIncludes (parentScope) {
-    let includes = this.defaultInclude()
+    let includes = this.constructor.defaultInclude
 
-    let requestedAvailableIncludes = this.availableInclude().filter(i => parentScope._isRequested(i))
+    let requestedAvailableIncludes = this.constructor.availableInclude.filter(i => parentScope._isRequested(i))
 
     return includes.concat(requestedAvailableIncludes)
   }

src/Bumblebee/index.js

@@ -58,7 +58,7 @@ class Bumblebee {
 
     if (transformer) {
       this.transformWith(transformer)
-      return this.toArray()
+      return this.toJSON()
     }
 
     return this
@@ -76,7 +76,7 @@ class Bumblebee {
 
     if (transformer) {
       this.transformWith(transformer)
-      return this.toArray()
+      return this.toJSON()
     }
 
     return this
@@ -115,7 +115,7 @@ class Bumblebee {
 
     if (transformer) {
       this.transformWith(transformer)
-      return this.toArray()
+      return this.toJSON()
     }
 
     return this
@@ -191,7 +191,14 @@ class Bumblebee {
    * Terminates the fluid interface and returns the transformed data.
    */
   toArray () {
-    return this._createData().toArray()
+    return this.toJSON()
+  }
+
+  /**
+   * Terminates the fluid interface and returns the transformed data.
+   */
+  toJSON () {
+    return this._createData().toJSON()
   }
 
   /**

test/available-includes.spec.js

@@ -16,7 +16,7 @@ const Bumblebee = require('../src/Bumblebee')
 const TransformerAbstract = require('../src/Bumblebee/TransformerAbstract')
 
 class Book1Transformer extends TransformerAbstract {
-  availableInclude () {
+  static get availableInclude () {
     return [
       'author',
       'characters'
@@ -40,7 +40,7 @@ class Book1Transformer extends TransformerAbstract {
 }
 
 class Book2Transformer extends TransformerAbstract {
-  availableInclude () {
+  static get availableInclude () {
     return [
       'author',
       'characters'
@@ -62,7 +62,7 @@ class Book2Transformer extends TransformerAbstract {
 }
 
 class Book2CharacterTransformer extends TransformerAbstract {
-  availableInclude () {
+  static get availableInclude () {
     return [
       'actor'
     ]

test/context.spec.js

@@ -17,7 +17,7 @@ const Bumblebee = require('../src/Bumblebee')
 const TransformerAbstract = require('../src/Bumblebee/TransformerAbstract')
 
 class IDTransformer extends TransformerAbstract {
-  availableInclude () {
+  static get availableInclude () {
     return [
       'ienv'
     ]
@@ -50,7 +50,7 @@ test.group('Context', (group) => {
       .item(data)
       .transformWith(IDTransformer)
       .withContext(ctx)
-      .toArray()
+      .toJSON()
 
     assert.equal(transformed.id, 3)
     assert.equal(transformed.env, 'testing')
@@ -67,7 +67,7 @@ test.group('Context', (group) => {
       .include('ienv')
       .transformWith(IDTransformer)
       .withContext(ctx)
-      .toArray()
+      .toJSON()
 
     assert.equal(transformed.id, 3)
     assert.equal(transformed.env, 'testing')
@@ -83,7 +83,7 @@ test.group('Context', (group) => {
     let transformed = await transform
       .item(data)
       .transformWith(model => ({ id: model.item_id }))
-      .toArray()
+      .toJSON()
 
     assert.equal(transformed.id, 3)
   })
@@ -97,7 +97,7 @@ test.group('Context', (group) => {
     let transformed = await transform
       .item(data)
       .transformWith(IDTransformer)
-      .toArray()
+      .toJSON()
 
     assert.equal(transformed.id, 3)
     assert.equal(transformed.env, 'testing')
@@ -119,7 +119,7 @@ test.group('Context', (group) => {
     let transformed = await Bumblebee.create()
       .item(data)
       .transformWith(UserTransformer)
-      .toArray()
+      .toJSON()
 
     assert.equal(transformed.id, 42)
   })

test/detault-includes.spec.js

@@ -15,7 +15,7 @@ const Bumblebee = require('../src/Bumblebee')
 const TransformerAbstract = require('../src/Bumblebee/TransformerAbstract')
 
 class Book1Transformer extends TransformerAbstract {
-  defaultInclude () {
+  static get defaultInclude () {
     return [
       'author'
     ]
@@ -35,7 +35,7 @@ class Book1Transformer extends TransformerAbstract {
 }
 
 class Book2Transformer extends TransformerAbstract {
-  defaultInclude () {
+  static get defaultInclude () {
     return [
       'author',
       'characters',
@@ -82,7 +82,7 @@ test.group('Default Includes', () => {
     let transformed = await Bumblebee.create()
       .item(data)
       .transformWith(Book1Transformer)
-      .toArray()
+      .toJSON()
 
     assert.deepEqual(transformed, {
       id: 1,
@@ -110,7 +110,7 @@ test.group('Default Includes', () => {
     let transformed = await Bumblebee.create()
       .item(data)
       .transformWith(Book2Transformer)
-      .toArray()
+      .toJSON()
 
     assert.deepEqual(transformed, {
       title: 'Harry Potter and the Chamber of Secrets',

test/eagerload.spec.js

@@ -15,7 +15,7 @@ const Bumblebee = require('../src/Bumblebee')
 const TransformerAbstract = require('../src/Bumblebee/TransformerAbstract')
 
 class Book1Transformer extends TransformerAbstract {
-  availableInclude () {
+  static get availableInclude () {
     return [
       'author',
       'dragon',
@@ -83,7 +83,7 @@ test.group('EagerLoading', (group) => {
       .item(data)
       .transformWith(Book1Transformer)
       .include(['author'])
-      .toArray()
+      .toJSON()
 
     assert.equal(data.$loadCalled, 1)
     assert.deepEqual(transformed, {
@@ -101,7 +101,7 @@ test.group('EagerLoading', (group) => {
       .item(data)
       .transformWith(Book1Transformer)
       .include(['author', 'characters'])
-      .toArray()
+      .toJSON()
 
     assert.equal(data.$loadCalled, 1)
     assert.deepEqual(transformed, {
@@ -135,7 +135,7 @@ test.group('EagerLoading', (group) => {
       .item(data)
       .transformWith(Book1Transformer)
       .include(['author'])
-      .toArray()
+      .toJSON()
 
     assert.equal(data.$loadCalled, 1)
     assert.deepEqual(transformed, {
@@ -160,7 +160,7 @@ test.group('EagerLoading', (group) => {
       .item(data)
       .transformWith(Book1Transformer)
       .include(['dragon'])
-      .toArray()
+      .toJSON()
 
     assert.equal(data.$loadCalled, 1)
     assert.deepEqual(transformed, {

test/exception.spec.js

@@ -16,7 +16,7 @@ const Bumblebee = require('../src/Bumblebee')
 const TransformerAbstract = require('../src/Bumblebee/TransformerAbstract')
 
 class IDTransformer extends TransformerAbstract {
-  availableInclude () {
+  static get availableInclude () {
     return [
       'notexisting'
     ]
@@ -40,7 +40,7 @@ test.group('Exception', (group) => {
         .item(data)
         .include(['notexisting'])
         .transformWith(IDTransformer)
-        .toArray()
+        .toJSON()
     } catch ({ message }) {
       assert.equal(message, 'A method called \'includeNotexisting\' could not be found in \'IDTransformer\'')
     }
@@ -70,7 +70,7 @@ test.group('Exception', (group) => {
     try {
       await Bumblebee.create()
         ._setData('ResourceAbstract', [{ item_id: 3 }])
-        .toArray()
+        .toJSON()
     } catch ({ message }) {
       assert.equal(message, 'This resourcetype is not supported. Use Item or Collection')
     }