npm - @aref-shojaei/router - Versions diffs - 1.0.1 → 1.1.0 - Mend

@aref-shojaei/router 1.0.1 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (25) hide show

package/README.md +332 -205
package/build/router.min.js +1 -1
package/example/assets/css/styles.css +45 -45
package/example/assets/js/app.js +7 -7
package/example/assets/js/router.min.js +1 -1
package/example/index.html +26 -26
package/example/server.js +17 -17
package/index.js +6 -4
package/package.json +10 -4
package/src/dto/route.js +13 -17
package/src/exception.js +5 -5
package/src/page.js +91 -91
package/src/route.js +103 -103
package/src/router.js +207 -207
package/src/utils/element.js +23 -22
package/src/utils/selector.js +59 -57
package/src/view.js +24 -24
package/tests/unit/element.test.js +32 -32
package/tests/unit/page.test.js +48 -48
package/tests/unit/route.test.js +82 -82
package/tests/unit/router.test.js +55 -55
package/tests/unit/selector.test.js +42 -42
package/tests/unit/view.test.js +46 -46
package/webpack.config.js +23 -0
package/.babelrc +0 -3

package/tests/unit/element.test.js CHANGED Viewed

@@ -1,33 +1,33 @@
-import { JSDOM } from "jsdom"
-import Element from "../../src/utils/element"
-describe("Element tests", () => {
-    let documentInstance
-    beforeEach(() => {
-        const { window : { document } } = new JSDOM(`
-            <html>
-                <head>
-                    <title>SPA Page</title>
-                </head>
-                <body>
-                    <a href='/'>Home page</a>
-                </body>
-            </html>
-        `)
-        documentInstance = document
-    })
-    it("should prevent instantiation of the class", () => {
-        expect(() => new Element).toThrow()
-    })
-    it("should fire click event", () => {
-        const link = documentInstance.querySelector("a")
-        Element.onClick(link , (event) => expect(typeof event).toBe(Event))
-    })
+import { JSDOM } from "jsdom"
+import Element from "../../src/utils/element"
+describe("Element tests", () => {
+    let documentInstance
+    beforeEach(() => {
+        const { window : { document } } = new JSDOM(`
+            <html>
+                <head>
+                    <title>SPA Page</title>
+                </head>
+                <body>
+                    <a href='/'>Home page</a>
+                </body>
+            </html>
+        `)
+        documentInstance = document
+    })
+    it("should prevent instantiation of the class", () => {
+        expect(() => new Element).toThrow()
+    })
+    it("should fire click event", () => {
+        const link = documentInstance.querySelector("a")
+        Element.onClick(link , (event) => expect(typeof event).toBe(Event))
+    })
 })

package/tests/unit/page.test.js CHANGED Viewed

@@ -1,49 +1,49 @@
-import { JSDOM } from "jsdom"
-import Page from "../../src/page.js"
-describe("Page tests", () => {
-    let documentInstance
-    const titles = {
-        default : "SPA Page",
-        custom : "Custom Page",
-    }
-    beforeEach(() => {
-        const { window : { document } } = new JSDOM(`
-            <html>
-                <head>
-                    <title>${titles["default"]}</title>
-                </head>
-                <body>
-                    <a href='/'>Home page</a>
-                </body>
-            </html>
-        `)
-        documentInstance = document
-        Page.setDocument(documentInstance)
-    })
-    it("should prevent instantiation of the class", () => {
-        expect(() => new Page).toThrow()
-    })
-    it("should set page default title", () => {
-        Page.setRootTitle(documentInstance.title)
-        expect(Page.getRootTitle()).toBeDefined()
-        expect(Page.getRootTitle()).toBe(titles["default"])
-        expect(typeof Page.getRootTitle()).toBe("string")
-    })
-    it("should set custom page title", () => {
-        Page.setTitle(titles["custom"])
-        expect(Page.getTitle()).toBeDefined()
-        expect(Page.getTitle()).toBe(titles["custom"])
-        expect(typeof Page.getTitle()).toBe("string")
-    })
+import { JSDOM } from "jsdom"
+import Page from "../../src/page.js"
+describe("Page tests", () => {
+    let documentInstance
+    const titles = {
+        default : "SPA Page",
+        custom : "Custom Page",
+    }
+    beforeEach(() => {
+        const { window : { document } } = new JSDOM(`
+            <html>
+                <head>
+                    <title>${titles["default"]}</title>
+                </head>
+                <body>
+                    <a href='/'>Home page</a>
+                </body>
+            </html>
+        `)
+        documentInstance = document
+        Page.setDocument(documentInstance)
+    })
+    it("should prevent instantiation of the class", () => {
+        expect(() => new Page).toThrow()
+    })
+    it("should set page default title", () => {
+        Page.setRootTitle(documentInstance.title)
+        expect(Page.getRootTitle()).toBeDefined()
+        expect(Page.getRootTitle()).toBe(titles["default"])
+        expect(typeof Page.getRootTitle()).toBe("string")
+    })
+    it("should set custom page title", () => {
+        Page.setTitle(titles["custom"])
+        expect(Page.getTitle()).toBeDefined()
+        expect(Page.getTitle()).toBe(titles["custom"])
+        expect(typeof Page.getTitle()).toBe("string")
+    })
 })

package/tests/unit/route.test.js CHANGED Viewed

@@ -1,83 +1,83 @@
-import Route from "../../src/route.js"
-describe("Route tests", () => {
-    it("should add a single route", () => {
-        const route = "/"
-        const template = () => "Welcome Page"
-        Route.addRoute(route, template)
-        const routes = Route._routes
-        expect(routes[route]).toBeDefined()
-    })
-    it("should add the group route", () => {
-        const routePrefix = "/auth"
-        const route = "/login"
-        const template = () => "Login Page"
-        Route.group(routePrefix, () => {
-            Route.addRoute(route, template)
-        })
-        const routes = Route._routes
-        expect(routes[routePrefix + route]).toBeDefined()
-        expect(typeof routes[routePrefix + route]).toBe("object")
-    })
-    it("should add a dynamic route", () => {
-        const route = "/users/{id}"
-        const template = ({ params: { id } }) => `User #${id}`
-        Route.addRoute(route, template)
-        const routes = Route._routes
-        expect(routes[route]).toBeDefined()
-        expect(typeof routes[route]).toBe("object")
-    })
-    it("should add middleware to a route", () => {
-        const route = "/admin"
-        const template = () => "Admin Page"
-        const loggerMiddleware = () => { message : "Custom Log Message!" }
-        Route.addRoute(route, template).middleware([loggerMiddleware])
-        const routes = Route._routes
-        expect(routes[route]["middlewares"]).toBeDefined()
-        expect(typeof routes[route]["middlewares"]).toBe("object")
-    })
-    it("should add page title to a route", () => {
-        const route = "/product"
-        const template = () => "SPA Page"
-        Route.addRoute(route, template).title("Custom page title (SPA)")
-        const routes = Route._routes
-        expect(routes[route]["title"]).toBeDefined()
-        expect(typeof routes[route]["title"]).toBe("string")
-    })
-    it("should redirect route", () => {
-        const welcomeRoute = "/"
-        const redirectionRoute = "/redirection"
-        const distRoute = welcomeRoute
-        Route.addRoute("/", () => "Welcome Page")
-        Route.addRoute("/redirection", () => Route.redirect(distRoute))
-        const routes = Route._routes
-        expect(routes[redirectionRoute]).toBeDefined()
-        expect(typeof routes[redirectionRoute]).toBe("object")
-        expect(routes[welcomeRoute]).toBeDefined()
-        expect(typeof routes[welcomeRoute]).toBe("object")
-    })
+import Route from "../../src/route.js"
+describe("Route tests", () => {
+    it("should add a single route", () => {
+        const route = "/"
+        const template = () => "Welcome Page"
+        Route.add(route, template)
+        const routes = Route._routes
+        expect(routes[route]).toBeDefined()
+    })
+    it("should add the group route", () => {
+        const routePrefix = "/auth"
+        const route = "/login"
+        const template = () => "Login Page"
+        Route.group(routePrefix, () => {
+            Route.add(route, template)
+        })
+        const routes = Route._routes
+        expect(routes[routePrefix + route]).toBeDefined()
+        expect(typeof routes[routePrefix + route]).toBe("object")
+    })
+    it("should add a dynamic route", () => {
+        const route = "/users/{id}"
+        const template = ({ params: { id } }) => `User #${id}`
+        Route.add(route, template)
+        const routes = Route._routes
+        expect(routes[route]).toBeDefined()
+        expect(typeof routes[route]).toBe("object")
+    })
+    it("should add middleware to a route", () => {
+        const route = "/admin"
+        const template = () => "Admin Page"
+        const loggerMiddleware = () => { message : "Custom Log Message!" }
+        Route.add(route, template).middleware([loggerMiddleware])
+        const routes = Route._routes
+        expect(routes[route]["middlewares"]).toBeDefined()
+        expect(typeof routes[route]["middlewares"]).toBe("object")
+    })
+    it("should add page title to a route", () => {
+        const route = "/product"
+        const template = () => "SPA Page"
+        Route.add(route, template).title("Custom page title (SPA)")
+        const routes = Route._routes
+        expect(routes[route]["title"]).toBeDefined()
+        expect(typeof routes[route]["title"]).toBe("string")
+    })
+    it("should redirect route", () => {
+        const welcomeRoute = "/"
+        const redirectionRoute = "/redirection"
+        const distRoute = welcomeRoute
+        Route.add("/", () => "Welcome Page")
+        Route.add("/redirection", () => Route.redirect(distRoute))
+        const routes = Route._routes
+        expect(routes[redirectionRoute]).toBeDefined()
+        expect(typeof routes[redirectionRoute]).toBe("object")
+        expect(routes[welcomeRoute]).toBeDefined()
+        expect(typeof routes[welcomeRoute]).toBe("object")
+    })
 })

package/tests/unit/router.test.js CHANGED Viewed

@@ -1,56 +1,56 @@
-import { JSDOM } from "jsdom"
-import Router from "../../src/router.js"
-describe("Router tests", () => {
-    let documentInstance
-    let windowtInstance
-    let selectorID
-    beforeEach(() => {
-        const { window } = new JSDOM(`
-            <html>
-                <head>
-                    <title>SPA Page</title>
-                </head>
-                <body>
-                    <div id='root'></div>
-                </body>
-            </html>
-        `)
-        const { document } = window
-        documentInstance = document
-        windowtInstance = window
-        selectorID = "#root"
-    })
-    it("should prevent instantiation of the class", () => {
-        expect(() => new Router).toThrow()
-    })
-    it("should configure router", () => {
-        expect(() => {
-            Router.configure({
-                window : windowtInstance,
-                document : documentInstance,
-                selector : selectorID
-            })
-        }).not.toThrow()
-    })
-    it("should run router", () => {
-        expect(() => {
-            Router.configure({
-                window : windowtInstance,
-                document : documentInstance,
-                selector : selectorID
-            })
-            Router.run()
-        }).not.toThrow()
-    })
+import { JSDOM } from "jsdom"
+import Router from "../../src/router.js"
+describe("Router tests", () => {
+    let documentInstance
+    let windowtInstance
+    let selectorID
+    beforeEach(() => {
+        const { window } = new JSDOM(`
+            <html>
+                <head>
+                    <title>SPA Page</title>
+                </head>
+                <body>
+                    <div id='root'></div>
+                </body>
+            </html>
+        `)
+        const { document } = window
+        documentInstance = document
+        windowtInstance = window
+        selectorID = "#root"
+    })
+    it("should prevent instantiation of the class", () => {
+        expect(() => new Router).toThrow()
+    })
+    it("should configure router", () => {
+        expect(() => {
+            Router.configure({
+                window : windowtInstance,
+                document : documentInstance,
+                selector : selectorID
+            })
+        }).not.toThrow()
+    })
+    it("should run router", () => {
+        expect(() => {
+            Router.configure({
+                window : windowtInstance,
+                document : documentInstance,
+                selector : selectorID
+            })
+            Router.run()
+        }).not.toThrow()
+    })
 })

package/tests/unit/selector.test.js CHANGED Viewed

@@ -1,42 +1,42 @@
-import { JSDOM } from "jsdom";
-import Selector from "../../src/utils/selector.js";
-describe("Selector tests", () => {
-    let documentInstance
-    beforeEach(() => {
-        const { window : { document } } = new JSDOM(`
-            <html>
-                <head></head>
-                <body>
-                    <a href='/'>Home page</a>
-                    <a href='/products'>Products page</a>
-                    <a href='/blog'>Blog page</a>
-                </body>
-            </html>
-        `)
-        documentInstance = document
-    })
-    it("should prevent instantiation of the class", () => {
-        expect(() => new Selector).toThrow();
-    });
-    it("should get all anchor elements", () => {
-        const links = Selector.findAll("a", documentInstance)._getElements();
-        expect(typeof links).toBe("object")
-    });
-    it("should get title of link", () => {
-        Selector.findAll("a", documentInstance).each(anchor => {
-            const link = anchor.getAttribute("href")
-            expect(typeof link).toBe("string")
-        })
-    })
-});
+import { JSDOM } from "jsdom";
+import Selector from "../../src/utils/selector.js";
+describe("Selector tests", () => {
+    let documentInstance
+    beforeEach(() => {
+        const { window : { document } } = new JSDOM(`
+            <html>
+                <head></head>
+                <body>
+                    <a href='/'>Home page</a>
+                    <a href='/products'>Products page</a>
+                    <a href='/blog'>Blog page</a>
+                </body>
+            </html>
+        `)
+        documentInstance = document
+    })
+    it("should prevent instantiation of the class", () => {
+        expect(() => new Selector).toThrow();
+    });
+    it("should get all anchor elements", () => {
+        const links = Selector.findAll("a", documentInstance)._getElements();
+        expect(typeof links).toBe("object")
+    });
+    it("should get title of link", () => {
+        Selector.findAll("a", documentInstance).each(anchor => {
+            const link = anchor.getAttribute("href")
+            expect(typeof link).toBe("string")
+        })
+    })
+});

package/tests/unit/view.test.js CHANGED Viewed

@@ -1,47 +1,47 @@
-import View from "../../src/view.js"
-describe("View tests", () => {
-    it("should prevent instantiation of the class", () => {
-        expect(() => new View).toThrow()
-    })
-    it("should render a template without params", () => {
-        const template = () => {
-            return `
-                <div>
-                    <h1>Welcome Page</h1>
-                    <p>This is SPA page!</p>
-                </div>
-            `
-        }
-        const renderedTemplate = View.render(template)
-        expect(typeof renderedTemplate).toBe("string")
-        expect(renderedTemplate).toContain("<h1>Welcome Page</h1>")
-        expect(renderedTemplate).toContain("<p>This is SPA page!</p>")
-    })
-    it("should render a template with params", () => {
-        const template = ({ id, name }) => {
-            return `
-                <div>
-                    <h1>User Page</h1>
-                    <p>ID: ${id}  -  Name: ${name}</p>
-                </div>
-            `
-        }
-        const user = {
-            id : 1,
-            name : "Robert"
-        }
-        const renderedTemplate = View.render(template, user)
-        expect(typeof renderedTemplate).toBe("string")
-        expect(renderedTemplate).toContain(`<h1>User Page</h1>`)
-        expect(renderedTemplate).toContain(`<p>ID: ${user.id}  -  Name: ${user.name}</p>`)
-    })
+import View from "../../src/view.js"
+describe("View tests", () => {
+    it("should prevent instantiation of the class", () => {
+        expect(() => new View).toThrow()
+    })
+    it("should render a template without params", () => {
+        const template = () => {
+            return `
+                <div>
+                    <h1>Welcome Page</h1>
+                    <p>This is SPA page!</p>
+                </div>
+            `
+        }
+        const renderedTemplate = View.render(template)
+        expect(typeof renderedTemplate).toBe("string")
+        expect(renderedTemplate).toContain("<h1>Welcome Page</h1>")
+        expect(renderedTemplate).toContain("<p>This is SPA page!</p>")
+    })
+    it("should render a template with params", () => {
+        const template = ({ id, name }) => {
+            return `
+                <div>
+                    <h1>User Page</h1>
+                    <p>ID: ${id}  -  Name: ${name}</p>
+                </div>
+            `
+        }
+        const user = {
+            id : 1,
+            name : "Robert"
+        }
+        const renderedTemplate = View.render(template, user)
+        expect(typeof renderedTemplate).toBe("string")
+        expect(renderedTemplate).toContain(`<h1>User Page</h1>`)
+        expect(renderedTemplate).toContain(`<p>ID: ${user.id}  -  Name: ${user.name}</p>`)
+    })
 })

package/webpack.config.js ADDED Viewed

@@ -0,0 +1,23 @@
+const path = require("path");
+module.exports = {
+    entry : path.join(__dirname,  "index.js"),
+    output : {
+        path : path.join(__dirname, "dist"),
+        filename : "router.min.js",
+    },
+    module : {
+        rules : [
+            {
+                test: /\.(js)$/,
+                exclude: /node_modules/,
+                use : {
+                    loader : "babel-loader",
+                    options : {
+                        presets : ["@babel/preset-env"]
+                    }
+                }
+            }
+        ]
+    }
+}

package/.babelrc DELETED Viewed

@@ -1,3 +0,0 @@
-{
-    "presets": ["@babel/preset-env"]
-}