snidely_whiplash 1.0.1 → 1.0.2

data/README.md

@@ -99,7 +99,27 @@ data = {
 var user = ich.user_template(data);
 ```
 
-The `SnidelyWhiplash` constructor can take one argument which can be used to specify the parent path for properties. For example, if you had used `SnidelyWhiplash.new('user')` in the examples above, the mustache outputs would have all been in the form `user.full_name`, `user.address`, and `user.email`. Your path can contain dots for those cases when your data is very deeply nested (for example: `SnidelyWhiplash.new('result.user')` would cause output like `{{result.user.full_name}}`, etc).
+There is only one method call that SnidelyWhiplash treats as a special case and that is `html_safe`. If any of your outputs contain `html_safe`, SnidelyWhiplash will render `{{{prop}}}` which will cause mustache to disable html escaping. For example:
+
+```erb
+<span><%= user.build_menu.html_safe %></span>
+```
+
+or
+
+```haml
+%span= user.build_menu.html_safe
+```
+
+will output:
+
+```html
+<span>{{{build_menu}}}</span>
+```
+
+The `SnidelyWhiplash` constructor can take an argument which can be used to specify the parent path for properties. For example, if you had used `SnidelyWhiplash.new('user')` in the examples above, the mustache outputs would have all been in the form `user.full_name`, `user.address`, and `user.email`. Your path can contain dots for those cases when your data is very deeply nested (for example: `SnidelyWhiplash.new('result.user')` would cause output like `{{result.user.full_name}}`, etc). The default value for this argument is `nil`.
+
+You may specify a second argument to the `SnidelyWhiplash` constructor: true to enable html escaping in mustache (this is the default), or false to disable html escaping for all outputs! You probably don't want to use this though... you're probably better off just using `html_safe` for the values that need to have html escaping disabled.
 
 ## Contributing
 

data/lib/snidely_whiplash/version.rb

@@ -1,3 +1,3 @@
 class SnidelyWhiplash
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/lib/snidely_whiplash.rb

@@ -2,16 +2,21 @@ require "snidely_whiplash/version"
 
 class SnidelyWhiplash
   
-  def initialize(path=nil)
+  def initialize(path=nil, html_escape=true)
     @path = path
+    @html_escape = html_escape
   end
   
   def to_s
-    "{{#{@path || ''}}}"
+    @html_escape ? "{{#{@path || ''}}}" : "{{{#{@path || ''}}}}"
   end
   
   def method_missing(method_sym, *args, &block)
-    SnidelyWhiplash.new(@path.nil? ? method_sym.to_s : "#{@path}.#{method_sym.to_s}")
+    if method_sym == :html_safe
+      SnidelyWhiplash.new(@path, false)
+    else
+      SnidelyWhiplash.new(@path.nil? ? method_sym.to_s : "#{@path}.#{method_sym.to_s}", @html_escape)
+    end
   end
   
   def respond_to?(method_sym, include_private=false)

data/spec/snidely_whiplash_spec.rb

@@ -14,6 +14,12 @@ describe SnidelyWhiplash do
     obj.nested.example.to_s.should eql '{{nested.example}}'
   end
   
+  it "should return a mustache-escaped string with html escaping disabled if the method calls include .html_safe" do
+    obj = SnidelyWhiplash.new
+    obj.example.html_safe.to_s.should eql '{{{example}}}'
+    obj.nested.example.html_safe.to_s.should eql '{{{nested.example}}}'
+  end
+  
   it "should allow the caller to specify a parent path" do
     obj = SnidelyWhiplash.new 'parent'
     obj.example.to_s.should eql '{{parent.example}}'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snidely_whiplash
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-14 00:00:00.000000000 Z
+date: 2013-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core