Allow defining template user functions (#74)

Author: heaths

pkg/template/template.go

@@ -29,6 +29,7 @@ type Template struct {
 	tmpl         *template.Template
 	tp           tableprinter.TablePrinter
 	width        int
+	funcs        template.FuncMap
 }
 
 // New initializes a Template.
@@ -38,9 +39,21 @@ func New(w io.Writer, width int, colorEnabled bool) Template {
 		output:       w,
 		tp:           tableprinter.New(w, true, width),
 		width:        width,
+		funcs:        template.FuncMap{},
 	}
 }
 
+// Funcs adds the elements of the argument map to the template's function map.
+// It must be called before the template is parsed.
+// It is legal to overwrite elements of the map including default functions.
+// The return value is the template, so calls can be chained.
+func (t *Template) Funcs(funcMap map[string]interface{}) *Template {
+	for name, f := range funcMap {
+		t.funcs[name] = f
+	}
+	return t
+}
+
 // Parse the given template string for use with Execute.
 func (t *Template) Parse(tmpl string) error {
 	now := time.Now()
@@ -70,6 +83,9 @@ func (t *Template) Parse(tmpl string) error {
 	if !t.colorEnabled {
 		templateFuncs["autocolor"] = autoColorFunc
 	}
+	for name, f := range t.funcs {
+		templateFuncs[name] = f
+	}
 	var err error
 	t.tmpl, err = template.New("").Funcs(templateFuncs).Parse(tmpl)
 	return err

pkg/template/template_test.go

@@ -11,6 +11,7 @@ import (
 	"time"
 
 	"github.com/MakeNowJust/heredoc"
+	"github.com/cli/go-gh/pkg/text"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -39,6 +40,44 @@ func ExampleTemplate() {
 	// FOOTER
 }
 
+func ExampleTemplate_Funcs() {
+	// Information about the terminal can be obtained using the [pkg/term] package.
+	colorEnabled := true
+	termWidth := 14
+	json := strings.NewReader(heredoc.Doc(`[
+		{"num": 1, "thing": "apple"},
+		{"num": 2, "thing": "orange"}
+	]`))
+	template := "{{range .}}* {{pluralize .num .thing}}\n{{end}}"
+	tmpl := New(os.Stdout, termWidth, colorEnabled)
+	tmpl.Funcs(map[string]interface{}{
+		"pluralize": func(fields ...interface{}) (string, error) {
+			if l := len(fields); l != 2 {
+				return "", fmt.Errorf("wrong number of args for pluralize: want 2 got %d", l)
+			}
+			var ok bool
+			var num float64
+			var thing string
+			if num, ok = fields[0].(float64); !ok && num == float64(int(num)) {
+				return "", fmt.Errorf("invalid value; expected int")
+			}
+			if thing, ok = fields[1].(string); !ok {
+				return "", fmt.Errorf("invalid value; expected string")
+			}
+			return text.Pluralize(int(num), thing), nil
+		},
+	})
+	if err := tmpl.Parse(template); err != nil {
+		log.Fatal(err)
+	}
+	if err := tmpl.Execute(json); err != nil {
+		log.Fatal(err)
+	}
+	// Output:
+	// * 1 apple
+	// * 2 oranges
+}
+
 func TestJsonScalarToString(t *testing.T) {
 	tests := []struct {
 		name    string
@@ -432,3 +471,41 @@ func TestTruncateMultiline(t *testing.T) {
 		})
 	}
 }
+
+func TestFuncs(t *testing.T) {
+	w := &bytes.Buffer{}
+	tmpl := New(w, 80, false)
+
+	// Override "truncate" and define a new "foo" function.
+	tmpl.Funcs(map[string]interface{}{
+		"truncate": func(fields ...interface{}) (string, error) {
+			if l := len(fields); l != 2 {
+				return "", fmt.Errorf("wrong number of args for truncate: want 2 got %d", l)
+			}
+			var ok bool
+			var width int
+			var input string
+			if width, ok = fields[0].(int); !ok {
+				return "", fmt.Errorf("invalid value; expected int")
+			}
+			if input, ok = fields[1].(string); !ok {
+				return "", fmt.Errorf("invalid value; expected string")
+			}
+			return input[:width], nil
+		},
+		"foo": func(fields ...interface{}) (string, error) {
+			return "test", nil
+		},
+	})
+
+	err := tmpl.Parse(`{{ .text | truncate 5 }} {{ .status | color "green" }} {{ foo }}`)
+	assert.NoError(t, err)
+
+	r := strings.NewReader(`{"text":"truncated","status":"open"}`)
+	err = tmpl.Execute(r)
+	assert.NoError(t, err)
+
+	err = tmpl.Flush()
+	assert.NoError(t, err)
+	assert.Equal(t, "trunc \x1b[0;32mopen\x1b[0m test", w.String())
+}