adding documentation

README.md

@@ -7,8 +7,6 @@ A composition library built by extending [express](http://expressjs.com/)
 [![Dependency Status](https://david-dm.org/jhorlin/express-composer.svg)](https://david-dm.org/jhorlin/express-composer)
 [![devDependency Status](https://david-dm.org/jhorlin/express-composer/dev-status.svg)](https://david-dm.org/jhorlin/express-composer#info=devDependencies)
 
-###[Coverage Report](http://htmlpreview.github.io/?https://github.com/Jhorlin/express-composer/blob/master/reports/coverage.html)
-
 ## Modules
 <table>
   <thead>

docjs2md/README.hbs

@@ -15,5 +15,9 @@ A composition library built by extending [express](http://expressjs.com/)
     {{>docs}}
 {{/module~}}
 
+{{#module name="scopeProvider" ~}}
+    {{>docs}}
+{{/module~}}
+
 
 

gulpfile.js

@@ -124,6 +124,7 @@
     });
 
     gulp.task('docjs2md', function () {
+        streamProcessors = [];
         streamProcessors.push(concat("README.md"));
         streamProcessors.push(docjs2md({template: fs.readFileSync("docjs2md/README.hbs", "utf8")}));
         streamProcessors.push(gulp.dest("."));

lib/schema.js

@@ -33,7 +33,7 @@
         /**
          * Express application options passed into [express](http://expressjs.com/api.html)
          * @typedef {Object} appOptions
-         * @property {String} [dotFiles] - Option for serving dotfiles. Possible values are �allow�, �deny�, and �ignore�
+         * @property {String} [dotFiles] - Option for serving dotfiles. Possible values are 'allow', 'deny', and 'ignore'
          * @property {Boolean} [etag] - Enable or disable etag generation
          * @property {Boolean} [extentions] - Sets file extension fallbacks.
          * @property {Object | String} [index] - Sends directory index file. Set false to disable directory indexing.
@@ -65,7 +65,7 @@
             strict: joi.boolean().optional()
         }),
         /**
-         * @typedef {object} requestMethod
+         * @typedef {Object} requestMethod
          * @property {function} validator - function used to validate the request
          * @property {requestHandlers} preHandlers - handlers that will be called during execution of the route
          * @property {scopeArg} scope - scope values to inject into the context of the handlers
@@ -90,7 +90,7 @@
             description: joi.string().optional()
         }),
         /**
-         * @typedef {object} requestMethods
+         * @typedef {Object} requestMethods
          * @property {requestMethod | requestHandlers} checkout - handles checkout requests
          * @property {requestMethod | requestHandlers} connect - handles connect requests
          * @property {requestMethod | requestHandlers} copy - handles copy requests
@@ -128,7 +128,7 @@
         methodsJsonSchema = joi.object(methodsJsonSchemaObject);
 
     /**
-     * @typedef {(Object)} routeScore
+     * @typedef {Object} routeScore
      * @property {requestMethods} methods - methods for this route
      * @property {requestHandlers} preHandlers - handlers that are executed before a route method
      * @property {requestHandlers} errorHandlers - handlers for errors within this route

lib/scopeProvider.js

@@ -7,7 +7,7 @@
  * ```javascript
  * scopeProvider = require('express-Composer).Scope
  * ```
- * @module Scope
+ * @module scopeProvider
  */
 (function (module, require) {
     "use strict";
@@ -18,10 +18,10 @@
     module.exports = ScopeProvider;
 
     /**
-     *
+     * Factory class that generates a new scope per request
      * @param {Object} scopeProperties - the properties used when creating a scope
-     * @param {Scope} parentScopeProvider - a parent scope to extend from
-     * @returns {Scope}
+     * @param {Scope} [parentScopeProvider] - an optional parent scope to extend from
+     * @alis module:scopeProvider
      * @constructor
      */
     function ScopeProvider (scopeProperties, parentScopeProvider) {
@@ -35,6 +35,13 @@
 
         this.key = uuid.v4();
 
+        /**
+         * middleware used to initialize the provider
+         * @method init
+         * @param req
+         * @param res
+         * @param next
+         */
         this.init = function (req, res, next) {
             var cacheStore = getCacheStore(req),
                 parentScope;
@@ -53,7 +60,7 @@
     };
 
     /**
-     * Creates an instance of scope
+     * Scope object used during handler execution
      * @param {Object} arg
      * @constructor
      */
@@ -137,7 +144,7 @@
 
     /**
      *
-     * @param {object} arg - extend argument properties onto the new course
+     * @param {Object} arg - extend argument properties onto the scope
      * @returns {Scope}
      */
     Scope.prototype.new = function (arg) {

package.json

@@ -22,8 +22,8 @@
   },
   "homepage": "https://github.com/Jhorlin/express-composer",
   "devDependencies": {
-    "body-parser": "^1.13.3",
-    "chai": "^3.2.0",
+    "body-parser": "^1.14.1",
+    "chai": "^3.3.0",
     "express": "^4.13.3",
     "gulp": "^3.9.0",
     "gulp-buddy.js": "^1.0.0",
@@ -32,32 +32,32 @@
     "gulp-coveralls": "^0.1.4",
     "gulp-exit": "0.0.2",
     "gulp-expect-file": "0.0.7",
-    "gulp-jscs": "^2.0.0",
+    "gulp-jscs": "^3.0.1",
     "gulp-jsdoc-to-markdown": "^1.1.1",
     "gulp-jshint": "^1.11.2",
-    "gulp-jsinspect": "^1.0.1",
+    "gulp-jsinspect": "^2.0.0",
     "gulp-mocha": "^2.1.3",
     "gulp-nsp": "^0.4.5",
     "gulp-util": "^3.0.6",
-    "gulp-watch": "^4.3.4",
-    "istanbul": "^0.3.17",
+    "gulp-watch": "^4.3.5",
+    "istanbul": "^0.3.22",
     "jshint-stylish": "^2.0.1",
-    "mocha": "^2.2.5",
-    "run-sequence": "^1.1.2",
+    "mocha": "^2.3.3",
+    "run-sequence": "^1.1.4",
     "supertest-as-promised": "^2.0.2"
   },
   "peerDependencies": {
     "express": ">4.0.0"
   },
   "dependencies": {
     "async-require": "^1.2.1",
-    "bluebird": "^2.9.34",
+    "bluebird": "^2.10.2",
     "extend": "^3.0.0",
     "inherit-multiple": "^1.0.1",
-    "joi": "^6.6.1",
+    "joi": "^6.9.0",
     "methods": "^1.1.1",
     "node-uuid": "^1.4.3",
-    "supertest": "^1.0.1",
+    "supertest": "^1.1.0",
     "utils-merge": "^1.0.0",
     "vhost": "^3.0.1"
   }