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

Jump to bottom

feat(6178): emit ruby enum as integer #11673

Closed
wants to merge 3 commits into from
Closed

feat(6178): emit ruby enum as integer #11673

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e61c13c
feat(6178): emit ruby enum as integer
MQuy Jan 26, 2023
eed5cbe
feat(6178): support enums as integers in jruby
MQuy Feb 2, 2023
90f986a
chore(6178): rename enums_as_integers to format_enums_as_integers
MQuy Feb 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions ruby/ext/google/protobuf_c/message.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1164,6 +1164,11 @@ static VALUE Message_encode_json(int argc, VALUE* argv, VALUE klass) {
Qfalse))) {
options |= upb_JsonEncode_EmitDefaults;
}

if (RTEST(rb_hash_lookup2(hash_args, ID2SYM(rb_intern("format_enums_as_integers")),
Qfalse))) {
options |= upb_JsonEncode_FormatEnumsAsIntegers;
}
}

upb_Status_Clear(&status);
Expand Down
6 changes: 6 additions & 0 deletions ruby/src/main/java/com/google/protobuf/jruby/RubyMessage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -669,6 +669,7 @@ public static IRubyObject decode(ThreadContext context, IRubyObject recv, IRubyO
* @param options [Hash] options for the decoder
* preserve_proto_fieldnames: set true to use original fieldnames (default is to camelCase)
* emit_defaults: set true to emit 0/false values (default is to omit them)
* format_enums_as_integers: set true to emit enum values as integer (default is string)
*/
@JRubyMethod(name = "encode_json", required = 1, optional = 1, meta = true)
public static IRubyObject encodeJson(
Expand All @@ -690,6 +691,7 @@ public static IRubyObject encodeJson(

IRubyObject emitDefaults = options.fastARef(runtime.newSymbol("emit_defaults"));
IRubyObject preserveNames = options.fastARef(runtime.newSymbol("preserve_proto_fieldnames"));
IRubyObject printingEnumsAsInts = options.fastARef(runtime.newSymbol("format_enums_as_integers"));

if (emitDefaults != null && emitDefaults.isTrue()) {
printer = printer.includingDefaultValueFields();
Expand All @@ -698,6 +700,10 @@ public static IRubyObject encodeJson(
if (preserveNames != null && preserveNames.isTrue()) {
printer = printer.preservingProtoFieldNames();
}

if (printingEnumsAsInts != null && printingEnumsAsInts.isTrue()) {
printer = printer.printingEnumsAsInts();
}
}
printer =
printer.usingTypeRegistry(
Expand Down
28 changes: 28 additions & 0 deletions ruby/tests/encode_decode_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,34 @@ def test_encode_json
)

assert_match 'optional_int32', json


# Test for enums printing as ints.
MQuy marked this conversation as resolved.
Show resolved Hide resolved
msg = A::B::C::TestMessage.new({ optional_enum: 1 })
json = A::B::C::TestMessage.encode_json(
msg,
{ :format_enums_as_integers => true }
)

assert_match '"optionalEnum":1', json

# Test for default enum being printed as int.
msg = A::B::C::TestMessage.new({ optional_enum: 0 })
json = A::B::C::TestMessage.encode_json(
msg,
{ :format_enums_as_integers => true, :emit_defaults => true }
)

assert_match '"optionalEnum":0', json

# Test for repeated enums printing as ints.
msg = A::B::C::TestMessage.new({ repeated_enum: [0,1,2,3] })
json = A::B::C::TestMessage.encode_json(
msg,
{ :format_enums_as_integers => true }
)

assert_match '"repeatedEnum":[0,1,2,3]', json
end

def test_encode_wrong_msg
Expand Down