mg-transport-core/core/template.go

package core

import (
	"html/template"

	"github.com/gin-contrib/multitemplate"
	"github.com/gobuffalo/packr/v2"
)

// Renderer wraps multitemplate.Renderer in order to make it easier to use.
type Renderer struct {
	multitemplate.Renderer
	TemplatesBox *packr.Box
	FuncMap      template.FuncMap
	alreadyAdded map[string]*template.Template
}

// NewRenderer is a Renderer constructor.
func NewRenderer(funcMap template.FuncMap) Renderer {
	return newRendererWithMultitemplate(funcMap, multitemplate.NewRenderer())
}

// NewStaticRenderer is a Renderer constructor with multitemplate.Render.
func NewStaticRenderer(funcMap template.FuncMap) Renderer {
	return newRendererWithMultitemplate(funcMap, multitemplate.New())
}

// NewDynamicRenderer is a Renderer constructor with multitemplate.DynamicRender.
func NewDynamicRenderer(funcMap template.FuncMap) Renderer {
	return newRendererWithMultitemplate(funcMap, multitemplate.NewDynamic())
}

// newRendererWithMultitemplate initializes Renderer with provided multitemplate.Renderer instance.
func newRendererWithMultitemplate(funcMap template.FuncMap, renderer multitemplate.Renderer) Renderer {
	return Renderer{
		Renderer:     renderer,
		FuncMap:      funcMap,
		alreadyAdded: map[string]*template.Template{},
	}
}

// Push is an AddFromFilesFuncs wrapper.
func (r *Renderer) Push(name string, files ...string) *template.Template {
	if tpl := r.getTemplate(name); tpl != nil {
		return tpl
	}

	if r.TemplatesBox == nil {
		return r.storeTemplate(name, r.AddFromFilesFuncs(name, r.FuncMap, files...))
	}

	return r.storeTemplate(name, r.addFromBox(name, r.FuncMap, files...))
}

// addFromBox adds embedded template.
func (r *Renderer) addFromBox(name string, funcMap template.FuncMap, files ...string) *template.Template {
	var filesData []string

	for _, file := range files {
		if data, err := r.TemplatesBox.FindString(file); err == nil {
			filesData = append(filesData, data)
		}
	}

	return r.AddFromStringsFuncs(name, funcMap, filesData...)
}

// storeTemplate stores built template if multitemplate.DynamicRender is used.
// Dynamic render doesn't store templates - it stores builders, that's why we can't just extract them.
// It possibly can cause data inconsistency in developer environments where return value from Renderer.Push is used.
func (r *Renderer) storeTemplate(name string, tpl *template.Template) *template.Template {
	if _, ok := r.Renderer.(multitemplate.DynamicRender); ok {
		r.alreadyAdded[name] = tpl
	}

	return tpl
}

// getTemplate returns template from render or from storage.
func (r *Renderer) getTemplate(name string) *template.Template {
	if renderer, ok := r.Renderer.(multitemplate.Render); ok {
		if i, ok := renderer[name]; ok {
			return i
		}
	}

	if _, ok := r.Renderer.(multitemplate.DynamicRender); ok {
		if i, ok := r.alreadyAdded[name]; ok {
			return i
		}
	}

	return nil
}