-
Notifications
You must be signed in to change notification settings - Fork 6
/
template.go
260 lines (230 loc) · 5.67 KB
/
template.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
// Copyright 2020 ConsenSys AG
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package bavard
import (
"bufio"
"bytes"
"fmt"
"io/ioutil"
"os"
"os/exec"
"path/filepath"
"strings"
"text/template"
)
type Bavard struct {
verbose bool
fmt bool
imports bool
packageName string
packageDoc string
license string
generated string
buildTag string
funcs template.FuncMap
}
func Generate(output string, templates []string, data interface{}, options ...func(*Bavard) error) error {
var bavard Bavard
// default settings
bavard.imports = true
bavard.fmt = true
bavard.verbose = true
bavard.generated = "bavard"
// handle options
for _, option := range options {
if err := option(&bavard); err != nil {
return err
}
}
// create output file
file, err := os.Create(output)
if err != nil {
return err
}
if bavard.verbose {
fmt.Printf("generating %-70s\n", output)
}
if bavard.buildTag != "" {
if _, err := file.WriteString("// +build " + bavard.buildTag + "\n"); err != nil {
return err
}
}
if bavard.license != "" {
if _, err := file.WriteString(bavard.license + "\n"); err != nil {
return err
}
}
if _, err := file.WriteString(fmt.Sprintf("// Code generated by %s DO NOT EDIT\n\n", bavard.generated)); err != nil {
return err
}
if bavard.packageName != "" {
if bavard.packageDoc != "" {
if _, err := file.WriteString("// Package " + bavard.packageName + " "); err != nil {
return err
}
if _, err := file.WriteString(bavard.packageDoc + "\n"); err != nil {
return err
}
}
if _, err := file.WriteString("package " + bavard.packageName + "\n\n"); err != nil {
return err
}
}
// parse templates
fnHelpers := helpers()
for k, v := range bavard.funcs {
fnHelpers[k] = v
}
tmpl := template.Must(template.New("").
Funcs(fnHelpers).
Parse(aggregate(templates)))
// execute template
if err = tmpl.Execute(file, data); err != nil {
file.Close()
return err
}
file.Close()
// format generated code
if bavard.fmt {
switch filepath.Ext(output) {
case ".go":
if err := exec.Command("gofmt", "-s", "-w", output).Run(); err != nil {
return err
}
case ".s":
// a quick and dirty formatter, not even in place
// 1- create result buffer
var result bytes.Buffer
// 2- open file
file, err := os.Open(output)
if err != nil {
return err
}
scanner := bufio.NewScanner(file)
prevLine := false
for scanner.Scan() {
line := strings.TrimSpace(scanner.Text())
isJump := line == ""
if (isJump && !prevLine) || !isJump {
result.WriteString(line)
result.WriteByte('\n')
}
if strings.HasPrefix(line, "TEXT ") {
break
}
prevLine = isJump
}
prevLine = false
for scanner.Scan() {
line := strings.TrimSpace(scanner.Text())
isJump := line == ""
if (isJump && !prevLine) || !isJump {
result.WriteString(" " + line)
result.WriteByte('\n')
}
prevLine = isJump
}
if err := scanner.Err(); err != nil {
file.Close()
return err
}
file.Close()
err = ioutil.WriteFile(output, result.Bytes(), 0644)
if err != nil {
return err
}
}
}
// run goimports on generated code
if bavard.imports {
if err := exec.Command("goimports", "-w", output).Run(); err != nil {
return err
}
}
return nil
}
func aggregate(values []string) string {
var sb strings.Builder
for _, v := range values {
sb.WriteString(v)
}
return sb.String()
}
// TODO add opt to add FuncMap
func Apache2(copyrightHolder string, year int) func(*Bavard) error {
return func(bavard *Bavard) error {
apache2 := `
// Copyright %d %s
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
`
bavard.license = fmt.Sprintf(apache2, year, copyrightHolder)
return nil
}
}
func GeneratedBy(label string) func(*Bavard) error {
return func(bavard *Bavard) error {
bavard.generated = label
return nil
}
}
func BuildTag(buildTag string) func(*Bavard) error {
return func(bavard *Bavard) error {
bavard.buildTag = buildTag
return nil
}
}
func Package(name string, doc ...string) func(*Bavard) error {
return func(bavard *Bavard) error {
bavard.packageName = name
if len(doc) > 0 {
bavard.packageDoc = doc[0]
}
return nil
}
}
func Verbose(v bool) func(*Bavard) error {
return func(bavard *Bavard) error {
bavard.verbose = v
return nil
}
}
func Format(v bool) func(*Bavard) error {
return func(bavard *Bavard) error {
bavard.fmt = v
return nil
}
}
func Import(v bool) func(*Bavard) error {
return func(bavard *Bavard) error {
bavard.imports = v
return nil
}
}
func Funcs(funcs template.FuncMap) func(*Bavard) error {
return func(bavard *Bavard) error {
bavard.funcs = funcs
return nil
}
}