Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cmd/stringer: add the ability to optionally generate TypeFromString function #46

Closed
wants to merge 2 commits into from
Closed

cmd/stringer: add the ability to optionally generate TypeFromString function #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c96fc8
option to generate TypeFromString method along with Stringer
bbrodriges Aug 18, 2018
e283a23
lazy populate type map
bbrodriges Aug 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/stringer/endtoend_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ func stringerCompileAndRun(t *testing.T, dir, stringer, typeName, fileName strin
}
stringSource := filepath.Join(dir, typeName+"_string.go")
// Run stringer in temporary directory.
err = run(stringer, "-type", typeName, "-output", stringSource, source)
err = run(stringer, "-type", typeName, "-output", stringSource, "-withfromstring", source)
if err != nil {
t.Fatal(err)
}
Expand Down
300 changes: 271 additions & 29 deletions cmd/stringer/golden_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,27 @@ import (

// Golden represents a test case.
type Golden struct {
name string
trimPrefix string
lineComment bool
input string // input; the package clause is provided when running the test.
output string // exected output.
name string
trimPrefix string
lineComment bool
withFromString bool
input string // input; the package clause is provided when running the test.
output string // exected output.
}

var golden = []Golden{
{"day", "", false, day_in, day_out},
{"offset", "", false, offset_in, offset_out},
{"gap", "", false, gap_in, gap_out},
{"num", "", false, num_in, num_out},
{"unum", "", false, unum_in, unum_out},
{"prime", "", false, prime_in, prime_out},
{"prefix", "Type", false, prefix_in, prefix_out},
{"tokens", "", true, tokens_in, tokens_out},
{"day", "", false, false, day_in, day_out},
{"offset", "", false, false, offset_in, offset_out},
{"gap", "", false, false, gap_in, gap_out},
{"num", "", false, false, num_in, num_out},
{"unum", "", false, false, unum_in, unum_out},
{"prime", "", false, false, prime_in, prime_out},
{"prefix", "Type", false, false, prefix_in, prefix_out},
{"tokens", "", true, false, tokens_in, tokens_out},
{"month", "", true, true, month_in, month_out},
{"mood", "", true, true, mood_in, mood_out},
{"fib", "", false, true, fib_in, fib_out},
{"hundreds", "", false, true, hundreds_in, hundreds_out},
}

// Each example starts with "type XXX [u]int", with a single space separating them.
Expand All @@ -50,6 +55,8 @@ const (
`

const day_out = `
import "strconv"

const _Day_name = "MondayTuesdayWednesdayThursdayFridaySaturdaySunday"

var _Day_index = [...]uint8{0, 6, 13, 22, 30, 36, 44, 50}
Expand All @@ -75,6 +82,8 @@ const (
`

const offset_out = `
import "strconv"

const _Number_name = "OneTwoThree"

var _Number_index = [...]uint8{0, 3, 6, 11}
Expand Down Expand Up @@ -103,6 +112,8 @@ const (
`

const gap_out = `
import "strconv"

const (
_Gap_name_0 = "TwoThree"
_Gap_name_1 = "FiveSixSevenEightNine"
Expand Down Expand Up @@ -142,6 +153,8 @@ const (
`

const num_out = `
import "strconv"

const _Num_name = "m_2m_1m0m1m2"

var _Num_index = [...]uint8{0, 3, 6, 8, 10, 12}
Expand Down Expand Up @@ -170,6 +183,8 @@ const (
`

const unum_out = `
import "strconv"

const (
_Unum_name_0 = "m0m1m2"
_Unum_name_1 = "m_2m_1"
Expand Down Expand Up @@ -215,25 +230,37 @@ const (
`

const prime_out = `
import (
"strconv"
"sync"
)

const _Prime_name = "p2p3p5p7p11p13p17p19p23p29p37p41p43"

var _Prime_map = map[Prime]string{
2: _Prime_name[0:2],
3: _Prime_name[2:4],
5: _Prime_name[4:6],
7: _Prime_name[6:8],
11: _Prime_name[8:11],
13: _Prime_name[11:14],
17: _Prime_name[14:17],
19: _Prime_name[17:20],
23: _Prime_name[20:23],
29: _Prime_name[23:26],
31: _Prime_name[26:29],
41: _Prime_name[29:32],
43: _Prime_name[32:35],
var _Prime_map map[Prime]string

var populatePrimeMapOnce sync.Once

func populatePrimeMap() {
_Prime_map = map[Prime]string{
2: _Prime_name[0:2],
3: _Prime_name[2:4],
5: _Prime_name[4:6],
7: _Prime_name[6:8],
11: _Prime_name[8:11],
13: _Prime_name[11:14],
17: _Prime_name[14:17],
19: _Prime_name[17:20],
23: _Prime_name[20:23],
29: _Prime_name[23:26],
31: _Prime_name[26:29],
41: _Prime_name[29:32],
43: _Prime_name[32:35],
}
}

func (i Prime) String() string {
populatePrimeMapOnce.Do(populatePrimeMap)
if str, ok := _Prime_map[i]; ok {
return str
}
Expand All @@ -254,6 +281,8 @@ const (
`

const prefix_out = `
import "strconv"

const _Type_name = "IntStringFloatRuneByteStructSlice"

var _Type_index = [...]uint8{0, 3, 9, 14, 18, 22, 28, 33}
Expand Down Expand Up @@ -284,6 +313,8 @@ const (
`

const tokens_out = `
import "strconv"

const _Token_name = "&|+-Ident.SingleBeforeinlineinline general"

var _Token_index = [...]uint8{0, 1, 2, 3, 4, 9, 10, 22, 28, 42}
Expand All @@ -296,11 +327,222 @@ func (i Token) String() string {
}
`

// Simple test: enumeration of type int starting at 0.
const month_in = `type Month int
const (
January Month = iota
February
March
April
May
June
July
August
September
October
November
December
)
`

const month_out = `
import "strconv"

const _Month_name = "JanuaryFebruaryMarchAprilMayJuneJulyAugustSeptemberOctoberNovemberDecember"

var _Month_index = [...]uint8{0, 7, 15, 20, 25, 28, 32, 36, 42, 51, 58, 66, 74}

func (i Month) String() string {
if i < 0 || i >= Month(len(_Month_index)-1) {
return "Month(" + strconv.FormatInt(int64(i), 10) + ")"
}
return _Month_name[_Month_index[i]:_Month_index[i+1]]
}

func MonthFromString(s string) (i Month, ok bool) {
for v := range _Month_index {
v += 0
if s == Month(v).String() {
return Month(v), true
}
}
return
}
`

// Enumeration with an negative offset.
const mood_in = `type Mood int
const (
Negative Mood = iota -1
Neutral
Happy
)
`

const mood_out = `
import "strconv"

const _Mood_name = "NegativeNeutralHappy"

var _Mood_index = [...]uint8{0, 8, 15, 20}

func (i Mood) String() string {
i -= -1
if i < 0 || i >= Mood(len(_Mood_index)-1) {
return "Mood(" + strconv.FormatInt(int64(i+-1), 10) + ")"
}
return _Mood_name[_Mood_index[i]:_Mood_index[i+1]]
}

func MoodFromString(s string) (i Mood, ok bool) {
for v := range _Mood_index {
v += -1
if s == Mood(v).String() {
return Mood(v), true
}
}
return
}
`

// Gaps and an offset with duplicates.
const fib_in = `type Fib int
const (
Zero Fib = 0
One Fib = 1
AnotherOne Fib = 1
Two Fib = 2
Three Fib = 3
Five Fib = 5
Eight Fib = 8
Thirteen Fib = 13
)
`

const fib_out = `
import "strconv"

const (
_Fib_name_0 = "ZeroOneTwoThree"
_Fib_name_1 = "Five"
_Fib_name_2 = "Eight"
_Fib_name_3 = "Thirteen"
)

var (
_Fib_index_0 = [...]uint8{0, 4, 7, 10, 15}
)

func (i Fib) String() string {
switch {
case 0 <= i && i <= 3:
return _Fib_name_0[_Fib_index_0[i]:_Fib_index_0[i+1]]
case i == 5:
return _Fib_name_1
case i == 8:
return _Fib_name_2
case i == 13:
return _Fib_name_3
default:
return "Fib(" + strconv.FormatInt(int64(i), 10) + ")"
}
}

func FibFromString(s string) (i Fib, ok bool) {
switch s {
case "Zero":
return Fib(0), true
case "One":
return Fib(1), true
case "Two":
return Fib(2), true
case "Three":
return Fib(3), true
case "Five":
return Fib(5), true
case "Eight":
return Fib(8), true
case "Thirteen":
return Fib(13), true
}
return
}
`

// Enough gaps to trigger a map implementation of the method.
// Also includes a duplicate to test that it doesn't cause problems
const hundreds_in = `type Hundred int
const (
One Hundred = 100
Two Hundred = 200
Three Hundred = 300
Four Hundred = 400
Five Hundred = 500
HighFive Hundred = 500 // duplicate
Six Hundred = 600
Seven Hundred = 700
Eight Hundred = 800
Nine Hundred = 900
Ten Hundred = 1000
Eleven Hundred = 1100
Twelve Hundred = 1200
)
`

const hundreds_out = `
import (
"strconv"
"sync"
)

const _Hundred_name = "OneTwoThreeFourFiveSixSevenEightNineTenElevenTwelve"

var _Hundred_map map[Hundred]string

var populateHundredMapOnce sync.Once

func populateHundredMap() {
_Hundred_map = map[Hundred]string{
100: _Hundred_name[0:3],
200: _Hundred_name[3:6],
300: _Hundred_name[6:11],
400: _Hundred_name[11:15],
500: _Hundred_name[15:19],
600: _Hundred_name[19:22],
700: _Hundred_name[22:27],
800: _Hundred_name[27:32],
900: _Hundred_name[32:36],
1000: _Hundred_name[36:39],
1100: _Hundred_name[39:45],
1200: _Hundred_name[45:51],
}
}

func (i Hundred) String() string {
populateHundredMapOnce.Do(populateHundredMap)
if str, ok := _Hundred_map[i]; ok {
return str
}
return "Hundred(" + strconv.FormatInt(int64(i), 10) + ")"
}

func HundredFromString(s string) (i Hundred, ok bool) {
populateHundredMapOnce.Do(populateHundredMap)
for k, v := range _Hundred_map {
if s == v {
return k, true
}
}
return
}
`

func TestGolden(t *testing.T) {
for _, test := range golden {
g := Generator{
trimPrefix: test.trimPrefix,
lineComment: test.lineComment,
trimPrefix: test.trimPrefix,
lineComment: test.lineComment,
withFromString: test.withFromString,
}
input := "package test\n" + test.input
file := test.name + ".go"
Expand Down
Loading