Skip to content

Commit 53609f6

Browse files
jpbetzjpbetz
committed
Rename TypedTag to Tag
1 parent 271cbf8 commit 53609f6

File tree

6 files changed

+92
-92
lines changed

6 files changed

+92
-92
lines changed

‎v2/codetags/extractor_test.go‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -147,12 +147,12 @@ func TestExtract(t *testing.T) {
147147
}
148148

149149
func TestExtractAndParse(t *testing.T) {
150-
mktags := func(t ...TypedTag) []TypedTag { return t }
150+
mktags := func(t ...Tag) []Tag { return t }
151151

152152
cases := []struct {
153153
name string
154154
comments []string
155-
expect map[string][]TypedTag
155+
expect map[string][]Tag
156156
}{
157157
{
158158
name: "positional params",
@@ -168,54 +168,54 @@ func TestExtractAndParse(t *testing.T) {
168168
"+true(true)",
169169
"+false(false)",
170170
},
171-
expect: map[string][]TypedTag{
171+
expect: map[string][]Tag{
172172
"quoted": mktags(
173-
TypedTag{Name: "quoted", Args: []Arg{
173+
Tag{Name: "quoted", Args: []Arg{
174174
{Value: "value", Type: ArgTypeString},
175175
}},
176176
),
177177
"backticked": mktags(
178-
TypedTag{Name: "backticked", Args: []Arg{
178+
Tag{Name: "backticked", Args: []Arg{
179179
{Value: "value", Type: ArgTypeString},
180180
}},
181181
),
182182
"ident": mktags(
183-
TypedTag{Name: "ident", Args: []Arg{
183+
Tag{Name: "ident", Args: []Arg{
184184
{Value: "value", Type: ArgTypeString},
185185
}},
186186
),
187187
"integer": mktags(
188-
TypedTag{Name: "integer", Args: []Arg{
188+
Tag{Name: "integer", Args: []Arg{
189189
{Value: "2", Type: ArgTypeInt},
190190
}},
191191
),
192192
"negative": mktags(
193-
TypedTag{Name: "negative", Args: []Arg{
193+
Tag{Name: "negative", Args: []Arg{
194194
{Value: "-5", Type: ArgTypeInt},
195195
}},
196196
),
197197
"hex": mktags(
198-
TypedTag{Name: "hex", Args: []Arg{
198+
Tag{Name: "hex", Args: []Arg{
199199
{Value: "0xFF00B3", Type: ArgTypeInt},
200200
}},
201201
),
202202
"octal": mktags(
203-
TypedTag{Name: "octal", Args: []Arg{
203+
Tag{Name: "octal", Args: []Arg{
204204
{Value: "0o04167", Type: ArgTypeInt},
205205
}},
206206
),
207207
"binary": mktags(
208-
TypedTag{Name: "binary", Args: []Arg{
208+
Tag{Name: "binary", Args: []Arg{
209209
{Value: "0b10101", Type: ArgTypeInt},
210210
}},
211211
),
212212
"true": mktags(
213-
TypedTag{Name: "true", Args: []Arg{
213+
Tag{Name: "true", Args: []Arg{
214214
{Value: "true", Type: ArgTypeBool},
215215
}},
216216
),
217217
"false": mktags(
218-
TypedTag{Name: "false", Args: []Arg{
218+
Tag{Name: "false", Args: []Arg{
219219
{Value: "false", Type: ArgTypeBool},
220220
}},
221221
),
@@ -228,23 +228,23 @@ func TestExtractAndParse(t *testing.T) {
228228
"+numbers(n1: 2, n2: -5, n3: 0xFF00B3, n4: 0o04167, n5: 0b10101)",
229229
"+bools(t: true, f:false)",
230230
},
231-
expect: map[string][]TypedTag{
231+
expect: map[string][]Tag{
232232
"strings": mktags(
233-
TypedTag{Name: "strings", Args: []Arg{
233+
Tag{Name: "strings", Args: []Arg{
234234
{Name: "q", Value: "value", Type: ArgTypeString},
235235
{Name: "b", Value: `value`, Type: ArgTypeString},
236236
{Name: "i", Value: "value", Type: ArgTypeString},
237237
}}),
238238
"numbers": mktags(
239-
TypedTag{Name: "numbers", Args: []Arg{
239+
Tag{Name: "numbers", Args: []Arg{
240240
{Name: "n1", Value: "2", Type: ArgTypeInt},
241241
{Name: "n2", Value: "-5", Type: ArgTypeInt},
242242
{Name: "n3", Value: "0xFF00B3", Type: ArgTypeInt},
243243
{Name: "n4", Value: "0o04167", Type: ArgTypeInt},
244244
{Name: "n5", Value: "0b10101", Type: ArgTypeInt},
245245
}}),
246246
"bools": mktags(
247-
TypedTag{Name: "bools", Args: []Arg{
247+
Tag{Name: "bools", Args: []Arg{
248248
{Name: "t", Value: "true", Type: ArgTypeBool},
249249
{Name: "f", Value: "false", Type: ArgTypeBool},
250250
}}),
@@ -254,7 +254,7 @@ func TestExtractAndParse(t *testing.T) {
254254

255255
for _, tc := range cases {
256256
t.Run(tc.name, func(t *testing.T) {
257-
out := map[string][]TypedTag{}
257+
out := map[string][]Tag{}
258258
for name, matchedTags := range Extract("+", tc.comments) {
259259
parsed, err := ParseAll(matchedTags)
260260
if err != nil {

‎v2/codetags/parser.go‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import (
2222
"unicode"
2323
)
2424

25-
// Parse parses a tag string into a TypedTag, or returns an error if the tag
25+
// Parse parses a tag string into a Tag, or returns an error if the tag
2626
// string fails to parse.
2727
//
2828
// ParseOption may be provided to modify the behavior of the parser. The below
@@ -102,7 +102,7 @@ import (
102102
// <int> ::= /* Standard Go integer literals (decimal, 0x hex, 0o octal, 0b binary),
103103
// ... with an optional +/- prefix. */
104104
// <bool> ::= "true" | "false"
105-
func Parse(tag string, options ...ParseOption) (TypedTag, error) {
105+
func Parse(tag string, options ...ParseOption) (Tag, error) {
106106
opts := parseOpts{}
107107
for _, o := range options {
108108
o(&opts)
@@ -113,8 +113,8 @@ func Parse(tag string, options ...ParseOption) (TypedTag, error) {
113113
}
114114

115115
// ParseAll calls Parse on each tag in the input slice.
116-
func ParseAll(tags []string, options ...ParseOption) ([]TypedTag, error) {
117-
var out []TypedTag
116+
func ParseAll(tags []string, options ...ParseOption) ([]Tag, error) {
117+
var out []Tag
118118
for _, tag := range tags {
119119
parsed, err := Parse(tag, options...)
120120
if err != nil {
@@ -155,8 +155,8 @@ const (
155155
stTrailingComment = "stTrailingComment"
156156
)
157157

158-
func parseTag(input string, opts parseOpts) (TypedTag, error) {
159-
var startTag, endTag *TypedTag // both ends of the chain when parsing chained tags
158+
func parseTag(input string, opts parseOpts) (Tag, error) {
159+
var startTag, endTag *Tag // both ends of the chain when parsing chained tags
160160

161161
// accumulators
162162
var tagName string // current tag name
@@ -200,7 +200,7 @@ func parseTag(input string, opts parseOpts) (TypedTag, error) {
200200
if !usingNamedArgs && len(args) > 1 {
201201
return fmt.Errorf("multiple arguments must use 'name: value' syntax")
202202
}
203-
newTag := &TypedTag{Name: tagName, Args: args}
203+
newTag := &Tag{Name: tagName, Args: args}
204204
if startTag == nil {
205205
startTag = newTag
206206
endTag = newTag
@@ -235,7 +235,7 @@ parseLoop:
235235
case isIdentBegin(r):
236236
ident, err := s.nextIdent(isTagNameInterior)
237237
if err != nil {
238-
return TypedTag{}, err
238+
return Tag{}, err
239239
}
240240
tagName = ident
241241
st = stMaybeArgs
@@ -271,21 +271,21 @@ parseLoop:
271271
case r == '-' || r == '+' || unicode.IsDigit(r):
272272
number, err := s.nextNumber()
273273
if err != nil {
274-
return TypedTag{}, err
274+
return Tag{}, err
275275
}
276276
saveInt(number)
277277
st = stArgEndOfToken
278278
case r == '"' || r == '`':
279279
str, err := s.nextString()
280280
if err != nil {
281-
return TypedTag{}, err
281+
return Tag{}, err
282282
}
283283
saveString(str)
284284
st = stArgEndOfToken
285285
case isIdentBegin(r):
286286
identifier, err := s.nextIdent(isIdentInterior)
287287
if err != nil {
288-
return TypedTag{}, err
288+
return Tag{}, err
289289
}
290290
r = s.peek() // reset r after nextIdent
291291
switch {
@@ -335,29 +335,29 @@ parseLoop:
335335
case r == '+' && isIdentBegin(s.peekN(1)): // tag value
336336
s.next() // consume +
337337
if err := saveTag(); err != nil {
338-
return TypedTag{}, err
338+
return Tag{}, err
339339
}
340340
st = stTag
341341
case r == '-' || r == '+' || unicode.IsDigit(r):
342342
number, err := s.nextNumber()
343343
valueType = ValueTypeInt
344344
if err != nil {
345-
return TypedTag{}, err
345+
return Tag{}, err
346346
}
347347
value = number
348348
st = stMaybeComment
349349
case r == '"' || r == '`':
350350
str, err := s.nextString()
351351
if err != nil {
352-
return TypedTag{}, err
352+
return Tag{}, err
353353
}
354354
value = str
355355
valueType = ValueTypeString
356356
st = stMaybeComment
357357
case isIdentBegin(r):
358358
str, err := s.nextIdent(isIdentInterior)
359359
if err != nil {
360-
return TypedTag{}, err
360+
return Tag{}, err
361361
}
362362
value = str
363363
if str == "true" || str == "false" {
@@ -393,23 +393,23 @@ parseLoop:
393393
s.pos = len(s.buf)
394394
break parseLoop
395395
default:
396-
return TypedTag{}, fmt.Errorf("unexpected internal parser error: unknown state: %s at position %d", st, s.pos)
396+
return Tag{}, fmt.Errorf("unexpected internal parser error: unknown state: %s at position %d", st, s.pos)
397397
}
398398
}
399399
if s.peek() != EOF {
400-
return TypedTag{}, fmt.Errorf("unexpected character %q at position %d", s.next(), s.pos)
400+
return Tag{}, fmt.Errorf("unexpected character %q at position %d", s.next(), s.pos)
401401
}
402402
if incomplete {
403-
return TypedTag{}, fmt.Errorf("unexpected end of input")
403+
return Tag{}, fmt.Errorf("unexpected end of input")
404404
}
405405
if err := saveTag(); err != nil {
406-
return TypedTag{}, err
406+
return Tag{}, err
407407
}
408408
if len(valueType) > 0 {
409409
saveValue()
410410
}
411411
if startTag == nil {
412-
return TypedTag{}, fmt.Errorf("unexpected internal parser error: no tags parsed")
412+
return Tag{}, fmt.Errorf("unexpected internal parser error: no tags parsed")
413413
}
414414
return *startTag, nil
415415
}

0 commit comments

Comments
 (0)