Merge da7adac into 4f274c7

README.md

@@ -146,7 +146,7 @@ Here you'll notice that the request object is available with `this.req` and you
     );
     ```
     Similarly, the class methods `post`, `put`, `delete`, `patch`, `head`, and `options` are available for the Route class e.g.  `Route.post`.
-
+  - You can redirect a route by simply passing the redirect url to the controller parameter e.g. `Route.get("/some-url", "/another-url")`
   - Each object in the *subroutes* array can be constructed using the `subroute` function, like so:
     ```javascript
     const { subroute } = require("@siddiqus/expressive");

__tests__/RouteUtil.test.js

@@ -157,4 +157,33 @@ describe("RouteUtil", () => {
             expect(result).toBeTruthy();
         });
     });
+
+    describe("isUrlPath", () => {
+        it("Should return true for valid urls", () => {
+            [
+                "/hehe/some",
+                "/hehe",
+                "/hehe-blah/:id/ahhs/:someId/hash"
+            ].forEach(str => {
+                expect(RouteUtil.isUrlPath(str)).toBeTruthy();
+            });
+        });
+
+        it("Should return false for invalid urls", () => {
+            [
+                "ajdlasjdksad",
+                "10980du90",
+                "/hh*ehe",
+                "hehe/",
+                "/heheh   ooo"
+            ].forEach(str => {
+                expect(RouteUtil.isUrlPath(str)).toBeFalsy();
+            });
+        });
+
+        it("Should return false if non string input is given", () => {
+            expect(RouteUtil.isUrlPath(() => { })).toBeFalsy();
+            expect(RouteUtil.isUrlPath(class SomeClass {})).toBeFalsy();
+        });
+    });
 });

__tests__/RouterFactory.test.js

@@ -321,6 +321,19 @@ describe("RouterFactory", () => {
         });
     });
 
+    describe("_executeController", () => {
+        it("Should redirect if route url", () => {
+            const factory = new RouterFactory();
+            const mockRes = {
+                redirect: jest.fn()
+            };
+
+            factory._executeController("/somepath", null, mockRes, null);
+
+            expect(mockRes.redirect).toHaveBeenCalledWith("/somepath");
+        });
+    });
+
     it("Should get router from method", () => {
         const factory = new RouterFactory();
 

example/src/routers/Root/RootRouter.js

@@ -9,7 +9,8 @@ module.exports = {
     routes: [
         Route.get("/", RootGetController, {
             doc: RootGetDoc
-        })
+        }),
+        Route.get("/hey", "/hello")
     ],
     subroutes: [
         subroute("/hello", HelloRouter, {

package.json

@@ -26,7 +26,7 @@
     "express": "4.16.3",
     "express-request-id": "1.4.1",
     "express-validator": "6.2.0",
-    "helmet": "3.20.0",
+    "helmet": "3.21.2",
     "swagger-ui-express": "4.0.1"
   },
   "jest-stare": {
@@ -75,7 +75,7 @@
   },
   "husky": {
     "hooks": {
-      "pre-commit": "npm test || npm run lintFix || git add -A",
+      "pre-commit": "npm test && npm run lintFix || git add -A",
       "pre-push": "npm test"
     }
   }

src/RouteUtil.js

@@ -46,4 +46,10 @@ module.exports = class RouteUtil {
         if (stringPrefix.includes(CLASS_STRING)) return false;
         return functionToCheck instanceof Function || stringPrefix === FUNCTION_STRING;
     }
+
+    static isUrlPath(string) {
+        if (typeof string !== "string") return false;
+        const regex = /^(\/[a-zA-Z0-9\-:]+)+\/?$/g;
+        return regex.test(string);
+    }
 };

src/RouterFactory.js

@@ -30,6 +30,10 @@ module.exports = class RouterFactory {
     }
 
     async _executeController(controller, req, res, next) {
+        if (this.routeUtil.isUrlPath(controller)) {
+            return res.redirect(controller);
+        }
+
         if (this.routeUtil.isFunction(controller)) {
             return controller(req, res, next);
         }

src/redoc/registerRedoc.js

@@ -14,4 +14,4 @@ module.exports = function registerRedoc(app, swaggerJson, url) {
             specUrl
         }));
     });
-}
+};