render.go

package render

import (
	"sync"

	"github.com/markbates/buffalo/render/helpers"
	"github.com/markbates/inflect"
)

// Engine used to power all defined renderers.
// This allows you to configure the system to your
// prefered settings, instead of just getting
// the defaults.
type Engine struct {
	Options
	moot *sync.Mutex
}

// New render.Engine ready to go with your Options
// and some defaults we think you might like. Engines
// have the following helpers added to them:
// https://github.com/markbates/buffalo/blob/master/render/helpers/helpers.go#L1
// https://github.com/markbates/inflect/blob/master/helpers.go#L3
func New(opts Options) *Engine {
	if opts.Helpers == nil {
		opts.Helpers = map[string]interface{}{}
	}
	h := opts.Helpers

	e := &Engine{
		Options: opts,
		moot:    &sync.Mutex{},
	}
	e.RegisterHelpers(helpers.Helpers)
	e.RegisterHelpers(inflect.Helpers)
	e.RegisterHelpers(h)
	return e
}

// RegisterHelper adds a helper to a template with the given name.
// See github.com/aymerick/raymond for more details on helpers.
/*
	e.RegisterHelper("upcase", strings.ToUpper)
*/
func (e *Engine) RegisterHelper(name string, helper interface{}) {
	e.moot.Lock()
	defer e.moot.Unlock()
	e.Helpers[name] = helper
}

// RegisterHelpers adds helpers to a template with the given name.
// See github.com/aymerick/raymond for more details on helpers.
/*
	h := map[string]interface{}{
		"upcase": strings.ToUpper,
		"downcase": strings.ToLower,
	}
	e.RegisterHelpers(h)
*/
func (e *Engine) RegisterHelpers(helpers map[string]interface{}) {
	for k, v := range helpers {
		e.RegisterHelper(k, v)
	}
}