IoC Support.

docs/Middleware.md

@@ -233,6 +233,9 @@ object keys are the handler name _({ControllerName}_{HandlerFunctionName}) and t
 found.  When `true`, we will ignore the missing handler and send the request downstream.
 * **options.useStubs:** `[boolean]` Whether or not stub handlers should be used for routes with no defined controller
 or the controller could not be found.
+* **options.injected:** `[object]` If the require() result of loading a module is a function itself, it is assumed
+this function is a generator/construction helper and the options.injected property will be passed. This allows for
+application level IoC to facilitate unit testing.
 
 **Returns**
 

docs/QuickStart.md

@@ -386,7 +386,11 @@ var serverPort = 3000;
 // swaggerRouter configuration
 var options = {
   controllers: './controllers',
-  useStubs: process.env.NODE_ENV === 'development' ? true : false // Conditionally turn on stubs (mock mode)
+  useStubs: process.env.NODE_ENV === 'development' ? true : false, // Conditionally turn on stubs (mock mode)
+  injected: {
+      // Optional - Set any values here that get passed 
+      // to controllers that return a function from require().
+  }
 };
 
 // The Swagger document (require it, build it programmatically, fetch it from a URL, ...)

examples/2.0/index.js

@@ -9,7 +9,11 @@ var serverPort = 3000;
 // swaggerRouter configuration
 var options = {
   controllers: './controllers',
-  useStubs: process.env.NODE_ENV === 'development' ? true : false // Conditionally turn on stubs (mock mode)
+  useStubs: process.env.NODE_ENV === 'development' ? true : false, // Conditionally turn on stubs (mock mode)
+  injected: {
+      // Optional - Set any values here that get passed 
+      // to controllers that return a function from require().
+  }
 };
 
 // The Swagger document (require it, build it programmatically, fetch it from a URL, ...)

middleware/swagger-router.js

@@ -58,7 +58,7 @@ var getHandlerName = function (req) {
 
   return handlerName;
 };
