refactor: separate responsibilities in req/res flow (#153)

refactor: router doesn't need it's own serializer

fix: router doesn't need idPattern constant

refactor: add missing ID_PATTERN constant import to router

Author: zacharygolba

package.json

@@ -1,6 +1,6 @@
 {
   "name": "lux-framework",
-  "version": "0.0.1-beta.13",
+  "version": "1.0.0-rc",
   "description": "A MVC style Node.js framework for building lightning fast JSON APIs",
   "repository": "https://github.com/postlight/lux",
   "keywords": [

src/packages/application/initialize.js

@@ -38,13 +38,6 @@ export default async function initialize(app: Application, {
     enabled: log
   });
 
-  const router = new Router();
-
-  const server = new Server({
-    router,
-    logger
-  });
-
   const store = await new Database({
     path,
     models,
@@ -55,56 +48,6 @@ export default async function initialize(app: Application, {
 
   Object.freeze(store);
 
-  Object.defineProperties(app, {
-    path: {
-      value: path,
-      writable: false,
-      enumerable: true,
-      configurable: false
-    },
-
-    port: {
-      value: port,
-      writable: false,
-      enumerable: true,
-      configurable: false
-    },
-
-    store: {
-      value: store,
-      writable: false,
-      enumerable: false,
-      configurable: false
-    },
-
-    logger: {
-      value: logger,
-      writable: false,
-      enumerable: true,
-      configurable: false
-    },
-
-    router: {
-      value: router,
-      writable: false,
-      enumerable: false,
-      configurable: false
-    },
-
-    server: {
-      value: server,
-      writable: false,
-      enumerable: false,
-      configurable: false
-    }
-  });
-
-  Object.assign(app, {
-    models,
-    controllers,
-    serializers
-  });
-
   models.forEach((model, name) => {
     const resource = pluralize(name);
 
@@ -162,8 +105,15 @@ export default async function initialize(app: Application, {
     }
   });
 
-  router.controllers = controllers;
-  routes.call(null, router.route, router.resource);
+  const router = new Router({
+    routes,
+    controllers
+  });
+
+  const server = new Server({
+    router,
+    logger
+  });
 
   server.instance.listen(port).once('listening', () => {
     if (typeof process.send === 'function') {
@@ -175,6 +125,71 @@ export default async function initialize(app: Application, {
     }
   });
 
+  Object.defineProperties(app, {
+    path: {
+      value: path,
+      writable: false,
+      enumerable: true,
+      configurable: false
+    },
+
+    port: {
+      value: port,
+      writable: false,
+      enumerable: true,
+      configurable: false
+    },
+
+    models: {
+      value: models,
+      writable: false,
+      enumerable: true,
+      configurable: false
+    },
+
+    controllers: {
+      value: controllers,
+      writable: false,
+      enumerable: true,
+      configurable: false
+    },
+
+    serializers: {
+      value: serializers,
+      writable: false,
+      enumerable: true,
+      configurable: false
+    },
+
+    store: {
+      value: store,
+      writable: false,
+      enumerable: false,
+      configurable: false
+    },
+
+    logger: {
+      value: logger,
+      writable: false,
+      enumerable: true,
+      configurable: false
+    },
+
+    router: {
+      value: router,
+      writable: false,
+      enumerable: false,
+      configurable: false
+    },
+
+    server: {
+      value: server,
+      writable: false,
+      enumerable: false,
+      configurable: false
+    }
+  });
+
   Object.freeze(app);
   Object.freeze(logger);
   Object.freeze(router);

src/packages/cli/commands/destroy.js

@@ -47,7 +47,7 @@ export default async function destroy(type, name) {
       .split('\n')
       .reduce((lines, line) => {
         const pattern = new RegExp(
-          `\s*resource\\(('|"|\`)${pluralize(name)}('|"|\`)\\);?`
+          `\s*this.resource\\(('|"|\`)${pluralize(name)}('|"|\`)\\);?`
         );
 
         return pattern.test(line) ? lines : [...lines, line];

src/packages/cli/commands/generate.js

@@ -136,7 +136,7 @@ export default async function generate(type, name, pwd = PWD, attrs = []) {
         }
 
         if (index + 1 === closeIndex) {
-          str += `${indent(2)}resource('${pluralize(name)}');\n`;
+          str += `${indent(2)}this.resource('${pluralize(name)}');\n`;
         }
 
         return str;

src/packages/serializer/content-stream/index.js renamed to src/packages/content-stream/index.js

@@ -14,11 +14,17 @@ class ContentStream extends Transform {
     return this;
   }
 
-  _transform(chunk: ?Object, encoding: string, done: () => void): void {
+  _transform(
+    chunk: string | Buffer | Object,
+    encoding: string,
+    done: () => void
+  ): void {
     if (chunk && typeof chunk === 'object') {
-      this.push(JSON.stringify(chunk));
+      chunk = JSON.stringify(chunk);
     }
 
+    this.push(chunk);
+
     done(null);
   }
 }

src/packages/controller/index.js

@@ -412,6 +412,8 @@ class Controller {
       }
     } = req;
 
+    res.statusCode = 201;
+
     return this.model.create(attributes);
   }
 
@@ -444,23 +446,23 @@ class Controller {
   /**
    * Destroy a single `Model` instance that the Controller instance represents.
    */
-  async destroy(req: IncomingMessage, res: ServerResponse): Promise<?Model> {
+  async destroy(req: IncomingMessage, res: ServerResponse): Promise<number> {
     const record = await this.model.find(req.params.id);
 
     if (record) {
       await record.destroy();
     }
 
-    return record;
+    return 204;
   }
 
   /**
    * An action handler used for responding to HEAD or OPTIONS requests.
    *
    * @private
    */
-  preflight(req: IncomingMessage, res: ServerResponse): boolean {
-    return true;
+  preflight(req: IncomingMessage, res: ServerResponse): number {
+    return 204;
   }
 }
 

src/packages/route/constants.js

@@ -0,0 +1,3 @@
+// @flow
+export const ID_PATTERN = /(?![\=])(\d+)/g;
+export const RESOURCE_PATTERN = /^((?!\/)[a-z\-]+)/ig;

src/packages/route/index.js

@@ -1,11 +1,12 @@
 // @flow
+import { ID_PATTERN, RESOURCE_PATTERN } from './constants';
+
 import createAction from './utils/create-action';
 import getStaticPath from './utils/get-static-path';
 import getDynamicSegments from './utils/get-dynamic-segments';
 
-import type { Controller } from '../controller';
-
-const resourcePattern = /^((?!\/)[a-z\-]+)/ig;
+import type Controller from '../controller';
+import type { options } from './interfaces';
 
 /**
  * @private
@@ -32,13 +33,8 @@ class Route {
     action,
     controllers,
     method
-  }: {
-    path: string,
-    action: string,
-    controllers: Map<string, Controller>,
-    method: string
-  }) {
-    const [resource] = path.match(resourcePattern) || [path];
+  }: options) {
+    const [resource] = path.match(RESOURCE_PATTERN) || [path];
     const controller: ?Controller = controllers.get(resource);
     const dynamicSegments = getDynamicSegments(path);
     let handlers;
@@ -119,6 +115,24 @@ class Route {
 
     return this;
   }
+
+  parseParams(pathname: string): Object {
+    const parts = pathname.match(ID_PATTERN) || [];
+
+    return parts.reduce((params, val, index) => {
+      const key = this.dynamicSegments[index];
+
+      if (key) {
+        params = {
+          ...params,
+          [key]: parseInt(val, 10)
+        };
+      }
+
+      return params;
+    }, {});
+  }
 }
 
+export { ID_PATTERN, RESOURCE_PATTERN } from './constants';
 export default Route;

src/packages/route/interfaces.js

@@ -0,0 +1,9 @@
+// @flow
+import type Controller from '../controller';
+
+export type options = {
+  path: string;
+  action: string;
+  method: string;
+  controllers: Map<string, Controller>;
+};

src/packages/router/define/index.js

@@ -0,0 +1,11 @@
+// @flow
+import route from './utils/define-route';
+import resource from './utils/define-resource';
+
+export { default as route } from './utils/define-route';
+export { default as resource } from './utils/define-resource';
+
+export default {
+  route,
+  resource
+};

src/packages/router/define/interfaces.js

@@ -0,0 +1,5 @@
+// @flow
+import type Router from '../index';
+import type { options as routeOptions } from '../../route/interfaces';
+
+export type options = routeOptions & { router: Router };