ruby-haml-js 0.0.1 → 0.0.2

data/.gitignore

@@ -1,4 +1,5 @@
 .bundle/
+Gemfile.lock
 log/*.log
 pkg/
 *.swp

data/README.md

@@ -4,7 +4,53 @@ Precompiles the HAML-JS templates into a function.
 
 This can be used as a standalone template or as part of Rails 3.1 assets pipeline.
 
-# Installation - Rails 3.1
+For example, if you have a file `app/assets/javascripts/templates/comment.jst.hamljs` with the following content:
+
+```haml
+.comment
+  .author= author
+  .text= text
+```
+
+Then it will be *compiled* on the server side into a plain JavaScript function.
+It doesn't require you to do anything on the client side.
+And the result will look like this:
+
+```javascript
+(function() {
+  this.JST || (this.JST = {});
+  this.JST["templates/comment"] = function (locals) { function html_escape(text) {
+      return (text + "").
+        replace(/&/g, "&").
+        replace(/</g, "&lt;").
+        replace(/>/g, "&gt;").
+        replace(/\"/g, "&quot;");
+    }
+  with(locals || {}) {
+    try {
+     var _$output="<div class=\"comment\"><div class=\"author\">" + 
+  html_escape(author) + 
+  "</div><div class=\"text\">" + 
+  html_escape(text) + 
+  "</div></div>";
+   return _$output;  } catch (e) {
+      return "\n<pre class='error'>" + html_escape(e.stack) + "</pre>\n";
+    }
+  }
+  };
+}).call(this);
+```
+
+Then you access that template like so:
+
+```javascript
+var commentView = JST['templates/comment'];
+// ...
+// Somewhere in your code later:
+var html = commentView({author: 'Dima', text: 'Looks nice'});
+```
+
+# Installation
 
 ```ruby
 # Gemfile
@@ -24,6 +70,21 @@ bundle
 4. Use the template from the JavaScript: `JST['my-template']({your: 'local', variables: 'go here'})`
 
 
+# Configuration
+
+## Custom HTML escape
+
+You can change the escape function from the built-in, autogenerated to your own:
+
+```ruby
+# Set it somewhere, before generating the template.
+# Good place can be a Rails initializer.
+RubyHamlJs::Template.custom_escape = "App.escape_html"
+```
+
+This will use the given function and will not generate custom escape code inside each template.
+But you need to make sure that the function is defined before using the templates in JavaScript.
+
 # Development
 
 - Source hosted at [GitHub](https://github.com/dnagir/ruby-haml-js)

data/lib/ruby-haml-js/template.rb

@@ -44,16 +44,18 @@ module RubyHamlJs
     end
 
     def js_custom_escape
-      # TODO: Figure out how to configure this
-      escape_function = nil 
+      escape_function = self.class.custom_escape
       escape_function ? "'#{js_string escape_function}'" : 'null'
     end
 
     class << self
+      attr_accessor :custom_escape
+
       def haml_source
         # Haml source is an asset
         @haml_source ||= IO.read File.expand_path('../../../vendor/assets/javascripts/haml.js', __FILE__) 
       end
+
     end
 
   end

data/lib/ruby-haml-js/version.rb

@@ -1,5 +1,5 @@
 module RubyHamlJs
   module Version
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/ruby-haml-js.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["dnagir@gmail.com"]
   s.homepage    = "http://github.com/dnagir/ruby-haml-js"
   s.summary     = %q{Precompile HAML-JS templates with or without Rails 3.1 assets pipeline}
-  s.description = %q{ruby-haml-js provides a Tilt template that you can use on the server side to compile HAML-JS templates. Handy for using it wth Bakcbone.js, Spine.js etc.}
+  s.description = %q{ruby-haml-js provides a Tilt template that you can use to compile HAML-JS templates into JS functions. Handy for using it wth Bakcbone.js, Spine.js etc.}
 
   s.rubyforge_project = "ruby-haml-js"
 

data/spec/template_spec.rb

@@ -18,6 +18,13 @@ describe RubyHamlJs::Template do
 
     it { should include "function (locals) {" }
     it { should include 'function html_escape' }
+
+    context "with custom HTML escape function" do
+      before { @original_escape = RubyHamlJs::Template.custom_escape }
+      before { RubyHamlJs::Template.custom_escape = "App.custom_escape" }
+      after  { RubyHamlJs::Template.custom_escape = @original_escape }
+      it { should include "App.custom_escape(" }
+    end
   end
 
   describe 'executing' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-haml-js
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-19 00:00:00.000000000Z
+date: 2011-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
-  requirement: &70279382272560 !ruby/object:Gem::Requirement
+  requirement: &70093427604120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70279382272560
+  version_requirements: *70093427604120
 - !ruby/object:Gem::Dependency
   name: execjs
-  requirement: &70279382271920 !ruby/object:Gem::Requirement
+  requirement: &70093427628260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70279382271920
+  version_requirements: *70093427628260
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70279382270920 !ruby/object:Gem::Requirement
+  requirement: &70093427627680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70279382270920
+  version_requirements: *70093427627680
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70279382269960 !ruby/object:Gem::Requirement
+  requirement: &70093427627020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,9 @@ dependencies:
         version: 3.1.1
   type: :development
   prerelease: false
-  version_requirements: *70279382269960
-description: ruby-haml-js provides a Tilt template that you can use on the server
-  side to compile HAML-JS templates. Handy for using it wth Bakcbone.js, Spine.js
-  etc.
+  version_requirements: *70093427627020
+description: ruby-haml-js provides a Tilt template that you can use to compile HAML-JS
+  templates into JS functions. Handy for using it wth Bakcbone.js, Spine.js etc.
 email:
 - dnagir@gmail.com
 executables: []
@@ -66,7 +65,6 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - HISTORY.md
 - MIT-LICENSE
 - README.md
@@ -129,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3891087008422554891
+      hash: 387273018365343158
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -138,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3891087008422554891
+      hash: 387273018365343158
 requirements: []
 rubyforge_project: ruby-haml-js
 rubygems_version: 1.8.10

data/Gemfile.lock

@@ -1,120 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ruby-haml-js (0.0.1)
-      execjs
-      sprockets (>= 2.0.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    actionmailer (3.1.1)
-      actionpack (= 3.1.1)
-      mail (~> 2.3.0)
-    actionpack (3.1.1)
-      activemodel (= 3.1.1)
-      activesupport (= 3.1.1)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      i18n (~> 0.6)
-      rack (~> 1.3.2)
-      rack-cache (~> 1.1)
-      rack-mount (~> 0.8.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.0.2)
-    activemodel (3.1.1)
-      activesupport (= 3.1.1)
-      builder (~> 3.0.0)
-      i18n (~> 0.6)
-    activerecord (3.1.1)
-      activemodel (= 3.1.1)
-      activesupport (= 3.1.1)
-      arel (~> 2.2.1)
-      tzinfo (~> 0.3.29)
-    activeresource (3.1.1)
-      activemodel (= 3.1.1)
-      activesupport (= 3.1.1)
-    activesupport (3.1.1)
-      multi_json (~> 1.0)
-    arel (2.2.1)
-    builder (3.0.0)
-    coderay (0.9.8)
-    diff-lcs (1.1.2)
-    erubis (2.7.0)
-    execjs (1.2.9)
-      multi_json (~> 1.0)
-    hike (1.2.1)
-    i18n (0.6.0)
-    json (1.6.1)
-    mail (2.3.0)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    method_source (0.6.0)
-      ruby_parser (>= 2.0.5)
-    mime-types (1.16)
-    multi_json (1.0.3)
-    polyglot (0.3.2)
-    pry (0.9.3)
-      coderay (>= 0.9.8)
-      method_source (>= 0.6.0)
-      ruby_parser (>= 2.0.5)
-      slop (~> 1.9.0)
-    rack (1.3.5)
-    rack-cache (1.1)
-      rack (>= 0.4)
-    rack-mount (0.8.3)
-      rack (>= 1.0.0)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    rails (3.1.1)
-      actionmailer (= 3.1.1)
-      actionpack (= 3.1.1)
-      activerecord (= 3.1.1)
-      activeresource (= 3.1.1)
-      activesupport (= 3.1.1)
-      bundler (~> 1.0)
-      railties (= 3.1.1)
-    railties (3.1.1)
-      actionpack (= 3.1.1)
-      activesupport (= 3.1.1)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (~> 0.14.6)
-    rake (0.9.2)
-    rdoc (3.10)
-      json (~> 1.4)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
-    ruby_parser (2.1.0)
-      sexp_processor (~> 3.0)
-    sexp_processor (3.0.5)
-    slop (1.9.1)
-    sprockets (2.0.3)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    thor (0.14.6)
-    tilt (1.3.3)
-    treetop (1.4.10)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.30)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  pry
-  rails (>= 3.1.1)
-  rspec
-  ruby-haml-js!