Skip to content

Commit

Permalink
support ktlint 0.46-0.48
Browse files Browse the repository at this point in the history
add tests for 0.44 and 0.45 as well
This resolves #589
This resolves #607
  • Loading branch information
wakingrufus committed Jan 17, 2023
1 parent 89b7fb6 commit 0bac117
Show file tree
Hide file tree
Showing 11 changed files with 466 additions and 76 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/).

## [Unreleased]

### Added

- The plugin will now work with ktlint `0.46.1` - `0.48.1`

## [11.0.0] - 2022-08-24

### Changed
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,320 @@
package org.jlleitschuh.gradle.ktlint.worker

import com.pinterest.ktlint.core.LintError
import com.pinterest.ktlint.core.api.FeatureInAlphaState
import java.io.File
import kotlin.reflect.KFunction
import kotlin.reflect.full.findParameterByName
import kotlin.reflect.full.instanceParameter
import kotlin.reflect.full.memberFunctions
import kotlin.reflect.full.memberProperties
import kotlin.reflect.full.primaryConstructor

/**
* An abstraction for invoking ktlint across all breaking changes between versions
*/
internal sealed interface KtLintInvocation {
fun invokeLint(file: File, cb: (LintError, Boolean) -> Unit)
fun invokeFormat(file: File, cb: (LintError, Boolean) -> Unit): String
}

sealed interface KtLintInvocationFactory

/**
* Implementation for invoking ktlint prior to 0.46.0
* Does not use reflection because the API is the same as the version of ktlint this project is compiled against
*/
internal class LegacyParamsInvocation(
private val editorConfigPath: String?,
private val ruleSets: Set<com.pinterest.ktlint.core.RuleSet>,
private val userData: Map<String, String>,
private val debug: Boolean
) : KtLintInvocation {
companion object Factory : KtLintInvocationFactory {
fun initialize(
editorConfigPath: String?,
ruleSets: Set<com.pinterest.ktlint.core.RuleSet>,
userData: Map<String, String>,
debug: Boolean
): KtLintInvocation = LegacyParamsInvocation(
editorConfigPath = editorConfigPath,
ruleSets = ruleSets,
userData = userData,
debug = debug
)
}

private fun buildParams(file: File, cb: (LintError, Boolean) -> Unit): com.pinterest.ktlint.core.KtLint.Params {
val script = !file.name.endsWith(".kt", ignoreCase = true)
return com.pinterest.ktlint.core.KtLint.Params(
fileName = file.absolutePath,
text = file.readText(),
ruleSets = ruleSets,
userData = userData,
debug = debug,
editorConfigPath = editorConfigPath,
script = script,
cb = cb
)
}

override fun invokeLint(file: File, cb: (LintError, Boolean) -> Unit) {
com.pinterest.ktlint.core.KtLint.lint(buildParams(file, cb))
}

override fun invokeFormat(file: File, cb: (LintError, Boolean) -> Unit): String {
return com.pinterest.ktlint.core.KtLint.format(buildParams(file, cb))
}
}

/**
* Implementation for invoking ktlint 0.46.x
*/
@OptIn(FeatureInAlphaState::class)
internal class ExperimentalParamsInvocation(
private val editorConfigPath: String?,
private val ruleSets: Set<com.pinterest.ktlint.core.RuleSet>,
private val userData: Map<String, String>,
private val debug: Boolean
) : KtLintInvocation {
companion object Factory : KtLintInvocationFactory {
fun initialize(
editorConfigPath: String?,
ruleSets: Set<com.pinterest.ktlint.core.RuleSet>,
userData: Map<String, String>,
debug: Boolean
): KtLintInvocation = ExperimentalParamsInvocation(
editorConfigPath = editorConfigPath,
ruleSets = ruleSets,
userData = userData,
debug = debug
)
}

private fun buildParams(
file: File,
cb: (LintError, Boolean) -> Unit
): com.pinterest.ktlint.core.KtLint.ExperimentalParams {
val script = !file.name.endsWith(".kt", ignoreCase = true)
val ctor = experimentalParamsClass!!.kotlin.primaryConstructor
val editorConfigOverride = userDataToEditorConfigOverride(userData)
return ctor!!.callBy(
mapOf(
ctor.findParameterByName("fileName")!! to file.absolutePath,
ctor.findParameterByName("text")!! to file.readText(),
ctor.findParameterByName("ruleSets")!! to ruleSets,
ctor.findParameterByName("cb")!! to cb,
ctor.findParameterByName("script")!! to script,
ctor.findParameterByName("editorConfigPath")!! to editorConfigPath,
ctor.findParameterByName("debug")!! to debug,
ctor.findParameterByName("editorConfigOverride")!! to editorConfigOverride
)
) as com.pinterest.ktlint.core.KtLint.ExperimentalParams
}

override fun invokeLint(file: File, cb: (LintError, Boolean) -> Unit) {
com.pinterest.ktlint.core.KtLint.lint(buildParams(file, cb))
}

override fun invokeFormat(file: File, cb: (LintError, Boolean) -> Unit): String {
return com.pinterest.ktlint.core.KtLint.format(buildParams(file, cb))
}
}

