haml_coffee_assets 1.6.2 → 1.7.0

data/README.md

@@ -32,7 +32,8 @@ Haml Coffee allows you to write inline [CoffeeScript](http://jashkenas.github.co
             %a{ :href => "/cart/item/remove/#{ item.id }" } Remove Item
 ```
 
-You can try Haml Coffee online by visiting [Haml Coffee Online](http://haml-coffee-online.herokuapp.com/).
+You can try Haml Coffee online by visiting [Haml Coffee Online](http://haml-coffee-online.herokuapp.com/) and have a
+look [the AMD example Rails app](https://github.com/netzpirat/haml_coffee_assets_amd).
 
 ## Installation
 
@@ -52,6 +53,8 @@ And require the `hamlcoffee.js` in your `app/assets/javascripts/application.js.c
 #= require hamlcoffee
 ```
 
+If you're using AMD support then you do not need to include the above helper, since it will be automatically included.
+
 This provides the default escaping and the global context functions. Read more about it in the configuration section
 below.
 
@@ -63,7 +66,26 @@ If you want to use Haml Coffee with Sinatra, please have a look at the
 
 ## Usage
 
-Haml Coffee Assets allows two different ways of generating your JavaScript templates:
+Haml Coffee Assets allows two different ways of generating your JavaScript templates, but the Haml Coffee template
+generation is preferred, since it provides more configuration options and a smoother experience.
+
+### Haml Coffee template generation
+
+* Extension: `.hamlc`
+
+If you omit the `.jst` and give your templates only a `.hamlc` extension, then Haml Coffee Assets will handle the
+JavaScript template generation. With this approach you can easily define your own namespace with a simple configuration
+and you can use the template name filter.
+
+You can place all your Haml Coffee templates in the `app/assets/javascripts/templates` directory and include all
+templates from your `app/assets/javascripts/application.js.coffee`:
+
+```coffeescript
+#= require_tree ./templates
+```
+
+Because Haml Coffee Assets provides a default template name filter, the `templates/` prefix will be automatically
+removed.
 
 ### Sprocket JST processor template generation
 
@@ -72,7 +94,7 @@ Haml Coffee Assets allows two different ways of generating your JavaScript templ
 When you give your templates the extension `.jst.hamlc`, Haml Coffee Assets will only generate the template function,
 which then in turn will be further processed by the
 [Sprocket JST processor](https://github.com/sstephenson/sprockets/blob/master/lib/sprockets/jst_processor.rb). Because
-Haml Coffee Assets will not generate the template, you can't use the template name filter and the JST namespace
+Haml Coffee Assets will not generate the template, you can't use the AMD support, template name filter and the JST namespace
 definition is more cumbersome compared to the Haml Coffee template generation.
 
 With this approach you should place all your Haml Coffee templates in the `app/assets/templates` directory and include
@@ -85,24 +107,6 @@ all templates from your `app/assets/javascripts/application.js.coffee`:
 If you would place your templates into `app/assets/javascripts/templates`, then all your JST template names would begin
 with `templates/`, which may be not what you want.
 
-### Haml Coffee template generation
-
-* Extension: `.hamlc`
-
-If you omit the `.jst` and give your templates only a `.hamlc` extension, then Haml Coffee Assets will handle the
-JavaScript template generation. With this approach you can easily define your own namespace with a simple configuration
-and you can use the template name filter.
-
-You can place all your Haml Coffee templates in the `app/assets/javascripts/templates` directory and include all
-templates from your `app/assets/javascripts/application.js.coffee`:
-
-```coffeescript
-#= require_tree ./templates
-```
-
-Because Haml Coffee Assets provides a default template name filter, the `templates/` prefix will be automatically
-removed.
-
 ## Configuration
 
 _Please note that all configuration examples will use the paths of the Haml Coffee template generation and not the
@@ -169,6 +173,18 @@ Please note, the `placement` option is only applicable if you use the `.hamlc` e
 handle the JST generation. The global `hamlcoffee` helpers must be loaded normally before making use of any
 templates due to the current template design.
 
+### Global template dependencies
+
+Haml Coffee Assets allows you to globally define the module dependencies for all templates. By default, the Haml Coffee
+Assets helper is included, but you can add your own:
+
+```ruby
+config.hamlcoffee.dependencies = { '_' => 'underscore', :hc => 'hamlcoffee_amd' }
+```
+
+If you do not include the `hamlcoffee_amd` module as `hc` in the list, then the helper methods will be included in each
+template, increasing its size. It's recommended to always have the `hamlcoffee` module included.
+
 ### Template namespace
 
 By default all Haml Coffee templates are registered under the `JST` namespace. A template
@@ -235,6 +251,8 @@ applicable if you use the `.hamlc` extension and let Haml Coffee Assets handle t
 `.jst.hamlc` extension, then Sprockets JST processor will name things accordingly (e.g., with `templates/` intact in
 this case).
 
+The template name filter is not used with AMD loader.
+
 ### Basename
 
 If you don't want to have your directory names under which your template is located to be contained in the JST name,
@@ -407,6 +425,49 @@ You can see the [default implementation](https://github.com/netzpirat/haml_coffe
 and the [Haml Coffee documentation](https://github.com/netzpirat/haml-coffee#custom-helper-function-options)
 for more information about each helper function.
 
+## Partial rendering
+
+With Haml Coffee Assets you can render partials when using plain JST approach and also with AMD support.
+
+### JST partial rendering
+
+With the traditional JST approach, all the templates are globally accessible in your defined namespace, which is `JST`
+by default. This allows you to render a template within another template like:
+
+```
+%h1 Comments for this article
+- for comment in @article.comments 
+  != JST['articles/comment'](comment)
+```
+
+### AMD partial rendering
+
+Haml Coffee parses the template source code for `require` statements and adds them to the template module dependencies.
+This allows you to require other templates like this:
+
+```Haml
+- require 'module'
+- require 'deep/nested/other'
+```
+
+Now your dependencies are available in the template, allowing you to render it with:
+
+```Haml
+!= module()
+!= other()
+```
+
+Please note that only the basename ot the template is used as module variable name.
+
+Of course you can also directly require and render a template like:
+
+```haml
+!= require("another/other")()
+```
+
+Please have a look at [the AMD example Rails app](https://github.com/netzpirat/haml_coffee_assets_amd) for a working
+example.
+
 ## Author
 
 Developed by Michael Kessler, [mksoft.ch](https://mksoft.ch).

data/lib/haml_coffee_assets/compiler.rb

@@ -23,7 +23,7 @@ module HamlCoffeeAssets
 
         runtime.call('HamlCoffeeAssets.compile', name, source, jst,
                      config.namespace, config.format, config.uglify, config.basename,
-                     config.escapeHtml, config.escapeAttributes, config.cleanValue, config.placement,
+                     config.escapeHtml, config.escapeAttributes, config.cleanValue, config.placement, config.dependencies,
                      config.customHtmlEscape, config.customCleanValue,
                      config.customPreserve, config.customFindAndPreserve,
                      config.customSurround, config.customSucceed, config.customPrecede,

data/lib/haml_coffee_assets/configuration.rb

@@ -25,6 +25,7 @@ module HamlCoffeeAssets
       self.escapeAttributes       = true
       self.cleanValue             = true
       self.placement              = 'global'
+      self.dependencies           = { :hc => 'hamlcoffee_amd' }
       self.customHtmlEscape       = 'window.HAML.escape'
       self.customCleanValue       = 'window.HAML.cleanValue'
       self.customPreserve         = 'window.HAML.preserve'
@@ -71,6 +72,10 @@ module HamlCoffeeAssets
     #
     attr_accessor :placement
 
+    # Define the global amd module dependencies
+    #
+    attr_accessor :dependencies
+
     # Custom global HTML escaping function
     #
     attr_accessor :customHtmlEscape

data/lib/haml_coffee_assets/version.rb

@@ -1,5 +1,5 @@
 # coding: UTF-8
 
 module HamlCoffeeAssets
-  VERSION = '1.6.2' unless defined?(HamlCoffeeAssets::VERSION)
+  VERSION = '1.7.0' unless defined?(HamlCoffeeAssets::VERSION)
 end

data/lib/js/haml_coffee_assets.js

@@ -21,6 +21,7 @@ var HamlCoffeeAssets = (function(){
        * @param escapeAttributes [Boolean] whether to escape HTML attributes output by default or not
        * @param cleanValue [String] the name of the function to clean the values
        * @param placement [String] where to place the function, either `global` or `amd`
+       * @param dependencies [Object] the amd module dependencies
        * @param customHtmlEscape [String] the name of the function to escape the output
        * @param customCleanValue [String] the name of the function to clean the code output
        * @param customSurround [String] the name of the function for the surround helper
@@ -32,7 +33,7 @@ var HamlCoffeeAssets = (function(){
        * @param extendScope [Boolean] extend the scope with the context
        */
       compile: function(name, source, jst, namespace, format, uglify, basename,
-                        escapeHtml, escapeAttributes, cleanValue, placement,
+                        escapeHtml, escapeAttributes, cleanValue, placement, dependencies,
                         customHtmlEscape, customCleanValue, customPreserve, customFindAndPreserve,
                         customSurround, customSucceed, customPrecede,
                         preserveTags, selfCloseTags,
@@ -46,6 +47,7 @@ var HamlCoffeeAssets = (function(){
           escapeAttributes: escapeAttributes,
           cleanValue: cleanValue,
           placement: placement,
+          dependencies: dependencies,
           customHtmlEscape: customHtmlEscape,
           customCleanValue: customCleanValue,
           customPreserve: customPreserve,
@@ -76,6 +78,9 @@ var HamlCoffeeAssets = (function(){
         }
 
         if (context !== '' && context !== false) {
+          if (placement === 'amd' && context === 'window.HAML.context') {
+              context = 'hc.context';
+          }
           template = template.replace('.call(context);', '.call(' + context + '(context));');
         }
 

data/lib/js/hamlcoffee.js

@@ -363,38 +363,43 @@ require.define("/haml-coffee.coffee", function (require, module, exports, __dirn
 
   module.exports = HamlCoffee = (function() {
 
-    HamlCoffee.VERSION = '1.6.2';
+    HamlCoffee.VERSION = '1.7.0';
 
     function HamlCoffee(options) {
-      var _base, _base10, _base2, _base3, _base4, _base5, _base6, _base7, _base8, _base9, _ref, _ref10, _ref2, _ref3, _ref4, _ref5, _ref6, _ref7, _ref8, _ref9;
+      var _base, _base10, _base11, _base2, _base3, _base4, _base5, _base6, _base7, _base8, _base9, _ref, _ref10, _ref11, _ref2, _ref3, _ref4, _ref5, _ref6, _ref7, _ref8, _ref9;
       this.options = options != null ? options : {};
       if ((_ref = (_base = this.options).placement) == null) {
         _base.placement = 'global';
       }
-      if ((_ref2 = (_base2 = this.options).escapeHtml) == null) {
-        _base2.escapeHtml = true;
+      if ((_ref2 = (_base2 = this.options).dependencies) == null) {
+        _base2.dependencies = {
+          hc: 'hamlcoffee'
+        };
+      }
+      if ((_ref3 = (_base3 = this.options).escapeHtml) == null) {
+        _base3.escapeHtml = true;
       }
-      if ((_ref3 = (_base3 = this.options).escapeAttributes) == null) {
-        _base3.escapeAttributes = true;
+      if ((_ref4 = (_base4 = this.options).escapeAttributes) == null) {
+        _base4.escapeAttributes = true;
       }
-      if ((_ref4 = (_base4 = this.options).cleanValue) == null) {
-        _base4.cleanValue = true;
+      if ((_ref5 = (_base5 = this.options).cleanValue) == null) {
+        _base5.cleanValue = true;
       }
-      if ((_ref5 = (_base5 = this.options).uglify) == null) _base5.uglify = false;
-      if ((_ref6 = (_base6 = this.options).basename) == null) {
-        _base6.basename = false;
+      if ((_ref6 = (_base6 = this.options).uglify) == null) _base6.uglify = false;
+      if ((_ref7 = (_base7 = this.options).basename) == null) {
+        _base7.basename = false;
       }
-      if ((_ref7 = (_base7 = this.options).extendScope) == null) {
-        _base7.extendScope = false;
+      if ((_ref8 = (_base8 = this.options).extendScope) == null) {
+        _base8.extendScope = false;
       }
-      if ((_ref8 = (_base8 = this.options).format) == null) {
-        _base8.format = 'html5';
+      if ((_ref9 = (_base9 = this.options).format) == null) {
+        _base9.format = 'html5';
       }
-      if ((_ref9 = (_base9 = this.options).preserveTags) == null) {
-        _base9.preserveTags = 'pre,textarea';
+      if ((_ref10 = (_base10 = this.options).preserveTags) == null) {
+        _base10.preserveTags = 'pre,textarea';
       }
-      if ((_ref10 = (_base10 = this.options).selfCloseTags) == null) {
-        _base10.selfCloseTags = 'meta,img,link,br,hr,input,area,param,col,base';
+      if ((_ref11 = (_base11 = this.options).selfCloseTags) == null) {
+        _base11.selfCloseTags = 'meta,img,link,br,hr,input,area,param,col,base';
       }
     }
 
@@ -570,17 +575,56 @@ require.define("/haml-coffee.coffee", function (require, module, exports, __dirn
       if (namespace == null) namespace = 'window.HAML';
       switch (this.options.placement) {
         case 'amd':
-          return this._render_amd();
+          return this.renderAmd();
         default:
-          return this._render_global(templateName, namespace);
+          return this.renderGlobal(templateName, namespace);
       }
     };
 
-    HamlCoffee.prototype._render_amd = function() {
-      return "define ->\n  (context) ->\n    render = ->\n      \n" + (indent(this.precompile(), 4)) + "\n    render.call(context)";
+    HamlCoffee.prototype.renderAmd = function() {
+      var m, module, modules, param, params, template, _ref, _ref2;
+      if (/^hamlcoffee/.test(this.options.dependencies['hc'])) {
+        this.options.customHtmlEscape = 'hc.escape';
+        this.options.customCleanValue = 'hc.cleanValue';
+        this.options.customPreserve = 'hc.preserve';
+        this.options.customFindAndPreserve = 'hc.findAndPreserve';
+        this.options.customSurround = 'hc.surround';
+        this.options.customSucceed = 'hc.succeed';
+        this.options.customPrecede = 'hc.precede';
+      }
+      modules = [];
+      params = [];
+      _ref = this.options.dependencies;
+      for (param in _ref) {
+        module = _ref[param];
+        modules.push(module);
+        params.push(param);
+      }
+      template = indent(this.precompile(), 4);
+      _ref2 = this.findDependencies(template);
+      for (param in _ref2) {
+        module = _ref2[param];
+        modules.push(module);
+        params.push(param);
+      }
+      if (modules.length !== 0) {
+        modules = (function() {
+          var _i, _len, _results;
+          _results = [];
+          for (_i = 0, _len = modules.length; _i < _len; _i++) {
+            m = modules[_i];
+            _results.push("'" + m + "'");
+          }
+          return _results;
+        })();
+        modules = "[" + modules + "], (" + (params.join(', ')) + ")";
+      } else {
+        modules = '';
+      }
+      return "define " + modules + " ->\n  (context) ->\n    render = ->\n      \n" + template + "\n    render.call(context)";
     };
 
-    HamlCoffee.prototype._render_global = function(templateName, namespace) {
+    HamlCoffee.prototype.renderGlobal = function(templateName, namespace) {
       var segment, segments, template, _i, _len;
       if (namespace == null) namespace = 'window.HAML';
       template = '';
@@ -618,7 +662,7 @@ require.define("/haml-coffee.coffee", function (require, module, exports, __dirn
         if (this.options.customHtmlEscape) {
           fn += "$e = " + this.options.customHtmlEscape + "\n";
         } else {
-          fn += "$e = (text, escape) ->\n  \"\#{ text }\"\n  .replace(/&/g, '&amp;')\n  .replace(/</g, '&lt;')\n  .replace(/>/g, '&gt;')\n  .replace(/\'/g, '&#39;')\n  .replace(/\"/g, '&quot;')\n";
+          fn += "$e = (text, escape) ->\n  \"\#{ text }\"\n  .replace(/&/g, '&amp;')\n  .replace(/</g, '&lt;')\n  .replace(/>/g, '&gt;')\n  .replace(/\'/g, '&#39;')\n  .replace(/\\//g, '&#47;')\n  .replace(/\"/g, '&quot;')\n";
         }
       }
       if (code.indexOf('$c') !== -1) {
@@ -767,6 +811,18 @@ require.define("/haml-coffee.coffee", function (require, module, exports, __dirn
       }
     };
 
+    HamlCoffee.prototype.findDependencies = function(code) {
+      var dependencies, match, module, name, requireRegexp;
+      requireRegexp = /require(?:\s+|\()(['"])(.+?)(\1)\)?/gm;
+      dependencies = {};
+      while (match = requireRegexp.exec(code)) {
+        module = match[2];
+        name = module.split('/').pop();
+        dependencies[name] = module;
+      }
+      return dependencies;
+    };
+
     return HamlCoffee;
 
   })();

data/vendor/assets/javascripts/hamlcoffee.js.coffee.erb

@@ -14,6 +14,7 @@ class window.HAML
       .replace(/>/g, ">")
       .replace(/"/g, """)
       .replace(/'/g, "'")
+      .replace(/\//g, "/")
 
   # HAML Coffee clean value function. Beside just
   # cleaning `null` and `undefined` values, it

data/vendor/assets/javascripts/hamlcoffee_amd.js.coffee.erb

@@ -0,0 +1,91 @@
+# HAML Coffee helper module
+#
+define ->
+
+  # HAML Coffee html escape function.
+  #
+  # @param text [String] the text to escape
+  # @return [String] the escaped text
+  #
+  escape: (text) ->
+    ("" + text)
+      .replace(/&/g, "&")
+      .replace(/</g, "&lt;")
+      .replace(/>/g, "&gt;")
+      .replace(/"/g, "&quot;")
+      .replace(/'/g, "&#39;")
+      .replace(/\//g, "&#47;")
+
+  # HAML Coffee clean value function. Beside just
+  # cleaning `null` and `undefined` values, it
+  # adds a hidden unicode marker character to
+  # boolean values, so that the render time boolean
+  # logic can distinguish between real booleans and
+  # boolean-like strings.
+  #
+  # @param text [String] the text to be cleaned
+  # @return [String] the cleaned text
+  #
+  cleanValue: (text) ->
+    switch text
+      when null, undefined then ''
+      when true, false then '\u0093' + text
+      else
+         text
+
+  # Preserve newlines in the text
+  #
+  # @param text [String] the text to preserve
+  # @return [String] the preserved text
+  #
+  preserve: (text) ->
+    text.replace /\n/g, '&#x000A;'
+
+  # Find and preserve newlines in the preserving tags
+  #
+  # @param text [String] the text to preserve
+  # @return [String] the preserved text
+  #
+  findAndPreserve: (text) ->
+    tags = '<%= HamlCoffeeAssets.config.preserveTags %>'.split(',').join('|')
+    text = text.replace ///<(#{ tags })>([^]*?)<\/\1>/// g, (str, tag, content) ->
+      "<#{ tag }>#{ <%= HamlCoffeeAssets.config.customPreserve %>(content) }</#{ tag }>"
+
+  # The surround helper surrounds the function output
+  # with the start and end string without whitespace in between.
+  #
+  # @param [String] start the text to prepend to the text
+  # @param [String] end the text to append to the text
+  # @param [Function] fn the text generating function
+  # @return [String] the surrounded text
+  #
+  surround: (start, end, fn) ->
+    start + fn.call(@)?.replace(/^\s+|\s+$/g, '') + end
+
+  # The succeed helper appends text to the function output
+  # without whitespace in between.
+  #
+  # @param [String] end the text to append to the text
+  # @param [Function] fn the text generating function
+  # @return [String] the succeeded text
+  #
+  succeed: (end, fn) ->
+    fn.call(@)?.replace(/\s+$/g, '') + end
+
+  # The precede helper prepends text to the function output
+  # without whitespace in between.
+  #
+  # @param [String] start the text to prepend to the text
+  # @param [Function] fn the text generating function
+  # @return [String] the preeceded text
+  #
+  precede: (start, fn) ->
+    start + fn.call(@)?.replace(/^\s+/g, '')
+
+  # Get the HAML template context. This merges the local
+  # and the global template context into a new context.
+  #
+  # @param locals [Object] the local template context
+  # @return [Object] the merged context
+  #
+  context: (locals) -> locals

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haml_coffee_assets
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-27 00:00:00.000000000 Z
+date: 2012-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-script
@@ -92,6 +92,7 @@ files:
 - lib/js/haml_coffee_assets.js
 - lib/js/hamlcoffee.js
 - vendor/assets/javascripts/hamlcoffee.js.coffee.erb
+- vendor/assets/javascripts/hamlcoffee_amd.js.coffee.erb
 - LICENSE
 - README.md
 homepage: https://github.com/netzpirat/haml_coffee_assets
@@ -108,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2825006732775094402
+      hash: 794208290192263430
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: