fix!: update shape and member extensions to use same casing as rest of the system (#467)

ganeshnj · web-flow · commit 8532df7cb94d · 2022-11-08T11:38:20.000-08:00
diff --git a/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/PaginatorGenerator.kt b/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/PaginatorGenerator.kt
@@ -16,10 +16,10 @@ import software.amazon.smithy.swift.codegen.core.CodegenContext
 import software.amazon.smithy.swift.codegen.integration.ProtocolGenerator
 import software.amazon.smithy.swift.codegen.integration.SwiftIntegration
 import software.amazon.smithy.swift.codegen.model.SymbolProperty
-import software.amazon.smithy.swift.codegen.model.camelCaseName
 import software.amazon.smithy.swift.codegen.model.expectShape
 import software.amazon.smithy.swift.codegen.model.hasTrait
 import software.amazon.smithy.swift.codegen.model.isBoxed
+import software.amazon.smithy.swift.codegen.model.toLowerCamelCase
 import software.amazon.smithy.swift.codegen.utils.toLowerCamelCase
 
 /**
@@ -102,9 +102,9 @@ class PaginatorGenerator : SwiftIntegration {
     ) {
         writer.addImport(SwiftDependency.CLIENT_RUNTIME.target)
         val nextMarkerLiteral = paginationInfo.outputTokenMemberPath.joinToString(separator = "?.") {
-            it.camelCaseName()
+            it.toLowerCamelCase()
         }
-        val markerLiteral = paginationInfo.inputTokenMember.camelCaseName()
+        val markerLiteral = paginationInfo.inputTokenMember.toLowerCamelCase()
         val markerLiteralShape = model.expectShape(paginationInfo.inputTokenMember.target)
         val markerLiteralSymbol = symbolProvider.toSymbol(markerLiteralShape)
         val docBody = """
@@ -125,7 +125,7 @@ class PaginatorGenerator : SwiftIntegration {
         writer.openBlock("extension \$L {", "}", serviceSymbol.name) {
             writer.openBlock(
                 "public func \$LPaginated(input: \$N) -> \$N<\$N, \$N> {", "}",
-                operationShape.camelCaseName(),
+                operationShape.toLowerCamelCase(),
                 inputSymbol,
                 ClientRuntimeTypes.Core.PaginatorSequence,
                 inputSymbol,
@@ -138,7 +138,7 @@ class PaginatorGenerator : SwiftIntegration {
                     outputSymbol,
                     inputSymbol,
                     outputSymbol,
-                    operationShape.camelCaseName()
+                    operationShape.toLowerCamelCase()
                 )
             }
         }
@@ -153,12 +153,12 @@ class PaginatorGenerator : SwiftIntegration {
                         writer.writeInline("\$N(", inputSymbol)
                             .indent()
                             .call {
-                                val sortedMembers = inputShape.members().sortedBy { it.camelCaseName() }
+                                val sortedMembers = inputShape.members().sortedBy { it.toLowerCamelCase() }
                                 for ((index, member) in sortedMembers.withIndex()) {
                                     if (member.memberName.toLowerCamelCase() != markerLiteral) {
-                                        writer.writeInline("\n\$L: \$L", member.camelCaseName(), "self.${member.camelCaseName()}")
+                                        writer.writeInline("\n\$L: \$L", member.toLowerCamelCase(), "self.${member.toLowerCamelCase()}")
                                     } else {
-                                        writer.writeInline("\n\$L: \$L", member.camelCaseName(), "token")
+                                        writer.writeInline("\n\$L: \$L", member.toLowerCamelCase(), "token")
                                     }
                                     if (index < sortedMembers.size - 1) {
                                         writer.writeInline(",")
@@ -184,7 +184,7 @@ class PaginatorGenerator : SwiftIntegration {
         writer.write("")
         val itemSymbolShape = itemDesc.itemSymbol.getProperty("shape").getOrNull() as? Shape
         val docBody = """
-        This paginator transforms the `AsyncSequence` returned by `${operationShape.camelCaseName()}Paginated`
+        This paginator transforms the `AsyncSequence` returned by `${operationShape.toLowerCamelCase()}Paginated`
         to access the nested member `${itemDesc.collectionLiteral}`
         - Returns: `${itemDesc.collectionLiteral}`
         """.trimIndent()
@@ -223,8 +223,8 @@ private data class ItemDescriptor(
  */
 private fun getItemDescriptorOrNull(paginationInfo: PaginationInfo, ctx: CodegenContext): ItemDescriptor? {
     val itemMemberId = paginationInfo.itemsMemberPath?.lastOrNull()?.target ?: return null
-    val itemLiteral = paginationInfo.itemsMemberPath!!.last()!!.camelCaseName()
-    val itemPathLiteral = paginationInfo.itemsMemberPath.joinToString(separator = "?.") { it.camelCaseName() }
+    val itemLiteral = paginationInfo.itemsMemberPath!!.last()!!.toLowerCamelCase()
+    val itemPathLiteral = paginationInfo.itemsMemberPath.joinToString(separator = "?.") { it.toLowerCamelCase() }
     val itemMember = ctx.model.expectShape(itemMemberId)
     val collectionLiteral = when (itemMember) {
         is MapShape -> {
diff --git a/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/ServiceGenerator.kt b/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/ServiceGenerator.kt
@@ -18,7 +18,7 @@ import software.amazon.smithy.swift.codegen.integration.DefaultServiceConfig
 import software.amazon.smithy.swift.codegen.integration.ProtocolGenerator
 import software.amazon.smithy.swift.codegen.integration.SectionId
 import software.amazon.smithy.swift.codegen.integration.middlewares.handlers.MiddlewareShapeUtils
-import software.amazon.smithy.swift.codegen.model.camelCaseName
+import software.amazon.smithy.swift.codegen.model.toLowerCamelCase
 
 /*
 * Generates a Swift protocol for the service
@@ -53,7 +53,7 @@ class ServiceGenerator(
             op: OperationShape,
             insideProtocol: Boolean = false
         ) {
-            val operationName = op.camelCaseName()
+            val operationName = op.toLowerCamelCase()
             // Theoretically this shouldn't happen since we insert empty input/outputs for operations that don't have one or the other to allow for sdk evolution
             if (!op.input.isPresent || !op.output.isPresent) throw CodegenException("model should have been preprocessed to ensure operations always have an input or output shape: $op.id")
 
diff --git a/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/StructureGenerator.kt b/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/StructureGenerator.kt
@@ -19,13 +19,13 @@ import software.amazon.smithy.swift.codegen.customtraits.NestedTrait
 import software.amazon.smithy.swift.codegen.customtraits.SwiftBoxTrait
 import software.amazon.smithy.swift.codegen.integration.ProtocolGenerator
 import software.amazon.smithy.swift.codegen.integration.SectionId
-import software.amazon.smithy.swift.codegen.model.camelCaseName
 import software.amazon.smithy.swift.codegen.model.expectShape
 import software.amazon.smithy.swift.codegen.model.getTrait
 import software.amazon.smithy.swift.codegen.model.hasTrait
 import software.amazon.smithy.swift.codegen.model.isError
 import software.amazon.smithy.swift.codegen.model.nestedNamespaceType
 import software.amazon.smithy.swift.codegen.model.recursiveSymbol
+import software.amazon.smithy.swift.codegen.model.toLowerCamelCase
 import software.amazon.smithy.swift.codegen.utils.toUpperCamelCase
 
 class StructureGenerator(
@@ -37,7 +37,7 @@ class StructureGenerator(
     private val serviceErrorProtocolSymbol: Symbol? = null
 ) {
 
-    private val membersSortedByName: List<MemberShape> = shape.allMembers.values.sortedBy { it.camelCaseName() }
+    private val membersSortedByName: List<MemberShape> = shape.allMembers.values.sortedBy { it.toLowerCamelCase() }
     private var memberShapeDataContainer: MutableMap<MemberShape, Pair<String, Symbol>> = mutableMapOf()
 
     init {
diff --git a/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpProtocolClientGenerator.kt b/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpProtocolClientGenerator.kt
@@ -15,7 +15,7 @@ import software.amazon.smithy.swift.codegen.SwiftWriter
 import software.amazon.smithy.swift.codegen.integration.middlewares.handlers.MiddlewareShapeUtils
 import software.amazon.smithy.swift.codegen.middleware.MiddlewareExecutionGenerator
 import software.amazon.smithy.swift.codegen.middleware.OperationMiddleware
-import software.amazon.smithy.swift.codegen.model.capitalizedName
+import software.amazon.smithy.swift.codegen.model.toUpperCamelCase
 
 /**
  * Renders an implementation of a service interface for HTTP protocol
@@ -46,7 +46,7 @@ open class HttpProtocolClientGenerator(
 
     private fun renderOperationsInExtension(serviceSymbol: Symbol) {
         val topDownIndex = TopDownIndex.of(model)
-        val operations = topDownIndex.getContainedOperations(serviceShape).sortedBy { it.capitalizedName() }
+        val operations = topDownIndex.getContainedOperations(serviceShape).sortedBy { it.toUpperCamelCase() }
         val operationsIndex = OperationIndex.of(model)
 
         writer.openBlock("extension ${serviceSymbol.name}: ${serviceSymbol.name}Protocol {", "}") {
diff --git a/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpProtocolTestGenerator.kt b/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpProtocolTestGenerator.kt
@@ -20,8 +20,8 @@ import software.amazon.smithy.swift.codegen.integration.middlewares.OperationInp
 import software.amazon.smithy.swift.codegen.integration.middlewares.RequestTestEndpointResolverMiddleware
 import software.amazon.smithy.swift.codegen.middleware.MiddlewareStep
 import software.amazon.smithy.swift.codegen.middleware.OperationMiddleware
-import software.amazon.smithy.swift.codegen.model.capitalizedName
 import software.amazon.smithy.swift.codegen.model.hasTrait
+import software.amazon.smithy.swift.codegen.model.toUpperCamelCase
 import java.util.TreeSet
 import java.util.logging.Logger
 
@@ -96,7 +96,7 @@ class HttpProtocolTestGenerator(
             .orEmpty()
         val requestTestCases = filterProtocolTestCases(tempTestCases)
         if (requestTestCases.isNotEmpty()) {
-            val testClassName = "${operation.capitalizedName()}RequestTest"
+            val testClassName = "${operation.toUpperCamelCase()}RequestTest"
             val testFilename = "./${ctx.settings.moduleName}Tests/$testClassName.swift"
             ctx.delegator.useTestFileWriter(testFilename, ctx.settings.moduleName) { writer ->
                 LOGGER.fine("Generating request protocol test cases for ${operation.id}")
@@ -175,7 +175,7 @@ class HttpProtocolTestGenerator(
                 // multiple error (tests) may be associated with a single operation,
                 // use the operation name + error name as the class name
                 val opName = operation.id.name.capitalize()
-                val testClassName = "${opName}${error.capitalizedName()}Test"
+                val testClassName = "${opName}${error.toUpperCamelCase()}Test"
                 val testFilename = "./${ctx.settings.moduleName}Tests/${opName}ErrorTest.swift"
                 ctx.delegator.useTestFileWriter(testFilename, ctx.settings.moduleName) { writer ->
                     LOGGER.fine("Generating error protocol test cases for ${operation.id}")
diff --git a/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpProtocolUnitTestErrorGenerator.kt b/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpProtocolUnitTestErrorGenerator.kt
@@ -7,7 +7,7 @@ package software.amazon.smithy.swift.codegen.integration
 import software.amazon.smithy.codegen.core.CodegenException
 import software.amazon.smithy.model.shapes.Shape
 import software.amazon.smithy.protocoltests.traits.HttpResponseTestCase
-import software.amazon.smithy.swift.codegen.model.capitalizedName
+import software.amazon.smithy.swift.codegen.model.toUpperCamelCase
 
 open class HttpProtocolUnitTestErrorGenerator protected constructor(builder: Builder) :
     HttpProtocolUnitTestResponseGenerator(builder) {
@@ -16,7 +16,7 @@ open class HttpProtocolUnitTestErrorGenerator protected constructor(builder: Bui
 
     override fun renderTestBody(test: HttpResponseTestCase) {
         outputShape?.let {
-            val operationErrorType = "${operation.capitalizedName()}OutputError"
+            val operationErrorType = "${operation.toUpperCamelCase()}OutputError"
             writer.openBlock("do {", "} catch let err {") {
                 renderBuildHttpResponse(test)
                 writer.write("")
diff --git a/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpProtocolUnitTestRequestGenerator.kt b/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpProtocolUnitTestRequestGenerator.kt
@@ -17,7 +17,7 @@ import software.amazon.smithy.swift.codegen.ShapeValueGenerator
 import software.amazon.smithy.swift.codegen.SwiftWriter
 import software.amazon.smithy.swift.codegen.middleware.MiddlewareStep
 import software.amazon.smithy.swift.codegen.model.RecursiveShapeBoxer
-import software.amazon.smithy.swift.codegen.model.capitalizedName
+import software.amazon.smithy.swift.codegen.model.toUpperCamelCase
 import software.amazon.smithy.swift.codegen.swiftFunctionParameterIndent
 
 open class HttpProtocolUnitTestRequestGenerator protected constructor(builder: Builder) :
@@ -78,7 +78,7 @@ open class HttpProtocolUnitTestRequestGenerator protected constructor(builder: B
             val outputShapeId = operation.output.get()
             val outputShape = model.expectShape(outputShapeId)
             val outputSymbol = symbolProvider.toSymbol(outputShape)
-            val outputErrorName = "${operation.capitalizedName()}OutputError"
+            val outputErrorName = "${operation.toUpperCamelCase()}OutputError"
 
             writer.write("let context = HttpContextBuilder()")
             val idempotentMember = inputShape.members().firstOrNull() { it.hasTrait(IdempotencyTokenTrait::class.java) }
diff --git a/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/middlewares/handlers/MiddlewareShapeUtils.kt b/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/middlewares/handlers/MiddlewareShapeUtils.kt
@@ -12,8 +12,8 @@ import software.amazon.smithy.model.traits.HttpTrait
 import software.amazon.smithy.swift.codegen.SwiftSettings
 import software.amazon.smithy.swift.codegen.integration.HttpBindingDescriptor
 import software.amazon.smithy.swift.codegen.integration.isInHttpBody
-import software.amazon.smithy.swift.codegen.model.capitalizedName
 import software.amazon.smithy.swift.codegen.model.getTrait
+import software.amazon.smithy.swift.codegen.model.toUpperCamelCase
 
 class MiddlewareShapeUtils {
     companion object {
@@ -41,7 +41,7 @@ class MiddlewareShapeUtils {
             return Symbol.builder().name(operationErrorName).build()
         }
         fun outputErrorSymbolName(op: OperationShape): String {
-            return "${op.capitalizedName()}OutputError"
+            return "${op.toUpperCamelCase()}OutputError"
         }
         fun rootNamespace(settings: SwiftSettings): String {
             return settings.moduleName
diff --git a/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/middleware/MiddlewareExecutionGenerator.kt b/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/middleware/MiddlewareExecutionGenerator.kt
@@ -9,8 +9,8 @@ import software.amazon.smithy.swift.codegen.integration.HttpBindingResolver
 import software.amazon.smithy.swift.codegen.integration.HttpProtocolCustomizable
 import software.amazon.smithy.swift.codegen.integration.ProtocolGenerator
 import software.amazon.smithy.swift.codegen.integration.middlewares.handlers.MiddlewareShapeUtils
-import software.amazon.smithy.swift.codegen.model.camelCaseName
-import software.amazon.smithy.swift.codegen.model.capitalizedName
+import software.amazon.smithy.swift.codegen.model.toLowerCamelCase
+import software.amazon.smithy.swift.codegen.model.toUpperCamelCase
 import software.amazon.smithy.swift.codegen.swiftFunctionParameterIndent
 
 typealias HttpMethodCallback = (OperationShape) -> String
@@ -27,14 +27,14 @@ class MiddlewareExecutionGenerator(
     private val symbolProvider = ctx.symbolProvider
 
     fun render(op: OperationShape, onError: (SwiftWriter, String) -> Unit) {
-        val operationErrorName = "${op.capitalizedName()}OutputError"
+        val operationErrorName = "${op.toUpperCamelCase()}OutputError"
         val inputShapeName = MiddlewareShapeUtils.inputSymbol(symbolProvider, ctx.model, op).name
         val outputShapeName = MiddlewareShapeUtils.outputSymbol(symbolProvider, ctx.model, op).name
         writer.write("let context = \$N()", ClientRuntimeTypes.Http.HttpContextBuilder)
         writer.swiftFunctionParameterIndent {
             renderContextAttributes(op)
         }
-        writer.write("var $operationStackName = \$N<$inputShapeName, $outputShapeName, $operationErrorName>(id: \"${op.camelCaseName()}\")", OperationStack)
+        writer.write("var $operationStackName = \$N<$inputShapeName, $outputShapeName, $operationErrorName>(id: \"${op.toLowerCamelCase()}\")", OperationStack)
         renderMiddlewares(op, operationStackName)
     }
 
@@ -46,7 +46,7 @@ class MiddlewareExecutionGenerator(
         writer.write("  .withDecoder(value: decoder)")
         writer.write("  .withMethod(value: .$httpMethod)")
         writer.write("  .withServiceName(value: serviceName)")
-        writer.write("  .withOperation(value: \"${op.camelCaseName()}\")")
+        writer.write("  .withOperation(value: \"${op.toLowerCamelCase()}\")")
         writer.write("  .withIdempotencyTokenGenerator(value: config.idempotencyTokenGenerator)")
         writer.write("  .withLogger(value: config.logger)")
 
diff --git a/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/model/ShapeExt.kt b/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/model/ShapeExt.kt
@@ -25,6 +25,8 @@ import software.amazon.smithy.model.traits.RequiredTrait
 import software.amazon.smithy.model.traits.StreamingTrait
 import software.amazon.smithy.model.traits.Trait
 import software.amazon.smithy.swift.codegen.getOrNull
+import software.amazon.smithy.swift.codegen.utils.toLowerCamelCase
+import software.amazon.smithy.swift.codegen.utils.toUpperCamelCase
 import software.amazon.smithy.utils.StringUtils
 import kotlin.streams.toList
 
@@ -71,8 +73,8 @@ val Shape.isError: Boolean
 val Shape.isNumberShape: Boolean
     get() = this is NumberShape
 
-fun Shape.capitalizedName(): String {
-    return StringUtils.capitalize(this.id.name)
+fun Shape.toUpperCamelCase(): String {
+    return this.id.name.toUpperCamelCase()
 }
 
 fun Shape.defaultName(serviceShape: ServiceShape? = null): String {
@@ -82,8 +84,8 @@ fun Shape.defaultName(serviceShape: ServiceShape? = null): String {
         StringUtils.capitalize(this.id.name)
     }
 }
-fun MemberShape.camelCaseName(): String = StringUtils.uncapitalize(this.memberName)
-fun Shape.camelCaseName(): String = StringUtils.uncapitalize(this.id.name)
+fun MemberShape.toLowerCamelCase(): String = this.memberName.toLowerCamelCase()
+fun Shape.toLowerCamelCase(): String = this.id.name.toLowerCamelCase()
 
 fun MemberShape.defaultValue(symbolProvider: SymbolProvider): String? {
     val targetSymbol = symbolProvider.toSymbol(this)
diff --git a/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/utils/CaseUtils.kt b/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/utils/CaseUtils.kt
@@ -10,7 +10,10 @@ fun String.splitOnWordBoundaries(): List<String> {
     var result = this
 
     // all non-alphanumeric characters: "acm-success"-> "acm success"
-    result = result.replace(Regex("[^A-Za-z0-9+]"), " ")
+    result = result.replace(Regex("[^A-Za-z0-9+_]"), " ")
+
+    // if there is an underscore, split on it: "acm_success" -> "acm", "_", "success"
+    result = result.replace(Regex("_"), " _ ")
 
     // if a number has a standalone v in front of it, separate it out
     result = result.replace(Regex("([^a-z]{2,})v([0-9]+)"), "$1 v$2 ") // TESTv4 -> "TEST v4 "
diff --git a/smithy-swift-codegen/src/test/kotlin/CaseUtilsTests.kt b/smithy-swift-codegen/src/test/kotlin/CaseUtilsTests.kt
@@ -35,4 +35,12 @@ class CaseUtilsTests {
         val actual = input.toUpperCamelCase()
         assertEquals(expected, actual)
     }
+
+    @Test
+    fun `it should preserve underscore`() {
+        val input = "Foo_Bar"
+        val expected = "foo_Bar"
+        val actual = input.toLowerCamelCase()
+        assertEquals(expected, actual)
+    }
 }
