Skip to content

Update generated service and client class names to better handle well-named services. #97

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

Open
darronschall wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update generated service and client class names to better handle well-named services. #97

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5322b13
Only append "Service" to the generated service class name when servic…
darronschall Jan 6, 2023
3c0927b
Remove `Service` from generated client class names for well-named ser…
darronschall Jan 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions protoc-gen-twirp_ruby/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,14 @@ func (g *generator) generateRubyCode(file *descriptor.FileDescriptorProto, pbFil
for i, service := range file.Service {
svcName := service.GetName()

print(b, "%sclass %sService < ::Twirp::Service", indent, camelCase(svcName))
// The generated service class name should end in "Service"; Only append the
// suffix if the service is not already well-named.
svcClassName := svcName
if !strings.HasSuffix(svcClassName, "Service") {
svcClassName += "Service"
}

print(b, "%sclass %s < ::Twirp::Service", indent, camelCase(svcClassName))
if pkgName != "" {
print(b, "%s package '%s'", indent, pkgName)
}
Expand All @@ -124,8 +131,11 @@ func (g *generator) generateRubyCode(file *descriptor.FileDescriptorProto, pbFil
print(b, "%send", indent)
print(b, "")

print(b, "%sclass %sClient < ::Twirp::Client", indent, camelCase(svcName))
print(b, "%s client_for %sService", indent, camelCase(svcName))
// Strip the "Service" suffix if present for better readability.
clientClassName := strings.TrimSuffix(svcName, "Service") + "Client"

print(b, "%sclass %s < ::Twirp::Client", indent, camelCase(clientClassName))
print(b, "%s client_for %s", indent, camelCase(svcClassName))
print(b, "%send", indent)
if i < len(file.Service)-1 {
print(b, "")
Expand Down