forked from go-fed/activity
/
generate.go
388 lines (367 loc) · 11.4 KB
/
generate.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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
// Package gen contains the libraries and algorithms used to generate the
// code for the vocab package.
package gen
import (
"bytes"
"fmt"
"github.com/writeas/activity/tools/defs"
"go/format"
"strings"
)
const (
objectName = "Object"
linkName = "Link"
ObjectTypeName = "ObjectType"
LinkTypeName = "LinkType"
typePropertyName = "type"
resolveLinkName = "resolveLink"
resolveObjectName = "resolveObject"
unknownValueDeserializeFnName = "unknownValueDeserialize"
unknownValueSerializeFnName = "unknownValueSerialize"
)
type File struct {
Name string
Content []byte
}
func GenerateImplementations(types []*defs.Type, properties []*defs.PropertyType, values []*defs.ValueType) (f []*File, err error) {
// Validate inputs
err = validateDomains(properties)
if err != nil {
return
}
err = validateProperties(types)
if err != nil {
return
}
err = validateValues(values, properties)
if err != nil {
return
}
p := generatePackageDefinition()
p.Defs = append(p.Defs, generateUnknownType())
// Add ValueType serialize & deserialize functions
for _, v := range values {
p.F = append(p.F, v.DeserializeFn, v.SerializeFn)
}
p.F = append(p.F, defs.IRIFuncs()...)
p.F = append(p.F, generateHasTypeFuncs(types)...)
p.I = append(p.I, generateTyperInterface())
// Add functions to resolve string 'name' into concrete types
p.F = append(p.F, generateResolveObjectFunction(types))
p.F = append(p.F, generateResolveLinkFunction(types))
unknown := generateUnknownValueType()
p.F = append(p.F, unknown.DeserializeFn, unknown.SerializeFn)
var b []byte
b, err = format.Source([]byte(p.Generate()))
if err != nil {
return
}
f = append(f, &File{
Name: "gen_vocab.go",
Content: b,
})
// ActivityStream Types
m := make(map[*defs.PropertyType]*intermedDef)
for _, t := range types {
p := &defs.PackageDef{
Name: "vocab",
}
funcs, defs, interfaces, imports := generateDefinitions(t, m)
for i, _ := range imports {
p.Imports = append(p.Imports, i)
}
p.F = append(p.F, funcs...)
p.Defs = append(p.Defs, defs...)
p.I = append(p.I, interfaces...)
var b []byte
b, err = format.Source([]byte(p.Generate()))
if err != nil {
return
}
f = append(f, &File{
Name: fmt.Sprintf("gen_%s.go", strings.ToLower(t.Name)),
Content: b,
})
}
// Intermediate definitions
p = &defs.PackageDef{
Name: "vocab",
Imports: []string{"fmt", "net/url", "time"},
}
for _, v := range m {
p.F = append(p.F, v.F...)
p.Defs = append(p.Defs, v.S)
}
b, err = format.Source([]byte(p.Generate()))
if err != nil {
return
}
f = append(f, &File{
Name: fmt.Sprintf("gen_intermediate.go"),
Content: b,
})
return
}
func generateTyperInterface() *defs.InterfaceDef {
return &defs.InterfaceDef{
Typename: "Typer",
Comment: "Typer supports common functions for determining an ActivityStream type",
F: []*defs.FunctionDef{
{
Name: "TypeLen",
Return: []*defs.FunctionVarDef{{Name: "l", Type: "int"}},
},
{
Name: "GetType",
Args: []*defs.FunctionVarDef{{Name: "index", Type: "int"}},
Return: []*defs.FunctionVarDef{{Name: "v", Type: "interface{}"}},
},
},
}
}
func generateHasTypeFuncs(types []*defs.Type) (f []*defs.FunctionDef) {
var activityTypes []string
for _, t := range types {
t := t
if defs.IsActivity(t) {
activityTypes = append(activityTypes, t.Name)
}
f = append(f, &defs.FunctionDef{
Name: fmt.Sprintf("HasType%s", t.Name),
Comment: fmt.Sprintf("HasType%s returns true if the Typer has a type of %s.", t.Name, t.Name),
Args: []*defs.FunctionVarDef{{Name: "t", Type: "Typer"}},
Return: []*defs.FunctionVarDef{{Name: "b", Type: "bool"}},
Body: func() string {
var b bytes.Buffer
b.WriteString("for i := 0; i < t.TypeLen(); i++ {\n")
b.WriteString("v := t.GetType(i)\n")
b.WriteString("if s, ok := v.(string); ok {\n")
b.WriteString(fmt.Sprintf("if s == \"%s\" {\n", t.Name))
b.WriteString("return true\n")
b.WriteString("}\n")
b.WriteString("}\n")
b.WriteString("}\n")
b.WriteString("return false\n")
return b.String()
},
})
}
f = append(f, &defs.FunctionDef{
Name: "IsActivityType",
Comment: "Returns true if the provided Typer is an Activity.",
Args: []*defs.FunctionVarDef{{Name: "t", Type: "Typer"}},
Return: []*defs.FunctionVarDef{{Name: "b", Type: "bool"}},
Body: func() string {
var b bytes.Buffer
b.WriteString(fmt.Sprintf("var activityTypes = []string{\"%s\"}\n", strings.Join(activityTypes, "\", \"")))
b.WriteString("hasType := make(map[string]bool, 1)\n")
b.WriteString("for i := 0; i < t.TypeLen(); i++ {\n")
b.WriteString("v := t.GetType(i)\n")
b.WriteString("if s, ok := v.(string); ok {\n")
b.WriteString("hasType[s] = true\n")
b.WriteString("}\n")
b.WriteString("}\n")
b.WriteString("for _, t := range activityTypes {\n")
b.WriteString("if hasType[t] {\n")
b.WriteString("return true\n")
b.WriteString("}\n")
b.WriteString("}\n")
b.WriteString("return false\n")
return b.String()
},
})
return
}
func generatePackageDefinition() *defs.PackageDef {
return &defs.PackageDef{
Name: "vocab",
Comment: "Package vocab provides an implementation of serializing and deserializing activity streams into native golang structs without relying on reflection. This package is code-generated from the vocabulary specification available at https://www.w3.org/TR/activitystreams-vocabulary and by design forgoes full resolution of raw JSON-LD data. However, custom extensions of the vocabulary are supported by modifying the data definitions in the generation tool and rerunning it. Do not modify this package directly.",
Imports: []string{"fmt", "time", "net/url", "regexp", "strconv", "math"},
I: []*defs.InterfaceDef{
{
Typename: "Serializer",
Comment: "Serializer implementations can serialize themselves to a generic map form.",
F: []*defs.FunctionDef{{
Name: "Serialize",
Return: []*defs.FunctionVarDef{{"m", "map[string]interface{}"}, {"e", "error"}},
}},
},
{
Typename: "Deserializer",
Comment: "Deserializer implementations can deserialize themselves from a generic map form.",
F: []*defs.FunctionDef{{
Name: "Deserialize",
Args: []*defs.FunctionVarDef{{"m", "map[string]interface{}"}},
Return: []*defs.FunctionVarDef{{"e", "error"}},
}},
},
},
}
}
func generateUnknownValueType() *defs.ValueType {
return &defs.ValueType{
Name: "Unknown Value",
DefinitionType: "interface{}",
Zero: "nil",
DeserializeFn: &defs.FunctionDef{
Name: unknownValueDeserializeFnName,
Comment: "unknownValueDeserialize transparently stores the object.",
Args: []*defs.FunctionVarDef{{"v", "interface{}"}},
Return: []*defs.FunctionVarDef{{"o", "interface{}"}},
Body: func() string {
var b bytes.Buffer
b.WriteString("o = v\n")
b.WriteString("return\n")
return b.String()
},
},
SerializeFn: &defs.FunctionDef{
Name: unknownValueSerializeFnName,
Comment: "unknownValueSerialize transparently returns the object.",
Args: []*defs.FunctionVarDef{{"v", "interface{}"}},
Return: []*defs.FunctionVarDef{{"o", "interface{}"}},
Body: func() string {
var b bytes.Buffer
b.WriteString("o = v\n")
b.WriteString("return\n")
return b.String()
},
},
}
}
func generateUnknownType() *defs.StructDef {
u := &defs.StructDef{
Typename: "Unknown",
Comment: "Unknown is an entry whose root type is unknown.",
M: []*defs.StructMember{{
Name: "u",
Type: "map[string]interface{}",
Comment: "Raw unknown, untyped values",
}},
}
u.F = append(u.F, []*defs.MemberFunctionDef{
{
Name: "Serialize",
Comment: "Serialize turns this object into a map[string]interface{}. Note that for the Unknown type, the \"type\" property is NOT populated with anything special during this process.",
P: u,
Return: []*defs.FunctionVarDef{{"m", "map[string]interface{}"}, {"err", "error"}},
Body: func() string {
var b bytes.Buffer
b.WriteString("m = t.u\n")
b.WriteString("return\n")
return b.String()
},
},
{
Name: "Deserialize",
Comment: "Deserialize populates this object from a map[string]interface{}",
P: u,
Args: []*defs.FunctionVarDef{{"m", "map[string]interface{}"}},
Return: []*defs.FunctionVarDef{{"err", "error"}},
Body: func() string {
var b bytes.Buffer
b.WriteString("t.u = m\n")
b.WriteString("return\n")
return b.String()
},
},
{
Name: "HasField",
Comment: "HasField determines whether the call to GetField is safe with the specified field",
P: u,
Args: []*defs.FunctionVarDef{{"f", "string"}},
Return: []*defs.FunctionVarDef{{"ok", "bool"}},
Body: func() string {
return "return t.u != nil && t.u[f] != nil\n"
},
},
{
Name: "GetField",
Comment: "GetField returns the unknown field value",
P: u,
Args: []*defs.FunctionVarDef{{"f", "string"}},
Return: []*defs.FunctionVarDef{{"v", "interface{}"}},
Body: func() string {
return "return t.u[f]"
},
},
{
Name: "SetField",
Comment: "SetField sets the unknown field value",
P: u,
Args: []*defs.FunctionVarDef{{"f", "string"}, {"i", "interface{}"}},
Return: []*defs.FunctionVarDef{{"this", "*" + u.Typename}},
Body: func() string {
var b bytes.Buffer
b.WriteString("if t.u == nil {\n")
b.WriteString("t.u = make(map[string]interface{})\n")
b.WriteString("}\n")
b.WriteString("t.u[f] = i\n")
b.WriteString("return t\n")
return b.String()
},
},
}...)
return u
}
func generateResolveObjectFunction(types []*defs.Type) *defs.FunctionDef {
return &defs.FunctionDef{
Name: resolveObjectName,
Comment: fmt.Sprintf("%s turns a string type that extends Object into a concrete type.", resolveObjectName),
Args: []*defs.FunctionVarDef{{"s", "string"}},
Return: []*defs.FunctionVarDef{{"i", "interface{}"}},
Body: func() string {
var b bytes.Buffer
for _, r := range types {
if isAnObjectType(r) {
b.WriteString(fmt.Sprintf("if s == \"%s\" {\n", r.Name))
b.WriteString(fmt.Sprintf("return &%s{}\n", r.Name))
b.WriteString("}\n")
}
}
b.WriteString("return nil\n")
return b.String()
},
}
}
func generateResolveLinkFunction(types []*defs.Type) *defs.FunctionDef {
return &defs.FunctionDef{
Name: resolveLinkName,
Comment: fmt.Sprintf("%s turns a string type that extends Link into a concrete type.", resolveLinkName),
Args: []*defs.FunctionVarDef{{"s", "string"}},
Return: []*defs.FunctionVarDef{{"i", "interface{}"}},
Body: func() string {
var b bytes.Buffer
for _, r := range types {
if isALinkType(r) {
b.WriteString(fmt.Sprintf("if s == \"%s\" {\n", r.Name))
b.WriteString(fmt.Sprintf("return &%s{}\n", r.Name))
b.WriteString("}\n")
}
}
b.WriteString("return nil\n")
return b.String()
},
}
}
func isAnObjectType(t *defs.Type) bool {
obj, _ := getIsAType(t)
return obj
}
func isALinkType(t *defs.Type) bool {
_, link := getIsAType(t)
return link
}
func getIsAType(t *defs.Type) (obj, link bool) {
if t.Name == objectName {
return true, false
} else if t.Name == linkName {
return false, true
}
for _, e := range t.Extends {
if obj, link = getIsAType(e); obj || link {
return
}
}
panic("Unknown root is-a-type")
}