fun getCodeStyle(styleName: String): Any {
return try {
Class.forName("com.pinterest.ktlint.core.api.DefaultEditorConfigProperties\$CodeStyleValue")
.getDeclaredField(styleName).get(null)
} catch (e: ClassNotFoundException) {
(Class.forName("com.pinterest.ktlint.core.api.editorconfig.CodeStyleValue").enumConstants as Array<Enum<*>>).first {
it.name == styleName
}
}
}

fun getEditorConfigPropertyClass(): Class<*> {
return try {
Class.forName("com.pinterest.ktlint.core.api.UsesEditorConfigProperties\$EditorConfigProperty")
} catch (e: ClassNotFoundException) {
Class.forName("com.pinterest.ktlint.core.api.editorconfig.EditorConfigProperty")
}
}

@Suppress("UnnecessaryOptInAnnotation")
@OptIn(FeatureInAlphaState::class)
fun userDataToEditorConfigOverride(userData: Map<String, String>): Any {
val defaultEditorConfigPropertiesClass =
Class.forName("com.pinterest.ktlint.core.api.DefaultEditorConfigProperties")
val defaultEditorConfigProperties = defaultEditorConfigPropertiesClass.kotlin.objectInstance
val codeStyle = getCodeStyle(if (userData["android"]?.toBoolean() == true) "android" else "official")
val editorConfigOverrideClass = Class.forName("com.pinterest.ktlint.core.api.EditorConfigOverride")
val editorConfigOverride = editorConfigOverrideClass.kotlin.primaryConstructor!!.call()
val addMethod = editorConfigOverrideClass.getDeclaredMethod("add", getEditorConfigPropertyClass(), Any::class.java)
addMethod.isAccessible = true
val disabledRulesProperty =
defaultEditorConfigPropertiesClass.kotlin.memberProperties.firstOrNull { it.name == "ktlintDisabledRulesProperty" }
?: defaultEditorConfigPropertiesClass.kotlin.memberProperties.first { it.name == "disabledRulesProperty" }
val codeStyleSetProperty =
defaultEditorConfigPropertiesClass.kotlin.memberProperties.first { it.name == "codeStyleSetProperty" }
addMethod.invoke(
editorConfigOverride, disabledRulesProperty.getter.call(defaultEditorConfigProperties),
userData["disabled_rules"]
)
addMethod.invoke(editorConfigOverride, codeStyleSetProperty.getter.call(defaultEditorConfigProperties), codeStyle)
return editorConfigOverride
}

/**
* Implementation for invoking ktlint 0.47.x
*/
@OptIn(FeatureInAlphaState::class)
internal class ExperimentalParamsProviderInvocation(
private val editorConfigPath: String?,
private val ruleProviders: Set<Any>,
private val userData: Map<String, String>,
private val debug: Boolean,
) : KtLintInvocation {
companion object Factory : KtLintInvocationFactory {
fun initialize(
editorConfigPath: String?,
ruleProviders: Set<Any>,
userData: Map<String, String>,
debug: Boolean
): ExperimentalParamsProviderInvocation =
ExperimentalParamsProviderInvocation(editorConfigPath, ruleProviders, userData, debug)
}

private fun buildParams(
file: File,
cb: (LintError, Boolean) -> Unit
): com.pinterest.ktlint.core.KtLint.ExperimentalParams {
val script = !file.name.endsWith(".kt", ignoreCase = true)
val ctor = experimentalParamsClass!!.kotlin.primaryConstructor
val editorConfigOverride = userDataToEditorConfigOverride(userData)
return ctor!!.callBy(
mapOf(
ctor.findParameterByName("fileName")!! to file.absolutePath,
ctor.findParameterByName("text")!! to file.readText(),
ctor.findParameterByName("ruleProviders")!! to ruleProviders,
ctor.findParameterByName("cb")!! to cb,
ctor.findParameterByName("script")!! to script,
ctor.findParameterByName("editorConfigPath")!! to editorConfigPath,
ctor.findParameterByName("debug")!! to debug,
ctor.findParameterByName("editorConfigOverride")!! to editorConfigOverride
)
) as com.pinterest.ktlint.core.KtLint.ExperimentalParams
}

override fun invokeLint(file: File, cb: (LintError, Boolean) -> Unit) {
com.pinterest.ktlint.core.KtLint.lint(buildParams(file, cb))
}

override fun invokeFormat(file: File, cb: (LintError, Boolean) -> Unit): String {
return com.pinterest.ktlint.core.KtLint.format(buildParams(file, cb))
}
}

