tmplt 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c189981acda50cb7656dc65f92a09e8f6fa566de
-  data.tar.gz: 745c42a88c6c176372dbacd88c36117c1529cd3a
+  metadata.gz: 7cb3b9c8e34de70b61862ed37537f9ee4b804bba
+  data.tar.gz: cdaabb91114afd902ce1a53005f115b8c378d38b
 SHA512:
-  metadata.gz: db70c9a996ddb096dedcf2380fbff22562de6d2095d14c13facba2bbd5a984258449f9fff586dc9f8a86086eaa94fa6fb2816257ab319b71b79c740b048739d9
-  data.tar.gz: 4c29c1342b7a6dead2866124d4624c045e9fc58a6cb35a419c6ab3f73fa7effe842a6c140e47964f738d15155c125f6537ff33e016ae9c4ad3af96c36829be73
+  metadata.gz: dda371cc08c21393979d1d18b3149b65c7a562a3823a26883b734f65b79234e783e99fb47f7cdb77f895e924fb70ec3a449b172a4f60db160aac32e4049fec99
+  data.tar.gz: 07c1a06cf8432d8c5ff27e1ceee6a57e40889a1683a924437cd5b9db4ba34b459976cdeaf80a8b412b5148a6a3736129c6f14c1fedf464037df6e092d71bca8e

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Lim Yuan Qing
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,32 +1,43 @@
-# tmplt [![Gem Version](http://img.shields.io/gem/v/tmplt.svg)](https://rubygems.org/gems/tmplt) [![Build Status](https://img.shields.io/travis/yuanqing/tmplt.svg)](https://travis-ci.org/yuanqing/tmplt) [![Coverage Status](https://img.shields.io/coveralls/yuanqing/tmplt.svg)](https://coveralls.io/r/yuanqing/tmplt)
+# Tmplt.rb [![Gem Version](http://img.shields.io/gem/v/tmplt.svg?style=flat)](https://rubygems.org/gems/tmplt) [![Build Status](https://img.shields.io/travis/yuanqing/tmplt.rb.svg?style=flat)](https://travis-ci.org/yuanqing/tmplt.rb) [![Coverage Status](https://img.shields.io/coveralls/yuanqing/tmplt.rb.svg?style=flat)](https://coveralls.io/r/yuanqing/tmplt.rb)
 
-A Ruby gem for interpolating values from a hash into a template string.
+> A Ruby gem for interpolating values from a hash or array into a template string.
 
 ## Usage
 
-Straight-up substitution, nothing more:
+Straight-up substitution, nothing more. Here’s a slightly contrived example:
 
