feat(lucid): add afterPaginate hook

Closes #236

src/Lucid/Hooks/index.js

@@ -24,7 +24,7 @@ const { resolver } = require('../../../lib/iocResolver')
  */
 class Hooks {
   constructor () {
-    this._events = ['create', 'update', 'delete', 'restore', 'find', 'fetch']
+    this._events = ['create', 'update', 'delete', 'restore', 'find', 'fetch', 'paginate']
 
     /**
      * The event aliases. Whenever a handler is saved for a alias,
@@ -141,11 +141,11 @@ class Hooks {
    * @async
    *
    * @param  {String} event
-   * @param  {Object} ctx
+   * @param  {Spread} ...args
    *
    * @return {void}
    */
-  async exec (event, ctx) {
+  async exec (event, ...args) {
     const handlers = this._handlers[event] || []
     const aliasesHandlers = this._aliases[event] ? this._handlers[this._aliases[event]] || [] : []
     const allHandlers = handlers.concat(aliasesHandlers)
@@ -163,7 +163,7 @@ class Hooks {
      */
     for (let handler of allHandlers) {
       const { method } = resolver.forDir('modelHooks').resolveFunc(handler.handler)
-      await method(ctx)
+      await method(...args)
     }
   }
 }

src/Lucid/QueryBuilder/index.js

@@ -388,10 +388,22 @@ class QueryBuilder {
     const modelInstances = this._mapRowsToInstances(result.data)
     await this._eagerLoad(modelInstances)
 
+    /**
+     * Pagination meta data
+     */
+    const pages = _.omit(result, ['data'])
+
+    /**
+     * Fire afterPaginate event
+     */
+    if (this.Model.$hooks) {
+      await this.Model.$hooks.after.exec('paginate', modelInstances, pages)
+    }
+
     /**
      * Return an instance of active model serializer
      */
-    return new this.Model.Serializer(modelInstances, _.omit(result, ['data']))
+    return new this.Model.Serializer(modelInstances, pages)
   }
 
   /**

test/unit/lucid.spec.js

@@ -1565,7 +1565,7 @@ test.group('Model', (group) => {
 
     User.addHook('afterFetch', fn)
     await ioc.use('Database').table('users').insert([{ username: 'virk' }, { username: 'nikk' }])
-    await User.all('username', 'virk')
+    await User.all()
   })
 
   test('create a new row when unable to find one', async (assert) => {
@@ -1660,4 +1660,24 @@ test.group('Model', (group) => {
     assert.equal(user.created_at, user.toJSON().created_at)
     assert.equal(user.updated_at, user.toJSON().updated_at)
   })
+
+  test('call after paginate hook when calling paginate method', async (assert) => {
+    assert.plan(3)
+    class User extends Model {
+    }
+
+    User._bootIfNotBooted()
+
+    const fn = async function (instances, pages) {
+      assert.deepEqual(pages, { perPage: 20, total: helpers.formatNumber(2), page: 1, lastPage: 1 })
+
+      instances.forEach((instance) => {
+        assert.instanceOf(instance, User)
+      })
+    }
+
+    User.addHook('afterPaginate', fn)
+    await ioc.use('Database').table('users').insert([{ username: 'virk' }, { username: 'nikk' }])
+    await User.query().paginate()
+  })
 })