-
Notifications
You must be signed in to change notification settings - Fork 4
/
layer.go
192 lines (156 loc) · 4.67 KB
/
layer.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
package layers
import (
"github.com/go-go-golems/glazed/pkg/cmds/parameters"
"github.com/go-go-golems/glazed/pkg/helpers/list"
"github.com/spf13/cobra"
orderedmap "github.com/wk8/go-ordered-map/v2"
)
// ParameterLayer is a struct that is used by one specific functionality layer
// to group and describe all the parameter definitions that it uses.
// It also provides a location for a name, slug and description to be used in help
// pages.
//
// TODO(manuel, 2023-12-20) This is a pretty messy interface, I think it used to be a struct?
type ParameterLayer interface {
AddFlags(flag ...*parameters.ParameterDefinition)
GetParameterDefinitions() *parameters.ParameterDefinitions
InitializeParameterDefaultsFromStruct(s interface{}) error
GetName() string
GetSlug() string
GetDescription() string
GetPrefix() string
Clone() ParameterLayer
}
const DefaultSlug = "default"
type ParameterLayers struct {
*orderedmap.OrderedMap[string, ParameterLayer]
}
type ParameterLayersOption func(*ParameterLayers)
func WithLayers(layers ...ParameterLayer) ParameterLayersOption {
return func(pl *ParameterLayers) {
for _, l := range layers {
pl.Set(l.GetSlug(), l)
}
}
}
func NewParameterLayers(options ...ParameterLayersOption) *ParameterLayers {
ret := &ParameterLayers{
OrderedMap: orderedmap.New[string, ParameterLayer](),
}
for _, o := range options {
o(ret)
}
return ret
}
func (pl *ParameterLayers) Subset(slugs ...string) *ParameterLayers {
ret := NewParameterLayers()
for _, slug := range slugs {
if l, ok := pl.Get(slug); ok {
ret.Set(slug, l)
}
}
return ret
}
// ForEach iterates over each element in the ParameterLayers map and applies the given function to each key-value pair.
func (pl *ParameterLayers) ForEach(f func(key string, p ParameterLayer)) {
for v := pl.Oldest(); v != nil; v = v.Next() {
f(v.Key, v.Value)
}
}
// ForEachE applies a function to each key-value pair in the ParameterLayers, in oldest-to-newest order.
// It stops iteration and returns the first error encountered, if any.
func (pl *ParameterLayers) ForEachE(f func(key string, p ParameterLayer) error) error {
for v := pl.Oldest(); v != nil; v = v.Next() {
if err := f(v.Key, v.Value); err != nil {
return err
}
}
return nil
}
func (pl *ParameterLayers) AppendLayers(layers ...ParameterLayer) {
for _, l := range layers {
pl.Set(l.GetSlug(), l)
}
}
func (pl *ParameterLayers) PrependLayers(layers ...ParameterLayer) {
list.Reverse[ParameterLayer](layers)
for _, l := range layers {
slug := l.GetSlug()
pl.Set(slug, l)
_ = pl.MoveToFront(slug)
}
}
func (pl *ParameterLayers) Merge(p *ParameterLayers) *ParameterLayers {
p.ForEach(func(k string, v ParameterLayer) {
pl.Set(k, v.Clone())
})
return pl
}
func (pl *ParameterLayers) AsList() []ParameterLayer {
ret := make([]ParameterLayer, 0, pl.Len())
pl.ForEach(func(_ string, v ParameterLayer) {
ret = append(ret, v)
})
return ret
}
func (pl *ParameterLayers) Clone() *ParameterLayers {
ret := NewParameterLayers()
return ret.Merge(pl)
}
func (pl *ParameterLayers) GetAllParameterDefinitions() *parameters.ParameterDefinitions {
ret := parameters.NewParameterDefinitions()
pl.ForEach(func(_ string, v ParameterLayer) {
v.GetParameterDefinitions().ForEach(func(p *parameters.ParameterDefinition) {
prefix := v.GetPrefix()
ret.Set(prefix+p.Name, p)
})
})
return ret
}
func (pl *ParameterLayers) AddToCobraCommand(cmd *cobra.Command) error {
return pl.ForEachE(func(_ string, v ParameterLayer) error {
if v.(CobraParameterLayer) != nil {
err := v.(CobraParameterLayer).AddLayerToCobraCommand(cmd)
if err != nil {
return err
}
}
return nil
})
}
func (pl *ParameterLayers) InitializeFromDefaults(options ...parameters.ParseStepOption) (*ParsedLayers, error) {
ret := NewParsedLayers()
err := pl.UpdateWithDefaults(ret, options...)
if err != nil {
return nil, err
}
return ret, nil
}
func InitializeParameterLayerWithDefaults(
v ParameterLayer,
parsedLayer *ParsedLayer,
options ...parameters.ParseStepOption,
) error {
pds := v.GetParameterDefinitions()
err := pds.ForEachE(func(pd *parameters.ParameterDefinition) error {
err := pd.CheckParameterDefaultValueValidity()
if err != nil {
return err
}
if pd.Default != nil {
parsedLayer.Parameters.SetAsDefault(pd.Name, pd, *pd.Default, options...)
}
return nil
})
if err != nil {
return err
}
return nil
}
func (pl *ParameterLayers) UpdateWithDefaults(parsedLayers *ParsedLayers, options ...parameters.ParseStepOption) error {
err := pl.ForEachE(func(_ string, v ParameterLayer) error {
parsedLayer := parsedLayers.GetOrCreate(v)
return InitializeParameterLayerWithDefaults(v, parsedLayer, options...)
})
return err
}