forked from go-swagger/go-swagger
-
Notifications
You must be signed in to change notification settings - Fork 2
/
classifier.go
146 lines (132 loc) · 4.05 KB
/
classifier.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
// Copyright 2015 go-swagger maintainers
//
// 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 scan
import (
"fmt"
"go/ast"
"golang.org/x/tools/go/loader"
)
type packageFilter struct {
Name string
}
func (pf *packageFilter) Matches(path string) bool {
return path == pf.Name
}
type packageFilters []packageFilter
func (pf packageFilters) HasFilters() bool {
return len(pf) > 0
}
func (pf packageFilters) Matches(path string) bool {
for _, mod := range pf {
if mod.Matches(path) {
return true
}
}
return false
}
type classifiedProgram struct {
prog *loader.Program
Meta []*ast.File
Models []*ast.File
Operations []*ast.File
Parameters []*ast.File
Responses []*ast.File
}
// programClassifier classifies the files of a program into buckets
// for processing by a swagger spec generator. This buckets files in
// 3 groups: Meta, Models and Operations.
//
// Each of these buckets is then processed with an appropriate parsing strategy
//
// When there are Include or Exclude filters provide they are used to limit the
// candidates prior to parsing.
// The include filters take precedence over the excludes. So when something appears
// in both filters it will be included.
type programClassifier struct {
Includes packageFilters
Excludes packageFilters
}
func (pc *programClassifier) Classify(prog *loader.Program) (*classifiedProgram, error) {
var cp classifiedProgram
for pkg, pkgInfo := range prog.AllPackages {
if pc.Includes.HasFilters() {
if !pc.Includes.Matches(pkg.Path()) {
continue
}
} else if pc.Excludes.HasFilters() {
if pc.Excludes.Matches(pkg.Path()) {
continue
}
}
for _, file := range pkgInfo.Files {
var op, mt, pm, rs bool // only add a particular file once
for _, comments := range file.Comments {
var seenStruct string
for _, cline := range comments.List {
if cline != nil {
matches := rxSwaggerAnnotation.FindStringSubmatch(cline.Text)
if len(matches) > 1 {
switch matches[1] {
case "route":
if !op {
cp.Operations = append(cp.Operations, file)
op = true
}
case "model":
// models are discovered through parameters and responses
// no actual scanning for them is required
if seenStruct == "" || seenStruct == matches[1] {
seenStruct = matches[1]
} else {
return nil, fmt.Errorf("classifier: already annotated as %s, can't also be %q", seenStruct, matches[1])
}
case "meta":
if !mt {
cp.Meta = append(cp.Meta, file)
mt = true
}
case "parameters":
if !pm {
cp.Parameters = append(cp.Parameters, file)
pm = true
}
if seenStruct == "" || seenStruct == matches[1] {
seenStruct = matches[1]
} else {
return nil, fmt.Errorf("classifier: already annotated as %s, can't also be %q", seenStruct, matches[1])
}
case "response":
if !rs {
cp.Responses = append(cp.Responses, file)
rs = true
}
if seenStruct == "" || seenStruct == matches[1] {
seenStruct = matches[1]
} else {
return nil, fmt.Errorf("classifier: already annotated as %s, can't also be %q", seenStruct, matches[1])
}
case "strfmt", "name", "discriminated":
// TODO: perhaps collect these and pass along to avoid lookups later on
case "allOf":
default:
return nil, fmt.Errorf("classifier: unknown swagger annotation %q", matches[1])
}
}
}
}
}
}
}
return &cp, nil
}