StringTemplate

The fastest template engine for Rails.

Ruby's String literal has such a powerful interpolation mechanism. It's almost a template engine, it's the fastest way to compose a String, and the syntax is already very well known by every Ruby programmer. Why don't we use this for the view files in our apps?

Add this line to your Rails application's Gemfile:

gem 'string_template'

And then bundle.

StringTemplate's syntax is based on Ruby's String interpolation. Plus, you can use Action View features.

Here's an example of a scaffold generated ERB template, and its string_template version.

ERB:

<p id="notice"><%= notice %></p>

<p>
  <strong>Title:</strong>
  <%= @post.title %>
</p>

<p>
  <strong>Body:</strong>
  <%= @post.body %>
</p>

<%= link_to 'Edit', "/posts/#{@post.id}/edit" %> |
<%= link_to 'Back', '/posts' %>

string_template:

<p id="notice">#{h notice }</p>

<p>
  <strong>Title:</strong>
  #{h @post.title }
</p>

<p>
  <strong>Body:</strong>
  #{h @post.body }
</p>

#{ link_to 'Edit', "/posts/#{@post.id}/edit" } |
#{ link_to 'Back', '/posts' }

Please take a look at the tests for actual examples.

By default, string_template renders view files with .string extension, e.g. app/views/posts/show.html.string

string_template does not automatically html_escape. Don't forget to explicitly call h() when interpolating possibly HTML unsafe strings, like we used to do in pre Rails 3 era.

string_template may not be the best choice as a general purpose template engine. It may sometimes be hard to express your template in a simple and maintainable code, especially when the template includes some business logic. You need to care about security. So this template engine is recommended to use only for performance hotspots. For other templates, you might better use your favorite template engine such as haml, or haml, or haml.

Following is the benchmark result showing how string_template is faster than ERB (Erubi, to be technically accurate), executed on Ruby trunk (2.6). This repo includes this actual benchmarking script so that you can try it on your machine.

% ruby benchmark.rb
Warming up --------------------------------------
                 erb   993.525  i/100ms
              string     1.911k i/100ms
Calculating -------------------------------------
                 erb    11.012k i/s -     49.676k in 4.511268s
              string    22.029k i/s -     95.529k in 4.336571s

Comparison:
              string:     22028.7 i/s
                 erb:     11011.5 i/s - 2.00x  slower

Bug reports and pull requests are welcome on GitHub at https://github.com/amatsuda/string_template.

The gem is available as open source under the terms of the MIT License.