-var handlerCacheFromDir = function (dirOrDirs) {
+var handlerCacheFromDir = function (dirOrDirs, injected) {
   var handlerCache = {};
   var jsFileRegex = /\.(coffee|js)$/;
   var dirs = [];
@@ -79,6 +79,14 @@ var handlerCacheFromDir = function (dirOrDirs) {
       if (file.match(jsFileRegex)) {
         controller = require(path.resolve(path.join(dir, controllerName)));
 
+        // If controller require()'s as a function, then execute it.
+        // and pass in our options.dependencies
+        if (_.isFunction(controller)) {
+            debug('    %s - resolved as function, executing to obtain instance.:',
+                path.resolve(path.join(dir, file)));
+            controller = controller(injected);
+        }
+
         debug('    %s%s:',
               path.resolve(path.join(dir, file)),
               (_.isPlainObject(controller) ? '' : ' (not an object, skipped)'));
@@ -374,7 +382,7 @@ exports = module.exports = function (options) {
     handlerCache = options.controllers;
   } else {
     // Create the handler cache from the modules in the controllers directory
-    handlerCache = handlerCacheFromDir(options.controllers);
+    handlerCache = handlerCacheFromDir(options.controllers, options.injected);
   }
 
   return function swaggerRouter (req, res, next) {

test/1.2/test-middleware-swagger-router.js

@@ -42,7 +42,8 @@ var petJson = _.cloneDeep(require('../../samples/1.2/pet.json'));
 var storeJson = _.cloneDeep(require('../../samples/1.2/store.json'));
 var userJson = _.cloneDeep(require('../../samples/1.2/user.json'));
 var optionsWithControllersDir = {
-  controllers: path.join(__dirname, '..', 'controllers')
+  controllers: path.join(__dirname, '..', 'controllers'),
+  injected: { value: true }
 };
 var samplePet = {
   category: {
@@ -109,7 +110,8 @@ describe('Swagger Router Middleware v1.2', function () {
         controllers: [
           path.join(__dirname, '..', 'controllers'),
           path.join(__dirname, '..', 'controllers2')
-        ]
+        ],
+        injected: { value: true }
       }
     }, function (app) {
       request(app)
@@ -120,7 +122,7 @@ describe('Swagger Router Middleware v1.2', function () {
   });
 
   it('should do routing when options.controllers is a valid controller map', function (done) {
-    var controller = require('../controllers/Users');
+    var controller = require('../controllers/Users')({ value: true });
 
     helpers.createServer([rlJson, [petJson, storeJson, userJson]], {
       swaggerRouterOptions: {

test/1.2/test-middleware-swagger-ui.js

@@ -53,7 +53,7 @@ describe('Swagger UI Middleware v1.2', function () {
     }, {});
 
     async.map(Object.keys(pathMap), function (path, callback) {
-      helpers.createServer([rlJson, [petJson, storeJson, userJson]], {}, function (app) {
+      helpers.createServer([rlJson, [petJson, storeJson, userJson]], { injected: { value: true }}, function (app) {
         request(app)
           .get(path)
           .expect(200)
@@ -97,7 +97,7 @@ describe('Swagger UI Middleware v1.2', function () {
   });
 
   it('should serve Swagger UI at /docs by default', function (done) {
-    helpers.createServer([rlJson, [petJson, storeJson, userJson]], {}, function (app) {
+    helpers.createServer([rlJson, [petJson, storeJson, userJson]], { injected: { value: true }}, function (app) {
       request(app)
         .get('/docs/') // Trailing slash to avoid a 303
         .expect(200)

test/2.0/test-middleware-swagger-router.js

@@ -40,7 +40,8 @@ var helpers = require('../helpers');
 
 var petStoreJson = _.cloneDeep(require('../../samples/2.0/petstore.json'));
 var optionsWithControllersDir = {
-  controllers: path.join(__dirname, '..', 'controllers')
+  controllers: path.join(__dirname, '..', 'controllers'),
+  injected: { value: true }
 };
 var samplePet = {
   category: {
@@ -108,7 +109,8 @@ describe('Swagger Router Middleware v2.0', function () {
         controllers: [
           path.join(__dirname, '..', 'controllers'),
           path.join(__dirname, '..', 'controllers2')
-        ]
+        ],
+        injected: { value: true }
       }
     }, function (app) {
       request(app)
@@ -120,7 +122,7 @@ describe('Swagger Router Middleware v2.0', function () {
 
   it('should do routing when options.controllers is a valid controller map', function (done) {
     var cPetStoreJson = _.cloneDeep(petStoreJson);
-    var controller = require('../controllers/Users');
+    var controller = require('../controllers/Users')({ value: true });
 
     // Use Users controller
     cPetStoreJson.paths['/pets/{id}'].get['x-swagger-router-controller'] = 'Users';
@@ -142,7 +144,7 @@ describe('Swagger Router Middleware v2.0', function () {
 
   it('should do routing when only operationId is given', function (done) {
     var cPetStoreJson = _.cloneDeep(petStoreJson);
-    var controller = require('../controllers/Users');
+    var controller = require('../controllers/Users')({ value: true });
 
     // Use Users controller
     delete cPetStoreJson.paths['/pets/{id}'].get['x-swagger-router-controller'];

test/controllers/Users.js

@@ -24,8 +24,27 @@
 
 'use strict';
 
-var response = module.exports.response = 'controllers/Users swagger-router OK';
+var response = 'controllers/Users swagger-router OK';
 
-module.exports.getById = module.exports._getById = function getById (req, res) {
+var getById = function getById (req, res) {
   res.end(response);
 };
+
+module.exports = function generator(injected) {
+    if (!injected) {
+        throw new Error('injected should be set.');
+    } else if (!injected.value) {
+        throw new Error('injected should have a sub-value set');
+    }
+
+    return {
+        getById,
+        _getById: getById,
+        getInjected(req, res) {
+            res.end(injected.value);
+        },
+        response
+    };
+};
+
+module.exports.response = response;