nolate 0.0.1

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2011, Salvatore Sanfilippo <antirez at gmail dot com>
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+ *  Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+ *  Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README

@@ -0,0 +1,108 @@
+Nolate - NO LAme TEmplate system
+
+OVERVIEW
+--------
+
+Nolate is a template system similar to erb that is designed for not consuming
+some huge amount of CPU without a good reason. It is written in pure Ruby.
+Nolate is distributed under a two clause BSD license for max freedom.
+
+Templates can include code inside <%= %> that is evaluated with eval() and
+substituted to the string.
+
+Also occurrences of <%#something%> are substituted with the value of the
+hash field :something of an additional hash passed to nolate() or nlt()
+functions.
+
+IS IT SUPER FAST?
+-----------------
+
+Fast enough that a small template substitution is not measurable by the
+apache benchmark against a sample Sinatra application.
+Surprisingly this is not as common as it should be.
+
+HOW TO USE IT?
+--------------
+
+Nolate consists of just a few functions. The first is nolate() that is the core
+of the template system:
+
+    nolate("The sum is <%= 2+2 %> Also substitute <%#myfield%> ok",
+           {:myfield => 10})
+
+The array is optional, if you don't have <%#%> style substitutions you can
+simply omit it.
+
+The second function is nlt(), and is used to also handle loading the template
+from a 'views' directory. The above example can be translated using nlt()
+just creating a file 'views/index.nlt' with the following content:
+
+The sum is <%= 2+2 %> Also substitute <%#myfield%> ok
+
+Then we can use nlt() calling:
+
+    nlt("index.nlt", {:myfield => "something"})
+
+the nlt() funciton will take care to cache templates into memory.
+In order to flush this templates to force reloading just call the third and
+final provided function:
+
+    nlt_flush_templates()
+
+It is possible to pass the template name as a symbol like in:
+
+    nlt(:index)
+
+nlt will add ".nlt" at the end of the name when it is a symbol.
+
+SUPPORTED SUBSTITUTIONS
+-----------------------
+
+<%= somecode %>     Evaluates somecode and substitutes the return value.
+<% somecode %>      Evaluates somecode.
+<%#filed_name%>     Substituted the value of the specified filed of the hash
+                    passed to nolate() or nlt() as optional argument.
+
+It is possible to interleave template and Ruby code together like in the
+following example:
+
+<% (0..5).each{|x| %>
+<li><%=x%></li>
+<% } %>
+
+USING LAYOUTS
+-------------
+
+Nolate suppots the concept of layout. You can specify to use a layout using
+the following call:
+
+    nlt_set_layout(:layout)
+
+The above call specifies to use "views/layout.nlt" as template.
+
+The layout is a normal nolate template that contains somewhere a
+substitution in the form of: <%#content%>. When a layout is set what happens
+is that all the calls to nolate() or nlt() are processed, then the result
+is substituted to the layout template.
+
+The layout template can also include any other standard nolate substitution
+and code evaluation.
+
+It is possible to change layout at runtime, or to disable the layout setting
+it to nil.
+
+CONTRIBUTE
+----------
+
+Please send me pull requests: http://github.com/antirez/nolate
+
+So far thank you to:
+
+    @soveran
+    @brmichel
+    @JEG2
+    Emmanuel Oga (https://github.com/EmmanuelOga)
+    @czarneckid
+
+It is not too late...
+Salvatore

data/bench.rb

@@ -0,0 +1,40 @@
+load "lib/nolate.rb"
+
+def bench(descr, times)
+    start = Time.now.to_f
+    times.times { yield }
+    elapsed = Time.now.to_f - start
+    reqsec = times / elapsed
+    puts "#{descr.ljust(25)}: #{(reqsec).to_i.to_s.rjust(10)} requests/second"
+    $template = ""
+end
+
+TEMPLATE = <<-TEMPLATE * 3
+<html>
+<body>
+Long template with all the features Yeah!. 2 + 2 is: <%= # 2+2 = 4
+2+2
+%>
+
+<%= @x %>
+
+<% @x %>
+
+<%#periquin%>
+
+<% (1..2).each{|x| %>
+Number <%= x %>
+<% } %>
+
+</body></html>
+TEMPLATE
+
+TIMES = 30_000
+
+bench("empty template"          , TIMES) { nolate("") }
+bench("small constant template" , TIMES) { nolate("nosub") }
+bench("simple substitution"     , TIMES) { nolate("simple <%= 'sub' %>") }
+bench("hash substitution"       , TIMES) { nolate("hash sub <%#x%>") }
+bench("testview2 file template" , TIMES) { nlt(:testview2) }
+bench("big template .nlt", TIMES/5) { @x = 1; nlt(:bigtemplate, :x => 1) }
+bench("big template (#{TEMPLATE.length} bytes)", TIMES/10) { @x = 1; nolate(TEMPLATE, :x => 1) }

data/example.rb

@@ -0,0 +1,5 @@
+load 'nolate.rb'
+
+hash = {:title => "Hello World!"}
+@ivar = "Instance Variable Content"
+puts nlt(:example,hash) # Check views/example.nlt for more info

data/lib/nolate.rb

@@ -0,0 +1,127 @@
+# NOLATE, A NO LAme TEmplate system
+#
+# Please read the README file for more information
+#
+# Copyright (c) 2011, Salvatore Sanfilippo <antirez at gmail dot com>
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#  *  Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+#
+#  *  Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+def nlt_empty_binding(__sub_)
+    __sub = __sub_
+    return binding()
+end
+
+def nlt_templates
+    $nolate_templates ||= {}
+end
+
+def nlt_flush_templates
+    $nolate_templates = {}
+end
+
+def nlt_set_layout(layout)
+    $nolate_layout = layout
+end
+
+def nlt_parse(str)
+    i = -1  # I wish I had map.with_index in 1.8 :(
+    prev_was_eval = false # Previous token was an :eval?
+    str.split(/<%(.*?)%>/m).map do |s|
+        i, first_char = i + 1, s[0..0]
+        newlines = s.count("\n")
+        if i % 2 == 0
+            j = 0
+            if prev_was_eval and s != "\n" and s != "\r\n"
+                j += 1 if s[j..j] == "\r"
+                j += 1 if s[j..j] == "\n"
+            end
+            prev_was_eval = false
+            [:verb, s[j..-1].inspect, newlines]
+        elsif first_char == "="
+            prev_was_eval = false
+            [:evalo, s[1..-1], newlines]
+        elsif first_char == "#"
+            prev_was_eval = false
+            [:sub,   s[1..-1].to_sym, newlines]
+        else
+            prev_was_eval = true
+            [:eval,  s, 0]
+        end
+    end
+end
+
+def nlt_compile(template)
+    s = "__=[]; "
+    nlt_parse(template).each do |action, param, newlines|
+        case action
+            when :evalo then s << "__<<(#{param}).to_s; "
+            when :eval  then s << "#{param}; "
+            when :sub   then s << "__<< __sub[#{param.to_sym.inspect}]; "
+            when :verb  then s << "__<<#{param}; "
+        end
+        s << "\n"*newlines
+    end
+    s << "\n__.join"
+end
+
+def nlt_eval(code, sub = {}, opt = {}, file="evaluated_string")
+    # Make sure that nested calls will not substitute the layout
+    saved = @nolate_no_layout
+    @nolate_no_layout = true
+    content = eval(code, nlt_empty_binding(sub), file, 1)
+    @nolate_no_layout = saved
+
+    # And... make sure that the layout will not trigger an infinite recursion
+    # substituting itself forever.
+    if $nolate_layout and !@nolate_no_layout and !(opt[:layout] == false)
+        saved = $nolate_layout
+        if !opt[:layout]
+            use = $nolate_layout
+        else
+            use = opt[:layout]
+        end
+        $nolate_layout = nil
+        content = nlt(use,{:content => content})
+        $nolate_layout = saved
+    end
+    content
+end
+
+def nlt(viewname, sub={}, opt={})
+    viewname = "#{viewname}.nlt" if viewname.is_a?(Symbol)
+    unless nlt_templates[viewname]
+        filename = "views/#{viewname}"
+        raise "NOLATE error: no template at #{filename}" \
+            unless File.exists?(filename)
+        nlt_templates[viewname] = nlt_compile(File.read(filename))
+    end
+    nlt_eval(nlt_templates[viewname], sub, opt, "views/#{viewname}")
+end
+
+def nolate(str, sub={}, opt={})
+    nlt_eval(nlt_compile(str), sub, opt)
+end

data/nolate.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+
+  s.name = %q{nolate}
+  s.version = "0.0.1"
+  s.summary = %q{Ruby Template System}
+  s.description = %q{Pure Ruby template engine optimized for speed}
+  s.authors = ["Salvatore Sanfilippo","Michel Martens","Bruno Michel","Emmanuel Oga"]
+  s.autorequire = %q{nolate}
+  s.date = %q{2011-04-05}
+  s.email = %q{antirez@gmail.com}
+  s.extra_rdoc_files = ["LICENSE"]
+  s.homepage = %q{http://github.com/antirez/nolaote}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.0}
+
+  s.files = %w{
+    LICENSE
+    README
+    bench.rb
+    example.rb
+    nolate.gemspec
+    test.rb
+    lib/nolate.rb
+    views/bigtemplate.nlt
+    views/example.nlt
+    views/layout.nlt
+    views/layout2.nlt
+    views/layout3.nlt
+    views/testview.nlt
+    views/testview2.nlt
+    views/testview3.nlt
+    views/testview4.nlt
+    views/testview5.nlt
+  }
+end

data/test.rb

@@ -0,0 +1,63 @@
+require 'test/unit'
+load 'lib/nolate.rb'
+
+class MyExampleClass
+    def method_one
+        @x = "Hello"
+        nolate("<%= @x %>")
+    end
+
+    def method_two
+        @x = "World"
+        nlt(:testview3)
+    end
+end
+
+class NolateTest < Test::Unit::TestCase
+    def test_basic
+        assert_equal("",nolate(""))
+        assert_equal("nosub",nolate("nosub"))
+        assert_equal("simple sub",nolate("simple <%= 'sub' %>"))
+        assert_equal("hash sub 1",nolate("hash sub <%#x%>",{:x => 1}))
+        assert_equal("just eval",nolate("just ev<% 'sub' %>al"))
+        assert_equal("test 4 view\n",nlt(:testview))
+        assert_equal("test 4 view\n",nlt("testview.nlt"))
+        assert_equal("<html>\n<body>\n4\n</body>\n</html>\n",nlt(:testview2))
+        assert_equal("3",nolate("<%x=2%><%=x+1%>"))
+        assert_equal("Hello",MyExampleClass.new.method_one)
+        assert_equal("World\n",MyExampleClass.new.method_two)
+    end
+
+    def test_iter
+        assert_equal(<<-OUTPUT, nlt(:testview4))
+Number 1
+Number 2
+Number 3
+Number 4
+
+OUTPUT
+    end
+
+    def test_layout
+        nlt_set_layout(:layout)
+        assert_equal("Header\n2+2=4\nFooter\n",nolate("2+2=<%= 2+2 %>"))
+        nlt_set_layout(:layout2)
+        assert_equal("Header\nciao\nnested call\nFooter\n",nolate("ciao"))
+        nlt_set_layout(:layout)
+        assert_equal("2+2=4",nolate("2+2=<%= 2+2 %>",{},{:layout => false}))
+        assert_equal("Other Header\n2+2=4\nOther Footer\n",
+                     nolate("2+2=<%= 2+2 %>",{},{:layout => :layout3}))
+    end
+
+    def test_error_lines
+        # Make sure that compiled template and template have the code in the
+        # same lines, so that eval() will report good error traces.
+        text = File.read("views/testview5.nlt").to_a
+        compiled = nlt_compile(File.read("views/testview5.nlt")).split("\n")
+        assert(text[3] =~ /title/ && compiled[3] =~ /title/)
+        assert(text[8] =~ /each/ && compiled[8] =~ /each/)
+        assert(text[22] =~ /4\+4/ && compiled[22] =~ /4\+4/)
+        assert(text[29] =~ /ivar/ && compiled[29] =~ /ivar/)
+        assert(text[36] =~ /else/ && compiled[36] =~ /else/)
+    end
+end

data/views/bigtemplate.nlt

@@ -0,0 +1,51 @@
+<html>
+<body>
+Long template with all the features Yeah!. 2 + 2 is: <%= # 2+2 = 4
+2+2
+%>
+
+<%= @x %>
+
+<% @x %>
+
+<%#periquin%>
+
+<% (1..2).each{|x| %>
+Number <%= x %>
+<% } %>
+
+</body></html>
+<html>
+<body>
+Long template with all the features Yeah!. 2 + 2 is: <%= # 2+2 = 4
+2+2
+%>
+
+<%= @x %>
+
+<% @x %>
+
+<%#periquin%>
+
+<% (1..2).each{|x| %>
+Number <%= x %>
+<% } %>
+
+</body></html>
+<html>
+<body>
+Long template with all the features Yeah!. 2 + 2 is: <%= # 2+2 = 4
+2+2
+%>
+
+<%= @x %>
+
+<% @x %>
+
+<%#periquin%>
+
+<% (1..2).each{|x| %>
+Number <%= x %>
+<% } %>
+
+</body></html>

data/views/example.nlt

@@ -0,0 +1,37 @@
+<html>
+<head>
+<title>
+Test <%#title%>
+</title>
+<body>
+
+<h1>List of items<h1>
+<% (0..5).each{|x| %>
+<li><%=x%></li>
+<% } %>
+
+<p>
+You can access the substitutions hash from Ruby code inside the template
+using the __sub variable name:
+
+:title is set to -> <%= __sub[:title].inspect %>
+</p>
+
+<p>
+Another way to pass values to the template is via instance variables that
+are accessible without any special convention:
+
+@ivar is set to <%= @ivar.inspect %>
+</p>
+
+<p>
+Example of conditional:
+<% if false %>
+Ruby is lame
+<% else %>
+Ruby is a cool programming language
+<% end %>
+</p>
+
+</body>
+</html>

data/views/layout.nlt

@@ -0,0 +1,3 @@
+Header
+<%#content%>
+Footer

data/views/layout2.nlt

@@ -0,0 +1,6 @@
+Header
+<%#content%>
+<%=
+nolate("nested call")
+%>
+Footer

data/views/layout3.nlt

@@ -0,0 +1,3 @@
+Other Header
+<%#content%>
+Other Footer

data/views/testview.nlt

@@ -0,0 +1 @@
+test <%= 2+2 %> view

data/views/testview2.nlt

@@ -0,0 +1,8 @@
+<html>
+<body>
+<%=
+# 2+2 = 4
+2+2
+%>
+</body>
+</html>

data/views/testview3.nlt

@@ -0,0 +1 @@
+<%= @x %>

data/views/testview4.nlt

@@ -0,0 +1,3 @@
+<% (1..4).each{|x| %>
+Number <%= x %>
+<% } %>

data/views/testview5.nlt

@@ -0,0 +1,43 @@
+<html>
+<head>
+<title>
+Test <%#title%>
+</title>
+<body>
+
+<h1>List of items<h1>
+<% (0..5).each{|x| %>
+<li><%=x%></li>
+<% } %>
+
+<p>
+You can access the substitutions hash from Ruby code inside the template
+using the __sub variable name:
+
+:title is set to -> <%= __sub[:title].inspect %>
+</p>
+
+<%
+# Example
+# Error
+4+4
+%>
+
+<p>
+Another way to pass values to the template is via instance variables that
+are accessible without any special convention:
+
+@ivar is set to <%= @ivar.inspect %>
+</p>
+
+<p>
+Example of conditional:
+<% if false %>
+Ruby is lame
+<% else %>
+Ruby is a cool programming language
+<% end %>
+</p>
+
+</body>
+</html>

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: nolate
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Salvatore Sanfilippo
+- Michel Martens
+- Bruno Michel
+- Emmanuel Oga
+autorequire: nolate
+bindir: bin
+cert_chain: []
+
+date: 2011-04-05 00:00:00 Z
+dependencies: []
+
+description: Pure Ruby template engine optimized for speed
+email: antirez@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+files: 
+- LICENSE
+- README
+- bench.rb
+- example.rb
+- nolate.gemspec
+- test.rb
+- lib/nolate.rb
+- views/bigtemplate.nlt
+- views/example.nlt
+- views/layout.nlt
+- views/layout2.nlt
+- views/layout3.nlt
+- views/testview.nlt
+- views/testview2.nlt
+- views/testview3.nlt
+- views/testview4.nlt
+- views/testview5.nlt
+homepage: http://github.com/antirez/nolaote
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.1
+signing_key: 
+specification_version: 2
+summary: Ruby Template System
+test_files: []
+