monastery 1.28.0 → 1.28.4

package/docs/Gemfile

@@ -1,20 +1,10 @@
-# Gemfile is only used in development
+# Old
+# source 'https://rubygems.org'
+# gem 'github-pages', group: :jekyll_plugins
 
-# Old, doesn't pull the latest version
+# Below pulls the latest remote_theme in development
 source 'https://rubygems.org'
-gem 'github-pages', group: :jekyll_plugins
-
-# # Below pulls the latest remote_theme in development
-# source "https://rubygems.org"
-
-# # Same as github-docs
-# gem "bundler"
-# gem "jekyll", "~> 3.9.0"
-# gem "jekyll-github-metadata", "~> 2.13.0"
-# gem "jekyll-seo-tag", "~> 2.7.1"
-# gem "kramdown-parser-gfm", "~> 1.1.0"
-# gem "github-docs", git: "https://github.com/boycce/github-docs"
-
-# group :jekyll_plugins do
-#   gem "jekyll-remote-theme", "~> 0.4.2"
-# end
+gem "github-docs", git: "https://github.com/boycce/github-docs"
+group :jekyll_plugins do
+  gem "jekyll-remote-theme", "~> 0.4.2"
+end

package/docs/_config.yml

@@ -2,16 +2,13 @@ remote_theme: boycce/github-docs
 title: Monastery
 description: A straight forward MongoDB ODM built upon MonkJS
 github_url: "https://github.com/boycce/monastery"
-basedir: ""
+basedir: "docs"
 
 # Aux links for the naviation.
 aux_links:
   "Monastery on GitHub":
     - "//github.com/boycce/monastery"
 
-plugins:
-  - jekyll-remote-theme
-
 defaults:
   -
     scope:

package/docs/readme.md