/**
* Implementation for invoking ktlint >= 0.48
* This should be the long term API.
* We can't compile against this version though, since it is compiled on a newer version of kotlin than gradle embeds.
*/
internal class RuleEngineInvocation(
private val engine: Any,
private val lintMethod: KFunction<*>,
private val formatMethod: KFunction<*>
) : KtLintInvocation {
companion object Factory : KtLintInvocationFactory {
fun initialize(ruleProviders: Set<Any>, userData: Map<String, String>): RuleEngineInvocation {
val editorConfigOverride = userDataToEditorConfigOverride(userData)
val ctor = ruleEngineClass!!.kotlin.primaryConstructor
val engine = ctor!!.callBy(
mapOf(
ctor.findParameterByName("ruleProviders")!! to ruleProviders,
ctor.findParameterByName("editorConfigOverride")!! to editorConfigOverride
)
)
val lintMethod = engine::class.memberFunctions.first {
it.name == "lint" && it.parameters.map { it.name }.containsAll(setOf("code", "filePath", "callback"))
}
val formatMethod = engine::class.memberFunctions.first {
it.name == "format" && it.parameters.map { it.name }.containsAll(setOf("code", "filePath", "callback"))
}
return RuleEngineInvocation(engine, lintMethod, formatMethod)
}
}

override fun invokeLint(file: File, cb: (LintError, Boolean) -> Unit) {
lintMethod.callBy(
mapOf(
lintMethod.instanceParameter!! to engine,
lintMethod.findParameterByName("code")!! to file.readText(),
lintMethod.findParameterByName("filePath")!! to file.absoluteFile.toPath(),
lintMethod.findParameterByName("callback")!! to { le: LintError -> cb.invoke(le, false) }
)
)
}

override fun invokeFormat(file: File, cb: (LintError, Boolean) -> Unit): String {
return formatMethod.callBy(
mapOf(
formatMethod.instanceParameter!! to engine,
formatMethod.findParameterByName("code")!! to file.readText(),
formatMethod.findParameterByName("filePath")!! to file.absoluteFile.toPath(),
formatMethod.findParameterByName("callback")!! to cb
)
) as String
}
}

/**
* detect the params class for ktlint < 0.46
*/
val legacyParamsClass: Class<*>? by lazy {
try {
Class.forName("com.pinterest.ktlint.core.KtLint\$Params")
} catch (e: Exception) {
null
}
}

/**
* detect the params class for ktlint 0.46.x and 0.47.x
*/
val experimentalParamsClass: Class<*>? by lazy {
try {
Class.forName("com.pinterest.ktlint.core.KtLint\$ExperimentalParams")
} catch (e: Exception) {
null
}
}

/**
* detect the RuleEngine class for ktlint >= 0.48.0
*/
val ruleEngineClass: Class<*>? by lazy {
try {
Class.forName("com.pinterest.ktlint.core.KtLintRuleEngine")
} catch (e: Exception) {
null
}
}

internal fun selectInvocation(): KtLintInvocationFactory? {
if (legacyParamsClass != null) {
return LegacyParamsInvocation
}
if (ruleEngineClass != null) {
return RuleEngineInvocation
}
return experimentalParamsClass?.let {
val ctor = it.kotlin.primaryConstructor
if (ctor?.findParameterByName("ruleProviders") != null) {
// ktlint = 0.47.x
ExperimentalParamsProviderInvocation
} else {
// ktlint = 0.46.x
ExperimentalParamsInvocation
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
package org.jlleitschuh.gradle.ktlint.worker

import java.util.ServiceLoader
import kotlin.reflect.full.memberProperties

/**
* Old API for loading rules available prior to ktlint 0.47.0
*/
internal fun loadRuleSetsFromClasspathWithRuleSetProvider(): Map<String, com.pinterest.ktlint.core.RuleSet> {
return ServiceLoader
.load(com.pinterest.ktlint.core.RuleSetProvider::class.java)
.associateBy {
val key = it.get().id
// Adapted from KtLint CLI module
if (key == "standard") "\u0000$key" else key
}
.mapValues { it.value.get() }
}

/**
* New API for loading rules available in ktlint 0.47+
*/
internal fun loadRuleSetsFromClasspathWithRuleSetProviderV2(): Map<String, Set<Any>> {
val ruleSetProviderV2Class = Class.forName("com.pinterest.ktlint.core.RuleSetProviderV2")
val idProperty = ruleSetProviderV2Class.kotlin.memberProperties.first{it.name == "id"}
val getRuleProviders = ruleSetProviderV2Class.getDeclaredMethod("getRuleProviders")
return ServiceLoader
.load(ruleSetProviderV2Class)
.associateBy {
val key = idProperty.getter.call(it) as String
// Adapted from KtLint CLI module
if (key == "standard") "\u0000$key" else key
}.mapValues {
getRuleProviders.invoke(it.value) as Set<Any>
}
}
Loading

0 comments on commit 0bac117

Please sign in to comment.