forked from elastic/crd-ref-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
functions.go
167 lines (141 loc) · 4.32 KB
/
functions.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
// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you 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 renderer
import (
"bytes"
"fmt"
"regexp"
"strings"
"text/template"
"github.com/rustycl0ck/crd-ref-docs/config"
"github.com/rustycl0ck/crd-ref-docs/types"
"go.uber.org/zap"
)
const (
kubePackagesRegex = `^k8s\.io/(?:api|apimachinery/pkg/apis)/`
kubeDocLinkTemplate = `https://kubernetes.io/docs/reference/generated/kubernetes-api/v{{ .kubeVersion }}/#{{ .type }}-{{ .version }}-{{ .group }}`
)
type Functions struct {
conf *config.Config
*kubernetesHelper
safeIDRegex *regexp.Regexp
}
func NewFunctions(conf *config.Config) (*Functions, error) {
kubeHelper, err := newKubernetesHelper(conf)
if err != nil {
return nil, err
}
safeIDRegex, err := regexp.Compile("[[:punct:]]+")
if err != nil {
return nil, fmt.Errorf("failed to compile safe ID regex: %w", err)
}
return &Functions{
conf: conf,
kubernetesHelper: kubeHelper,
safeIDRegex: safeIDRegex,
}, nil
}
func (f *Functions) TypeID(t *types.Type) string {
return f.SafeID(types.Key(t))
}
func (f *Functions) GroupVersionID(gv types.GroupVersionDetails) string {
return f.SafeID(gv.GroupVersionString())
}
func (f *Functions) SafeID(id string) string {
return strings.ToLower(f.safeIDRegex.ReplaceAllLiteralString(id, "-"))
}
func (f *Functions) LinkForType(t *types.Type) (link string, local bool) {
if f.IsKubeType(t) {
return f.LinkForKubeType(t), false
}
if t.IsBasic() || t.Imported {
return "", false
}
return f.TypeID(t), true
}
func (f *Functions) SimplifiedTypeName(t *types.Type) string {
if !t.IsBasic() {
return t.Name
}
switch t.Kind {
case types.BasicKind:
return f.BasicTypeName(t.Name)
case types.PointerKind:
return f.BasicTypeName(t.UnderlyingType.Name)
case types.ArrayKind, types.SliceKind:
return fmt.Sprintf("%s array", f.BasicTypeName(t.UnderlyingType.Name))
case types.MapKind:
return "object"
default:
return t.Name
}
}
func (f *Functions) BasicTypeName(name string) string {
switch name {
case "int", "int8", "int16", "int32", "int64", "uint", "uint8", "uint16", "uint32", "uint64", "byte", "rune":
return "integer"
case "float32", "float64":
return "float"
case "bool":
return "boolean"
default:
return name
}
}
type kubernetesHelper struct {
kubeVersion string
packagesRegex *regexp.Regexp
docLinkTemplate *template.Template
}
func newKubernetesHelper(conf *config.Config) (*kubernetesHelper, error) {
packagesRegex, err := regexp.Compile(kubePackagesRegex)
if err != nil {
return nil, fmt.Errorf("failed to compile kube package regex: %w", err)
}
docLinkTemplate, err := template.New("").Parse(kubeDocLinkTemplate)
if err != nil {
return nil, fmt.Errorf("failed to parse kube doc link template: %w", err)
}
return &kubernetesHelper{
kubeVersion: conf.Render.KubernetesVersion,
packagesRegex: packagesRegex,
docLinkTemplate: docLinkTemplate,
}, nil
}
func (k *kubernetesHelper) IsKubeType(t *types.Type) bool {
return k.packagesRegex.MatchString(t.Package)
}
func (k *kubernetesHelper) LinkForKubeType(t *types.Type) string {
if !k.IsKubeType(t) {
return ""
}
parts := strings.Split(t.Package, "/")
if len(parts) < 2 {
zap.S().Fatalw("Unexpected Kubernetes package name", "type", t)
}
args := map[string]string{
"kubeVersion": k.kubeVersion,
"group": strings.ToLower(parts[len(parts)-2]),
"version": strings.ToLower(parts[len(parts)-1]),
"type": strings.ToLower(t.Name),
}
s := new(bytes.Buffer)
if err := k.docLinkTemplate.Execute(s, args); err != nil {
zap.S().Fatalw("Failed to render Kube doc link", "type", t, "error", err)
}
return s.String()
}