starred/pkl
1
0
Fork 0
mirror of https://github.com/apple/pkl.git synced 2026-03-24 10:01:10 +01:00
Code Issues 198 Packages Projects Releases 10 Wiki Activity

Revert "Add setting for Kotlin package to codegen (#194)" (#271)

Browse Source 
This reverts commit 7f404fff49.

The package is derived from the module name.
Having `module com.example.Foo` in Pkl
will create Kotlin `package com.example`.

Eventually, we may want to introduce a way to map
Pkl names to package names that provides finer
controls to the code generator.
This commit is contained in:
Daniel Chao
2024-03-04 07:51:39 -08:00
committed by GitHub
parent 4f3858aaaf
commit 11f07d1ce8
7 changed files with 8 additions and 145 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
pkl-codegen-kotlin/src/main/kotlin/org/pkl/codegen/kotlin/CliKotlinCodeGeneratorOptions.kt
View File

@@ -29,9 +29,6 @@ data class CliKotlinCodeGeneratorOptions(
/** The characters to use for indenting generated source code. */
val indent: String = " ",
/** Kotlin package to use for generated code; if none is provided, the root package is used. */
val kotlinPackage: String = "",
/** Whether to generate Kdoc based on doc comments for Pkl modules, classes, and properties. */
val generateKdoc: Boolean = false,
@@ -42,11 +39,5 @@ data class CliKotlinCodeGeneratorOptions(
val implementSerializable: Boolean = false
) {
fun toKotlinCodegenOptions(): KotlinCodegenOptions =
KotlinCodegenOptions(
indent = indent,
generateKdoc = generateKdoc,
generateSpringBootConfig = generateSpringBootConfig,
implementSerializable = implementSerializable,
kotlinPackage = kotlinPackage,
)
KotlinCodegenOptions(indent, generateKdoc, generateSpringBootConfig, implementSerializable)
}

19
pkl-codegen-kotlin/src/main/kotlin/org/pkl/codegen/kotlin/KotlinCodeGenerator.kt
View File

@@ -27,9 +27,6 @@ data class KotlinCodegenOptions(
/** The characters to use for indenting generated Kotlin code. */
val indent: String = " ",
/** Kotlin package to use for generated code; if none is provided, the root package is used. */
val kotlinPackage: String = "",
/** Whether to generate KDoc based on doc comments for Pkl modules, classes, and properties. */
val generateKdoc: Boolean = false,
@@ -114,9 +111,6 @@ class KotlinCodeGenerator(
append("lin/${relativeOutputPathFor(moduleSchema.moduleName)}")
}
val kotlinPackage: String?
get() = options.kotlinPackage.ifEmpty { null }
val kotlinFile: String
get() {
if (moduleSchema.moduleUri.scheme == "pkl") {
@@ -129,7 +123,6 @@ class KotlinCodeGenerator(
val hasProperties = pModuleClass.properties.any { !it.value.isHidden }
val isGenerateClass = hasProperties || pModuleClass.isOpen || pModuleClass.isAbstract
val packagePrefix = kotlinPackage?.let { "$it." } ?: ""
val moduleType =
if (isGenerateClass) {
generateTypeSpec(pModuleClass, moduleSchema)
@@ -179,9 +172,7 @@ class KotlinCodeGenerator(
val packageName = if (index == -1) "" else moduleName.substring(0, index)
val moduleTypeName = moduleName.substring(index + 1).replaceFirstChar { it.titlecaseChar() }
val packagePath =
if (packagePrefix.isNotBlank()) "$packagePrefix.$packageName" else packageName
val fileSpec = FileSpec.builder(packagePath, moduleTypeName).indent(options.indent)
val fileSpec = FileSpec.builder(packageName, moduleTypeName).indent(options.indent)
for (typeAlias in moduleSchema.typeAliases.values) {
if (typeAlias.aliasedType is PType.Alias) {
@@ -647,14 +638,10 @@ class KotlinCodeGenerator(
val index = moduleName.lastIndexOf(".")
val packageName = if (index == -1) "" else moduleName.substring(0, index)
val moduleTypeName = moduleName.substring(index + 1).replaceFirstChar { it.titlecaseChar() }
val packagePrefix = kotlinPackage?.let { "$it." } ?: ""
val renderedPackage =
if (packagePrefix.isNotBlank()) "$packagePrefix.$packageName" else packageName
return if (isModuleClass) {
ClassName(renderedPackage, moduleTypeName)
ClassName(packageName, moduleTypeName)
} else {
ClassName(renderedPackage, moduleTypeName, simpleName)
ClassName(packageName, moduleTypeName, simpleName)
}
}

92
pkl-codegen-kotlin/src/test/kotlin/org/pkl/codegen/kotlin/KotlinCodeGeneratorTest.kt
View File

@@ -133,8 +133,7 @@ class KotlinCodeGeneratorTest {
pklCode: String,
generateKdoc: Boolean = false,
generateSpringBootConfig: Boolean = false,
implementSerializable: Boolean = false,
kotlinPackage: String? = null,
implementSerializable: Boolean = false
): String {
val module = Evaluator.preconfigured().evaluateSchema(ModuleSource.text(pklCode))
@@ -145,8 +144,7 @@ class KotlinCodeGeneratorTest {
KotlinCodegenOptions(
generateKdoc = generateKdoc,
generateSpringBootConfig = generateSpringBootConfig,
implementSerializable = implementSerializable,
kotlinPackage = kotlinPackage ?: "",
implementSerializable = implementSerializable
)
)
return generator.kotlinFile
@@ -555,92 +553,6 @@ class KotlinCodeGeneratorTest {
assertCompilesSuccessfully(kotlinCode)
}
@Test
fun `custom kotlin package prefix`() {
val kotlinCode =
generateKotlinCode(
"""
module my.mod
class Person {
name: String
age: Int
hobbies: List<String>
friends: Map<String, Person>
sibling: Person?
}
""",
kotlinPackage = "cool.pkg.path",
)
assertEqualTo(
"""
package cool.pkg.path.my
import kotlin.Long
import kotlin.String
import kotlin.collections.List
import kotlin.collections.Map
object Mod {
data class Person(
val name: String,
val age: Long,
val hobbies: List<String>,
val friends: Map<String, Person>,
val sibling: Person?
)
}
""",
kotlinCode
)
assertCompilesSuccessfully(kotlinCode)
}
@Test
fun `empty kotlin package prefix`() {
val kotlinCode =
generateKotlinCode(
"""
module my.mod
class Person {
name: String
age: Int
hobbies: List<String>
friends: Map<String, Person>
sibling: Person?
}
""",
kotlinPackage = "",
)
assertEqualTo(
"""
package my
import kotlin.Long
import kotlin.String
import kotlin.collections.List
import kotlin.collections.Map
object Mod {
data class Person(
val name: String,
val age: Long,
val hobbies: List<String>,
val friends: Map<String, Person>,
val sibling: Person?
)
}
""",
kotlinCode
)
assertCompilesSuccessfully(kotlinCode)
}
@Test
fun `recursive types`() {
val kotlinCode =

3
pkl-gradle/src/main/java/org/pkl/gradle/PklPlugin.java
View File

@@ -196,15 +196,12 @@ public class PklPlugin implements Plugin<Project> {
configureCodeGenSpec(spec);
spec.getGenerateKdoc().convention(false);
spec.getKotlinPackage().convention("");
createModulesTask(KotlinCodeGenTask.class, spec)
.configure(
task -> {
configureCodeGenTask(task, spec);
task.getGenerateKdoc().set(spec.getGenerateKdoc());
task.getIndent().set(spec.getIndent());
task.getKotlinPackage().set(spec.getKotlinPackage());
});
});

4
pkl-gradle/src/main/java/org/pkl/gradle/spec/KotlinCodeGenSpec.java
View File

@@ -19,9 +19,5 @@ import org.gradle.api.provider.Property;
/** Configuration options for Kotlin code generators. Documented in user manual. */
public interface KotlinCodeGenSpec extends CodeGenSpec {
Property<String> getIndent();
Property<String> getKotlinPackage();
Property<Boolean> getGenerateKdoc();
}

4
pkl-gradle/src/main/java/org/pkl/gradle/task/KotlinCodeGenTask.java
View File

@@ -25,9 +25,6 @@ public abstract class KotlinCodeGenTask extends CodeGenTask {
@Input
public abstract Property<Boolean> getGenerateKdoc();
@Input
public abstract Property<String> getKotlinPackage();
@Override
protected void doRunTask() {
//noinspection ResultOfMethodCallIgnored
@@ -38,7 +35,6 @@ public abstract class KotlinCodeGenTask extends CodeGenTask {
getCliBaseOptions(),
getProject().file(getOutputDir()).toPath(),
getIndent().get(),
getKotlinPackage().get(),
getGenerateKdoc().get(),
getGenerateSpringBootConfig().get(),
getImplementSerializable().get()))

20
pkl-gradle/src/test/kotlin/org/pkl/gradle/KotlinCodeGeneratorsTest.kt
View File

@@ -65,22 +65,7 @@ class KotlinCodeGeneratorsTest : AbstractTest() {
assertThat(personClassFile).exists()
assertThat(addressClassFile).exists()
}
@Test
fun `compile generated code with custom kotlin package`() {
writeBuildFile(kotlinPackage = "my.cool.pkl.pkg")
writePklFile()
runTask("compileKotlin")
val classesDir = testProjectDir.resolve("build/classes/kotlin/main")
val moduleClassFile = classesDir.resolve("my/cool/pkl/pkg/org/Mod.class")
val personClassFile = classesDir.resolve("my/cool/pkl/pkg/org/Mod\$Person.class")
val addressClassFile = classesDir.resolve("my/cool/pkl/pkg/org/Mod\$Address.class")
assertThat(moduleClassFile).exists()
assertThat(personClassFile).exists()
assertThat(addressClassFile).exists()
}
@Test
fun `no source modules`() {
writeFile(
@@ -103,7 +88,7 @@ class KotlinCodeGeneratorsTest : AbstractTest() {
assertThat(result.output).contains("No source modules specified.")
}
private fun writeBuildFile(kotlinPackage: String? = null) {
private fun writeBuildFile() {
val kotlinVersion = "1.6.0"
writeFile(
@@ -140,7 +125,6 @@ class KotlinCodeGeneratorsTest : AbstractTest() {
sourceModules = ["mod.pkl"]
outputDir = file("build/generated")
settingsModule = "pkl:settings"
${kotlinPackage?.let { "kotlinPackage = \"$it\"" } ?: ""}
}
}
}