snidely_whiplash 1.0.2 → 1.1.0

data/README.md

@@ -20,7 +20,7 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -117,9 +117,13 @@ will output:
 <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`.
+### Options
 
-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.
+The `SnidelyWhiplash` constructor can take three arguments:
+
+1. *Parent Path:* A parent path to use for mustache code. 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` which means "no parent path".
+2. *HTML Escape:* 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.
+3. *Values:* A hash of values to use for certain methods. Sometimes you don't want certain methods to output mustache code, but you'd rather have them do something server-side. This hash lets you do that. The keys of the hash correspond to the paths that SnidelyWhiplash would output normally, so nesting is possible. For example, if you wanted to use the value "Dudley Do-Right" for "model.user.name", you could use the hash: `{'user.name' => 'Dudley Do-Right'}`. The keys must be strings.
 
 ## Contributing
 

data/lib/snidely_whiplash.rb

@@ -2,9 +2,36 @@ require "snidely_whiplash/version"
 
 class SnidelyWhiplash
   
-  def initialize(path=nil, html_escape=true)
+  # Initialize SnidelyWhiplash
+  #
+  # options:
+  #   path
+  #     Specifies a parent path for the mustache output. For example, if you
+  #     set path to "user", and then used things like "model.first_name" in
+  #     your view, the resulting mustache output would be "{{user.first_name}}".
+  #     You may have dots in this path (ex: "post.user"). The default is nil,
+  #     which means that there is no parent path.
+  #   html_escape
+  #     If true (the default), the mustache output will use two curly braces,
+  #     which signifies that the output should be html escaped. If you set this
+  #     to false, the mustache output will use three curly braces, signifying
+  #     that the output should not be altered. Since this affects all mustache
+  #     outputs, you probably don't want to use this! Rather, you should use
+  #     something like "model.item.html_safe" in cases where you want to
+  #     disable html escaping.
+  #   values
+  #     Sometimes you want certain values to be interpreted server-side
+  #     instead of converted to client-side mustache code. You can use this
+  #     parameter to specify values that should be used for certain methods
+  #     server-side. The keys in this hash MUST be strings and they correspond
+  #     to the paths that SnidelyWhiplash would have output otherwise. So, for
+  #     example, if you wanted to specify a value for "model.user.name", you
+  #     could pass the following hash in as "values":
+  #       {'user.name' => 'Dudley Do-Right'}
+  def initialize(path=nil, html_escape=true, values={})
     @path = path
     @html_escape = html_escape
+    @values = values
   end
   
   def to_s
@@ -13,9 +40,11 @@ class SnidelyWhiplash
   
   def method_missing(method_sym, *args, &block)
     if method_sym == :html_safe
-      SnidelyWhiplash.new(@path, false)
+      SnidelyWhiplash.new(@path, false, @values)
     else
-      SnidelyWhiplash.new(@path.nil? ? method_sym.to_s : "#{@path}.#{method_sym.to_s}", @html_escape)
+      newpath = @path.nil? ? method_sym.to_s : "#{@path}.#{method_sym.to_s}"
+      return @values[newpath] if @values.has_key? newpath
+      SnidelyWhiplash.new(newpath, @html_escape, @values)
     end
   end
   

data/lib/snidely_whiplash/version.rb

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

data/snidely_whiplash.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Convert simple partial views into a mustache template.}
   gem.summary       = %q{Convert simple partial views into a mustache template.}
   gem.homepage      = "https://github.com/bmatcuk/snidely_whiplash"
+  gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/snidely_whiplash_spec.rb

@@ -32,4 +32,14 @@ describe SnidelyWhiplash do
     ary = [obj]
     ary.flatten.should eql [obj]
   end
+  
+  it "should use a specific value if one is passed in" do
+    obj = SnidelyWhiplash.new nil, true, 'test' => 42
+    obj.test.should eql 42
+  end
+  
+  it "should understand nesting when determining if there is a specific value to use" do
+    obj = SnidelyWhiplash.new nil, true, 'nested.test' => 42
+    obj.nested.test.should eql 42
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snidely_whiplash
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-09 00:00:00.000000000 Z
+date: 2014-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -62,7 +62,8 @@ files:
 - spec/snidely_whiplash_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bmatcuk/snidely_whiplash
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths: