-
Notifications
You must be signed in to change notification settings - Fork 0
/
gyaml.go
366 lines (313 loc) · 8.09 KB
/
gyaml.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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
package yaml
// Version: 24-09-2022
import (
"encoding/json"
"fmt"
"os"
"strconv"
"strings"
"github.com/goccy/go-yaml"
)
// YAML represents a complex internal YAML structure with convenient access methods,
// using dotted path syntax
type YAML struct {
data any
}
// *************************************************************
// Utility functions to parse JSON and YAML files
// *************************************************************
// ParseJson reads a JSON configuration from the given string.
func ParseJson(src string) (*YAML, error) {
return parseJson([]byte(src))
}
// ParseJsonFile reads a JSON configuration from the given filename.
func ParseJsonFile(filename string) (*YAML, error) {
src, err := os.ReadFile(filename)
if err != nil {
return nil, err
}
return parseJson(src)
}
// parseJson performs the real JSON parsing.
func parseJson(src []byte) (*YAML, error) {
var out any
var err error
if err = json.Unmarshal(src, &out); err != nil {
return nil, err
}
return &YAML{data: out}, nil
}
// ParseYamlBytes reads a YAML configuration from the given []byte.
func ParseYamlBytes(src []byte) (*YAML, error) {
return parseYaml(src)
}
// ParseYaml reads a YAML configuration from the given string.
func ParseYaml(src string) (*YAML, error) {
return parseYaml([]byte(src))
}
// ParseYamlFile reads a YAML configuration from the given filename.
func ParseYamlFile(filename string) (*YAML, error) {
src, err := os.ReadFile(filename)
if err != nil {
return nil, err
}
return parseYaml(src)
}
// parseYaml performs the real YAML parsing.
func parseYaml(src []byte) (*YAML, error) {
var out any
var err error
if err = yaml.Unmarshal(src, &out); err != nil {
return nil, err
}
return &YAML{data: out}, nil
}
func New(data any) *YAML {
return &YAML{data: data}
}
func (y *YAML) Data() any {
return y.data
}
// Get returns a nested element according to a dotted path.
func (y *YAML) Get(path string) (*YAML, error) {
n, err := Get(y.data, path)
if err != nil {
return nil, err
}
return &YAML{data: n}, nil
}
// bool returns a bool according to a dotted path.
func (y *YAML) bool(path string) (bool, error) {
n, err := Get(y.data, path)
if err != nil {
return false, err
}
switch n := n.(type) {
case bool:
return n, nil
case string:
return strconv.ParseBool(n)
}
return false, typeMismatch("bool or string", n)
}
// Bool returns a bool according to a dotted path or default value or false.
func (y *YAML) Bool(path string, defaults ...bool) bool {
value, err := y.bool(path)
if err == nil {
return value
}
for _, def := range defaults {
return def
}
return false
}
// float64 returns a float64 according to a dotted path.
func (y *YAML) float64(path string) (float64, error) {
n, err := Get(y.data, path)
if err != nil {
return 0, err
}
switch n := n.(type) {
case float64:
return n, nil
case int:
return float64(n), nil
case string:
return strconv.ParseFloat(n, 64)
}
return 0, typeMismatch("float64, int or string", n)
}
// Float64 returns a float64 according to a dotted path or default value or 0.
func (y *YAML) Float64(path string, defaults ...float64) float64 {
value, err := y.float64(path)
if err == nil {
return value
}
for _, def := range defaults {
return def
}
return float64(0)
}
// int returns an int according to a dotted path.
func (y *YAML) int(path string) (int, error) {
n, err := Get(y.data, path)
if err != nil {
return 0, err
}
switch n := n.(type) {
case float64:
// encoding/json unmarshals numbers into floats, so we compare
// the string representation to see if we can return an int.
if i := int(n); fmt.Sprint(i) == fmt.Sprint(n) {
return i, nil
} else {
return 0, fmt.Errorf("value can't be converted to int: %v", n)
}
case int:
return n, nil
case string:
if v, err := strconv.ParseInt(n, 10, 0); err == nil {
return int(v), nil
} else {
return 0, err
}
}
return 0, typeMismatch("float64, int or string", n)
}
// Int returns an int according to a dotted path or default value or 0.
func (y *YAML) Int(path string, defaults ...int) int {
value, err := y.int(path)
if err == nil {
return value
}
for _, def := range defaults {
return def
}
return 0
}
// list returns a []any according to a dotted path.
func (y *YAML) list(path string) ([]any, error) {
n, err := Get(y.data, path)
if err != nil {
return nil, err
}
if value, ok := n.([]any); ok {
return value, nil
}
return nil, typeMismatch("[]any", n)
}
// List returns a []any according to a dotted path or defaults or []any.
func (y *YAML) List(path string, defaults ...[]any) []any {
value, err := y.list(path)
if err == nil {
return value
}
for _, def := range defaults {
return def
}
return make([]any, 0)
}
// ListString is for the very common case of a list of strings
func (y *YAML) ListString(path string, defaults ...[]string) []string {
value, err := y.list(path)
if err == nil {
return ToListString(value)
}
for _, def := range defaults {
return def
}
return make([]string, 0)
}
func ToListString(in []any) []string {
out := make([]string, len(in))
for i := range in {
out[i] = (in[i]).(string)
}
return out
}
// map_strict returns a map[string]any according to a dotted path.
func (y *YAML) map_strict(path string) (map[string]any, error) {
n, err := Get(y.data, path)
if err != nil {
return nil, err
}
if value, ok := n.(map[string]any); ok {
return value, nil
}
return nil, typeMismatch("map[string]any", n)
}
// Map returns a map[string]any according to a dotted path or default or map[string]any.
func (y *YAML) Map(path string, defaults ...map[string]any) map[string]any {
value, err := y.map_strict(path)
if err == nil {
return value
}
for _, def := range defaults {
return def
}
return map[string]any{}
}
// string_strict returns a string according to a dotted path.
func (y *YAML) string_strict(path string) (string, error) {
n, err := Get(y.data, path)
if err != nil {
return "", err
}
switch n := n.(type) {
case bool, float64, int:
return fmt.Sprint(n), nil
case string:
return n, nil
}
return "", typeMismatch("bool, float64, int or string", n)
}
// String returns a string according to a dotted path or default or "".
func (y *YAML) String(path string, defaults ...string) string {
value, err := y.string_strict(path)
if err == nil {
return value
}
for _, def := range defaults {
return def
}
return ""
}
// typeMismatch returns an error for an expected type.
func typeMismatch(expected string, got any) error {
return fmt.Errorf("type mismatch: expected %s; got %T", expected, got)
}
// Get returns a child of the given value according to a dotted path.
// The source data must be either map[string]any or []any
func Get(src any, path string) (any, error) {
parts := strings.Split(path, ".")
// Quick short-circuits
if path == "" || path == "." {
return src, nil
}
if len(parts) == 1 && parts[0] == "." {
return src, nil
}
// Normalize path, for example when there are two consecutive dots
for k, v := range parts {
if v == "" {
if k == 0 {
parts = parts[1:]
} else {
return nil, fmt.Errorf("invalid path %q", path)
}
}
}
// Get the value.
for pos, pathComponent := range parts {
switch c := src.(type) {
case []any:
// If data is an array, the path component must be an integer (base 10) to index the array
i, err := strconv.ParseInt(pathComponent, 10, 0)
if err != nil {
return nil, fmt.Errorf("invalid list index at %q",
strings.Join(parts[:pos+1], "."))
}
if int(i) < len(c) {
// Update src to be teh indexed element of the array
src = c[i]
} else {
return nil, fmt.Errorf(
"index out of range at %q: list has only %v items",
strings.Join(parts[:pos+1], "."), len(c))
}
case map[string]any:
// If data is a map, try to get the corresponding element
if value, ok := c[pathComponent]; ok {
src = value
} else {
return nil, fmt.Errorf("nonexistent map key at %q",
strings.Join(parts[:pos+1], "."))
}
default:
return nil, fmt.Errorf(
"invalid type at %q: expected []any or map[string]any; got %T",
strings.Join(parts[:pos+1], "."), src)
}
}
return src, nil
}