add doc for addMiddleware

Author: mathieudutour

LICENCE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Automattic
+Copyright (c) 2012 Guillermo Rauch <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -28,10 +28,10 @@ db.close()
 
 ## Features
 
+- Well-designed signatures
+- Easy connections / configuration
 - Command buffering. You can start querying right away.
 - Promises built-in for all queries. Easy interoperability with modules.
-- Easy connections / configuration
-- Well-designed signatures
 - Improvements to the MongoDB APIs (eg: `findAndModify` supports the
   `update` signature style)
 - Auto-casting of `_id` in queries
@@ -44,25 +44,4 @@ db.close()
 
 ## License
 
-(The MIT License)
-
-Copyright (c) 2012 Guillermo Rauch <[email protected]>
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+MIT

docs/Debugging.md

@@ -1,4 +1,14 @@
-# Query debugging
+# Debugging
+
+To get some information on what monk is doing, use the `monk-middleware-debug`:
+
+```
+npm install --save monk-middleware-debug
+```
+
+```js
+db.addMiddleware(require('monk-middleware-debug))
+```
 
 * If you wish to see what queries `monk` passes to the driver, simply leverage
   [debug](http://github.com/visionmedia/debug):
@@ -12,13 +22,13 @@
   ```bash
   DEBUG="monk:*" npm start
   ```
-  
+
 * You can also see the output from the mongo driver using `debug`:
 
   ```bash
   DEBUG="mongo:*" npm start
   ```
-  
+
   There are several separated features available on this namespace:
 
     * Db: The Db instance log statements
@@ -29,9 +39,9 @@
     * Pool: Connection Pool specific log statements
     * Connection: Singular connection specific log statements
     * Ping: Replicaset ping inquiry log statements
-    
+
   To see the output of only one of those features:
-  
+
   ```bash
   DEBUG="mongo:Cursor" npm start // will only print the Cursor log statements
   ```

docs/manager/addMiddleware.md

@@ -0,0 +1,13 @@
+# `manager.addMiddleware`
+
+Add a middleware to the middlewares chain.
+
+#### Arguments
+
+1. `middleware` *(function)*: the middleware to add the the chain
+
+#### Example
+
+```js
+db.addMiddleware(require('monk-plugin-dereference'))
+```

lib/collection.js

@@ -65,6 +65,17 @@ Collection.prototype.count = function (query, opts, fn) {
   })({options: opts, query: query, callback: fn}, 'count')
 }
 
+Collection.prototype.createIndex = function (fields, opts, fn) {
+  if (typeof opts === 'function') {
+    fn = opts
+    opts = {}
+  }
+
+  return this._dispatch(function createIndex (args) {
+    return args.col.createIndex(args.fields, args.options)
+  })({options: opts, fields: fields, callback: fn}, 'createIndex')
+}
+
 Collection.prototype.distinct = function (field, query, opts, fn) {
   if (typeof opts === 'function') {
     fn = opts
@@ -110,17 +121,6 @@ Collection.prototype.dropIndexes = function (fn) {
   })({callback: fn}, 'dropIndexes')
 }
 
