feat: Add support for loading mdiddlewares from npm.

hswolff · hswolff · commit 88df54e08d21 · 2017-03-22T08:35:18.000-04:00
diff --git a/lib/config/index.js b/lib/config/index.js
@@ -1,6 +1,7 @@
 import path from 'path';
 import findUp from 'find-up';
 import _ from 'lodash';
+import resolve from 'resolve';
 import Constants from '../constants';
 import log from '../log';
 import schema from './config-schema';
@@ -118,10 +119,23 @@ export default class Config {
       return defaultObj;
     });
 
+    // For a given value if it is a string resolve it as if it's an NPM module.
+    const resolveMiddlewareModules = (moduleVal) => {
+      if (_.isString(moduleVal)) {
+        const modulePath = resolve.sync(moduleVal, { basedir: this.root });
+        // eslint-disable-next-line global-require, import/no-dynamic-require
+        return require(modulePath);
+      }
+      return moduleVal;
+    };
+
     // Make sure all values are arrays.
-    this._raw.middlewares = _.flatten(Array.of(this._raw.middlewares));
+    const middlewares = _.flatten(Array.of(this._raw.middlewares));
+    this._raw.middlewares = middlewares.map(resolveMiddlewareModules);
+
     _.forEach(this._raw.lifecycle, (val, key) => {
-      this._raw.lifecycle[key] = _.flatten(Array.of(val));
+      const newVal = _.flatten(Array.of(val));
+      this._raw.lifecycle[key] = newVal.map(resolveMiddlewareModules);
     });
   }
 
diff --git a/test/e2e/yarn.spec.js b/test/e2e/yarn.spec.js
@@ -99,7 +99,8 @@ describe('reptar Reptar', function test() {
 
     it('calls every middleware function in the expected order', () => {
       _.reduce(instance._test.middlewares, (prevValue, nextValue) => {
-        assert(nextValue >= prevValue);
+        assert(nextValue > prevValue);
+        return nextValue;
       });
     });
 
@@ -109,15 +110,15 @@ describe('reptar Reptar', function test() {
         didUpdate,
       } = instance._test.lifecycle;
 
-      assert(willUpdate[0] <= didUpdate[0]);
+      assert(willUpdate[0] < didUpdate[0]);
     });
 
     it('didUpdate is called before the first middleware', () => {
       const {
         didUpdate,
       } = instance._test.lifecycle;
 
-      assert(didUpdate[0] <= instance._test.middlewares[0]);
+      assert(didUpdate[0] < instance._test.middlewares[0]);
     });
 
     it('willBuild is not called', () => {
@@ -178,7 +179,7 @@ describe('reptar Reptar', function test() {
           instance._test.middlewares.length - 1
         ];
 
-        assert(lastMiddleware <= willBuild[0]);
+        assert(lastMiddleware < willBuild[0]);
       });
 
       it('willBuild is called before didBuild', () => {
@@ -187,7 +188,7 @@ describe('reptar Reptar', function test() {
           didBuild,
         } = instance._test.lifecycle;
 
-        assert(willBuild[0] <= didBuild[0]);
+        assert(willBuild[0] < didBuild[0]);
       });
     });
   });
