From 13a7754f2b91021e8895b580490339655308d4d6 Mon Sep 17 00:00:00 2001 From: "C. James Winslow" Date: Wed, 10 Sep 2014 16:19:02 -0700 Subject: [PATCH 1/5] whitespace fixes --- docs/mithril.module.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/mithril.module.md b/docs/mithril.module.md index d76f76a0..3875ca47 100644 --- a/docs/mithril.module.md +++ b/docs/mithril.module.md @@ -62,13 +62,13 @@ The example below shows a component module called `user` being included in a par var dashboard = { controller: function() { this.greeting = "Hello"; - + this.user = new user.controller(); }, view: function(controller) { return [ m("h1", controller.greeting), - + user.view(controller.user) ]; } @@ -158,7 +158,7 @@ where: - **DOMElement rootElement** A DOM element which will contain the view's template. - + - **Module module** A module is supposed to be an Object with two keys: `controller` and `view`. Each of those should point to a Javascript class constructor function @@ -166,11 +166,11 @@ where: The controller class is instantiated immediately upon calling `m.module`. Once the controller code finishes executing (and this may include waiting for AJAX requests to complete), the view class is instantiated, and the instance of the controller is passed as an argument to the view's constructor. - + Note that controllers can manually instantiate child controllers (since they are simply Javascript constructors), and likewise, views can instantiate child views and manually pass the child controller instances down the the child view constructors. - + This "[turtles all the way down](https://en.wikipedia.org/wiki/Turtles_all_the_way_down)" approach is the heart of Mithril's component system. - + Components are nothing more than decoupled classes that can be dynamically brought together as required. This permits the swapping of implementations at a routing level (for example, if implementing widgetized versions of existing components), and class dependency hierarchies can be structurally organized to provide uniform interfaces (for unit tests, for example). From 36f02f54102cd98f292350c576a5907b2035be5f Mon Sep 17 00:00:00 2001 From: "C. James Winslow" Date: Wed, 10 Sep 2014 16:19:20 -0700 Subject: [PATCH 2/5] updated docs --- docs/mithril.module.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/mithril.module.md b/docs/mithril.module.md index 3875ca47..d02fb113 100644 --- a/docs/mithril.module.md +++ b/docs/mithril.module.md @@ -147,7 +147,7 @@ module1.controller = function() { [How to read signatures](how-to-read-signatures.md) ```clike -void module(DOMElement rootElement, Module module) +Object module(DOMElement rootElement, Module module) where: Module :: Object { Controller, void view(Object controllerInstance) } @@ -162,9 +162,9 @@ where: - **Module module** A module is supposed to be an Object with two keys: `controller` and `view`. Each of those should point to a Javascript class constructor function - - The controller class is instantiated immediately upon calling `m.module`. - + + The controller class is instantiated immediately and a reference is returned upon calling `m.module`. + Once the controller code finishes executing (and this may include waiting for AJAX requests to complete), the view class is instantiated, and the instance of the controller is passed as an argument to the view's constructor. Note that controllers can manually instantiate child controllers (since they are simply Javascript constructors), and likewise, views can instantiate child views and manually pass the child controller instances down the the child view constructors. From 343687d5f236d47ad2a54314b84c4cd2413880ee Mon Sep 17 00:00:00 2001 From: "C. James Winslow" Date: Wed, 10 Sep 2014 16:19:43 -0700 Subject: [PATCH 3/5] update typescript definition --- mithril.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mithril.d.ts b/mithril.d.ts index 7b2c4cef..ad5caed6 100644 --- a/mithril.d.ts +++ b/mithril.d.ts @@ -5,7 +5,7 @@ interface MithrilStatic { (selector: string, children?: any): MithrilVirtualElement; prop(value?: any): (value?: any) => any; withAttr(property: string, callback: (value: any) => void): (e: Event) => any; - module(rootElement: Element, module: MithrilModule): void; + module(rootElement: Element, module: MithrilModule): Object; trust(html: string): String; render(rootElement: Element, children?: any): void; render(rootElement: HTMLDocument, children?: any): void; From 445087c606f9115d0f85059326f2000d62556947 Mon Sep 17 00:00:00 2001 From: "C. James Winslow" Date: Wed, 10 Sep 2014 16:20:42 -0700 Subject: [PATCH 4/5] changed the tests to expect that m.module returns the instance of module.controller that was passed to it --- tests/mithril-tests.js | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/tests/mithril-tests.js b/tests/mithril-tests.js index cafddc10..975ece3f 100644 --- a/tests/mithril-tests.js +++ b/tests/mithril-tests.js @@ -34,20 +34,21 @@ function testMithril(mock) { mock.requestAnimationFrame.$resolve() var root1 = mock.document.createElement("div") - m.module(root1, { + var mod1 = m.module(root1, { controller: function() {this.value = "test1"}, view: function(ctrl) {return ctrl.value} }) var root2 = mock.document.createElement("div") - m.module(root2, { + var mod2 = m.module(root2, { controller: function() {this.value = "test2"}, view: function(ctrl) {return ctrl.value} }) mock.requestAnimationFrame.$resolve() - return root1.childNodes[0].nodeValue === "test1" && root2.childNodes[0].nodeValue === "test2" + return (root1.childNodes[0].nodeValue === "test1" && root2.childNodes[0].nodeValue === "test2") + && (mod1.value && mod1.value === "test1") && (mod2.value && mod2.value === "test2") }) //m.withAttr From 1222eb913a2eaceb5f41d40229d06cbef07ba2cc Mon Sep 17 00:00:00 2001 From: "C. James Winslow" Date: Wed, 10 Sep 2014 16:21:33 -0700 Subject: [PATCH 5/5] return reference to the instantiated controller from m.module --- mithril.js | 1 + 1 file changed, 1 insertion(+) diff --git a/mithril.js b/mithril.js index c0983bb1..56880897 100644 --- a/mithril.js +++ b/mithril.js @@ -455,6 +455,7 @@ Mithril = m = new function app(window, undefined) { modules[index] = module controllers[index] = new module.controller m.endComputation() + return controllers[index] } } m.redraw = function(force) {