mirror of https://github.com/mickael-menu/zk
Add a handlebars template renderer
Mickaël Menu
3 years ago
parent
3bfc0754c7
commit
76ac1d1bb1
@ -0,0 +1 @@
|
||||
Hello, {{name}}
|
||||
@ -0,0 +1 @@
|
||||
Salut, <{{name}}>!
|
||||
@ -0,0 +1,78 @@
|
||||
package handlebars
|
||||
|
||||
import (
|
||||
"html"
|
||||
"io/ioutil"
|
||||
"path/filepath"
|
||||
|
||||
"github.com/aymerick/raymond"
|
||||
"github.com/mickael-menu/zk/util/errors"
|
||||
)
|
||||
|
||||
// HandlebarsRenderer holds parsed handlebars template and renders them.
|
||||
type HandlebarsRenderer struct {
|
||||
templates map[string]*raymond.Template
|
||||
}
|
||||
|
||||
// NewRenderer creates a new instance of HandlebarsRenderer.
|
||||
func NewRenderer() *HandlebarsRenderer {
|
||||
return &HandlebarsRenderer{
|
||||
templates: make(map[string]*raymond.Template),
|
||||
}
|
||||
}
|
||||
|
||||
// Render renders a handlebars string template with the given context.
|
||||
func (hr *HandlebarsRenderer) Render(template string, context interface{}) (string, error) {
|
||||
template = html.EscapeString(template)
|
||||
res, err := raymond.Render(template, context)
|
||||
if err != nil {
|
||||
return "", errors.Wrap(err, "render template failed")
|
||||
}
|
||||
return html.UnescapeString(res), nil
|
||||
}
|
||||
|
||||
// RenderFile renders a handlebars template file with the given context.
|
||||
func (hr *HandlebarsRenderer) RenderFile(path string, context interface{}) (string, error) {
|
||||
wrap := errors.Wrapper("render template failed")
|
||||
|
||||
templ, err := hr.loadFileTemplate(path)
|
||||
if err != nil {
|
||||
return "", wrap(err)
|
||||
}
|
||||
|
||||
res, err := templ.Exec(context)
|
||||
if err != nil {
|
||||
return "", wrap(err)
|
||||
}
|
||||
|
||||
return html.UnescapeString(res), nil
|
||||
}
|
||||
|
||||
// LoadFileTemplate loads the template at given path into the renderer if needed.
|
||||
// Returns the parsed template.
|
||||
func (hr *HandlebarsRenderer) loadFileTemplate(path string) (*raymond.Template, error) {
|
||||
wrap := errors.Wrapperf("load template file failed: %v", path)
|
||||
|
||||
path, err := filepath.Abs(path)
|
||||
if err != nil {
|
||||
return nil, wrap(err)
|
||||
}
|
||||
|
||||
// Already loaded?
|
||||
templ, ok := hr.templates[path]
|
||||
if ok {
|
||||
return templ, nil
|
||||
}
|
||||
|
||||
// Load new template.
|
||||
bytes, err := ioutil.ReadFile(path)
|
||||
if err != nil {
|
||||
return nil, wrap(err)
|
||||
}
|
||||
templ, err = raymond.Parse(html.EscapeString(string(bytes)))
|
||||
if err != nil {
|
||||
return nil, wrap(err)
|
||||
}
|
||||
hr.templates[path] = templ
|
||||
return templ, nil
|
||||
}
|
||||
@ -0,0 +1,41 @@
|
||||
package handlebars
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/mickael-menu/zk/util/assert"
|
||||
"github.com/mickael-menu/zk/util/fixtures"
|
||||
)
|
||||
|
||||
func TestRenderString(t *testing.T) {
|
||||
sut := NewRenderer()
|
||||
res, err := sut.Render("Goodbye, {{name}}", map[string]string{"name": "Ed"})
|
||||
assert.Nil(t, err)
|
||||
assert.Equal(t, res, "Goodbye, Ed")
|
||||
}
|
||||
|
||||
func TestRenderFile(t *testing.T) {
|
||||
sut := NewRenderer()
|
||||
res, err := sut.RenderFile(fixtures.Path("template.txt"), map[string]string{"name": "Thom"})
|
||||
assert.Nil(t, err)
|
||||
assert.Equal(t, res, "Hello, Thom\n")
|
||||
}
|
||||
|
||||
func TestUnknownVariable(t *testing.T) {
|
||||
sut := NewRenderer()
|
||||
res, err := sut.Render("Hi, {{unknown}}!", nil)
|
||||
assert.Nil(t, err)
|
||||
assert.Equal(t, res, "Hi, !")
|
||||
}
|
||||
|
||||
func TestDoesntEscapeHTML(t *testing.T) {
|
||||
sut := NewRenderer()
|
||||
|
||||
res, err := sut.Render("Salut, <{{name}}>!", map[string]string{"name": "l'ami"})
|
||||
assert.Nil(t, err)
|
||||
assert.Equal(t, res, "Salut, <l'ami>!")
|
||||
|
||||
res, err = sut.RenderFile(fixtures.Path("unescape.txt"), map[string]string{"name": "l'ami"})
|
||||
assert.Nil(t, err)
|
||||
assert.Equal(t, res, "Salut, <l'ami>!\n")
|
||||
}
|
||||
@ -0,0 +1,15 @@
|
||||
package fixtures
|
||||
|
||||
import (
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
)
|
||||
|
||||
// Path returns the absolute path to the given fixture.
|
||||
func Path(name string) string {
|
||||
_, callerPath, _, ok := runtime.Caller(1)
|
||||
if !ok {
|
||||
panic("failed to get the caller's path")
|
||||
}
|
||||
return filepath.Join(filepath.Dir(callerPath), "fixtures", name)
|
||||
}
|
||||
Loading…
Reference in New Issue