Skip to content

feat: typed enums #241

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

Merged
deepmap-marcinr merged 2 commits into from
Apr 14, 2021
Merged

feat: typed enums #241

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
b9cad98
fix(model): Copying servers from path definition to operation definition
vlastahajek Oct 21, 2020
af10f5e
feat(enums): Adding support for enums in all positions
vlastahajek Oct 21, 2020
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
31 changes: 19 additions & 12 deletions internal/test/issues/issue-illegal_enum_names/issue.gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 8 additions & 8 deletions internal/test/issues/issue-illegal_enum_names/issue_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ func TestIllegalEnumNames(t *testing.T) {
}
}

require.Equal(t, `"Bar"`, constDefs["Bar_Bar"])
require.Equal(t, `"Foo"`, constDefs["Bar_Foo"])
require.Equal(t, `"Foo Bar"`, constDefs["Bar_Foo_Bar"])
require.Equal(t, `"Foo-Bar"`, constDefs["Bar_Foo_Bar1"])
require.Equal(t, `"1Foo"`, constDefs["Bar__Foo"])
require.Equal(t, `" Foo"`, constDefs["Bar__Foo1"])
require.Equal(t, `" Foo "`, constDefs["Bar__Foo_"])
require.Equal(t, `"_Foo_"`, constDefs["Bar__Foo_1"])
require.Equal(t, `"Bar"`, constDefs["BarBar"])
require.Equal(t, `"Foo"`, constDefs["BarFoo"])
require.Equal(t, `"Foo Bar"`, constDefs["BarFooBar"])
require.Equal(t, `"Foo-Bar"`, constDefs["BarFooBar1"])
require.Equal(t, `"1Foo"`, constDefs["BarFoo1"])
require.Equal(t, `" Foo"`, constDefs["BarFoo2"])
require.Equal(t, `" Foo "`, constDefs["BarFoo3"])
require.Equal(t, `"_Foo_"`, constDefs["BarFoo4"])
}
7 changes: 5 additions & 2 deletions internal/test/server/server.gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 7 additions & 7 deletions internal/test/server/server_moq.gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

37 changes: 36 additions & 1 deletion pkg/codegen/codegen.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,11 @@ func GenerateTypeDefinitions(t *template.Template, swagger *openapi3.Swagger, op
return "", errors.Wrap(err, "error generating Go types for operation parameters")
}

enumsOut, err := GenerateEnums(t, allTypes)
if err != nil {
return "", errors.Wrap(err, "error generating code for type enums")
}

typesOut, err := GenerateTypes(t, allTypes)
if err != nil {
return "", errors.Wrap(err, "error generating code for type definitions")
Expand All @@ -307,7 +312,7 @@ func GenerateTypeDefinitions(t *template.Template, swagger *openapi3.Swagger, op
return "", errors.Wrap(err, "error generating allOf boilerplate")
}

typeDefinitions := strings.Join([]string{typesOut, paramTypesOut, allOfBoilerplate}, "")
typeDefinitions := strings.Join([]string{enumsOut, typesOut, paramTypesOut, allOfBoilerplate}, "")
return typeDefinitions, nil
}

Expand Down Expand Up @@ -514,6 +519,36 @@ func GenerateTypes(t *template.Template, types []TypeDefinition) (string, error)
return buf.String(), nil
}

func GenerateEnums(t *template.Template, types []TypeDefinition) (string, error) {
var buf bytes.Buffer
w := bufio.NewWriter(&buf)
c := Constants{
EnumDefinitions: []EnumDefinition{},
}
for _, tp := range types {
if len(tp.Schema.EnumValues) > 0 {
wrapper := ""
if tp.Schema.GoType == "string" {
wrapper = `"`
}
c.EnumDefinitions = append(c.EnumDefinitions, EnumDefinition{
Schema: tp.Schema,
TypeName: tp.TypeName,
ValueWrapper: wrapper,
})
}
}
err := t.ExecuteTemplate(w, "constants.tmpl", c)
if err != nil {
return "", errors.Wrap(err, "error generating enums")
}
err = w.Flush()
if err != nil {
return "", errors.Wrap(err, "error flushing output buffer for enums")
}
return buf.String(), nil
}

// Generate our import statements and package definition.
func GenerateImports(t *template.Template, externalImports []string, packageName string) (string, error) {
var buf bytes.Buffer
Expand Down
3 changes: 3 additions & 0 deletions pkg/codegen/operations.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,9 @@ func OperationDefinitions(swagger *openapi3.Swagger) ([]OperationDefinition, err
pathOps := pathItem.Operations()
for _, opName := range SortedOperationsKeys(pathOps) {
op := pathOps[opName]
if pathItem.Servers != nil {
op.Servers = &pathItem.Servers
}
// We rely on OperationID to generate function names, it's required
if op.OperationID == "" {
op.OperationID, err = generateDefaultOperationID(opName, requestPath)
Expand Down
Loading