@@ -71,6 +71,12 @@ $ DEBUG=monastery:info
 $ DEBUG=monastery:*
 ```
 
+To run isolated tests with Jest:
+
+```bash
+npm run dev -- -t 'Model indexes'
+```
+
 ## Contributing
 
 Coming soon...

package/docs/schema.md

@@ -173,13 +173,13 @@ You are able to define custom validation rules to use. (`this` will refer to the
 ```js
 schema.rules = {
   // Basic definition
-  isGrandMaster: function(value, ruleArgument, fieldName, model) {
+  isGrandMaster: function(value, ruleArgument, path, model) {
     return (value == 'Martin Luther')? true : false
   },
   // Full definition
   isGrandMaster: {
-    message: (value, ruleArgument, fieldName, model) => 'Only grand masters are permitted'
-    fn: function(value, ruleArgument, fieldName, model) {
+    message: (value, ruleArgument, path, model) => 'Only grand masters are permitted'
+    fn: function(value, ruleArgument, path, model) {
       return (value == 'Martin Luther' || this.age > 100)? true : false
     }
   }
@@ -214,7 +214,7 @@ schema.messages = {
     type: 'Sorry, your name needs to be a string'
   },
   'address.city': {
-    minLength: (value, ruleArgument, fieldName, model) => {
+    minLength: (value, ruleArgument, path, model) => {
       return `Is your city of residence really only ${ruleArgument} characters long?`
     }
   },

package/lib/model.js

@@ -6,10 +6,11 @@ let validate = require('./model-validate')
 let Model = module.exports = function(name, opts, manager) {
   /**
    * Setup a model (aka monk collection)
-   * Todo: convert into a promise
    * @param {string} name
    * @param {object} opts - see mongodb colleciton documentation
-   * @this Model
+   * @param {boolean} opts.waitForIndexes
+   * @this model
+   * @return Promise(model) | this
    */
   if (!(this instanceof Model)) {
     return new Model(name, opts, this)
@@ -25,10 +26,6 @@ let Model = module.exports = function(name, opts, manager) {
   opts = opts || {}
   Object.assign(this, {
     ...(opts.methods || {}),
-    name: name,
-    manager: manager,
-    error: manager.error,
-    info: manager.info,
     afterFind: opts.afterFind || [],
     afterInsert: (opts.afterInsert || []).concat(opts.afterInsertUpdate || []),
     afterUpdate: (opts.afterUpdate || []).concat(opts.afterInsertUpdate || []),
@@ -37,12 +34,16 @@ let Model = module.exports = function(name, opts, manager) {
     beforeUpdate: (opts.beforeUpdate || []).concat(opts.beforeInsertUpdate || []),
     beforeRemove: opts.beforeRemove || [],
     beforeValidate: opts.beforeValidate || [],
-    findBL: opts.findBL || ['password'],
+    error: manager.error,
+    info: manager.info,
     insertBL: opts.insertBL || [],
-    updateBL: opts.updateBL || [],
-    messages: opts.messages || {},
     fields: { ...(util.deepCopy(opts.fields) || {}) },
-    rules: { ...(opts.rules || {}) }
+    findBL: opts.findBL || ['password'],
+    manager: manager,
+    messages: opts.messages || {},
+    name: name,
+    rules: { ...(opts.rules || {}) },
+    updateBL: opts.updateBL || [],
   })
 
   // Run before model hooks
@@ -94,13 +95,13 @@ let Model = module.exports = function(name, opts, manager) {
   // Add model to manager.model
   this.manager.model[name] = this
 
-  // Ensure field indexes exist in mongodb
+  // Setup/Ensure field indexes exist in MongoDB
   let errHandler = err => {
     if (err.type == 'info') this.info(err.detail)
     else this.error(err)
   }
-  if (opts.promise) return this._setupIndexes().catch(errHandler)
-  else this._setupIndexes().catch(errHandler)
+  if (opts.waitForIndexes) return this._setupIndexes().catch(errHandler).then(() => this)
+  else this._setupIndexes().catch(errHandler) // returns this
 }
 
 Model.prototype._getFieldlist = function(fields, path) {
@@ -243,7 +244,7 @@ Model.prototype._setupIndexes = function(fields) {
    * @link https://docs.mongodb.com/manual/reference/command/createIndexes/
    * @link https://mongodb.github.io/node-mongodb-native/2.1/api/Collection.html#createIndexes
    * @param {object} <fields>
-   * @return Promise( {array} indexes | {string} error )
+   * @return Promise( {array} indexes ensured | {string} error )
    *
    * MongoDB index structures = [
    *   true =     { name: 'name_1', key: { name: 1 } },
@@ -267,6 +268,7 @@ Model.prototype._setupIndexes = function(fields) {
 
   // Find all indexes
   recurseFields(fields || model.fields, '')
+  // console.log(2, indexes, fields)
   if (hasTextIndex) indexes.push(textIndex)
   if (!indexes.length) return Promise.resolve([]) // No indexes defined
 
@@ -313,6 +315,7 @@ Model.prototype._setupIndexes = function(fields) {
     })
     .then(response => {
       model.info('db index(s) created for ' + model.name)
+      return indexes
     })
 
   function recurseFields(fields, parentPath) {

package/package.json

@@ -2,7 +2,7 @@
   "name": "monastery",
   "description": "⛪ A straight forward MongoDB ODM built around Monk",
   "author": "Ricky Boyce",
-  "version": "1.28.0",
+  "version": "1.28.4",
   "license": "MIT",
   "repository": "github:boycce/monastery",
   "homepage": "https://boycce.github.io/monastery/",
@@ -26,7 +26,7 @@
   },
   "dependencies": {
     "aws-sdk": "^2.742.0",
-    "debug": "^4.1.1",
+    "debug": "4.1.1",
     "file-type": "^15.0.0",
     "monk": "^7.3.0",
     "nanoid": "^3.1.12",

package/test/model.js

@@ -116,27 +116,76 @@ module.exports = function(monastery, opendb) {
   })
 
   test('Model indexes', async (done) => {
-    // Setup
     // Need to test different types of indexes
     let db = (await opendb(null)).db
-    let user = db.model('user', {})
-    let user2 = db.model('user2', {})
 
-    // Text index setup
-    let setupIndex1 = await user._setupIndexes({
-      name: { type: 'string', index: 'text' }
+    // Drop previously tested collections
+    if ((await db._db.listCollections().toArray()).find(o => o.name == 'userIndexRaw')) {
+      await db._db.collection('userIndexRaw').drop()
+    }
+    if ((await db._db.listCollections().toArray()).find(o => o.name == 'userIndex')) {
+      await db._db.collection('userIndex').drop()
+    }
+
+    // Unique & text index (after model initialisation, in serial)
+    let userIndexRawModel = db.model('userIndexRaw', {})
+    let setupIndex1 = await userIndexRawModel._setupIndexes({
+      email: { type: 'string', index: 'unique' },
+    })
+    let setupIndex2 = await userIndexRawModel._setupIndexes({
+      name: { type: 'string', index: 'text' },
+    })
+    let indexes = await db._db.collection('userIndexRaw').indexes()
+    expect(indexes[0]).toMatchObject({ v: 2, key: { _id: 1 }, name: '_id_' })
+    expect(indexes[1]).toMatchObject({ v: 2, unique: true, key: { email: 1 }, name: 'email_1' })
+    expect(indexes[2]).toMatchObject({
+      v: 2,
+      key: { _fts: 'text', _ftsx: 1 },
+      name: 'text',
+      weights: { name: 1 },
+      default_language: 'english',
+      language_override: 'language',
+      textIndexVersion: 3
+    })
+
+    // Unique & text index
+    let userIndexModel = await db.model('userIndex', {
+      waitForIndexes: true,
+      fields: {
+        email: { type: 'string', index: 'unique' },
+        name: { type: 'string', index: 'text' },
+      }
+    })
+
+    let indexes2 = await db._db.collection('userIndex').indexes()
+    expect(indexes2[0]).toMatchObject({ v: 2, key: { _id: 1 }, name: '_id_' })
+    expect(indexes2[1]).toMatchObject({ v: 2, unique: true, key: { email: 1 }, name: 'email_1' })
+    expect(indexes2[2]).toMatchObject({
+      v: 2,
+      key: { _fts: 'text', _ftsx: 1 },
+      name: 'text',
+      weights: { name: 1 },
+      default_language: 'english',
+      language_override: 'language',
+      textIndexVersion: 3
     })
 
     // No text index change error, i.e. new Error("Index with name: text already exists with different options")
-    await expect(user._setupIndexes({
+    await expect(userIndexModel._setupIndexes({
       name: { type: 'string', index: 'text' },
       name2: { type: 'string', index: 'text' }
-    })).resolves.toEqual(undefined)
+    })).resolves.toEqual([{
+      "key": { "name": "text", "name2": "text" },
+      "name": "text",
+    }])
 
     // Text index on a different model
-    await expect(user2._setupIndexes({
-      name: { type: 'string', index: 'text' }
-    })).resolves.toEqual(undefined)
+    await expect(userIndexRawModel._setupIndexes({
+      name2: { type: 'string', index: 'text' }
+    })).resolves.toEqual([{
+      "key": {"name2": "text"},
+      "name": "text",
+    }])
 
     db.close()
     done()
@@ -147,7 +196,7 @@ module.exports = function(monastery, opendb) {
     // with text indexes are setup at the same time
     let db = (await opendb(null)).db
     await db.model('user3', {
-      promise: true,
+      waitForIndexes: true,
       fields: {
         location: {
           index: '2dsphere',