/
annotations.go
173 lines (153 loc) · 4.21 KB
/
annotations.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
package docparser
import (
"encoding/json"
"errors"
"log"
"strings"
"golang.org/x/tools/go/packages"
)
type DocData struct {
Doc string
Raw []string
Comments []string
Data map[string]interface{}
}
func (d *DocData) Parameter(varName string) (map[string]interface{}, bool) {
if params, ok := d.Data["parameters"]; ok {
params := params.([]interface{})
for _, p := range params {
param := p.(map[string]interface{})
if param["name"] == varName {
return param, true
}
}
}
return nil, false
}
func ParseDoc(pkgs []*packages.Package, doc string) (*DocData, error) {
// TODO: investigate using Go doc formatter to parse blocks of comments
// var p comment.Parser
// doc := p.Parse(doc)
// fmt.Println()
// for _, c := range doc.Content {
// switch v := c.(type) {
// case *comment.Code:
// fmt.Printf("Code block: %v\n\n", v.Text)
// case *comment.Heading:
// fmt.Printf("Heading: %v\n\n", v.Text)
// case *comment.Paragraph:
// fmt.Printf("Paragraph: %v\n\n", v.Text)
// }
// }
var doclines []string
spec := make(map[string]interface{})
lines := strings.Split(doc, "\n")
for i := 0; i < len(lines); i++ {
lines[i] = strings.TrimSpace(lines[i])
if strings.HasPrefix(lines[i], "@") {
kv := strings.SplitN(strings.TrimPrefix(lines[i], "@"), " ", 2)
kv[0], kv[1] = strings.TrimSpace(kv[0]), strings.TrimSpace(kv[1])
for ; i+1 < len(lines) && !strings.HasPrefix(lines[i+1], "@") && len(lines[i+1]) > 0; i++ {
kv[1] = kv[1] + lines[i+1]
}
err := ParseLine(pkgs, strings.TrimSpace(kv[0]), strings.TrimSpace(kv[1]), spec)
if err != nil {
return nil, err
}
} else {
doclines = append(doclines, strings.TrimSpace(lines[i]))
}
}
return &DocData{Doc: doc, Raw: lines, Comments: doclines, Data: spec}, nil
}
func ParseLine(pkgs []*packages.Package, key, value string, data map[string]interface{}) error {
switch key {
case "schemes", "consumes", "produces", "tags":
p, err := parseStringValue(value)
if err != nil {
return err
}
if pl, ok := p.([]string); ok {
data[key] = pl
} else {
if ov, ok := data[key]; ok {
data[key] = append(ov.([]string), p.(string))
} else {
data[key] = []string{p.(string)}
}
}
case "parameters":
p, err := parseValue(pkgs, value)
if err != nil {
return err
}
if pl, ok := p.([]interface{}); ok {
data[key] = pl
} else {
if ov, ok := data[key]; ok {
data[key] = append(ov.([]interface{}), p)
} else {
data[key] = []interface{}{p}
}
}
default:
keys := strings.Split(key, ".")
for i := 0; i < len(keys); i++ {
if i+1 == len(keys) {
pv, err := parseValue(pkgs, value)
if err != nil {
return err
}
if pl, ok := pv.([]interface{}); ok {
data[keys[i]] = pl
} else {
data[keys[i]] = pv
}
} else {
if ov, ok := data[keys[i]]; ok {
if ov, ok := ov.(map[string]interface{}); ok {
data = ov
} else {
return errors.New("expecting a map for key: " + key)
}
} else {
temp := make(map[string]interface{})
data[keys[i]] = temp
data = temp
}
}
}
}
return nil
}
func parseValue(pkgs []*packages.Package, value string) (interface{}, error) {
if strings.HasPrefix(value, "{") && strings.HasSuffix(value, "}") {
obj := make(map[string]interface{})
if err := json.Unmarshal([]byte(value), &obj); err != nil {
// attempt to parse struct in format `{packagename.structname}`
data, err := FindStruct(pkgs, strings.Trim(value, "{}"))
if err == nil {
return data, err
}
log.Printf("failed to parse annotation `%s`, error: %v", value, err)
}
return obj, nil
} else if strings.HasPrefix(value, "[") && strings.HasSuffix(value, "]") {
obj := make([]interface{}, 0)
if err := json.Unmarshal([]byte(value), &obj); err != nil {
log.Printf("failed to parse annotation `%s`, error: %v", value, err)
}
return obj, nil
}
return value, nil
}
func parseStringValue(value string) (interface{}, error) {
if strings.HasPrefix(value, "[") && strings.HasSuffix(value, "]") {
obj := make([]string, 0)
if err := json.Unmarshal([]byte(value), &obj); err != nil {
log.Printf("failed to parse annotation `%s`, error: %v", value, err)
}
return obj, nil
}
return value, nil
}