Skip to content

feat: improve coding style of DDBMapper auto-generated schemas #1522

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

Merged
merged 1 commit into from
Feb 6, 2025
Merged

feat: improve coding style of DDBMapper auto-generated schemas #1522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions .changes/5fa3154d-1f42-4b98-9ad1-ef8ef1ad5fbc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"id": "5fa3154d-1f42-4b98-9ad1-ef8ef1ad5fbc",
"type": "feature",
"description": "Improve the coding style of DynamoDB Mapper auto-generated schemas",
"issues": [
"https://github.com/awslabs/aws-sdk-kotlin/issues/1521"
]
}
4 changes: 2 additions & 2 deletions .../kotlin/aws/sdk/kotlin/hll/dynamodbmapper/codegen/annotations/rendering/SchemaRenderer.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ internal class SchemaRenderer(

// converter
renderValueConverter(prop.type.resolve())
write("")
write(",")
}
}

Expand Down Expand Up @@ -291,7 +291,7 @@ internal class SchemaRenderer(

write("@#T", Types.Smithy.ExperimentalApi)
withBlock("#Lobject #L : #T {", "}", ctx.attributes.visibility, schemaName, schemaType) {
write("override val converter : #1T = #1T", itemConverter)
write("override val converter: #1T = #1T", itemConverter)
write("override val partitionKey: #T = #T(#S)", MapperTypes.Items.keySpec(partitionKeyProp.keySpec), partitionKeyProp.keySpecType, partitionKeyName)
if (sortKeyProp != null) {
write("override val sortKey: #T = #T(#S)", MapperTypes.Items.keySpec(sortKeyProp.keySpec), sortKeyProp.keySpecType, sortKeyName!!)
Expand Down
22 changes: 11 additions & 11 deletions ...in/src/test/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPluginTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,25 +106,25 @@ class SchemaGeneratorPluginTest {
"id",
User::id,
UserBuilder::id::set,
IntConverter
IntConverter,
),
AttributeDescriptor(
"fName",
User::givenName,
UserBuilder::givenName::set,
StringConverter
StringConverter,
),
AttributeDescriptor(
"lName",
User::surname,
UserBuilder::surname::set,
StringConverter
StringConverter,
),
AttributeDescriptor(
"age",
User::age,
UserBuilder::age::set,
IntConverter
IntConverter,
),
),
)
Expand All @@ -136,7 +136,7 @@ class SchemaGeneratorPluginTest {
schemaContents,
"""
object UserSchema : ItemSchema.PartitionKey<User, Int> {
override val converter : UserConverter = UserConverter
override val converter: UserConverter = UserConverter
override val partitionKey: KeySpec<Number> = aws.sdk.kotlin.hll.dynamodbmapper.items.KeySpec.Number("id")
}
""".trimIndent(),
Expand Down Expand Up @@ -173,25 +173,25 @@ class SchemaGeneratorPluginTest {
"id",
BuilderNotRequired::id,
BuilderNotRequired::id::set,
IntConverter
IntConverter,
),
AttributeDescriptor(
"fName",
BuilderNotRequired::givenName,
BuilderNotRequired::givenName::set,
StringConverter
StringConverter,
),
AttributeDescriptor(
"lName",
BuilderNotRequired::surname,
BuilderNotRequired::surname::set,
StringConverter
StringConverter,
),
AttributeDescriptor(
"age",
BuilderNotRequired::age,
BuilderNotRequired::age::set,
IntConverter
IntConverter,
),
),
)
Expand Down Expand Up @@ -414,7 +414,7 @@ class SchemaGeneratorPluginTest {
schemaContents,
"""
public object CustomUserSchema : ItemSchema.PartitionKey<CustomUser, Int> {
override val converter : MyCustomUserConverter = MyCustomUserConverter
override val converter: MyCustomUserConverter = MyCustomUserConverter
override val partitionKey: KeySpec<Number> = aws.sdk.kotlin.hll.dynamodbmapper.items.KeySpec.Number("id")
}
""".trimIndent(),
Expand Down Expand Up @@ -570,7 +570,7 @@ class SchemaGeneratorPluginTest {
schemaContents,
"""
object RenamedPartitionKeySchema : ItemSchema.PartitionKey<RenamedPartitionKey, Int> {
override val converter : RenamedPartitionKeyConverter = RenamedPartitionKeyConverter
override val converter: RenamedPartitionKeyConverter = RenamedPartitionKeyConverter
override val partitionKey: KeySpec<Number> = aws.sdk.kotlin.hll.dynamodbmapper.items.KeySpec.Number("user_id")
}
""".trimIndent(),
Expand Down
Loading