Skip to content

Commit be75a74

Browse files
tianontianon
committed
Deprecate most of "templatelib" in favor of Sprig
It implements many of the same functions like `first`, `last`, `ternary`, etc, some just with a different name like `toJson` vs `json`, and gives us *many* more useful functions.
1 parent 8e42901 commit be75a74

File tree

4 files changed

+39
-52
lines changed

4 files changed

+39
-52
lines changed

‎cmd/bashbrew/cmd-cat.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ func cmdCat(c *cli.Context) error {
4848
}
4949

5050
var i int
51-
tmpl, err := template.New(templateName).Funcs(templatelib.FuncMap).Funcs(template.FuncMap{
51+
tmpl, err := template.New(templateName).Funcs(templatelib.FuncMap()).Funcs(template.FuncMap{
5252
"i": func() int {
5353
return i
5454
},

‎pkg/templatelib/lib.go

+28-41
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
package templatelib
22

33
import (
4-
"encoding/json"
54
"fmt"
65
"os"
76
"reflect"
87
"strings"
98
"text/template"
9+
10+
"github.com/Masterminds/sprig/v3"
1011
)
1112

1213
func swapStringsFuncBoolArgsOrder(a func(string, string) bool) func(string, string) bool {
@@ -68,55 +69,33 @@ func stringsModifierActionFactory(a func(string, string) string) func([]string,
6869
}
6970
}
7071

71-
var FuncMap = template.FuncMap{
72-
// {{- $isGitHub := hasPrefix "https://github.com/" $url -}}
73-
// {{- $isHtml := hasSuffix ".html" $url -}}
74-
"hasPrefix": swapStringsFuncBoolArgsOrder(strings.HasPrefix),
75-
"hasSuffix": swapStringsFuncBoolArgsOrder(strings.HasSuffix),
76-
77-
// {{- $hugeIfTrue := .SomeValue | ternary "HUGE" "not so huge" -}}
78-
// if .SomeValue is truthy, $hugeIfTrue will be "HUGE"
79-
// (otherwise, "not so huge")
80-
"ternary": func(truthy interface{}, falsey interface{}, val interface{}) interface{} {
81-
if t, ok := template.IsTrue(val); !ok {
82-
panic(fmt.Sprintf(`template.IsTrue(%+v) says things are NOT OK`, val))
83-
} else if t {
84-
return truthy
85-
} else {
86-
return falsey
72+
func FuncMap() template.FuncMap {
73+
funcMap := sprig.TxtFuncMap()
74+
75+
// https://github.com/Masterminds/sprig/pull/276
76+
funcMap["ternary"] = func(vt interface{}, vf interface{}, v interface{}) interface{} {
77+
if truth, ok := template.IsTrue(v); !ok {
78+
panic(fmt.Sprintf(`template.IsTrue(%+v) says things are NOT OK`, v))
79+
} else if truth {
80+
return vt
8781
}
88-
},
82+
return vf
83+
}
8984

90-
// First Tag: {{- .Tags | first -}}
91-
// Last Tag: {{- .Tags | last -}}
92-
"first": thingsActionFactory("first", true, func(args []interface{}, arg interface{}) interface{} { return arg }),
93-
"last": thingsActionFactory("last", false, func(args []interface{}, arg interface{}) interface{} { return arg }),
85+
// Everybody: {{- join ", " .Names -}}
86+
// Concat: {{- join "/" "https://github.com" "jsmith" "some-repo" -}}
87+
funcMap["join"] = stringsActionFactory("join", true, strings.Join)
88+
// (this differs slightly from the Sprig "join" in that it accepts either a list of strings or multiple arguments - Sprig instead has an explicit "list" function which can create a list of strings *from* a list of arguments so that multiple-signature usability like this is not necessary)
9489

9590
// JSON data dump: {{ json . }}
9691
// (especially nice for taking data and piping it to "jq")
9792
// (ie "some-tool inspect --format '{{ json . }}' some-things | jq .")
98-
"json": func(v interface{}) (string, error) {
99-
j, err := json.Marshal(v)
100-
return string(j), err
101-
},
102-
103-
// Everybody: {{- join ", " .Names -}}
104-
// Concat: {{- join "/" "https://github.com" "jsmith" "some-repo" -}}
105-
"join": stringsActionFactory("join", true, strings.Join),
106-
107-
// {{- $mungedUrl := $url | replace "git://" "https://" | trimSuffixes ".git" -}}
108-
// turns: git://github.com/jsmith/some-repo.git
109-
// into: https://github.com/jsmith/some-repo
110-
"trimPrefixes": stringsActionFactory("trimPrefixes", false, stringsModifierActionFactory(strings.TrimPrefix)),
111-
"trimSuffixes": stringsActionFactory("trimSuffixes", false, stringsModifierActionFactory(strings.TrimSuffix)),
112-
"replace": stringsActionFactory("replace", false, func(strs []string, str string) string {
113-
return strings.NewReplacer(strs...).Replace(str)
114-
}),
93+
funcMap["json"] = funcMap["toJson"]
11594

11695
// {{- getenv "PATH" -}}
11796
// {{- getenv "HOME" "no HOME set" -}}
11897
// {{- getenv "HOME" "is set" "is NOT set (or is empty)" -}}
119-
"getenv": thingsActionFactory("getenv", true, func(args []interface{}, arg interface{}) interface{} {
98+
funcMap["getenv"] = thingsActionFactory("getenv", true, func(args []interface{}, arg interface{}) interface{} {
12099
var (
121100
val = os.Getenv(arg.(string))
122101
setVal interface{} = val
@@ -134,5 +113,13 @@ var FuncMap = template.FuncMap{
134113
} else {
135114
return unsetVal
136115
}
137-
}),
116+
})
117+
118+
// {{- $mungedUrl := $url | replace "git://" "https://" | trimSuffixes ".git" -}}
119+
// turns: git://github.com/jsmith/some-repo.git
120+
// into: https://github.com/jsmith/some-repo
121+
funcMap["trimPrefixes"] = stringsActionFactory("trimPrefixes", false, stringsModifierActionFactory(strings.TrimPrefix))
122+
funcMap["trimSuffixes"] = stringsActionFactory("trimSuffixes", false, stringsModifierActionFactory(strings.TrimSuffix))
123+
124+
return funcMap
138125
}

‎pkg/templatelib/lib_example_test.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import (
88
)
99

1010
func Example_prefixSuffix() {
11-
tmpl, err := template.New("github-or-html").Funcs(templatelib.FuncMap).Parse(`
11+
tmpl, err := template.New("github-or-html").Funcs(templatelib.FuncMap()).Parse(`
1212
{{- . -}}
1313
1414
{{- if hasPrefix "https://github.com/" . -}}
@@ -53,7 +53,7 @@ func Example_prefixSuffix() {
5353
}
5454

5555
func Example_ternary() {
56-
tmpl, err := template.New("huge-if-true").Funcs(templatelib.FuncMap).Parse(`
56+
tmpl, err := template.New("huge-if-true").Funcs(templatelib.FuncMap()).Parse(`
5757
{{- range $a := . -}}
5858
{{ printf "%#v: %s\n" $a (ternary "HUGE" "not so huge" $a) }}
5959
{{- end -}}
@@ -91,7 +91,7 @@ func Example_ternary() {
9191
}
9292

9393
func Example_firstLast() {
94-
tmpl, err := template.New("first-and-last").Funcs(templatelib.FuncMap).Parse(`First: {{ . | first }}, Last: {{ . | last }}`)
94+
tmpl, err := template.New("first-and-last").Funcs(templatelib.FuncMap()).Parse(`First: {{ . | first }}, Last: {{ . | last }}`)
9595

9696
err = tmpl.Execute(os.Stdout, []interface{}{
9797
"a",
@@ -107,7 +107,7 @@ func Example_firstLast() {
107107
}
108108

109109
func Example_json() {
110-
tmpl, err := template.New("json").Funcs(templatelib.FuncMap).Parse(`
110+
tmpl, err := template.New("json").Funcs(templatelib.FuncMap()).Parse(`
111111
{{- json . -}}
112112
`)
113113

@@ -125,7 +125,7 @@ func Example_json() {
125125
}
126126

127127
func Example_join() {
128-
tmpl, err := template.New("join").Funcs(templatelib.FuncMap).Parse(`
128+
tmpl, err := template.New("join").Funcs(templatelib.FuncMap()).Parse(`
129129
Array: {{ . | join ", " }}{{ "\n" -}}
130130
Args: {{ join ", " "a" "b" "c" -}}
131131
`)
@@ -145,7 +145,7 @@ func Example_join() {
145145
}
146146

147147
func Example_trimReplaceGitToHttps() {
148-
tmpl, err := template.New("git-to-https").Funcs(templatelib.FuncMap).Parse(`
148+
tmpl, err := template.New("git-to-https").Funcs(templatelib.FuncMap()).Parse(`
149149
{{- range . -}}
150150
{{- . | replace "git://" "https://" | trimSuffixes ".git" }}{{ "\n" -}}
151151
{{- end -}}
@@ -167,7 +167,7 @@ func Example_trimReplaceGitToHttps() {
167167
}
168168

169169
func Example_trimReplaceGitToGo() {
170-
tmpl, err := template.New("git-to-go").Funcs(templatelib.FuncMap).Parse(`
170+
tmpl, err := template.New("git-to-go").Funcs(templatelib.FuncMap()).Parse(`
171171
{{- range . -}}
172172
{{- . | trimPrefixes "git://" "http://" "https://" "ssh://" | trimSuffixes ".git" }}{{ "\n" -}}
173173
{{- end -}}
@@ -193,7 +193,7 @@ func Example_trimReplaceGitToGo() {
193193
}
194194

195195
func Example_getenv() {
196-
tmpl, err := template.New("getenv").Funcs(templatelib.FuncMap).Parse(`
196+
tmpl, err := template.New("getenv").Funcs(templatelib.FuncMap()).Parse(`
197197
The FOO environment variable {{ getenv "FOO" "is set" "is not set" }}. {{- "\n" -}}
198198
BAR: {{ getenv "BAR" "not set" }} {{- "\n" -}}
199199
BAZ: {{ getenv "BAZ" "not set" }} {{- "\n" -}}

‎pkg/templatelib/lib_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import (
1212
func TestTernaryPanic(t *testing.T) {
1313
// one of the only places template.IsTrue will return "false" for the "ok" value is an UnsafePointer (hence this test)
1414

15-
tmpl, err := template.New("unsafe-pointer").Funcs(templatelib.FuncMap).Parse(`{{ ternary "true" "false" . }}`)
15+
tmpl, err := template.New("unsafe-pointer").Funcs(templatelib.FuncMap()).Parse(`{{ ternary "true" "false" . }}`)
1616
if err != nil {
1717
t.Errorf("Unexpected error: %v", err)
1818
}
@@ -27,7 +27,7 @@ func TestTernaryPanic(t *testing.T) {
2727
}
2828

2929
func TestJoinPanic(t *testing.T) {
30-
tmpl, err := template.New("join-no-arg").Funcs(templatelib.FuncMap).Parse(`{{ join }}`)
30+
tmpl, err := template.New("join-no-arg").Funcs(templatelib.FuncMap()).Parse(`{{ join }}`)
3131
if err != nil {
3232
t.Errorf("Unexpected error: %v", err)
3333
}

0 commit comments

Comments
 (0)