/
documentation.go
159 lines (124 loc) · 3.7 KB
/
documentation.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
// Copyright 2019 Aporeto Inc.
// 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 doc
import (
"bytes"
"fmt"
"regexp"
"strings"
"text/template"
"go.aporeto.io/regolithe/cmd/rego/static"
"go.aporeto.io/regolithe/spec"
)
func shortString(s string, max int) string {
s = strings.Split(s, "\n")[0]
if len(s) < max {
return s
}
return s[:max] + "..."
}
var functions = template.FuncMap{
"join": strings.Join,
"title": strings.Title,
"trimspace": strings.TrimSpace,
"toc": toc,
"operations": operations,
"characteristics": characteristics,
"example": makeExample,
"typeOf": typeOf,
"makeDefaultValue": makeDefaultValue,
}
// Write writes the documentation for the given spec.SpecificationSet.
func Write(set spec.SpecificationSet, format string) error {
switch format {
case "markdown":
return writeMarkdownDoc(set)
default:
return fmt.Errorf("unsuported documentation format: %s", format)
}
}
func writeMarkdownDoc(set spec.SpecificationSet) error {
tocData, err := static.Asset("templates/toc-md.gotpl")
if err != nil {
return fmt.Errorf("cannot open toc template: %s", err)
}
specData, err := static.Asset("templates/spec-md.gotpl")
if err != nil {
return fmt.Errorf("cannot open spec template: %s", err)
}
relationships := set.RelationshipsByRestName()
out := fmt.Sprintf(`<!-- markdownlint-disable MD024 MD025 -->
# %s API Documentation
> Version: %d
`, strings.Title(set.Configuration().ProductName), set.APIInfo().Version)
r := regexp.MustCompile(`\n\n\n+`)
groups := set.Groups()
for _, g := range groups {
specs := set.SpecificationGroup(g)
if len(specs) == 0 || g == "none" {
continue
}
buf := &bytes.Buffer{}
s := struct {
Set spec.SpecificationSet
GroupName string
}{
set,
g,
}
tocTemplate, err := template.New("toc-" + g).Funcs(functions).Parse(string(tocData))
if err != nil {
return fmt.Errorf("cannot parse template: %s", err)
}
if err := tocTemplate.Execute(buf, s); err != nil {
return fmt.Errorf("cannot execute template: %s", err)
}
var initializedGroup bool
for _, s := range specs {
model := s.Model()
if model.IsRoot {
continue
}
_, ok := model.Extensions["forceDocumentation"]
if model.Private && !ok {
continue
}
if !initializedGroup {
out = fmt.Sprintf("%s%s\n", out, buf.String())
initializedGroup = true
}
temp, err := template.New(model.RestName).Funcs(functions).Parse(string(specData[:len(specData)-1]))
if err != nil {
return fmt.Errorf("cannot parse template: %s", err)
}
buf := &bytes.Buffer{}
if err := temp.Execute(buf, struct {
Set spec.SpecificationSet
Spec spec.Specification
Relationships map[string]*spec.Relationship
}{
Set: set,
Spec: s,
Relationships: relationships,
}); err != nil {
return fmt.Errorf("cannot execute template: %s", err)
}
out = out + r.ReplaceAllString(buf.String(), "\n\n")
}
}
sout := strings.Split(out[:len(out)-1], "\n")
fout := make([]string, len(sout))
for i, l := range sout {
fout[i] = strings.TrimRight(l, " ")
}
fmt.Print(strings.Join(fout, "\n"))
return nil
}