tempeh 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e662a14d9152dd7487a8b69e550d16b075886ca8
-  data.tar.gz: 50a9fb441f3823938a2f8d06b620d902b40389a3
+  metadata.gz: 17deec681294c1e4063e5d17506291cc84f0a565
+  data.tar.gz: 8a20e0ec8b46118a008db617b56e242fca4e3091
 SHA512:
-  metadata.gz: 4bfe92cdcea987941dc31ac079708b86f9c0fbf8926390fc8e92fd42b49594f0408e44a51ea8650dd21d173749c16156d47bc42c20feff2390941b69d3d4b6d3
-  data.tar.gz: deecdba9c512a409722888a1bbb464ecffe8eb9955cdd9e22bbfbc7e66a3a69e1e8751e2b241dcf706e65cd7aa217e4381cba259f1c33614889b880983675b93
+  metadata.gz: 53d84b831ce14d0155e56b84f2608af0cd3ed843a9cdb304de5bd3b4d875ec4400dff52cd32d8e80a19dae9d5291f3f1d762a4ed588de361f5c9a0a966b0cc83
+  data.tar.gz: 0e646e35b1542b1b36fdae9861b224be95eed88056767155ff72038791ccdd617a0bb6bd168582485f0ef7624e8caecece01f074499d7705222b9c38e7f2fd87

data/README.md

@@ -1,33 +1,67 @@
-Tempeh
-======
+# Tempeh
 
 Tasty Ruby Templates
 
-Description
------------
+## Description
 
 Tempeh is an opininated template engine for rendering html. It steals