diff --git a/test/fixtures/simple-site/expected/reptar.config.js b/test/fixtures/simple-site/expected/reptar.config.js
@@ -1,11 +1,9 @@
-import sinon from 'sinon';
-
-const middleware = (reptar) => {
-  reptar._test.middlewares.push(Date.now());
+const createMiddleware = val => (reptar) => {
+  reptar._test.middlewares.push(val);
 };
 
-const createLifecycleMiddleware = (lifecycleName) => (reptar) => {
-  reptar._test.lifecycle[lifecycleName].push(Date.now());
+const createLifecycleMiddleware = (lifecycleName, val) => (reptar) => {
+  reptar._test.lifecycle[lifecycleName].push(val);
 };
 
 module.exports = {
@@ -60,13 +58,14 @@ module.exports = {
   server: { port: 8080, host: '127.0.0.1', baseurl: '' },
   new_file_permalink: '/_posts/:date|YYYY-:date|MM-:date|D-:title.md',
   middlewares: [
-    middleware,
-    middleware,
+    createMiddleware(3),
+    'my-middleware',
+    createMiddleware(5),
   ],
   lifecycle: {
-    willUpdate: createLifecycleMiddleware('willUpdate'),
-    didUpdate: createLifecycleMiddleware('didUpdate'),
-    willBuild: createLifecycleMiddleware('willBuild'),
-    didBuild: createLifecycleMiddleware('didBuild'),
+    willUpdate: createLifecycleMiddleware('willUpdate', 1),
+    didUpdate: createLifecycleMiddleware('didUpdate', 2),
+    willBuild: createLifecycleMiddleware('willBuild', 6),
+    didBuild: createLifecycleMiddleware('didBuild', 7),
   }
 };
diff --git a/test/fixtures/simple-site/src/node_modules/fake-module/index.js b/test/fixtures/simple-site/src/node_modules/fake-module/index.js
diff --git a/test/fixtures/simple-site/src/node_modules/my-middleware/index.js b/test/fixtures/simple-site/src/node_modules/my-middleware/index.js
diff --git a/test/fixtures/simple-site/src/reptar.config.js b/test/fixtures/simple-site/src/reptar.config.js
@@ -1,11 +1,9 @@
-import sinon from 'sinon';
-
-const middleware = (reptar) => {
-  reptar._test.middlewares.push(Date.now());
+const createMiddleware = val => (reptar) => {
+  reptar._test.middlewares.push(val);
 };
 
-const createLifecycleMiddleware = (lifecycleName) => (reptar) => {
-  reptar._test.lifecycle[lifecycleName].push(Date.now());
+const createLifecycleMiddleware = (lifecycleName, val) => (reptar) => {
+  reptar._test.lifecycle[lifecycleName].push(val);
 };
 
 module.exports = {
@@ -60,13 +58,14 @@ module.exports = {
   server: { port: 8080, host: '127.0.0.1', baseurl: '' },
   new_file_permalink: '/_posts/:date|YYYY-:date|MM-:date|D-:title.md',
   middlewares: [
-    middleware,
-    middleware,
+    createMiddleware(3),
+    'my-middleware',
+    createMiddleware(5),
   ],
   lifecycle: {
-    willUpdate: createLifecycleMiddleware('willUpdate'),
-    didUpdate: createLifecycleMiddleware('didUpdate'),
-    willBuild: createLifecycleMiddleware('willBuild'),
-    didBuild: createLifecycleMiddleware('didBuild'),
+    willUpdate: createLifecycleMiddleware('willUpdate', 1),
+    didUpdate: createLifecycleMiddleware('didUpdate', 2),
+    willBuild: createLifecycleMiddleware('willBuild', 6),
+    didBuild: createLifecycleMiddleware('didBuild', 7),
   }
 };
diff --git a/test/unit/config/index.spec.js b/test/unit/config/index.spec.js
@@ -5,6 +5,9 @@ import path from 'path';
 import _ from 'lodash';
 
 import fixture from '../../fixture';
+import {
+  simpleSite,
+} from '../../utils';
 
 const ConfigRewire = rewire('../../../lib/config/index.js');
 const Config = ConfigRewire.default;
@@ -233,16 +236,14 @@ describe('config/index Config', () => {
     });
 
     it('coerces middleware and lifecycle config values to arrays', () => {
-      const rootPath = '/root/';
-
       const instance = new Config('');
-      instance.root = rootPath;
+      instance.root = simpleSite.src;
 
       const rawConfig = {
-        middlewares: 'foo',
+        middlewares: 'fake-module',
         lifecycle: {
           willUpdate: _.noop,
-          didUpdate: ['one'],
+          didUpdate: ['my-middleware'],
         },
       };
 
@@ -254,9 +255,13 @@ describe('config/index Config', () => {
       instance.update();
 
       assert(_.isArray(instance.get('middlewares')));
+      assert.equal(typeof instance.get('middlewares[0]'), 'function');
+
       assert(_.isArray(instance.get('lifecycle.willUpdate')));
+      assert.equal(typeof instance.get('lifecycle.willUpdate[0]'), 'function');
+
       assert(_.isArray(instance.get('lifecycle.didUpdate')));
-      assert.equal(instance.get('lifecycle.didUpdate'), 'one');
+      assert.equal(typeof instance.get('lifecycle.didUpdate[0]'), 'function');
     });
   });
 });
