feat(app generator,view subgenerator): normalize template expansion

Make template part a view class property. Add renderData method.
marviq · Apr 13, 2015 · bc32f20 · bc32f20
1 parent 6aa0d3c
commit bc32f20
Show file tree

Hide file tree

Showing 7 changed files with 211 additions and 11 deletions.
diff --git a/generators/app/templates/demo/views/buildscript.coffee b/generators/app/templates/demo/views/buildscript.coffee
@@ -61,6 +61,20 @@
         className:          'buildscript-view'
 
 
+        ###*
+        #   The compiled handlebars template expander function.
+        #
+        #   @property       template
+        #
+        #   @type           Function
+        #   @protected
+        #   @static
+        #   @final
+        ###
+
+        template:           template
+
+
         ###*
         #   @method         render
         #
@@ -72,10 +86,25 @@
 
             ##  Expand the handlebars template into this view's container element.
             ##
-            @$el.html( template() )
+            @$el.html( @template( @renderData() ) )
 
             ##  This method is chainable.
             ##
             return @
 
+
+        ###*
+        #   Collect and return all data needed to expand the handlebars `@template` with
+        #
+        #   @method         renderData
+        #   @protected
+        #
+        #   @return         {Object}
+        #
+        ###
+
+        renderData: () ->
+
+            return {}
+
 )
diff --git a/generators/app/templates/demo/views/documentation.coffee b/generators/app/templates/demo/views/documentation.coffee
@@ -59,6 +59,20 @@
         className:          'documentation-view'
 
 
+        ###*
+        #   The compiled handlebars template expander function.
+        #
+        #   @property       template
+        #
+        #   @type           Function
+        #   @protected
+        #   @static
+        #   @final
+        ###
+
+        template:           template
+
+
         ###*
         #   @method         render
         #
@@ -70,10 +84,25 @@
 
             ##  Expand the handlebars template into this view's container element.
             ##
-            @$el.html( template() )
+            @$el.html( @template( @renderData() ) )
 
             ##  This method is chainable.
             ##
             return @
 
+
+        ###*
+        #   Collect and return all data needed to expand the handlebars `@template` with
+        #
+        #   @method         renderData
+        #   @protected
+        #
+        #   @return         {Object}
+        #
+        ###
+
+        renderData: () ->
+
+            return {}
+
 )
diff --git a/generators/app/templates/demo/views/i18n.coffee b/generators/app/templates/demo/views/i18n.coffee
@@ -64,6 +64,20 @@
         className:          'i18n-view'
 
 
+        ###*
+        #   The compiled handlebars template expander function.
+        #
+        #   @property       template
+        #
+        #   @type           Function
+        #   @protected
+        #   @static
+        #   @final
+        ###
+
+        template:           template
+
+
         ###*
         #   Setup UI event handler definitions.
         #
@@ -90,11 +104,7 @@
 
             ##  Expand the handlebars template into this view's container element.
             ##
-            @$el.html( template(
-                date:       new Date()
-                money:      100000
-                number:     1090870987
-            ))
+            @$el.html( @template( @renderData() ) )
 
             ##  Set the current locale as selected option.
             ##
@@ -105,6 +115,23 @@
             return @
 
 
+        ###*
+        #   Collect and return all data needed to expand the handlebars `@template` with
+        #
+        #   @method         renderData
+        #   @protected
+        #
+        #   @return         {Object}
+        #
+        ###
+
+        renderData: () ->
+
+            date:       new Date()
+            money:      100000
+            number:     1090870987
+
+
         ###*
         #   Handles changes to the selected language.
         #

diff --git a/generators/app/templates/demo/views/index.coffee b/generators/app/templates/demo/views/index.coffee
@@ -61,6 +61,20 @@
         className:          'index-view'
 
 
+        ###*
+        #   The compiled handlebars template expander function.
+        #
+        #   @property       template
+        #
+        #   @type           Function
+        #   @protected
+        #   @static
+        #   @final
+        ###
+
+        template:           template
+
+
         ###*
         #   @method         render
         #
@@ -72,10 +86,25 @@
 
             ##  Expand the handlebars template into this view's container element.
             ##
-            @$el.html( template() )
+            @$el.html( @template( @renderData() ) )
 
             ##  This method is chainable.
             ##
             return @
 
+
+        ###*
+        #   Collect and return all data needed to expand the handlebars `@template` with
+        #
+        #   @method         renderData
+        #   @protected
+        #
+        #   @return         {Object}
+        #
+        ###
+
+        renderData: () ->
+
+            return {}
+
 )
diff --git a/generators/app/templates/demo/views/navigation.coffee b/generators/app/templates/demo/views/navigation.coffee
@@ -47,6 +47,20 @@
         className:          'navigation-view'
 
 
+        ###*
+        #   The compiled handlebars template expander function.
+        #
+        #   @property       template
+        #
+        #   @type           Function
+        #   @protected
+        #   @static
+        #   @final
+        ###
+
+        template:           template
+
+
         ###*
         #   @method         render
         #
@@ -58,7 +72,7 @@
 
             ##  Expand the handlebars template into this view's container element.
             ##
-            @$el.html( template() )
+            @$el.html( @template( @renderData() ) )
 
             # Set reference to the navbar
             #
@@ -69,6 +83,20 @@
             return @
 
 
+        ###*
+        #   Collect and return all data needed to expand the handlebars `@template` with
+        #
+        #   @method         renderData
+        #   @protected
+        #
+        #   @return         {Object}
+        #
+        ###
+
+        renderData: () ->
+
+            return {}
+
         ###*
         #   Set the activeMenuItem based on the url passed.
         #

diff --git a/generators/app/templates/src/views/index.coffee b/generators/app/templates/src/views/index.coffee
@@ -61,6 +61,20 @@
         className:          'index-view'
 
 
+        ###*
+        #   The compiled handlebars template expander function.
+        #
+        #   @property       template
+        #
+        #   @type           Function
+        #   @protected
+        #   @static
+        #   @final
+        ###
+
+        template:           template
+
+
         ###*
         #   @method         initialize
         #   @protected
@@ -95,10 +109,25 @@
 
             ##  Expand the handlebars template into this view's container element.
             ##
-            @$el.html( template() )
+            @$el.html( @template( @renderData() ) )
 
             ##  This method is chainable.
             ##
             return @
 
+
+        ###*
+        #   Collect and return all data needed to expand the handlebars `@template` with
+        #
+        #   @method         renderData
+        #   @protected
+        #
+        #   @return         {Object}
+        #
+        ###
+
+        renderData: () ->
+
+            return {}
+
 )
diff --git a/generators/view/templates/view.coffee b/generators/view/templates/view.coffee
@@ -61,6 +61,20 @@
         className:          '<%= fileName %>-view'
 
 
+        ###*
+        #   The compiled handlebars template expander function.
+        #
+        #   @property       template
+        #
+        #   @type           Function
+        #   @protected
+        #   @static
+        #   @final
+        ###
+
+        template:           template
+
+
         ###*
         #   @method         initialize
         #   @protected
@@ -95,10 +109,25 @@
 
             ##  Expand the handlebars template into this view's container element.
             ##
-            @$el.html( template() )
+            @$el.html( @template( @renderData() ) )
 
             ##  This method is chainable.
             ##
             return @
 
+
+        ###*
+        #   Collect and return all data needed to expand the handlebars `@template` with
+        #
+        #   @method         renderData
+        #   @protected
+        #
+        #   @return         {Object}
+        #
+        ###
+
+        renderData: () ->
+
+            return {}
+
 )