Skip to content

Commit

Permalink
Updates to the ruby generator for protobuf 3.6.0 changes
Browse files Browse the repository at this point in the history
test for verifying the ruby_package option
added WeWork to the AUTHORS file
  • Loading branch information
Nick Gordon committed Sep 14, 2018
1 parent 608188c commit 3fe2c98
Show file tree
Hide file tree
Showing 4 changed files with 92 additions and 2 deletions.
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Google Inc.
WeWork Companies Inc.
12 changes: 10 additions & 2 deletions src/compiler/ruby_generator.cc
Original file line number Diff line number Diff line change
Expand Up @@ -160,12 +160,20 @@ grpc::string GetServices(const FileDescriptor* file) {
return output;
}

std::string package_name;

if (file->options().has_ruby_package()) {
package_name = file->options().ruby_package();
} else {
package_name = file->package();
}

// Write out a file header.
std::map<grpc::string, grpc::string> header_comment_vars = ListToDict({
"file.name",
file->name(),
"file.package",
file->package(),
package_name,
});
out.Print("# Generated by the protocol buffer compiler. DO NOT EDIT!\n");
out.Print(header_comment_vars,
Expand All @@ -190,7 +198,7 @@ grpc::string GetServices(const FileDescriptor* file) {

// Write out services within the modules
out.Print("\n");
std::vector<grpc::string> modules = Split(file->package(), '.');
std::vector<grpc::string> modules = Split(package_name, '.');
for (size_t i = 0; i < modules.size(); ++i) {
std::map<grpc::string, grpc::string> module_vars = ListToDict({
"module.name",
Expand Down
28 changes: 28 additions & 0 deletions src/proto/grpc/testing/package_options.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
// Copyright 2018 gRPC authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax = "proto3";

package grpc.testing;

// For sanity checking package definitions
option ruby_package = "Grpc.Testing.Package.Options";

message TestRequest { }

message TestResponse { }

service TestService {
rpc GetTest(TestRequest) returns (TestResponse) { }
}
53 changes: 53 additions & 0 deletions src/ruby/spec/pb/codegen/package_option_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Copyright 2018 gRPC authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

require 'spec_helper'
require 'open3'
require 'tmpdir'

describe 'Code Generation Options' do
it 'should generate and respect package options' do
fail 'CONFIG env variable unexpectedly unset' unless ENV['CONFIG']
bins_sub_dir = ENV['CONFIG']

src_dir = File.join(File.dirname(__FILE__), '..', '..', '..', '..')
pb_dir = File.join(src_dir, 'proto')
bins_dir = File.join(src_dir, '..', 'bins', bins_sub_dir)

plugin = File.join(bins_dir, 'grpc_ruby_plugin')
protoc = File.join(bins_dir, 'protobuf', 'protoc')

# Generate the service from the proto
Dir.mktmpdir(nil, File.dirname(__FILE__)) do |tmp_dir|
gen_file = system(protoc,
'-I.',
'grpc/testing/package_options.proto',
"--grpc_out=#{tmp_dir}", # generate the service
"--ruby_out=#{tmp_dir}", # generate the definitions
"--plugin=protoc-gen-grpc=#{plugin}",
chdir: pb_dir,
out: File::NULL)

expect(gen_file).to be_truthy
begin
$LOAD_PATH.push(tmp_dir)
expect { Grpc::Testing::Package::Options::TestService::Service }.to raise_error(NameError)
expect(require('grpc/testing/package_options_services_pb')).to be_truthy
expect { Grpc::Testing::Package::Options::TestService::Service }.to_not raise_error
ensure
$LOAD_PATH.delete(tmp_dir)
end
end
end
end

0 comments on commit 3fe2c98

Please sign in to comment.