-Collection.prototype.createIndex = function (fields, opts, fn) {
-  if (typeof opts === 'function') {
-    fn = opts
-    opts = {}
-  }
-
-  return this._dispatch(function createIndex (args) {
-    return args.col.createIndex(args.fields, args.options)
-  })({options: opts, fields: fields, callback: fn}, 'createIndex')
-}
-
 Collection.prototype.ensureIndex = function (fields, opts, fn) {
   if (typeof opts === 'function') {
     fn = opts

lib/manager.js

@@ -9,23 +9,9 @@ var monkDebug = Debug('monk:manager')
 var Collection = require('./collection')
 var ObjectId = mongo.ObjectID
 var MongoClient = mongo.MongoClient
-var Logger = mongo.Logger
 var EventEmitter = require('events').EventEmitter
 var inherits = require('util').inherits
 
-/*
- * Logger
- */
-Logger.setCurrentLogger(function (msg, context) {
-  if (context.type === 'error') {
-    return console.error(msg)
-  }
-  var logger = Debug('mongo:' + context.className)
-  logger.log = console.log.bind(console)
-  logger(context.type.toUpperCase() + ': ' + context.message)
-})
-Logger.setLevel('debug') // set the level to `debug` so we have everything going through debug
-
 var STATE = {
   CLOSED: 'closed',
   OPENING: 'opening',

middlewares/castIds/package.json

@@ -1,11 +1,11 @@
 {
-  "name": "monk-plugin-cast-ids",
-  "description": "A monk plugin to parse the ids",
+  "name": "monk-middleware-cast-ids",
+  "description": "A monk middleware to parse the ids",
   "version": "0.2.0",
   "main": "index.js",
   "keywords": [
     "monk",
-    "plugin",
+    "middleware",
     "ids"
   ],
   "repository": {

middlewares/fields/package.json

@@ -1,11 +1,11 @@
 {
-  "name": "monk-plugin-fields",
-  "description": "A monk plugin to parse the fields",
+  "name": "monk-middleware-fields",
+  "description": "A monk middleware to parse the fields",
   "version": "0.2.0",
   "main": "index.js",
   "keywords": [
     "monk",
-    "plugin",
+    "middleware",
     "fields"
   ],
   "repository": {

middlewares/handle-callback/package.json

@@ -1,11 +1,11 @@
 {
-  "name": "monk-plugin-handle-callback",
-  "description": "A monk plugin to handle callback",
+  "name": "monk-middleware-handle-callback",
+  "description": "A monk middleware to handle callback",
   "version": "0.2.0",
   "main": "index.js",
   "keywords": [
     "monk",
-    "plugin",
+    "middleware",
     "callback"
   ],
   "repository": {

middlewares/options/package.json

@@ -1,11 +1,11 @@
 {
-  "name": "monk-plugin-options",
-  "description": "A monk plugin to parse the options",
+  "name": "monk-middleware-options",
+  "description": "A monk middleware to parse the options",
   "version": "0.2.0",
   "main": "index.js",
   "keywords": [
     "monk",
-    "plugin",
+    "middleware",
     "options"
   ],
   "repository": {

middlewares/query/package.json

@@ -1,11 +1,11 @@
 {
-  "name": "monk-plugin-query",
-  "description": "A monk plugin to parse the query",
+  "name": "monk-middleware-query",
+  "description": "A monk middleware to parse the query",
   "version": "0.2.0",
   "main": "index.js",
   "keywords": [
     "monk",
-    "plugin",
+    "middleware",
     "query"
   ],
   "repository": {

middlewares/wait-for-connection/package.json

@@ -1,11 +1,11 @@
 {
-  "name": "monk-plugin-wait-for-connection",
-  "description": "A monk plugin to wait for the connection",
+  "name": "monk-middleware-wait-for-connection",
+  "description": "A monk middleware to wait for the connection",
   "version": "0.2.0",
   "main": "index.js",
   "keywords": [
     "monk",
-    "plugin",
+    "middleware",
     "wait",
     "connection"
   ],

package.json

@@ -18,14 +18,13 @@
   },
   "dependencies": {
     "debug": "*",
-    "gitbook-plugin-github": "2.0.0",
     "mongodb": "^2.1.18",
-    "monk-plugin-cast-ids": "^0.2.0",
-    "monk-plugin-fields": "^0.2.0",
-    "monk-plugin-handle-callback": "^0.2.0",
-    "monk-plugin-options": "^0.2.0",
-    "monk-plugin-query": "^0.2.0",
-    "monk-plugin-wait-for-connection": "^0.2.0",
+    "monk-middleware-cast-ids": "^0.2.0",
+    "monk-middleware-fields": "^0.2.0",
+    "monk-middleware-handle-callback": "^0.2.0",
+    "monk-middleware-options": "^0.2.0",
+    "monk-middleware-query": "^0.2.0",
+    "monk-middleware-wait-for-connection": "^0.2.0",
     "object-assign": "^4.1.1"
   },
   "devDependencies": {