monastery 1.31.6 → 1.31.7

package/changelog.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.31.7](https://github.com/boycce/monastery/compare/1.31.6...1.31.7) (2022-02-28)
+
+
+### Bug Fixes
+
+* refactored crud ops ([e7f3f78](https://github.com/boycce/monastery/commit/e7f3f784e123e4a66586a4d9e733d5cac477b98b))
+
 ### [1.31.6](https://github.com/boycce/monastery/compare/1.31.5...1.31.6) (2022-02-25)
 
 

package/docs/Gemfile

@@ -1,10 +1,4 @@
-# Old
-# source 'https://rubygems.org'
-# gem 'github-pages', group: :jekyll_plugins
-
-# Below pulls the latest remote_theme in development
 source 'https://rubygems.org'
-gem "github-docs", git: "https://github.com/boycce/github-docs"
-group :jekyll_plugins do
-  gem "jekyll-remote-theme", "~> 0.4.2"
-end
+
+# Development (strict gem versions used)
+gem 'github-pages', group: :jekyll_plugins

package/docs/_config.yml

@@ -2,6 +2,7 @@ remote_theme: boycce/github-docs
 title: Monastery
 description: A straight forward MongoDB ODM built upon MonkJS
 github_url: "https://github.com/boycce/monastery"
+port: 4001
 basedir: "docs"
 
 # Aux links for the naviation.

package/docs/{schema.md → schema/index.md}

@@ -1,6 +1,7 @@
 ---
 title: Schema
 nav_order: 4
+has_children: true
 ---
 
 # Schema

package/docs/{rules.md → schema/rules.md}

@@ -1,6 +1,7 @@
 ---
 title: Rules
 nav_order: 5
+parent: Schema
 ---
 
 # Validation Rules

package/lib/model-crud.js

@@ -2,7 +2,7 @@ let util = require('./util')
 
 module.exports = {
 
-  insert: function(opts, cb) {
+  insert: async function(opts, cb) {
     /**
      * Inserts document(s) with monk after validating data & before hooks.
      * @param {object} opts
@@ -18,44 +18,36 @@ module.exports = {
      * @this model
      * @return promise
      */
-    opts = opts || {}
-    opts.insert = true
-    opts.model = this
-    let req = opts.req
-    let data = opts.data = util.isDefined(opts.data)? opts.data : util.isDefined((req||{}).body) ? req.body : {}
-    let options = util.omit(opts, [
-      'data', 'insert', 'model', 'respond', 'validateUndefined', 'skipValidation', 'blacklist'
-    ])
     if (cb && !util.isFunction(cb)) {
       throw new Error(`The callback passed to ${this.name}.insert() is not a function`)
     }
-    return util.parseData(data).then(data => {
-      opts.data = data
-      return this.validate(data, { ...opts })
-
-    }).then(data => {
-      return util.runSeries(this.beforeInsert.map(f => f.bind(opts, data))).then(() => data)
-
-    }).then(data => {
-      return this._insert(data, options)
-
-    }).then(data => {
-      return util.runSeries(this.afterInsert.map(f => f.bind(opts, data))).then(() => data)
-
-    // Success/error
-    }).then(data => {
-      if (cb) cb(null, data)
-      else if (opts.req && opts.respond) opts.req.res.json(data)
-      else return Promise.resolve(data)
-
-    }).catch(err => {
+    try {
+      opts = await this._queryObject(opts, 'insert')
+      let options = util.omit(opts, [
+        'data', 'insert', 'model', 'respond', 'validateUndefined', 'skipValidation', 'blacklist'
+      ])
+
+      // Validate
+      opts.data = await this.validate(opts.data||{}, { ...opts })
+
+      // Insert
+      await util.runSeries(this.beforeInsert.map(f => f.bind(opts, opts.data)))
+      let response = await this._insert(opts.data, options)
+      await util.runSeries(this.afterInsert.map(f => f.bind(opts, response)))
+
+      // Success/error
+      if (cb) cb(null, response)
+      else if (opts.req && opts.respond) opts.req.res.json(response)
+      else return Promise.resolve(response)
+
+    } catch (err) {
       if (cb) cb(err)
       else if (opts && opts.req && opts.respond) opts.req.res.error(err)
       else throw err
-    })
+    }
   },
 
-  find: function(opts, cb, one) {
+  find: async function(opts, cb, one) {
     /**
      * Finds document(s) with monk, also auto populates
      * @param {object} opts
@@ -69,19 +61,15 @@ module.exports = {
      * @this model
      * @return promise
      */
-    let options, lookups = []
     if (cb && !util.isFunction(cb)) {
       throw new Error(`The callback passed to ${this.name}.find() is not a function`)
     }
-    return new Promise((resolve, reject) => {
-      opts = this._queryObject(opts)
-      opts.one = one || opts.one
-      // Operation options
-      options = util.omit(opts, ['blacklist', 'one', 'populate', 'project', 'query', 'respond'])
-      options.sort = options.sort || { 'createdAt': -1 }
-      options.skip = Math.max(0, options.skip || 0)
-      options.limit = opts.one? 1 : parseInt(options.limit || this.manager.limit || 0)
+    try {
+      opts = await this._queryObject(opts, 'find', one)
+      let lookups = []
+      let options = util.omit(opts, ['blacklist', 'one', 'populate', 'project', 'query', 'respond'])
       options.addFields = options.addFields || {}
+
       // Project, or use blacklisting
       if (opts.project) {
         // Can be an inclusion or exclusion projection
@@ -105,14 +93,10 @@ module.exports = {
       //   options.projection.score = { $meta: 'textScore' }
       //   options.sort = { score: { $meta: 'textScore' }}
       // }
-      // Sort string passed
-      if (util.isString(options.sort)) {
-        let name = (options.sort.match(/([a-z0-9-_]+)/) || [])[0]
-        let order = (options.sort.match(/:(-?[0-9])/) || [])[1]
-        options.sort = { [name]: parseInt(order || 1) }
-      }
       // Wanting to populate?
-      if (opts.populate) {
+      if (!opts.populate) {
+        var response = await this[`_find${opts.one? 'One' : ''}`](opts.query, options)
+      } else {
         loop: for (let item of opts.populate) {
           let path = util.isObject(item)? item.as : item
           // Blacklisted?
@@ -148,7 +132,7 @@ module.exports = {
         }
         // console.log(1, options.projection)
         // console.log(2, lookups)
-        let aggreagte = [
+        let aggregate = [
           { $match: opts.query },
           { $sort: options.sort },
           { $skip: options.skip },
@@ -157,41 +141,37 @@ module.exports = {
           ...util.isEmpty(options.addFields)? [] : [{ $addFields: options.addFields }],
           { $project: options.projection }
         ]
-        var operation = this._aggregate.bind(this._collection, aggreagte)
-        this.info('aggregate', JSON.stringify(aggreagte))
-
-      // Normal operation
-      } else {
-        operation = this[opts.one? '_findOne' : '_find'].bind(this._collection, opts.query, options)
+        response = await this._aggregate(aggregate)
+        this.info('aggregate', JSON.stringify(aggregate))
       }
-      operation()
-        .then(data => resolve(data))
-        .catch(err => reject(err))
 
-    }).then(data => {
-      if (opts.one && util.isArray(data)) data = data[0]
+      if (opts.one && util.isArray(response)) response = response[0]
       // (Not using) Project works with lookup.
       // Remove blacklisted properties from joined models, because subpiplines with 'project' are slower
       // if (opts.populate) this._depreciated_removeBlacklisted(data, opts.populate, options.projection)
-      return this._processAfterFind(data, options.projection, opts)
+      response = await this._processAfterFind(response, options.projection, opts)
 
-    }).then(data => {
-      if (cb) cb(null, data)
-      else if (opts.req && opts.respond) opts.req.res.json(data)
-      else return Promise.resolve(data)
+      // Success
+      if (cb) cb(null, response)
+      else if (opts.req && opts.respond) opts.req.res.json(response)
+      else return Promise.resolve(response)
 
-    }).catch(err => {
+    } catch (err) {
       if (cb) cb(err)
       else if (opts && opts.req && opts.respond) opts.req.res.error(err)
       else throw err
-    })
+    }
   },
 
-  findOne: function(opts, cb) {
+  findOne: async function(opts, cb) {
     return this.find(opts, cb, true)
   },
 
-  update: function(opts, cb) {
+  // findOneAndUpdate: function(opts, cb) {
+  //   return this._findOneAndUpdate(opts, cb)
+  // },
+
+  update: async function(opts, cb) {
     /**
      * Updates document(s) with monk after validating data & before hooks.
      * @param {object} opts
@@ -208,78 +188,51 @@ module.exports = {
      * @this model
      * @return promise(data)
      */
-    let data, options, operators
     if (cb && !util.isFunction(cb)) {
       throw new Error(`The callback passed to ${this.name}.update() is not a function`)
     }
-    return new Promise((resolve, reject) => {
-      opts = this._queryObject(opts)
-      opts.update = true
-      opts.model = this
-      let req = opts.req
-      data = opts.data = util.isDefined(opts.data)? opts.data : util.isDefined((req||{}).body) ? req.body : undefined
-      operators = util.pluck(opts, [/^\$/])
-      // Operation options
-      options = util.omit(opts, ['data', 'query', 'respond', 'validateUndefined', 'skipValidation', 'blacklist'])
-      options.sort = options.sort || { 'createdAt': -1 }
-      options.limit = parseInt(options.limit || 0)
-      // Sort string passed
-      if (util.isString(options.sort)) {
-        let name = (options.sort.match(/([a-z0-9-_]+)/) || [])[0]
-        let order = (options.sort.match(/:(-?[0-9])/) || [])[1]
-        options.sort = { [name]: parseInt(order || 1) }
+    try {
+      opts = await this._queryObject(opts, 'update')
+      let response = null
+      let operators = util.pluck(opts, [/^\$/])
+      let options = util.omit(opts, ['data', 'query', 'respond', 'validateUndefined', 'skipValidation', 'blacklist'])
+
+      // Validate
+      if (util.isDefined(opts.data)) opts.data = await this.validate(opts.data, { ...opts })
+      if (!util.isDefined(opts.data) && util.isEmpty(operators)) {
+        throw new Error(`Please pass an update operator to ${this.name}.update(), e.g. data, $unset, etc`)
       }
-      util.parseData(data).then(d => resolve(d))
-
-    }).then(data => {
-      opts.data = data
-      if (util.isDefined(data)) return this.validate(data, { ...opts })
-      else return Promise.resolve(data)
-
-    }).then(data => {
-      if (util.isDefined(data) && (!data || util.isEmpty(data))) {
+      if (util.isDefined(opts.data) && (!opts.data || util.isEmpty(opts.data))) {
         throw new Error(`No valid data passed to ${this.name}.update({ data: .. })`)
       }
-      if (!util.isDefined(data) && util.isEmpty(operators)) {
-        throw new Error(`Please pass an update operator to ${this.name}.update(), e.g. data, $unset, etc`)
-      }
-      return util.runSeries(this.beforeUpdate.map(f => f.bind(opts, data||{}))).then(() => data)
-
-    }).then(data => {
-      if (data && operators['$set']) {
+      // Hook: beforeUpdate
+      await util.runSeries(this.beforeUpdate.map(f => f.bind(opts, opts.data||{})))
+      if (opts.data && operators['$set']) {
         this.warn(`'$set' fields take precedence over the data fields for \`${this.name}.update()\``)
       }
-      if (data || operators['$set']) {
-        operators['$set'] = {
-          ...data,
-          ...(operators['$set'] || {}),
-        }
+      if (opts.data || operators['$set']) {
+        operators['$set'] = { ...opts.data, ...(operators['$set'] || {}) }
       }
-      return this._update(opts.query, operators, options).then(output => {
-        if (!output.n) return null
-        let response = Object.assign(Object.create({ _output: output }), operators['$set']||{})
-        output = data = null // Cleanup (just incase)
-        return response
-      })
+      // Update
+      let update = await this._update(opts.query, operators, options)
+      if (update.n) response = Object.assign(Object.create({ _output: update }), operators['$set']||{})
 
-    }).then(data => {
-      if (!data) return data
-      return util.runSeries(this.afterUpdate.map(f => f.bind(opts, data))).then(() => data)
+      // Hook: afterUpdate
+      if (update.n) await util.runSeries(this.afterUpdate.map(f => f.bind(opts, response)))
 
-    // Success/error
-    }).then(data => {
-      if (cb) cb(null, data)
-      else if (opts.req && opts.respond) opts.req.res.json(data)
-      else return Promise.resolve(data)
+      // Success
+      if (cb) cb(null, response)
+      else if (opts.req && opts.respond) opts.req.res.json(response)
+      else return response
 
-    }).catch(err => {
+    } catch (err) {
       if (cb) cb(err)
       else if (opts && opts.req && opts.respond) opts.req.res.error(err)
       else throw err
-    })
+    }
   },
 
-  remove: function(opts, cb) {
+  remove: async function(opts, cb) {
     /**
      * Remove document(s) with monk after before hooks.
      * @param {object} opts
@@ -290,73 +243,84 @@ module.exports = {
      * @this model
      * @return promise
      */
-    let options
     if (cb && !util.isFunction(cb)) {
       throw new Error(`The callback passed to ${this.name}.remove() is not a function`)
     }
-    return new Promise((resolve, reject) => {
-      opts = this._queryObject(opts)
-      opts.remove = true
-      opts.model = this
+    try {
+      opts = await this._queryObject(opts, 'remove')
+      let options = util.omit(opts, ['query', 'respond'])
       if (util.isEmpty(opts.query)) throw new Error('Please specify opts.query')
-      // Operation options
-      options = util.omit(opts, ['query', 'respond'])
-      options.sort = options.sort || { 'createdAt': -1 }
-      options.limit = parseInt(options.limit || 1)
-      // Sort string passed
-      if (util.isString(options.sort)) {
-        let name = (options.sort.match(/([a-z0-9-_]+)/) || [])[0]
-        let order = (options.sort.match(/:(-?[0-9])/) || [])[1]
-        options.sort = { [name]: parseInt(order || 1) }
-      }
-      util.runSeries(this.beforeRemove.map(f => f.bind(opts)))
-        .then(() => resolve())
-        .catch(e => reject(e))
-
-    }).then(() => {
-      return this._remove(opts.query, options)
 
-    }).then(data => {
-      return util.runSeries(this.afterRemove.map(f => f.bind(opts))).then(() => data)
+      // Remove
+      await util.runSeries(this.beforeRemove.map(f => f.bind(opts)))
+      let response = await this._remove(opts.query, options)
+      await util.runSeries(this.afterRemove.map(f => f.bind(response)))
 
-    // Success/error
-    }).then(data => {
-      if (cb) cb(null, data)
-      else if (opts.req && opts.respond) opts.req.res.json(data)
-      else return Promise.resolve(data)
+      // Success
+      if (cb) cb(null, response)
+      else if (opts.req && opts.respond) opts.req.res.json(response)
+      else return Promise.resolve(response)
 
-    }).catch(err => {
+    } catch (err) {
       if (cb) cb(err)
       else if (opts && opts.req && opts.respond) opts.req.res.error(err)
       else throw err
-    })
+    }
   },
 
-  _queryObject: function(opts) {
+  _queryObject: async function(opts, type, one) {
     /**
-     * Extract the query id from opts, opts.query
-     * @param {MongoId|ID string|Query object} opts
-     * @return opts
+     * Normalise options
+     * @param {MongoId|string|object} opts
+     * @param {string} type - operation type
+     * @param {boolean} one - return one document
+     * @this model
+     * @return {Promise} opts
      *
-     * opts == string|MongodID - treated as an id
+     * opts == string|MongodId - treated as an id
      * opts == undefined|null|false - throw error
      * opts.query == string|MongodID - treated as an id
      * opts.query == undefined|null|false - throw error
      */
-    let isIdType = (o) => util.isId(o) || util.isString(o)
-    if (isIdType(opts)) opts = { query: { _id: opts || '' }}
-    if (isIdType((opts||{}).query)) opts.query = { _id: opts.query || '' }
-    if (!util.isObject(opts) || !util.isObject(opts.query)) {
-      throw new Error('Please pass an object or MongoId to options.query')
-    }
-    // For security, if _id is set and undefined, throw an error
-    if (typeof opts.query._id == 'undefined' && opts.query.hasOwnProperty('_id')) {
-      throw new Error('Please pass an object or MongoId to options.query')
+
+    // Query
+    if (type != 'insert') {
+      let isIdType = (o) => util.isId(o) || util.isString(o)
+      if (isIdType(opts)) {
+        opts = { query: { _id: opts || '' }}
+      }
+      if (isIdType((opts||{}).query)) {
+        opts.query = { _id: opts.query || '' }
+      }
+      if (!util.isObject(opts) || !util.isObject(opts.query)) {
+        throw new Error('Please pass an object or MongoId to options.query')
+      }
+      // For security, if _id is set and undefined, throw an error
+      if (typeof opts.query._id == 'undefined' && opts.query.hasOwnProperty('_id')) {
+        throw new Error('Please pass an object or MongoId to options.query')
+      }
+      if (util.isId(opts.query._id)) opts.query._id = this.manager.id(opts.query._id)
+      if (isIdType(opts.query._id) || one) opts.one = true
+      opts.query = util.removeUndefined(opts.query)
+
+      // Query options
+      opts.limit = opts.one? 1 : parseInt(opts.limit || (type == 'remove' ? 1 : this.manager.limit || 0))
+      opts.skip = Math.max(0, opts.skip || 0)
+      opts.sort = opts.sort || { 'createdAt': -1 }
+      if (util.isString(opts.sort)) {
+        let name = (opts.sort.match(/([a-z0-9-_]+)/) || [])[0]
+        let order = (opts.sort.match(/:(-?[0-9])/) || [])[1]
+        opts.sort = { [name]: parseInt(order || 1) }
+      }
     }
-    // Remove undefined query parameters
-    opts.query = util.removeUndefined(opts.query)
-    if (util.isId(opts.query._id)) opts.query._id = this.manager.id(opts.query._id)
-    if (isIdType(opts.query._id)) opts.one = true
+
+    // Data
+    if (!opts) opts = {}
+    if (!util.isDefined(opts.data) && util.isDefined((opts.req||{}).body)) opts.data = opts.req.body
+    if (util.isDefined(opts.data)) opts.data = await util.parseData(opts.data)
+
+    opts[type] = true
+    opts.model = this
     return opts
   },
 

package/package.json

@@ -2,7 +2,7 @@
   "name": "monastery",
   "description": "⛪ A straight forward MongoDB ODM built around Monk",
   "author": "Ricky Boyce",
-  "version": "1.31.6",
+  "version": "1.31.7",
   "license": "MIT",
   "repository": "github:boycce/monastery",
   "homepage": "https://boycce.github.io/monastery/",