Merge pull request #209 from chaowlert/defaults

pleerock · web-flow · commit 9f93e3a892e9 · 2017-07-22T13:05:59.000+05:00
allow default options
diff --git a/README.md b/README.md
@@ -41,6 +41,7 @@ You can use routing-controllers with [express.js][1] or [koa.js][2].
       - [Render templates](#render-templates)
       - [Throw HTTP errors](#throw-http-errors)
       - [Enable CORS](#enable-cors)
+      - [Default settings](#default-settings)
   * [Using middlewares](#using-middlewares)
     + [Use exist middleware](#use-exist-middleware)
     + [Creating your own express middleware](#creating-your-own-express-middleware)
@@ -728,6 +729,34 @@ const app = createExpressServer({
 app.listen(3000);
 ```
 
+#### Default settings
+
+You can override default status code in routing-controllers options. 
+
+```typescript
+import "reflect-metadata";
+import {createExpressServer} from "routing-controllers";
+import {UserController} from "./UserController";
+
+const app = createExpressServer({
+    defaults: {
+
+        //with this option, null will return 404 by default
+        nullResultCode: 404,
+
+        //with this option, void or Promise<void> will return 204 by default 
+        undefinedResultCode: 204,
+        
+        paramOptions: {
+            //with this option, argument will be required by default
+            required: true
+        }
+    }
+});
+
+app.listen(3000);
+```
+
 ## Using middlewares
 
 You can use any exist express / koa middleware, or create your own.
diff --git a/src/RoutingControllers.ts b/src/RoutingControllers.ts
@@ -1,13 +1,14 @@
-import {ActionParameterHandler} from "./ActionParameterHandler";
-import {MetadataBuilder} from "./metadata-builder/MetadataBuilder";
-import {ActionMetadata} from "./metadata/ActionMetadata";
 import {Action} from "./Action";
+import {ActionMetadata} from "./metadata/ActionMetadata";
+import {ActionParameterHandler} from "./ActionParameterHandler";
 import {Driver} from "./driver/Driver";
-import {isPromiseLike} from "./util/isPromiseLike";
-import {runInSequence} from "./util/runInSequence";
+import {InterceptorInterface} from "./InterceptorInterface";
 import {InterceptorMetadata} from "./metadata/InterceptorMetadata";
+import {MetadataBuilder} from "./metadata-builder/MetadataBuilder";
+import { RoutingControllersOptions } from "./RoutingControllersOptions";
 import {getFromContainer} from "./container";
-import {InterceptorInterface} from "./InterceptorInterface";
+import {isPromiseLike} from "./util/isPromiseLike";
+import {runInSequence} from "./util/runInSequence";
 
 /**
  * Registers controllers and middlewares in the given server framework.
@@ -37,9 +38,9 @@ export class RoutingControllers {
     // Constructor
     // -------------------------------------------------------------------------
 
-    constructor(private driver: Driver) {
+    constructor(private driver: Driver, private options: RoutingControllersOptions) {
         this.parameterHandler = new ActionParameterHandler(driver);
-        this.metadataBuilder = new MetadataBuilder();
+        this.metadataBuilder = new MetadataBuilder(options);
     }
 
     // -------------------------------------------------------------------------
diff --git a/src/RoutingControllersOptions.ts b/src/RoutingControllersOptions.ts
@@ -1,7 +1,8 @@
-import {ClassTransformOptions} from "class-transformer";
-import {ValidatorOptions} from "class-validator";
 import {AuthorizationChecker} from "./AuthorizationChecker";
+import {ClassTransformOptions} from "class-transformer";
 import {CurrentUserChecker} from "./CurrentUserChecker";
+import { ParamOptions } from "./decorator-options/ParamOptions";
+import {ValidatorOptions} from "class-validator";
 
 /**
  * Routing controller initialization options.
@@ -85,4 +86,28 @@ export interface RoutingControllersOptions {
      */
     currentUserChecker?: CurrentUserChecker;
     
+    /**
+     * Default settings
+     */
+    defaults?: {
+        /**
+         * If set, all null responses will return specified status code by default
+         */
+        nullResultCode?: number;
+
+        /**
+         * If set, all undefined responses will return specified status code by default
+         */
+        undefinedResultCode?: number;
+
+        /**
+         * Default param options
+         */
+        paramOptions?: {
+            /**
+             * If true, all non-set parameters will be required by default
+             */
+            required?: boolean;
+        };
+    };
 }
diff --git a/src/decorator/Body.ts b/src/decorator/Body.ts
@@ -13,7 +13,7 @@ export function Body(options?: BodyOptions): Function {
             method: methodName,
             index: index,
             parse: false,
-            required: options ? options.required : false,
+            required: options ? options.required : undefined,
             classTransform: options ? options.transform : undefined,
             validate: options ? options.validate : undefined,
             explicitType: options ? options.type : undefined,
diff --git a/src/decorator/BodyParam.ts b/src/decorator/BodyParam.ts
@@ -1,5 +1,5 @@
-import {getMetadataArgsStorage} from "../index";
 import {ParamOptions} from "../decorator-options/ParamOptions";
+import {getMetadataArgsStorage} from "../index";
 
 /**
  * Takes partial data of the request body.
@@ -14,7 +14,7 @@ export function BodyParam(name: string, options?: ParamOptions): Function {
             index: index,
             name: name,
             parse: options ? options.parse : false,
-            required: options ? options.required : false,
+            required: options ? options.required : undefined,
             explicitType: options ? options.type : undefined,
             classTransform: options ? options.transform : undefined,
             validate: options ? options.validate : undefined
diff --git a/src/decorator/CookieParam.ts b/src/decorator/CookieParam.ts
@@ -1,5 +1,5 @@
-import {getMetadataArgsStorage} from "../index";
 import {ParamOptions} from "../decorator-options/ParamOptions";
+import {getMetadataArgsStorage} from "../index";
 
 /**
  * Injects a request's cookie value to the controller action parameter.
@@ -14,7 +14,7 @@ export function CookieParam(name: string, options?: ParamOptions) {
             index: index,
             name: name,
             parse: options ? options.parse : false,
-            required: options ? options.required : false,
+            required: options ? options.required : undefined,
             explicitType: options ? options.type : undefined,
             classTransform: options ? options.transform : undefined,
             validate: options ? options.validate : undefined
diff --git a/src/decorator/CurrentUser.ts b/src/decorator/CurrentUser.ts
@@ -12,7 +12,7 @@ export function CurrentUser(options?: { required?: boolean }) {
             method: methodName,
             index: index,
             parse: false,
-            required: options ? options.required : false
+            required: options ? options.required : undefined
         });
     };
 }
diff --git a/src/decorator/HeaderParam.ts b/src/decorator/HeaderParam.ts
@@ -1,5 +1,5 @@
-import {getMetadataArgsStorage} from "../index";
 import {ParamOptions} from "../decorator-options/ParamOptions";
+import {getMetadataArgsStorage} from "../index";
 
 /**
  * Injects a request's http header value to the controller action parameter.
@@ -14,7 +14,7 @@ export function HeaderParam(name: string, options?: ParamOptions): Function {
             index: index,
             name: name,
             parse: options ? options.parse : false,
-            required: options ? options.required : false,
+            required: options ? options.required : undefined,
             classTransform: options ? options.transform : undefined,
             explicitType: options ? options.type : undefined,
             validate: options ? options.validate : undefined
diff --git a/src/decorator/QueryParam.ts b/src/decorator/QueryParam.ts
@@ -1,5 +1,5 @@
-import {getMetadataArgsStorage} from "../index";
 import {ParamOptions} from "../decorator-options/ParamOptions";
+import {getMetadataArgsStorage} from "../index";
 
 /**
  * Injects a request's query parameter value to the controller action parameter.
@@ -14,7 +14,7 @@ export function QueryParam(name: string, options?: ParamOptions): Function {
             index: index,
             name: name,
             parse: options ? options.parse : false,
-            required: options ? options.required : false,
+            required: options ? options.required : undefined,
             classTransform: options ? options.transform : undefined,
             explicitType: options ? options.type : undefined,
             validate: options ? options.validate : undefined
diff --git a/src/decorator/Session.ts b/src/decorator/Session.ts
@@ -1,6 +1,5 @@
-import { getMetadataArgsStorage } from "../index";
 import { ParamOptions } from "../decorator-options/ParamOptions";
-
+import { getMetadataArgsStorage } from "../index";
 
 /**
  * Injects a Session object to the controller action parameter.
diff --git a/src/decorator/UploadedFile.ts b/src/decorator/UploadedFile.ts
@@ -1,5 +1,5 @@
-import {getMetadataArgsStorage} from "../index";
 import {UploadOptions} from "../decorator-options/UploadOptions";
+import {getMetadataArgsStorage} from "../index";
 
 /**
  * Injects an uploaded file object to the controller action parameter.
@@ -14,7 +14,7 @@ export function UploadedFile(name: string, options?: UploadOptions): Function {
             index: index,
             name: name,
             parse: false,
-            required: options ? options.required : false,
+            required: options ? options.required : undefined,
             extraOptions: options ? options.options : undefined
         });
     };
diff --git a/src/decorator/UploadedFiles.ts b/src/decorator/UploadedFiles.ts
@@ -1,5 +1,5 @@
-import {getMetadataArgsStorage} from "../index";
 import {UploadOptions} from "../decorator-options/UploadOptions";
+import {getMetadataArgsStorage} from "../index";
 
 /**
  * Injects all uploaded files to the controller action parameter.
@@ -14,7 +14,7 @@ export function UploadedFiles(name: string, options?: UploadOptions): Function {
             index: index,
             name: name,
             parse: false,
-            required: options ? options.required : false,
+            required: options ? options.required : undefined,
             extraOptions: options ? options.options : undefined
         });
     };
diff --git a/src/index.ts b/src/index.ts
@@ -1,12 +1,12 @@
-import {importClassesFromDirectories} from "./util/importClassesFromDirectories";
-import {RoutingControllers} from "./RoutingControllers";
+import {CustomParameterDecorator} from "./CustomParameterDecorator";
+import {Driver} from "./driver/Driver";
 import {ExpressDriver} from "./driver/express/ExpressDriver";
 import {KoaDriver} from "./driver/koa/KoaDriver";
-import {Driver} from "./driver/Driver";
-import {RoutingControllersOptions} from "./RoutingControllersOptions";
-import {CustomParameterDecorator} from "./CustomParameterDecorator";
 import {MetadataArgsStorage} from "./metadata-builder/MetadataArgsStorage";
+import {RoutingControllers} from "./RoutingControllers";
+import {RoutingControllersOptions} from "./RoutingControllersOptions";
 import {ValidationOptions} from "class-validator";
+import {importClassesFromDirectories} from "./util/importClassesFromDirectories";
 
 // -------------------------------------------------------------------------
 // Main exports
@@ -212,7 +212,7 @@ export function createExecutor(driver: Driver, options: RoutingControllersOption
     driver.cors = options.cors;
 
     // next create a controller executor
-    new RoutingControllers(driver)
+    new RoutingControllers(driver, options)
         .initialize()
         .registerInterceptors(interceptorClasses)
         .registerMiddlewares("before")
diff --git a/src/metadata-builder/MetadataBuilder.ts b/src/metadata-builder/MetadataBuilder.ts
@@ -1,17 +1,21 @@
-import {ControllerMetadata} from "../metadata/ControllerMetadata";
 import {ActionMetadata} from "../metadata/ActionMetadata";
+import {ControllerMetadata} from "../metadata/ControllerMetadata";
+import {InterceptorMetadata} from "../metadata/InterceptorMetadata";
+import {MiddlewareMetadata} from "../metadata/MiddlewareMetadata";
 import {ParamMetadata} from "../metadata/ParamMetadata";
+import { ParamMetadataArgs } from "../metadata/args/ParamMetadataArgs";
 import {ResponseHandlerMetadata} from "../metadata/ResponseHandleMetadata";
-import {MiddlewareMetadata} from "../metadata/MiddlewareMetadata";
+import { RoutingControllersOptions } from "../RoutingControllersOptions";
 import {UseMetadata} from "../metadata/UseMetadata";
 import {getMetadataArgsStorage} from "../index";
-import {InterceptorMetadata} from "../metadata/InterceptorMetadata";
 
 /**
  * Builds metadata from the given metadata arguments.
  */
 export class MetadataBuilder {
 
+    constructor(private options: RoutingControllersOptions) { }
+
     // -------------------------------------------------------------------------
     // Public Methods
     // -------------------------------------------------------------------------
@@ -83,7 +87,7 @@ export class MetadataBuilder {
         return getMetadataArgsStorage()
             .filterActionsWithTarget(controller.target)
             .map(actionArgs => {
-                const action = new ActionMetadata(controller, actionArgs);
+                const action = new ActionMetadata(controller, actionArgs, this.options);
                 action.params = this.createParams(action);
                 action.uses = this.createActionUses(action);
                 action.interceptors = this.createActionInterceptorUses(action);
@@ -98,7 +102,21 @@ export class MetadataBuilder {
     protected createParams(action: ActionMetadata): ParamMetadata[] {
         return getMetadataArgsStorage()
             .filterParamsWithTargetAndMethod(action.target, action.method)
-            .map(paramArgs => new ParamMetadata(action, paramArgs));
+            .map(paramArgs => new ParamMetadata(action, this.decorateDefaultParamOptions(paramArgs)));
+    }
+
+    /**
+     * Decorate paramArgs with default settings
+     */
+    private decorateDefaultParamOptions(paramArgs: ParamMetadataArgs) {
+        let options = this.options.defaults && this.options.defaults.paramOptions;
+        if (!options)
+            return paramArgs;
+        
+        if (paramArgs.required === undefined)
+            paramArgs.required = options.required || false;
+
+        return paramArgs;
     }
 
     /**
diff --git a/src/metadata/ActionMetadata.ts b/src/metadata/ActionMetadata.ts
@@ -1,12 +1,13 @@
-import {ParamMetadata} from "./ParamMetadata";
+import {Action} from "../Action";
 import {ActionMetadataArgs} from "./args/ActionMetadataArgs";
 import {ActionType} from "./types/ActionType";
+import {ClassTransformOptions} from "class-transformer";
 import {ControllerMetadata} from "./ControllerMetadata";
+import {InterceptorMetadata} from "./InterceptorMetadata";
+import {ParamMetadata} from "./ParamMetadata";
 import {ResponseHandlerMetadata} from "./ResponseHandleMetadata";
+import { RoutingControllersOptions } from "../RoutingControllersOptions";
 import {UseMetadata} from "./UseMetadata";
-import {ClassTransformOptions} from "class-transformer";
-import {Action} from "../Action";
-import {InterceptorMetadata} from "./InterceptorMetadata";
 
 /**
  * Action metadata.
@@ -147,7 +148,7 @@ export class ActionMetadata {
     // Constructor
     // -------------------------------------------------------------------------
 
-    constructor(controllerMetadata: ControllerMetadata, args: ActionMetadataArgs) {
+    constructor(controllerMetadata: ControllerMetadata, args: ActionMetadataArgs, private options: RoutingControllersOptions) {
         this.controllerMetadata = controllerMetadata;
         this.route = args.route;
         this.target = args.target;
@@ -177,10 +178,15 @@ export class ActionMetadata {
 
         if (classTransformerResponseHandler)
             this.responseClassTransformOptions = classTransformerResponseHandler.value;
-        if (undefinedResultHandler)
-            this.undefinedResultCode = undefinedResultHandler.value;
-        if (nullResultHandler)
-            this.nullResultCode = nullResultHandler.value;
+        
+        this.undefinedResultCode = undefinedResultHandler
+            ? undefinedResultHandler.value
+            : this.options.defaults && this.options.defaults.undefinedResultCode;
+        
+        this.nullResultCode = nullResultHandler
+            ? nullResultHandler.value
+            : this.options.defaults && this.options.defaults.nullResultCode;
+        
         if (successCodeHandler)
             this.successHttpCode = successCodeHandler.value;
         if (redirectHandler)
diff --git a/test/functional/defaults.spec.ts b/test/functional/defaults.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ export function CurrentUser(options?: { required?: boolean }) {`
`12`	`12`	`method: methodName,`
`13`	`13`	`index: index,`
`14`	`14`	`parse: false,`
`15`		`- required: options ? options.required : false`
	`15`	`+ required: options ? options.required : undefined`
`16`	`16`	`});`
`17`	`17`	`};`
`18`	`18`	`}`