Skip to content

Commit

Permalink
Add support for optional fields (fixes #24)
Browse files Browse the repository at this point in the history
  • Loading branch information
mdehoog committed May 8, 2021
1 parent c9f7758 commit 91bb72c
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 4 deletions.
22 changes: 20 additions & 2 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ func (m *rbiModule) InitContext(c pgs.BuildContext) {

funcs := map[string]interface{}{
"increment": m.increment,
"optional": m.optional,
"optionalOneOf": m.optionalOneOf,
"willGenerateInvalidRuby": m.willGenerateInvalidRuby,
"rubyModules": ruby_types.RubyModules,
"rubyPackage": ruby_types.RubyPackage,
Expand Down Expand Up @@ -79,6 +81,14 @@ func (m *rbiModule) increment(i int) int {
return i + 1
}

func (m *rbiModule) optional(field pgs.Field) bool {
return field.Descriptor().GetProto3Optional()
}

func (m *rbiModule) optionalOneOf(oneOf pgs.OneOf) bool {
return len(oneOf.Fields()) == 1 && oneOf.Fields()[0].Descriptor().GetProto3Optional()
}

func (m *rbiModule) willGenerateInvalidRuby(fields []pgs.Field) bool {
for _, field := range fields {
if !validRubyField.MatchString(string(field.Name())) {
Expand Down Expand Up @@ -149,11 +159,19 @@ class {{ rubyMessageType . }}
sig { params(value: {{ rubySetterFieldType . }}).void }
def {{ .Name }}=(value)
end
{{ end }}{{ range .OneOfs }}
{{ if optional . }}
sig { returns(T::Boolean) }
def has_{{ .Name }}?
end
sig { void }
def clear_{{ .Name }}
end
{{ end }}{{ end }}{{ range .OneOfs }}{{ if not (optionalOneOf .) }}
sig { returns(T.nilable(Symbol)) }
def {{ .Name }}
end
{{ end }}
{{ end }}{{ end }}
sig { params(field: String).returns(T.untyped) }
def [](field)
end
Expand Down
2 changes: 2 additions & 0 deletions testdata/subdir/messages.proto
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,6 @@ message AllTypes {
map<string, IntegerMessage> string_map_value = 26;
map<int32, IntegerMessage> int32_map_value = 27;
map<string, Corpus> enum_map_value = 28;

optional bool optional_bool = 29;
}
1 change: 1 addition & 0 deletions testdata/subdir/messages_pb.rb

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

22 changes: 20 additions & 2 deletions testdata/subdir/messages_pb.rbi
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,8 @@ class Testdata::Subdir::AllTypes
sub_message: T.nilable(T::Boolean),
string_map_value: T.nilable(T::Hash[String, T.nilable(Testdata::Subdir::IntegerMessage)]),
int32_map_value: T.nilable(T::Hash[Integer, T.nilable(Testdata::Subdir::IntegerMessage)]),
enum_map_value: T.nilable(T::Hash[String, T.any(Symbol, String, Integer)])
enum_map_value: T.nilable(T::Hash[String, T.any(Symbol, String, Integer)]),
optional_bool: T.nilable(T::Boolean)
).void
end
def initialize(
Expand Down Expand Up @@ -181,7 +182,8 @@ class Testdata::Subdir::AllTypes
sub_message: false,
string_map_value: Google::Protobuf::Map.new(:string, :message, Testdata::Subdir::IntegerMessage),
int32_map_value: Google::Protobuf::Map.new(:int32, :message, Testdata::Subdir::IntegerMessage),
enum_map_value: Google::Protobuf::Map.new(:string, :enum)
enum_map_value: Google::Protobuf::Map.new(:string, :enum),
optional_bool: false
)
end

Expand Down Expand Up @@ -409,6 +411,22 @@ class Testdata::Subdir::AllTypes
def enum_map_value=(value)
end

sig { returns(T::Boolean) }
def optional_bool
end

sig { params(value: T::Boolean).void }
def optional_bool=(value)
end

sig { returns(T::Boolean) }
def has_optional_bool?
end

sig { void }
def clear_optional_bool
end

sig { returns(T.nilable(Symbol)) }
def test_oneof
end
Expand Down

0 comments on commit 91bb72c

Please sign in to comment.