Merge pull request #436 from fhalim/feature/oneof

Support oneof in templates

examples/templates/grpc-md.tmpl

@@ -0,0 +1,75 @@
+# API Reference
+
+# Table of Contents
+{{range .Files}}
+{{if .HasServices}}
+- Services
+  {{range .Services}}  - [{{.Name}}](#{{.FullName | lower | replace "." ""}})
+  {{end}}
+{{end}}
+{{if .HasMessages}}
+- Messages
+  {{range .Messages}}  - [{{.LongName}}](#{{.LongName | lower | replace "." ""}})
+  {{end}}
+{{end}}
+{{if .HasEnums}}
+- Enums
+  {{range .Enums}}  - [{{.LongName}}](#{{.LongName | lower | replace "." ""}})
+  {{end}}
+{{end}}
+{{end}}
+- [Scalar Value Types](#scalar-value-types)
+
+{{range .Files}}
+
+{{range .Services -}}
+# {{.Name}} {#{{.FullName | lower | replace "." ""}}}
+{{.Description}}
+
+{{range .Methods -}}
+## {{.Name}}
+
+> **rpc** {{.Name}}([{{.RequestLongType}}](#{{.RequestLongType | lower | replace "." ""}}))
+    [{{.ResponseLongType}}](#{{.ResponseLongType | lower | replace "." ""}})
+
+{{ .Description}}
+{{end}} <!-- end methods -->
+{{end}} <!-- end services -->
+
+# Messages
+{{range .Messages}}
+
+## {{.LongName}} {#{{.LongName | lower | replace "." ""}}}
+{{.Description}}
+
+{{if .HasFields}}
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+{{range .Fields -}}
+	| {{if .IsOneof}}[**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) {{.OneofDecl}}.{{end}}{{.Name}} | [{{if .IsMap}}map {{else}}{{.Label}} {{end}}{{.LongType}}](#{{.LongType | lower | replace "." ""}}) | {{if .Description}}{{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}}{{else}}none{{end}} |
+{{end}} <!-- end Fields -->
+{{end}} <!-- end HasFields -->
+{{end}} <!-- end messages -->
+
+# Enums
+{{range .Enums}}
+
+## {{.LongName}} {#{{.LongName | lower | replace "." ""}}}
+{{.Description}}
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+{{range .Values -}}
+	| {{.Name}} | {{.Number}} | {{if .Description}}{{nobr .Description}}{{else}}none{{end}} |
+{{end}}
+
+{{end}} <!-- end Enums -->
+{{end}} <!-- end Files -->
+
+# Scalar Value Types
+
+| .proto Type | Notes | C++ Type | Java Type | Python Type |
+| ----------- | ----- | -------- | --------- | ----------- |
+{{range .Scalars -}}
+  | <div><h4 id="{{.ProtoType | lower | replace "." ""}}" /></div><a name="{{.ProtoType}}" /> {{.ProtoType}} | {{.Notes}} | {{.CppType}} | {{.JavaType}} | {{.PythonType}} |
+{{end}}

fixtures/Vehicle.proto

@@ -144,4 +144,14 @@ message Vehicle {
   repeated sint32 rates = 6;
 
   map<string, string> properties = 7; // bag of properties related to the vehicle.
+
+  oneof travel {
+	int32 kilometers = 8;
+	int64 lightyears = 10;
+  }
+
+  oneof drivers {
+	string human_name = 11;
+	string cat_name = 12;
+  }
 }

template.go

@@ -176,6 +176,7 @@ type Message struct {
 
 	HasExtensions bool `json:"hasExtensions"`
 	HasFields     bool `json:"hasFields"`
+	HasOneofs     bool `json:"hasOneofs"`
 
 	Extensions []*MessageExtension `json:"extensions"`
 	Fields     []*MessageField     `json:"fields"`
@@ -232,6 +233,8 @@ type MessageField struct {
 	LongType     string `json:"longType"`
 	FullType     string `json:"fullType"`
 	IsMap        bool   `json:"ismap"`
+	IsOneof      bool   `json:"isoneof"`
+	OneofDecl    string `json:"oneofdecl"`
 	DefaultValue string `json:"defaultValue"`
 
 	Options map[string]interface{} `json:"options,omitempty"`
@@ -442,6 +445,7 @@ func parseMessage(pm *protokit.Descriptor) *Message {
 		Description:   description(pm.GetComments().String()),
 		HasExtensions: len(pm.GetExtensions()) > 0,
 		HasFields:     len(pm.GetMessageFields()) > 0,
+		HasOneofs:     len(pm.GetOneofDecl()) > 0,
 		Extensions:    make([]*MessageExtension, 0, len(pm.Extensions)),
 		Fields:        make([]*MessageField, 0, len(pm.Fields)),
 		Options:       mergeOptions(extractOptions(pm.GetOptions()), extensions.Transform(pm.OptionExtensions)),
@@ -452,7 +456,7 @@ func parseMessage(pm *protokit.Descriptor) *Message {
 	}
 
 	for _, f := range pm.Fields {
-		msg.Fields = append(msg.Fields, parseMessageField(f))
+		msg.Fields = append(msg.Fields, parseMessageField(f, pm.GetOneofDecl()))
 	}
 
 	return msg
@@ -467,7 +471,7 @@ func parseMessageExtension(pe *protokit.ExtensionDescriptor) *MessageExtension {
 	}
 }
 
-func parseMessageField(pf *protokit.FieldDescriptor) *MessageField {
+func parseMessageField(pf *protokit.FieldDescriptor, oneofDecls []*descriptor.OneofDescriptorProto) *MessageField {
 	t, lt, ft := parseType(pf)
 
 	m := &MessageField{
@@ -479,6 +483,11 @@ func parseMessageField(pf *protokit.FieldDescriptor) *MessageField {
 		FullType:     ft,
 		DefaultValue: pf.GetDefaultValue(),
 		Options:      mergeOptions(extractOptions(pf.GetOptions()), extensions.Transform(pf.OptionExtensions)),
+		IsOneof:      pf.OneofIndex != nil,
+	}
+
+	if m.IsOneof {
+		m.OneofDecl = oneofDecls[pf.GetOneofIndex()].GetName()
 	}
 
 	// Check if this is a map.

template_test.go

@@ -251,6 +251,7 @@ func TestFieldProperties(t *testing.T) {
 	require.Equal(t, "int32", field.LongType)
 	require.Equal(t, "int32", field.FullType)
 	require.Empty(t, field.DefaultValue)
+	require.False(t, field.IsOneof)
 	require.NotEmpty(t, field.Options)
 	require.True(t, *field.Option(E_ExtendField.Name).(*bool))
 
@@ -262,6 +263,7 @@ func TestFieldProperties(t *testing.T) {
 	require.Equal(t, "BookingStatus.StatusCode", field.LongType)
 	require.Equal(t, "com.example.BookingStatus.StatusCode", field.FullType)
 	require.Empty(t, field.DefaultValue)
+	require.False(t, field.IsOneof)
 
 	field = findField("category", findMessage("Vehicle", vehicleFile))
 	require.Equal(t, "category", field.Name)
@@ -271,6 +273,7 @@ func TestFieldProperties(t *testing.T) {
 	require.Equal(t, "Vehicle.Category", field.LongType)
 	require.Equal(t, "com.example.Vehicle.Category", field.FullType)
 	require.Empty(t, field.DefaultValue)
+	require.False(t, field.IsOneof)
 
 	field = findField("properties", findMessage("Vehicle", vehicleFile))
 	require.Equal(t, "properties", field.Name)
@@ -280,6 +283,7 @@ func TestFieldProperties(t *testing.T) {
 	require.Equal(t, "com.example.Vehicle.PropertiesEntry", field.FullType)
 	require.Empty(t, field.DefaultValue)
 	require.True(t, field.IsMap)
+	require.False(t, field.IsOneof)
 
 	field = findField("rates", findMessage("Vehicle", vehicleFile))
 	require.Equal(t, "rates", field.Name)
@@ -288,6 +292,27 @@ func TestFieldProperties(t *testing.T) {
 	require.Equal(t, "sint32", field.LongType)
 	require.Equal(t, "sint32", field.FullType)
 	require.False(t, field.IsMap)
+	require.False(t, field.IsOneof)
+
+	field = findField("kilometers", findMessage("Vehicle", vehicleFile))
+	require.Equal(t, "kilometers", field.Name)
+	require.Equal(t, "", field.Label)
+	require.Equal(t, "int32", field.Type)
+	require.Equal(t, "int32", field.LongType)
+	require.Equal(t, "int32", field.FullType)
+	require.False(t, field.IsMap)
+	require.True(t, field.IsOneof)
+	require.Equal(t, "travel", field.OneofDecl)
+
+	field = findField("human_name", findMessage("Vehicle", vehicleFile))
+	require.Equal(t, "human_name", field.Name)
+	require.Equal(t, "", field.Label)
+	require.Equal(t, "string", field.Type)
+	require.Equal(t, "string", field.LongType)
+	require.Equal(t, "string", field.FullType)
+	require.False(t, field.IsMap)
+	require.True(t, field.IsOneof)
+	require.Equal(t, "drivers", field.OneofDecl)
 }
 
 func TestFieldPropertiesProto3(t *testing.T) {