-```ruby
+```rb
 tmpl = "{{ foo }}, {{ bar.baz }}!"
 data = {
   :foo => "Hello",
-  :bar => {
-    :baz => "World"
+  :bar => "World",
+  :baz => {
+    :qux => Proc.new {|d| "#{d[:bar]}" }
   }
 }
 puts Tmplt.render(tmpl, data) #=> "Hello, World!"
 ```
 
-Full usage details are in [the tests](https://github.com/yuanqing/tmplt/blob/master/spec/tmplt_spec.rb).
+More usage examples are in [the tests](https://github.com/yuanqing/tmplt.rb/blob/master/spec/tmplt_spec.rb).
+
+## API
+
+### Tmplt.render(tmpl, data)
+
+Interpolates values from `data` into the `tmpl` string.
+
+- `tmpl` is a `string` with tags enclosed in double braces. Use a dot-delimited tag to reference nested values in `data`.
+
+- `data` can be a `hash` or `array`, with arbitrary nesting. If a `proc` in `data` is referenced in `tmpl`, it will be invoked, and its return value will be substituted into `tmpl`. The `proc` takes a single argument, namely the `data` object itself.
 
 ## Installation
 
-Via [RubyGems](https://rubygems.org/), of course:
+Install via [RubyGems](https://rubygems.org/):
 
-```
+```bash
 $ gem install tmplt
 ```
 
 ## License
 
-MIT license
+[MIT license](https://github.com/yuanqing/tmplt.rb/blob/master/LICENSE)

data/lib/tmplt.rb

@@ -3,9 +3,9 @@ class Tmplt
   class << self
 
     def render(tmpl, data)
-      raise ArgumentError unless tmpl.is_a?(String) && (data.is_a?(Hash))
+      raise ArgumentError unless tmpl.is_a?(String) && (data.is_a?(Hash) || data.is_a?(Array))
       tmpl.gsub(/{{(.+?)}}/) do
-        val = access(data, $1)
+        val = follow_path(data, $1)
         if val.is_a?(Proc)
           val = val.call(data)
         end
@@ -19,7 +19,7 @@ class Tmplt
       true if Float(obj) rescue false
     end
 
-    def access(data, keys)
+    def follow_path(data, keys)
       keys.split(".").each do |key|
         key.strip!
         if key.start_with?(":")

data/spec/tmplt_spec.rb

@@ -7,36 +7,48 @@ describe Tmplt do
     expect { Tmplt.render(1, data) }.to raise_error(ArgumentError)
   end
 
-  it "should raise an ArgumentError if data is not a hash" do
+  it "should raise an ArgumentError if data is not a hash or an array" do
+    expect { Tmplt.render("{{ foo }}", 1) }.to raise_error(ArgumentError)
+  end
+
+  it "should replace the tag with the empty string if the tag is not in the data hash or array" do
+    data = {}
+    expect(Tmplt.render("{{ foo }}", data)).to eq("")
     data = []
-    expect { Tmplt.render("{{ 0 }}", data) }.to raise_error(ArgumentError)
+    expect(Tmplt.render("{{ 0 }}", data)).to eq("")
   end
 
-  it "should replace the tag with the corresponding value in the data hash" do
-    data = { :foo => "bar" }
+  it "should allow string tag names" do
+    data = { "foo" => "bar" }
     expect(Tmplt.render("{{ foo }}", data)).to eq("bar")
     expect(Tmplt.render("{{foo}}", data)).to eq("bar")
   end
 
-  it "should be a global replace" do
-    data = { :foo => "bar" }
-    expect(Tmplt.render("{{ foo }} {{ foo }}", data)).to eq("bar bar")
+  it "should allow whitespace within the string tag name" do
+    data = { "foo bar" => "baz" }
+    expect(Tmplt.render("{{ foo bar }}", data)).to eq("baz")
+    expect(Tmplt.render("{{foo bar}}", data)).to eq("baz")
   end
 
-  it "should replace the tag with the empty string if the tag is not found in the data" do
-    data = {}
-    expect(Tmplt.render("{{ foo }}", data)).to eq("")
+  it "should allow symbol tag names" do
+    data = { :foo => "bar" }
+    expect(Tmplt.render("{{ foo }}", data)).to eq("bar")
+    expect(Tmplt.render("{{ :foo }}", data)).to eq("bar")
   end
 
   it "should allow numeric tag names" do
     data = { 0 => "foo" }
     expect(Tmplt.render("{{ 0 }}", data)).to eq("foo")
+    data = [ "foo", "bar" ]
+    expect(Tmplt.render("{{ 1 }}", data)).to eq("bar")
+    expect(Tmplt.render("{{1}}", data)).to eq("bar")
   end
 
-  it "should allow whitespace within the tag name" do
-    data = { "foo bar" => "baz" }
-    expect(Tmplt.render("{{ foo bar }}", data)).to eq("baz")
-    expect(Tmplt.render("{{foo bar}}", data)).to eq("baz")
+  it "should be a global replace" do
+    data = { :foo => "bar" }
+    expect(Tmplt.render("{{ foo }} {{ foo }}", data)).to eq("bar bar")
+    data = [ "foo", "bar" ]
+    expect(Tmplt.render("{{ 1 }} {{ 1 }}", data)).to eq("bar bar")
   end
 
   it "should match the string key and not the symbol key if the two keys have the same name" do
@@ -63,7 +75,7 @@ describe Tmplt do
     expect(Tmplt.render("{{ foo }}{{ bar }}", data)).to eq("3.14159")
   end
 
-  it "should interpolate Proc values" do
+  it "should interpolate proc values" do
     data = {
       :foo => "qux",
       :bar => "quux",
@@ -72,16 +84,18 @@ describe Tmplt do
     expect(Tmplt.render("{{ baz }}", data)).to eq("qux quux")
   end
 
-  it "should interpolate nested keys" do
+  it "should interpolate values corresponding to nested keys" do
     data = {
-      :foo => {
-        "bar baz" => {
-          :qux => "quux"
+      :foo => [
+        {
+          "bar baz" => {
+            :qux => "quux"
+          }
         }
-      }
+      ]
     }
-    expect(Tmplt.render("{{ foo.bar baz.qux }}", data)).to eql("quux")
-    expect(Tmplt.render("{{foo . bar baz . qux}}", data)).to eql("quux")
+    expect(Tmplt.render("{{ foo.0.bar baz.qux }}", data)).to eql("quux")
+    expect(Tmplt.render("{{ foo . 0 . bar baz . qux }}", data)).to eql("quux")
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tmplt
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - yuanqing
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-15 00:00:00.000000000 Z
+date: 2014-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,11 +73,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - lib/tmplt.rb
 - spec/spec_helper.rb
 - spec/tmplt_spec.rb
-homepage: https://github.com/yuanqing/tmplt
+homepage: https://github.com/yuanqing/tmplt.rb
 licenses:
 - MIT
 metadata: {}
@@ -100,7 +101,7 @@ rubyforge_project:
 rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: Interpolate values from a hash into a template string.
+summary: Interpolate values from a hash or array into a template string.
 test_files:
 - spec/spec_helper.rb
 - spec/tmplt_spec.rb