-
-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #136 from jmattheis/enum
Enum Support
- Loading branch information
Showing
105 changed files
with
3,368 additions
and
264 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,6 +3,7 @@ | |
| /c.out | ||
| /coverage.txt | ||
| /.vscode | ||
| /covdata | ||
|
|
||
| node_modules/ | ||
| /docs/.vitepress/cache | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| package builder | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/dave/jennifer/jen" | ||
| "github.com/jmattheis/goverter/config" | ||
| "github.com/jmattheis/goverter/enum" | ||
| "github.com/jmattheis/goverter/xtype" | ||
| ) | ||
|
|
||
| // Basic handles basic data types. | ||
| type Enum struct{} | ||
|
|
||
| // Matches returns true, if the builder can create handle the given types. | ||
| func (*Enum) Matches(ctx *MethodContext, source, target *xtype.Type) bool { | ||
| return ctx.Conf.Enum.Enabled && | ||
| source.Enum(&ctx.Conf.Enum).OK && | ||
| target.Enum(&ctx.Conf.Enum).OK | ||
| } | ||
|
|
||
| // Build creates conversion source code for the given source and target type. | ||
| func (*Enum) Build(gen Generator, ctx *MethodContext, sourceID *xtype.JenID, source, target *xtype.Type, path ErrorPath) ([]jen.Code, *xtype.JenID, *Error) { | ||
| stmt, nameVar, err := buildTargetVar(gen, ctx, sourceID, source, target, path) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| var cases []jen.Code | ||
|
|
||
| targetEnum := target.Enum(&ctx.Conf.Enum) | ||
| sourceEnum := source.Enum(&ctx.Conf.Enum) | ||
|
|
||
| definedKeys := ctx.DefinedEnumFields(target) | ||
|
|
||
| transformerMapping, err := executeTransformers(ctx.Conf.EnumMapping.Transformers, source, target, sourceEnum, targetEnum) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| for _, sourceName := range sourceEnum.SortedMembers() { | ||
| value := sourceEnum.Members[sourceName] | ||
| delete(definedKeys, sourceName) | ||
|
|
||
| targetName, ok := ctx.Conf.EnumMapping.Map[sourceName] | ||
| if !ok { | ||
| targetName, ok = transformerMapping[sourceName] | ||
| } | ||
|
|
||
| if !ok { | ||
| targetName = sourceName | ||
| } | ||
|
|
||
| sourceQual := jen.Qual(source.NamedType.Obj().Pkg().Path(), sourceName) | ||
| body, err := caseAction(gen, ctx, nameVar, target, targetEnum, targetName, sourceID, path) | ||
| if err != nil { | ||
| return nil, nil, err.Lift(&Path{ | ||
| SourceType: fmt.Sprint("constant: ", value), | ||
| SourceID: sourceName, | ||
| Prefix: ".", | ||
| TargetID: targetName, | ||
| TargetType: "???", | ||
| }) | ||
| } | ||
| cases = append(cases, jen.Case(sourceQual).Add(body)) | ||
| } | ||
|
|
||
| enumUnknown := ctx.Conf.Common.Enum.Unknown | ||
| if enumUnknown == "" { | ||
| return nil, nil, NewError("No enum:unknown configured.\nSee https://goverter.jmattheis.de/guide/enum#unknown-enum-values") | ||
| } | ||
|
|
||
| body, err := caseAction(gen, ctx, nameVar, target, targetEnum, enumUnknown, sourceID, path) | ||
| if err != nil { | ||
| return nil, nil, err.Lift(&Path{ | ||
| SourceID: "@enum:unknown", | ||
| Prefix: ".", | ||
| TargetID: enumUnknown, | ||
| TargetType: "???", | ||
| }) | ||
| } | ||
| cases = append(cases, jen.Default().Add(body)) | ||
|
|
||
| for name := range definedKeys { | ||
| return nil, nil, NewError(fmt.Sprintf("Configured enum value %s does not exist on\n %s", name, source.String)). | ||
| Lift(&Path{ | ||
| Prefix: ".", | ||
| SourceID: name, | ||
| SourceType: "???", | ||
| }) | ||
| } | ||
|
|
||
| stmt = append(stmt, jen.Switch(sourceID.Code).Block(cases...)) | ||
| return stmt, xtype.VariableID(nameVar), nil | ||
| } | ||
|
|
||
| func caseAction(gen Generator, ctx *MethodContext, nameVar *jen.Statement, target *xtype.Type, targetEnum *xtype.Enum, targetName string, sourceID *xtype.JenID, errPath ErrorPath) (jen.Code, *Error) { | ||
| if config.IsEnumAction(targetName) { | ||
| switch targetName { | ||
| case config.EnumActionIgnore: | ||
| return jen.Comment("ignored"), nil | ||
| case config.EnumActionPanic: | ||
| return jen.Panic(jen.Qual("fmt", "Sprintf").Call(jen.Lit("unexpected enum element: %v"), sourceID.Code.Clone())), nil | ||
| case config.EnumActionError: | ||
| errStmt := jen.Qual("fmt", "Errorf").Call(jen.Lit("unexpected enum element: %v"), sourceID.Code.Clone()) | ||
| code, ok := gen.ReturnError(ctx, errPath, errStmt) | ||
| if !ok { | ||
| return nil, NewError(fmt.Sprintf("Cannot return %s because the explicitly defined conversion method doesn't return an error.", config.EnumActionError)) | ||
| } | ||
| return code, nil | ||
| default: | ||
| return nil, NewError(fmt.Sprintf("invalid target %q", targetName)) | ||
| } | ||
| } | ||
| _, ok := targetEnum.Members[targetName] | ||
| if !ok { | ||
| return nil, NewError(fmt.Sprintf("Enum %s does not exist on\n %s", targetName, target.String)) | ||
| } | ||
|
|
||
| targetQual := jen.Qual(target.NamedType.Obj().Pkg().Path(), targetName) | ||
| return nameVar.Clone().Op("=").Add(targetQual), nil | ||
| } | ||
|
|
||
| func executeTransformers(transformers []config.ConfiguredTransformer, source, target *xtype.Type, sourceEnum, targetEnum *xtype.Enum) (map[string]string, *Error) { | ||
| transformerMapping := map[string]string{} | ||
| for _, t := range transformers { | ||
| m, err := t.Transformer(enum.TransformContext{ | ||
| Source: enum.Enum{Type: source.NamedType, Members: sourceEnum.Members}, | ||
| Target: enum.Enum{Type: target.NamedType, Members: targetEnum.Members}, | ||
| Config: t.Config, | ||
| }) | ||
| if err != nil { | ||
| return nil, NewError(fmt.Sprintf("error executing transformer %q with config %q: %s", t.Name, t.Config, err)) | ||
| } | ||
| if len(m) == 0 { | ||
| return nil, NewError(fmt.Sprintf("transformer %q with config %q did not return any mapped values. Is there an configuration error?", t.Name, t.Config)) | ||
| } | ||
| for key, value := range m { | ||
| transformerMapping[key] = value | ||
| } | ||
| } | ||
| return transformerMapping, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.