-most of its ideas from Mote and also the Herb fork. That means it is a
-small layer on top of Ruby that escapes strings by default. The render API
-differs from both, as the context the template gets rendered with does not
-get "compiled" with the template, instead the context gets lazily executed
-each time when passed to `#render`.
+most of its ideas from [Mote](https://github.com/soveran/mote)
+and the [Herb](https://github.com/frodsan/herb) fork. The motivation for
+a new library is the different rendering API that is designed
+for lazily binding a context with instance_eval for use with view components.
 
-Usage
------
+## Installation
+
+`gem install tempeh`
+
+## Example
 
 ```ruby
-template = Tempeh.new("
-  % if hungry? %
-    Eat { args[:food] }!
-  % end %
-")
-
-module Steve
-  def self.hungry?
-    true # always...
+# ./templates/eat.tempeh
+#
+# % if hungry? %
+#  Eat {{ food }}!
+# % end %
+
+require 'tempeh'
+
+class View
+  include Tempeh::Helpers
+
+  def initialize(food)
+    @food = food
+  end
+
+  def food
+    @food
+  end
+
+  def hungry?
+    true
   end
 end
 
-template.render(Steve, food: 'Tempeh') # Eat Tempeh!
+View.new('Tempeh').render('./templates/eat.tempeh') # Eat Tempeh!
 ```
+
+## API
+
+### Templates
+
+`% code %`: Ruby to be evaluated but not outputted.
+
+`{{ code }}`: Ruby that gets outputted as an escaped string. Safe for user input.
+
+`{{& code }}`: Ruby that gets outputted as an unescaped string. Useful for rendering partials and other content that is guarenteed to be safe.
+
+### Module Methods
+
+`cache`: Hash of compiled templates, populated by the `render` helper.
+
+`compile`: Creates a proc from the the given string.
+
+`escape`: HTML escapes the given string.
+
+### Helpers
+
+`render`: instance_eval's a template found at a file path. Saves the compiled template in `Tempeh::cache` for reuse.

data/examples/advanced.tempeh

@@ -0,0 +1,14 @@
+% # this is a comment %
+
+% if true %
+  {{ 'hello world' }}
+% end %
+
+% # multiline blocks work as well %
+% [
+  'foo',
+  'bar',
+].each do |word| %
+  {{& word }} % # word will not be escaped %
+% end %
+

data/examples/basic.tempeh

@@ -0,0 +1 @@
+% 3.times do %{{ name }}% end %

data/extras/Tempeh.sublime-syntax

@@ -0,0 +1,38 @@
+%YAML 1.2
+---
+name: Tempeh
+file_extensions:
+  - tempeh
+scope: text.html
+contexts:
+  main:
+    - match: ''
+      push: 'scope:text.html.basic'
+      with_prototype:
+        - match: "%\\s*#"
+          push:
+            - meta_scope: comment.block
+            - match: "%"
+              pop: true
+
+        - match: "%"
+          push:
+            - meta_scope: punctuation.section.braces
+            - match: "%"
+              pop: true
+            - include: 'scope:source.ruby'
+
+        - match: "{{&"
+          push:
+            - meta_scope: punctuation.section.braces
+            - match: "}}"
+              pop: true
+            - include: 'scope:source.ruby'
+
+
+        - match: "{{"
+          push:
+            - meta_scope: punctuation.section.braces
+            - match: "}}"
+              pop: true
+            - include: 'scope:source.ruby'

data/lib/tempeh.rb

@@ -1,17 +1,22 @@
-class Tempeh
-  VERSION = "0.1.0"
+module Tempeh
+  VERSION = "0.2.0"
 
-  BLK_OPEN = '%'
+  BLK_OPEN = "%"
 
-  BLK_CLOSE = '%'
+  BLK_CLOSE = "%"
 
-  STR_OPEN = '{'
+  RAW_OPEN = "{{&"
 
-  STR_CLOSE = '}'
+  RAW_CLOSE = "}}"
+
+  STR_OPEN = "{{"
+
+  STR_CLOSE = "}}"
 
   PATTERN = /
-    (?<!\\)(#{BLK_OPEN})\s+(.*?)\s+#{BLK_CLOSE} | # Multiline Ruby blocks.
-    (?<!\\)(#{STR_OPEN})(.*?)#{STR_CLOSE}         # Ruby to be evaluated a string.
+    (?<!\\)(#{BLK_OPEN})\s+(.*?)\s+#{BLK_CLOSE} | # Multiline blocks.
+    (?<!\\)(#{RAW_OPEN})(.*?)#{RAW_CLOSE}       | # Evaluated as a string, unescaped
+    (?<!\\)(#{STR_OPEN})(.*?)#{STR_CLOSE}         # Evaluated as a string, escaped.
   /mx
 
   HTML_ESCAPE = {
@@ -19,25 +24,30 @@ class Tempeh
     ">" => "&gt;",
     "<" => "&lt;",
     '"' => "&#39;",
-    "'" => "&#34;",
+    "'" => "&#34;"
   }.freeze
 
   UNSAFE = /[&"'><]/
 
   class << self
+    def cache
+      @cache ||= {}
+    end
+
     def compile(str)
       terms = str.split(PATTERN)
-      parts = "proc do |args = {}, __o = ''|"
+      parts = "proc { __o = '';"
 
       while (term = terms.shift)
         case term
-        when BLK_OPEN then parts << terms.shift << "\n"
-        when STR_OPEN then parts << "__o << Tempeh.escape((" << terms.shift << ").to_s)\n"
-        else               parts << "__o << " << term.dump << "\n"
+        when BLK_OPEN then parts << "#{terms.shift}\n"
+        when RAW_OPEN then parts << "__o << (#{terms.shift}).to_s\n"
+        when STR_OPEN then parts << "__o << Tempeh.escape((#{terms.shift}).to_s)\n"
+        else               parts << "__o << #{term.dump}\n"
         end
       end
 
-      parts << "__o; end"
+      parts << "__o; }"
 
       eval(parts)
     end
@@ -47,11 +57,13 @@ class Tempeh
     end
   end
 
-  def initialize(str)
-    @code = Tempeh.compile(str)
-  end
+  module Helpers
+    def render(path)
+      instance_eval &tempeh_template_for(path)
+    end
 
-  def render(context = nil, **args)
-    context.instance_exec(args, &@code)
+    def tempeh_template_for(path)
+      Tempeh.cache[path] ||= Tempeh.compile(File.read(path))
+    end
   end
 end

data/test/all.rb

@@ -1,57 +1,76 @@
 require_relative '../lib/tempeh'
 
 test 'empty lines' do
-  template = Tempeh.new("\n\n \n")
+  template = Tempeh.compile("\n\n \n")
 
-  assert_equal "\n\n \n", template.render
+  assert_equal "\n\n \n", template.call
 end
 
 test 'quotes' do
-  template = Tempeh.new("'foo' 'bar' 'baz'")
+  template = Tempeh.compile("'foo' 'bar' 'baz'")
 
-  assert_equal "'foo' 'bar' 'baz'", template.render
+  assert_equal "'foo' 'bar' 'baz'", template.call
 end
 
 test 'block expressions' do
-  template = Tempeh.new("% if true %yes% else %no% end %")
+  template = Tempeh.compile("% if true %yes% else %no% end %")
 
-  assert_equal "yes", template.render
+  assert_equal "yes", template.call
 end
 
-test 'string expressions' do
-  template = Tempeh.new("{ 'Hello' }")
+test 'unescaped string expressions' do
+  template = Tempeh.compile(%q({{& %q(<>&"') }}))
 
-  assert_equal "Hello", template.render
+  assert_equal %q(<>&"'), template.call
 end
 
-test 'escapes string expressions' do
-  template = Tempeh.new(%q({ %q(<>&"') }))
+test 'escaped string expressions' do
+  template = Tempeh.compile(%q({{ %q(<>&"') }}))
 
-  assert_equal "&lt;&gt;&amp;&#39;&#34;", template.render
+  assert_equal "&lt;&gt;&amp;&#39;&#34;", template.call
 end
 
 test 'nil string expressions' do
-  template = Tempeh.new("{ nil }")
+  template = Tempeh.compile("{{ nil }}")
 
-  assert_equal "", template.render
+  assert_equal "", template.call
 end
 
 test 'allows escaping expressions' do
-  template = Tempeh.new('\{ nil }\% hello %')
+  template = Tempeh.compile('\{{ nil }}\% hello %')
 
-  assert_equal '\{ nil }\% hello %', template.render
+  assert_equal '\{{ nil }}\% hello %', template.call
 end
 
-test 'render with context' do
-  context = Struct.new(:foo).new('bar')
+test 'contextual rendering' do
+  context  = Struct.new(:foo).new('bar')
+  template = Tempeh.compile("{{ foo }}")
 
-  template = Tempeh.new("{ foo }")
+  assert_equal "bar", context.instance_eval(&template)
+end
+
+class View
+  include Tempeh::Helpers
 
-  assert_equal "bar", template.render(context)
+  def initialize(name)
+    @name = name
+  end
+
+  def name
+    @name
+  end
 end
 
-test 'render with args' do
-  template = Tempeh.new("{ args[:foo] }")
+setup do
+  View.new('steve')
+end
+
+test 'helpers' do |view|
+  path = './test/basic.tempeh'
+
+  assert Tempeh.cache[path].nil?, 'template is already cached'
+
+  assert_equal 'stevestevesteve', view.render('./examples/basic.tempeh')
 
-  assert_equal "bar", template.render(foo: "bar")
+  assert Tempeh.cache[path], 'template was not cached'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tempeh
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Steve Weiss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-02 00:00:00.000000000 Z
+date: 2017-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cutest
@@ -37,6 +37,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- examples/advanced.tempeh
+- examples/basic.tempeh
+- extras/Tempeh.sublime-syntax
 - lib/tempeh.rb
 - tempeh.gemspec
 - test/all.rb