haml_coffee_assets 0.2.6 → 0.3.0

data/README.md

@@ -1,6 +1,6 @@
 # Haml Coffee Assets [![Build Status](https://secure.travis-ci.org/netzpirat/haml_coffee_assets.png)](http://travis-ci.org/netzpirat/haml_coffee_assets)
 
-Haml Coffee Assets compiles [Haml CoffeeScript](https://github.com/9elements/haml-coffee) templates in the Rails 3.1
+Haml Coffee Assets compiles [Haml Coffee](https://github.com/9elements/haml-coffee) templates in the Rails 3.1
 asset pipeline, so you can use them as JavaScript templates in your JavaScript heavy Rails application.
 
 Tested on MRI Ruby 1.8.7, 1.9.2, 1.9.3, REE and the latest version of JRuby.
@@ -214,7 +214,7 @@ config.hamlcoffee.escapeHtml = false
 By default your code block in your Haml Coffee template will be escaped through the `HAML.escape` function that is
 provided in the `hamlcoffee.js` script.
 
-You can set another escaping function in your `config/application.rb`:
+You can set a custom escaping function in your `config/application.rb`:
 
 ```ruby
 config.hamlcoffee.customHtmlEscape = 'App.myEscape'
@@ -232,6 +232,24 @@ App.myEscape = (text) ->
     .replace(/"/g, '"')
 ```
 
+#### Custom clean value function
+
+All your evaluated CoffeeScript code will go through the clean value function. By default this simply cleans `undefined`
+and `null` values, so that they appear as empty string in your template.
+
+You can set a custom clean value function in your `config/application.rb`:
+
+```ruby
+config.hamlcoffee.customCleanValue = 'App.myCleanValue'
+```
+
+Your custom clean value function must take the value as parameter and returns the cleaned value.
+The following default implementation comes with `hamlcoffee.js`:
+
+```coffeescript
+App.myCleanValue = (value) -> if value is null or value is undefined then '' else value
+```
+
 ### Global context
 
 Haml Coffee Assets allows you to configure a global context function that gets merged into the local template context for
@@ -289,6 +307,15 @@ App.globalTemplateContext = (locals) -> _.extend({}, {
 }, locals)
 ```
 
+## Using on Heroku
+
+Using haml_coffee_assets on Heroku with Ruby on Rails 3.1 requires you to set
+
+    config.assets.initialize_on_precompile = true
+
+in your `config/environments/production.rb`. Read more about the it at the
+[Asset Pipeline Guide](http://guides.rubyonrails.org/asset_pipeline.html#precompiling-assets).
+
 ## Acknowledgement
 
 * [Jeremy Ashkenas](http://twitter.com/#!/jashkenas) for CoffeeScript, that little language that compiles into

data/lib/haml_coffee_assets/engine.rb

@@ -14,6 +14,7 @@ module HamlCoffeeAssets
         :escapeHtml       => true,
         :escapeAttributes => true,
         :customHtmlEscape => 'HAML.escape',
+        :customCleanValue => 'HAML.cleanValue',
         :context          => 'HAML.context'
     }
 
@@ -34,6 +35,7 @@ module HamlCoffeeAssets
         config.escapeHtml       = options[:escapeHtml]
         config.escapeAttributes = options[:escapeAttributes]
         config.customHtmlEscape = options[:customHtmlEscape]
+        config.customCleanValue = options[:customCleanValue]
         config.context          = options[:context]
       end
     end

data/lib/haml_coffee_assets/haml_coffee.rb

@@ -31,6 +31,11 @@ module HamlCoffeeAssets
     mattr_accessor :customHtmlEscape
     self.customHtmlEscape = 'window.HAML.escape'
 
+    # Custom global code clean value function
+    #
+    mattr_accessor :customCleanValue
+    self.customCleanValue = 'window.HAML.cleanValue'
+
     # Custom global context to merge
     #
     mattr_accessor :context
@@ -53,7 +58,7 @@ module HamlCoffeeAssets
       def compile(name, source)
         runtime.call('HamlCoffeeAssets.compile', name, source,
                      HamlCoffee.namespace, HamlCoffee.format, HamlCoffee.escapeHtml, HamlCoffee.escapeAttributes,
-                     HamlCoffee.customHtmlEscape, HamlCoffee.context)
+                     HamlCoffee.customHtmlEscape, HamlCoffee.customCleanValue, HamlCoffee.context)
       end
 
       private

data/lib/haml_coffee_assets/haml_coffee_assets.js

@@ -25,15 +25,17 @@ var HamlCoffeeAssets = (function(){
        * @param escapeHtml [Boolean] whether to escape HTML output by default or not
        * @param escapeAttributes [Boolean] whether to escape HTML attributes output by default or not
        * @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 context [String] the name of the function to merge contexts
        */
-      compile: function(name, source, namespace, format, escapeHtml, escapeAttributes, customHtmlEscape, context) {
+      compile: function(name, source, namespace, format, escapeHtml, escapeAttributes, customHtmlEscape, customCleanValue, context) {
 
         var compiler = new Compiler({
           format: format,
           escapeHtml: escapeHtml,
           escapeAttributes: escapeAttributes,
-          customHtmlEscape: customHtmlEscape
+          customHtmlEscape: customHtmlEscape,
+          customCleanValue: customCleanValue
         });
 
         compiler.parse(source);

data/lib/haml_coffee_assets/version.rb

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

data/lib/js/haml-coffee.js

@@ -578,9 +578,9 @@ require.define("/nodes/haml.js", function (require, module, exports, __dirname,
             if (identifier === '~') {
               code = p(assignment);
             } else if (identifier === '&=' || (identifier === '=' && this.escapeHtml)) {
-              code = "\#{e " + assignment + "}";
+              code = "\#{e(c(" + assignment + "))}";
             } else if (identifier === '!=' || (identifier === '=' && !this.escapeHtml)) {
-              code = "\#{" + assignment + "}";
+              code = "\#{c(" + assignment + ")}";
             }
             this.opener = this.markText("" + prefix + ">" + code);
             return this.closer = this.markText("</" + tokens.tag + ">");
@@ -708,9 +708,9 @@ require.define("/nodes/haml.js", function (require, module, exports, __dirname,
             bool = true;
           } else if (!value.match(/^("|').*\1$/)) {
             if (this.escapeAttributes) {
-              value = '\'#{ e(' + value + ') }\'';
+              value = '\'#{ e(c(' + value + ')) }\'';
             } else {
-              value = '\'#{ ' + value + ' }\'';
+              value = '\'#{ c(' + value + ') }\'';
             }
           }
           if (quoted = value.match(/^("|')(.*)\1$/)) value = quoted[2];
@@ -1191,7 +1191,7 @@ require.define("/compiler.js", function (require, module, exports, __dirname, __
           whitespace = result[1];
           expression = result[2];
           if (/^(\s)*$/.test(line)) continue;
-          while (/^%.*[{(]/.test(expression) && !/^(\s*)[.%<]/.test(lines[0]) && /(?:(\w+[\w:-]*\w?|'\w+[\w:-]*\w?'|"\w+[\w:-]*\w?")\s*=\s*("(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|[\w@.]+)|(:\w+[\w:-]*\w?|'\w+[\w:-]*\w?'|"\w+[\w:-]*\w?")\s*=>\s*("(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|[-\w@.()\[\]'"]+)|(\w+[\w:-]*\w?|'\w+[\w:-]*\w?'|'\w+[\w:-]*\w?'):\s*("(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|[-\w@.()\[\]'"]+))/.test(lines[0])) {
+          while (/^%.*[{(]/.test(expression) && !/^(\s*)[.%#<]/.test(lines[0]) && /(?:(\w+[\w:-]*\w?|'\w+[\w:-]*\w?'|"\w+[\w:-]*\w?")\s*=\s*("(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|[\w@.]+)|(:\w+[\w:-]*\w?|'\w+[\w:-]*\w?'|"\w+[\w:-]*\w?")\s*=>\s*("(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|[-\w@.()\[\]'"]+)|(\w+[\w:-]*\w?|'\w+[\w:-]*\w?'|'\w+[\w:-]*\w?'):\s*("(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|[-\w@.()\[\]'"]+))/.test(lines[0])) {
             attributes = lines.shift();
             expression += ' ' + attributes.match(/^(\s*)(.*)/)[2];
             this.line_number++;
@@ -1230,7 +1230,7 @@ require.define("/compiler.js", function (require, module, exports, __dirname, __
     };
 
     Compiler.prototype.render = function(templateName, namespace) {
-      var code, escapeFn, output, segment, segments, _i, _len;
+      var cleanFn, code, escapeFn, output, segment, segments, _i, _len;
       if (namespace == null) namespace = 'window.HAML';
       output = '';
       segments = ("" + namespace + "." + templateName).replace(/(\s|-)+/g, '_').split(/\./);
@@ -1249,12 +1249,19 @@ require.define("/compiler.js", function (require, module, exports, __dirname, __
         escapeFn = this.options.customHtmlEscape;
       } else {
         escapeFn = "" + namespace + ".htmlEscape";
-        output += escapeFn + '||= (text) ->\n  "#{ text }"\n  .replace(/&/g, \'&amp;\')\n  .replace(/</g, \'&lt;\')\n  .replace(/>/g, \'&gt;\')\n  .replace(/\'/g, \'&apos;\')\n  .replace(/\"/g, \'&quot;\')\n';
+        output += escapeFn + '||= (text, escape) ->\n  "#{ text }"\n  .replace(/&/g, \'&amp;\')\n  .replace(/</g, \'&lt;\')\n  .replace(/>/g, \'&gt;\')\n  .replace(/\'/g, \'&apos;\')\n  .replace(/\"/g, \'&quot;\')\n';
+      }
+      if (this.options.customCleanValue) {
+        cleanFn = this.options.customCleanValue;
+      } else {
+        cleanFn = "" + namespace + ".cleanValue";
+        output += cleanFn + '||= (text) -> if text is null or text is undefined then \'\' else text\n';
       }
       output += "" + namespace + "['" + templateName + "'] = (context) ->\n";
       output += "  fn = (context) ->\n";
       output += "    o = []\n";
       output += "    e = " + escapeFn + "\n";
+      output += "    c = " + cleanFn + "\n";
       code = this.createCode();
       output += "" + code + "\n";
       output += "    return o.join(\"\\n\")" + (this.cleanupWhitespace(code)) + "\n";
@@ -1284,9 +1291,9 @@ require.define("/compiler.js", function (require, module, exports, __dirname, __
               break;
             case 'insert':
               if (line.hw === 0) {
-                code.push("" + (w(line.cw)) + "o.push " + (w(line.escape) ? 'e ' : '') + line.code);
+                code.push("" + (w(line.cw)) + "o.push " + (w(line.escape) ? 'e ' : '') + "c(" + line.code + ")");
               } else {
-                code.push("" + (w(line.cw)) + "o.push " + (w(line.escape) ? 'e' : '') + " \"" + (w(line.hw - line.cw + 2)) + "\" + " + line.code);
+                code.push("" + (w(line.cw)) + "o.push " + (w(line.escape) ? 'e' : '') + " \"" + (w(line.hw - line.cw + 2)) + "\" + c(" + line.code + ")");
               }
           }
         }

data/vendor/assets/javascripts/hamlcoffee.js

@@ -17,6 +17,20 @@ window.HAML.escape || (window.HAML.escape = function(text) {
     .replace(/"/g, """);
 });
 
+/**
+ * HAML Coffee clean value function
+ *
+ * @param text [String] the text to be cleaned
+ * @return [String] the cleaned text
+ */
+window.HAML.cleanValue || (window.HAML.cleanValue = function(text) {
+  if (text === null || text === void 0) {
+    return '';
+  } else {
+    return text;
+  }
+});
+
 /**
  * HAML Coffee extend function.
  *

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haml_coffee_assets
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-23 00:00:00.000000000Z
+date: 2011-11-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70263052799780 !ruby/object:Gem::Requirement
+  requirement: &70271110267660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70263052799780
+  version_requirements: *70271110267660
 - !ruby/object:Gem::Dependency
   name: execjs
-  requirement: &70263052799040 !ruby/object:Gem::Requirement
+  requirement: &70271110266700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.2.9
   type: :runtime
   prerelease: false
-  version_requirements: *70263052799040
+  version_requirements: *70271110266700
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70263052798560 !ruby/object:Gem::Requirement
+  requirement: &70271110264040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70263052798560
+  version_requirements: *70271110264040
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70263052792700 !ruby/object:Gem::Requirement
+  requirement: &70271110263360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70263052792700
+  version_requirements: *70271110263360
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70263052791720 !ruby/object:Gem::Requirement
+  requirement: &70271110262780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.5.0
   type: :development
   prerelease: false
-  version_requirements: *70263052791720
+  version_requirements: *70271110262780
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70263052789280 !ruby/object:Gem::Requirement
+  requirement: &70271110262040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.7.3
   type: :development
   prerelease: false
-  version_requirements: *70263052789280
+  version_requirements: *70271110262040
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70263052788280 !ruby/object:Gem::Requirement
+  requirement: &70271110261360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.17.2
   type: :development
   prerelease: false
-  version_requirements: *70263052788280
+  version_requirements: *70271110261360
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70263052785760 !ruby/object:Gem::Requirement
+  requirement: &70271110260900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 0.9.6.2
   type: :development
   prerelease: false
-  version_requirements: *70263052785760
+  version_requirements: *70271110260900
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70263052785120 !ruby/object:Gem::Requirement
+  requirement: &70271110225480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,7 +109,7 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *70263052785120
+  version_requirements: *70271110225480
 description: Compile Haml CoffeeScript templates in the Rails asset pipeline.
 email:
 - michi@netzpiraten.ch
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: haml_coffee_assets
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Haml CoffeeScript templates