Keyword sanitization for Lens code generation (arrow-kt#2924) (arrow-kt#2925)

Author: hrafnthor

arrow-libs/optics/arrow-optics-ksp-plugin/src/main/kotlin/arrow/optics/plugin/internals/domain.kt

@@ -9,7 +9,7 @@ data class ADT(val pckg: KSName, val declaration: KSClassDeclaration, val target
   val sourceClassName = declaration.qualifiedNameOrSimpleName
   val sourceName = declaration.simpleName.asString().replaceFirstChar { it.lowercase(Locale.getDefault()) }
   val simpleName = declaration.nameWithParentClass
-  val packageName = pckg.asString()
+  val packageName = pckg.asSanitizedString()
   val visibilityModifierName = when (declaration.companionObject?.getVisibility()) {
     Visibility.INTERNAL -> "internal"
     else -> "public"

arrow-libs/optics/arrow-optics-ksp-plugin/src/main/kotlin/arrow/optics/plugin/internals/processor.kt

@@ -80,7 +80,7 @@ internal fun evalAnnotatedPrismElement(
   }
 
 internal val KSDeclaration.qualifiedNameOrSimpleName: String
-  get() = (qualifiedName ?: simpleName).asString()
+  get() = (qualifiedName ?: simpleName).asSanitizedString()
 
 internal fun KSClassDeclaration.sealedSubclassFqNameList(): List<String> =
   getSealedSubclasses().mapNotNull { it.qualifiedName?.asString() }.toList()
@@ -135,10 +135,10 @@ internal fun KSClassDeclaration.getConstructorTypesNames(): List<String> =
 
 internal fun KSType.qualifiedString(): String = when (declaration) {
   is KSTypeParameter -> {
-    val n = declaration.simpleName.asString()
+    val n = declaration.simpleName.asSanitizedString()
     if (isMarkedNullable) "$n?" else n
   }
-  else -> when (val qname = declaration.qualifiedName?.asString()) {
+  else -> when (val qname = declaration.qualifiedName?.asSanitizedString()) {
     null -> toString()
     else -> {
       val withArgs = when {

arrow-libs/optics/arrow-optics-ksp-plugin/src/main/kotlin/arrow/optics/plugin/internals/utils.kt

@@ -1,8 +1,108 @@
 package arrow.optics.plugin.internals
 
+import com.google.devtools.ksp.symbol.KSName
+
 /**
  * From Eugenio's https://github.com/Takhion/kotlin-metadata If this [isNotBlank] then it adds the
  * optional [prefix] and [postfix].
  */
 fun String.plusIfNotBlank(prefix: String = "", postfix: String = "") =
   if (isNotBlank()) "$prefix${this}$postfix" else this
+
+/**
+ * Sanitizes each delimited section if it matches with Kotlin reserved keywords.
+ */
+fun KSName.asSanitizedString(delimiter: String = ".", separator: String = delimiter) =
+  asString().splitToSequence(delimiter).joinToString(separator) { if (kotlinKeywords.contains(it)) "`$it`" else it }
+
+
+private val kotlinKeywords = setOf(
+  // Hard keywords
+  "as",
+  "break",
+  "class",
+  "continue",
+  "do",
+  "else",
+  "false",
+  "for",
+  "fun",
+  "if",
+  "in",
+  "interface",
+  "is",
+  "null",
+  "object",
+  "package",
+  "return",
+  "super",
+  "this",
+  "throw",
+  "true",
+  "try",
+  "typealias",
+  "typeof",
+  "val",
+  "var",
+  "when",
+  "while",
+
+  // Soft keywords
+  "by",
+  "catch",
+  "constructor",
+  "delegate",
+  "dynamic",
+  "field",
+  "file",
+  "finally",
+  "get",
+  "import",
+  "init",
+  "param",
+  "property",
+  "receiver",
+  "set",
+  "setparam",
+  "where",
+
+  // Modifier keywords
+  "actual",
+  "abstract",
+  "annotation",
+  "companion",
+  "const",
+  "crossinline",
+  "data",
+  "enum",
+  "expect",
+  "external",
+  "final",
+  "infix",
+  "inline",
+  "inner",
+  "internal",
+  "lateinit",
+  "noinline",
+  "open",
+  "operator",
+  "out",
+  "override",
+  "private",
+  "protected",
+  "public",
+  "reified",
+  "sealed",
+  "suspend",
+  "tailrec",
+  "value",
+  "vararg",
+
+  // These aren't keywords anymore but still break some code if unescaped.
+  // https://youtrack.jetbrains.com/issue/KT-52315
+  "header",
+  "impl",
+
+  // Other reserved keywords
+  "yield",
+)

arrow-libs/optics/arrow-optics-ksp-plugin/src/test/kotlin/arrow/optics/plugin/DSLTests.kt

@@ -7,6 +7,7 @@ class DSLTests {
   @Test
   fun `DSL is generated for complex model with Every`() {
     """
+      |$`package`
       |$imports
       |$dslModel
       |$dslValues
@@ -19,6 +20,7 @@ class DSLTests {
   @Test
   fun `DSL is generated for complex model with At`() {
     """
+      |$`package`
       |$imports
       |$dslModel
       |$dslValues
@@ -32,6 +34,7 @@ class DSLTests {
     // it's important to keep the 'Source' name for the class,
     // because files in the test are named 'Source.kt'
     """
+      |$`package`
       |$imports
       |
       |@optics

arrow-libs/optics/arrow-optics-ksp-plugin/src/test/kotlin/arrow/optics/plugin/IsoTests.kt

@@ -9,6 +9,7 @@ class IsoTests {
   @Test
   fun `Isos will be generated for data class`() {
     """
+      |$`package`
       |$imports
       |@optics
       |data class IsoData(
@@ -23,6 +24,7 @@ class IsoTests {
   @Test
   fun `Isos will be generated for generic data class`() {
     """
+      |$`package`
       |$imports
       |@optics
       |data class IsoData<A>(
@@ -37,6 +39,7 @@ class IsoTests {
   @Test
   fun `Isos will be generated for data class with secondary constructors`() {
     """
+      |$`package`
       |$imports
       |@optics
       |data class IsoSecondaryConstructor(val fieldNumber: Int, val fieldString: String) {
@@ -52,6 +55,7 @@ class IsoTests {
   @Test
   fun `Iso generation requires companion object declaration`() {
     """
+      |$`package`
       |$imports
       |@optics
       |data class IsoNoCompanion(
@@ -63,6 +67,7 @@ class IsoTests {
   @Test
   fun `Isos cannot be generated for huge classes`() {
     """
+      |$`package`
       |$imports
       |@optics
       |data class IsoXXL(
@@ -92,6 +97,6 @@ class IsoTests {
       |) {
       |  companion object
       |}
-      """.failsWith { it.contains("IsoXXL".isoTooBigErrorMessage) }
+      """.failsWith { it.contains("${`package`.removePrefix("package ")}.IsoXXL".isoTooBigErrorMessage) }
   }
 }

arrow-libs/optics/arrow-optics-ksp-plugin/src/test/kotlin/arrow/optics/plugin/LensTests.kt

@@ -1,13 +1,13 @@
 package arrow.optics.plugin
 
-import arrow.optics.plugin.internals.typeParametersErrorMessage
 import org.junit.jupiter.api.Test
 
 class LensTests {
 
   @Test
   fun `Lenses will be generated for data class`() {
     """
+      |$`package`
       |$imports
       |@optics
       |data class LensData(
@@ -22,6 +22,7 @@ class LensTests {
   @Test
   fun `Lenses will be generated for data class with secondary constructors`() {
     """
+      |$`package`
       |$imports
       |@optics
       |data class LensesSecondaryConstructor(val fieldNumber: Int, val fieldString: String) {
@@ -37,6 +38,7 @@ class LensTests {
   @Test
   fun `Lenses which mentions imported elements`() {
     """
+      |$`package`
       |$imports
       |
       |@optics
@@ -52,6 +54,7 @@ class LensTests {
   @Test
   fun `Lenses which mentions type arguments`() {
     """
+      |$`package`
       |$imports
       |@optics
       |data class OpticsTest<A>(val field: A) {
@@ -66,6 +69,7 @@ class LensTests {
   @Test
   fun `Lenses for nested classes`() {
     """
+      |$`package`
       |$imports
       |@optics
       |data class LensData(val field1: String) {
@@ -84,6 +88,7 @@ class LensTests {
   @Test
   fun `Lenses for nested classes with repeated names (#2718)`() {
     """
+      |$`package`
       |$imports
       |@optics
       |data class LensData(val field1: String) {

arrow-libs/optics/arrow-optics-ksp-plugin/src/test/kotlin/arrow/optics/plugin/OptionalTests.kt

@@ -7,6 +7,7 @@ class OptionalTests {
   @Test
   fun `Optional will be generated for data class`() {
     """
+      |$`package`
       |$imports
       |@optics
       |data class OptionalData(
@@ -21,6 +22,7 @@ class OptionalTests {
   @Test
   fun `Optional will be generated for generic data class`() {
     """
+      |$`package`
       |$imports
       |@optics
       |data class OptionalData<A>(
@@ -35,6 +37,7 @@ class OptionalTests {
   @Test
   fun `Optional will be generated for data class with secondary constructors`() {
     """
+      |$`package`
       |$imports
       |@optics
       |data class OptionalSecondaryConstructor(val fieldNumber: Int?, val fieldString: String?) {

arrow-libs/optics/arrow-optics-ksp-plugin/src/test/kotlin/arrow/optics/plugin/PrismTests.kt

@@ -7,6 +7,7 @@ class PrismTests {
   @Test
   fun `Prism will be generated for sealed class`() {
     """
+      |$`package`
       |$imports
       |@optics
       |sealed class PrismSealed(val field: String, val nullable: String?) {
@@ -22,6 +23,7 @@ class PrismTests {
   @Test
   fun `Prism will be generated for generic sealed class`() {
     """
+      |$`package`
       |$imports
       |@optics
       |sealed class PrismSealed<A,B>(val field: A, val nullable: B?) {
@@ -37,6 +39,7 @@ class PrismTests {
   @Test
   fun `Prism will not be generated for sealed class if DSL Target is specified`() {
     """
+      |$`package`
       |$imports
       |@optics([OpticsTarget.DSL])
       |sealed class PrismSealed(val field: String, val nullable: String?) {

arrow-libs/optics/arrow-optics-ksp-plugin/src/test/kotlin/arrow/optics/plugin/Utils.kt

@@ -1,5 +1,7 @@
 package arrow.optics.plugin
 
+const val `package` = "package `if`.`this`.`object`.`is`.`finally`.`null`.`expect`.`annotation`"
+
 const val imports =
   """
       import arrow.core.None