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.

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

Fix casing of generated services and methods #8

Merged
merged 6 commits into from
Oct 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 43 additions & 0 deletions Sources/GRPCProtobufCodeGen/CamelCaser.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
* Copyright 2024, gRPC Authors All rights reserved.
*
* 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.
*/

package enum CamelCaser {
/// Converts a string from upper camel case to lower camel case.
package static func toLowerCamelCase(_ input: String) -> String {
guard let indexOfFirstLowercase = input.firstIndex(where: { $0.isLowercase }) else {
return input.lowercased()
}

if indexOfFirstLowercase == input.startIndex {
// `input` already begins with a lower case letter. As in: "importCSV".
return input
} else if indexOfFirstLowercase == input.index(after: input.startIndex) {
// The second character in `input` is lower case. As in: "ImportCSV".
// returns "importCSV"
return input[input.startIndex].lowercased() + input[indexOfFirstLowercase...]
} else {
// The first lower case character is further within `input`. Tentatively, `input` begins
// with one or more abbreviations. Therefore, the last encountered upper case character
// could be the beginning of the next word. As in: "FOOBARImportCSV".

let leadingAbbreviation = input[..<input.index(before: indexOfFirstLowercase)]
let followingWords = input[input.index(before: indexOfFirstLowercase)...]

// returns "foobarImportCSV"
return leadingAbbreviation.lowercased() + followingWords
}
}
}
11 changes: 6 additions & 5 deletions Sources/GRPCProtobufCodeGen/ProtobufCodeGenParser.swift
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*/

internal import Foundation
internal import SwiftProtobuf
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this import not used for anything?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was imported to access NamingUtils which is no longer used.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NamingUtils comes from the SwiftProtobufPluginLibrary

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh yes. That means SwiftProtobuf was already not in use.

internal import SwiftProtobufPluginLibrary

internal import struct GRPCCodeGen.CodeGenerationRequest
Expand Down Expand Up @@ -125,8 +124,9 @@ extension CodeGenerationRequest.ServiceDescriptor {
}
let name = CodeGenerationRequest.Name(
base: descriptor.name,
generatedUpperCase: NamingUtils.toUpperCamelCase(descriptor.name),
generatedLowerCase: NamingUtils.toLowerCamelCase(descriptor.name)
// The service name from the '.proto' file is expected to be in upper camel case
generatedUpperCase: descriptor.name,
generatedLowerCase: CamelCaser.toLowerCamelCase(descriptor.name)
)

// Packages that are based on the path of the '.proto' file usually
Expand All @@ -145,8 +145,9 @@ extension CodeGenerationRequest.ServiceDescriptor.MethodDescriptor {
fileprivate init(descriptor: MethodDescriptor, protobufNamer: SwiftProtobufNamer) {
let name = CodeGenerationRequest.Name(
base: descriptor.name,
generatedUpperCase: NamingUtils.toUpperCamelCase(descriptor.name),
generatedLowerCase: NamingUtils.toLowerCamelCase(descriptor.name)
// The method name from the '.proto' file is expected to be in upper camel case
generatedUpperCase: descriptor.name,
generatedLowerCase: CamelCaser.toLowerCamelCase(descriptor.name)
)
let documentation = descriptor.protoSourceComments()
self.init(
Expand Down
46 changes: 46 additions & 0 deletions Tests/GRPCProtobufCodeGenTests/CamelCaserTests.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/*
* Copyright 2024, gRPC Authors All rights reserved.
*
* 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.
*/

import GRPCProtobufCodeGen
import Testing

@Suite("CamelCaser")
struct CamelCaserTests {
@Test(
"Convert to lower camel case",
arguments: [
("ImportCsv", "importCsv"),
("ImportCSV", "importCSV"),
("CSVImport", "csvImport"),
("importCSV", "importCSV"),
("FOOBARImport", "foobarImport"),
("FOO_BARImport", "foo_barImport"),
("My_CSVImport", "my_CSVImport"),
("_CSVImport", "_csvImport"),
("V2Request", "v2Request"),
("V2_Request", "v2_Request"),
("CSV", "csv"),
("I", "i"),
("i", "i"),
("I_", "i_"),
("_", "_"),
("", ""),
]
)
func toLowerCamelCase(_ input: String, expectedOutput: String) async throws {
#expect(CamelCaser.toLowerCamelCase(input) == expectedOutput)
}
}
Loading