aboutsummaryrefslogtreecommitdiff
path: root/core
diff options
context:
space:
mode:
authorGoooler <wangzongler@gmail.com>2022-02-21 22:01:06 +0800
committerGitHub <noreply@github.com>2022-02-21 17:01:06 +0300
commitf5b7797255576e5f1c230e2ca3fcb5f4e602387c (patch)
tree25fd98250066c4ed6c2fff1104be533604bbf1b9 /core
parentdf4780c31026aaa626746f49f0e6fa3fa0278a05 (diff)
downloaddokka-f5b7797255576e5f1c230e2ca3fcb5f4e602387c.tar.gz
dokka-f5b7797255576e5f1c230e2ca3fcb5f4e602387c.tar.bz2
dokka-f5b7797255576e5f1c230e2ca3fcb5f4e602387c.zip
Code cleanups (#2165)
Diffstat (limited to 'core')
-rw-r--r--core/content-matcher-test-utils/src/main/kotlin/matchers/content/contentMatchers.kt13
-rw-r--r--core/src/main/kotlin/CoreExtensions.kt2
-rw-r--r--core/src/main/kotlin/model/Documentable.kt2
-rw-r--r--core/src/main/kotlin/model/WithChildren.kt8
-rw-r--r--core/src/main/kotlin/pages/ContentNodes.kt2
-rw-r--r--core/src/main/kotlin/transformers/documentation/DocumentableMerger.kt1
-rw-r--r--core/src/main/kotlin/transformers/documentation/DocumentableToPageTranslator.kt1
-rw-r--r--core/src/main/kotlin/transformers/documentation/DocumentableTransformer.kt1
-rw-r--r--core/src/main/kotlin/transformers/pages/PageCreator.kt1
-rw-r--r--core/src/main/kotlin/utilities/ServiceLocator.kt17
-rw-r--r--core/src/main/kotlin/utilities/safeEnumValueOf.kt2
-rw-r--r--core/test-api/src/main/kotlin/testApi/context/MockContext.kt2
-rw-r--r--core/test-api/src/main/kotlin/testApi/testRunner/TestRunner.kt4
13 files changed, 23 insertions, 33 deletions
diff --git a/core/content-matcher-test-utils/src/main/kotlin/matchers/content/contentMatchers.kt b/core/content-matcher-test-utils/src/main/kotlin/matchers/content/contentMatchers.kt
index 6a0e1c97..e2b69226 100644
--- a/core/content-matcher-test-utils/src/main/kotlin/matchers/content/contentMatchers.kt
+++ b/core/content-matcher-test-utils/src/main/kotlin/matchers/content/contentMatchers.kt
@@ -37,7 +37,7 @@ class CompositeMatcher<T : ContentComposite>(
assertions: T.() -> Unit = {}
) : NodeMatcher<T>(kclass, assertions) {
internal val normalizedChildren: List<MatcherElement> by lazy {
- children.fold(listOf<MatcherElement>()) { acc, e ->
+ children.fold(listOf()) { acc, e ->
when {
acc.lastOrNull() is Anything && e is Anything -> acc
acc.lastOrNull() is TextMatcher && e is TextMatcher ->
@@ -119,8 +119,7 @@ private class FurtherSiblings(val list: List<MatcherElement>, val parent: Compos
fun drop() = FurtherSiblings(list.drop(1), parent)
val messageEnd: String
- get() = list.filter { it !is Anything }
- .count().takeIf { it > 0 }
+ get() = list.count { it !is Anything }.takeIf { it > 0 }
?.let { " and $it further matchers were not satisfied" } ?: ""
}
@@ -139,10 +138,10 @@ internal fun MatcherElement.toDebugString(anchor: MatcherElement?, anchorAfter:
is CompositeMatcher<*> -> {
append("${element.kclass.simpleName.toString()}\n")
if (element.normalizedChildren.isNotEmpty()) {
- val newOwnPrefix = childPrefix + '\u251c' + '\u2500' + ' '
- val lastOwnPrefix = childPrefix + '\u2514' + '\u2500' + ' '
- val newChildPrefix = childPrefix + '\u2502' + ' ' + ' '
- val lastChildPrefix = childPrefix + ' ' + ' ' + ' '
+ val newOwnPrefix = "$childPrefix├─ "
+ val lastOwnPrefix = "$childPrefix└─ "
+ val newChildPrefix = "$childPrefix│ "
+ val lastChildPrefix = "$childPrefix "
element.normalizedChildren.forEachIndexed { n, e ->
if (n != element.normalizedChildren.lastIndex) append(e, newOwnPrefix, newChildPrefix)
else append(e, lastOwnPrefix, lastChildPrefix)
diff --git a/core/src/main/kotlin/CoreExtensions.kt b/core/src/main/kotlin/CoreExtensions.kt
index 0dd5780b..ddfa0c69 100644
--- a/core/src/main/kotlin/CoreExtensions.kt
+++ b/core/src/main/kotlin/CoreExtensions.kt
@@ -26,6 +26,6 @@ object CoreExtensions {
private fun <T : Any> coreExtensionPoint() = object {
operator fun provideDelegate(thisRef: CoreExtensions, property: KProperty<*>): Lazy<ExtensionPoint<T>> =
- lazy { ExtensionPoint<T>(thisRef::class.qualifiedName!!, property.name) }
+ lazy { ExtensionPoint(thisRef::class.qualifiedName!!, property.name) }
}
} \ No newline at end of file
diff --git a/core/src/main/kotlin/model/Documentable.kt b/core/src/main/kotlin/model/Documentable.kt
index fcbb9591..13d04555 100644
--- a/core/src/main/kotlin/model/Documentable.kt
+++ b/core/src/main/kotlin/model/Documentable.kt
@@ -126,7 +126,7 @@ data class DPackage(
* e.g. this will return a human readable version for root packages.
* Use [packageName] or `dri.packageName` instead to obtain the real packageName
*/
- override val name: String = if (packageName.isBlank()) "[root]" else packageName
+ override val name: String = packageName.ifBlank { "[root]" }
override val children: List<Documentable> = properties + functions + classlikes + typealiases
diff --git a/core/src/main/kotlin/model/WithChildren.kt b/core/src/main/kotlin/model/WithChildren.kt
index 59a14acc..01a188c8 100644
--- a/core/src/main/kotlin/model/WithChildren.kt
+++ b/core/src/main/kotlin/model/WithChildren.kt
@@ -79,10 +79,10 @@ fun <T : WithChildren<T>> T.asPrintableTree(
nodeNameBuilder(element)
appendLine()
element.children.takeIf(Collection<*>::isNotEmpty)?.also { children ->
- val newOwnPrefix = childPrefix + '\u251c' + '\u2500' + ' '
- val lastOwnPrefix = childPrefix + '\u2514' + '\u2500' + ' '
- val newChildPrefix = childPrefix + '\u2502' + ' ' + ' '
- val lastChildPrefix = childPrefix + ' ' + ' ' + ' '
+ val newOwnPrefix = "$childPrefix├─ "
+ val lastOwnPrefix = "$childPrefix└─ "
+ val newChildPrefix = "$childPrefix│ "
+ val lastChildPrefix = "$childPrefix "
children.forEachIndexed { n, e ->
if (n != children.lastIndex) append(e, newOwnPrefix, newChildPrefix)
else append(e, lastOwnPrefix, lastChildPrefix)
diff --git a/core/src/main/kotlin/pages/ContentNodes.kt b/core/src/main/kotlin/pages/ContentNodes.kt
index 23baa482..4210b4dd 100644
--- a/core/src/main/kotlin/pages/ContentNodes.kt
+++ b/core/src/main/kotlin/pages/ContentNodes.kt
@@ -33,7 +33,7 @@ data class ContentText(
) : ContentNode {
override fun withNewExtras(newExtras: PropertyContainer<ContentNode>): ContentText = copy(extra = newExtras)
override fun withSourceSets(sourceSets: Set<DisplaySourceSet>): ContentText = copy(sourceSets = sourceSets)
- override fun hasAnyContent(): Boolean = !text.isBlank()
+ override fun hasAnyContent(): Boolean = text.isNotBlank()
}
// TODO: Remove
diff --git a/core/src/main/kotlin/transformers/documentation/DocumentableMerger.kt b/core/src/main/kotlin/transformers/documentation/DocumentableMerger.kt
index 358fdb1d..1d655423 100644
--- a/core/src/main/kotlin/transformers/documentation/DocumentableMerger.kt
+++ b/core/src/main/kotlin/transformers/documentation/DocumentableMerger.kt
@@ -1,7 +1,6 @@
package org.jetbrains.dokka.transformers.documentation
import org.jetbrains.dokka.model.DModule
-import org.jetbrains.dokka.plugability.DokkaContext
fun interface DocumentableMerger {
operator fun invoke(modules: Collection<DModule>): DModule?
diff --git a/core/src/main/kotlin/transformers/documentation/DocumentableToPageTranslator.kt b/core/src/main/kotlin/transformers/documentation/DocumentableToPageTranslator.kt
index f8005cfe..cd85b8ad 100644
--- a/core/src/main/kotlin/transformers/documentation/DocumentableToPageTranslator.kt
+++ b/core/src/main/kotlin/transformers/documentation/DocumentableToPageTranslator.kt
@@ -1,7 +1,6 @@
package org.jetbrains.dokka.transformers.documentation
import org.jetbrains.dokka.model.DModule
-import org.jetbrains.dokka.pages.ModulePageNode
import org.jetbrains.dokka.pages.RootPageNode
fun interface DocumentableToPageTranslator {
diff --git a/core/src/main/kotlin/transformers/documentation/DocumentableTransformer.kt b/core/src/main/kotlin/transformers/documentation/DocumentableTransformer.kt
index a808a224..923a7236 100644
--- a/core/src/main/kotlin/transformers/documentation/DocumentableTransformer.kt
+++ b/core/src/main/kotlin/transformers/documentation/DocumentableTransformer.kt
@@ -1,7 +1,6 @@
package org.jetbrains.dokka.transformers.documentation
import org.jetbrains.dokka.model.DModule
-import org.jetbrains.dokka.model.Documentable
import org.jetbrains.dokka.plugability.DokkaContext
fun interface DocumentableTransformer {
diff --git a/core/src/main/kotlin/transformers/pages/PageCreator.kt b/core/src/main/kotlin/transformers/pages/PageCreator.kt
index ebb9dac5..fb5b3b47 100644
--- a/core/src/main/kotlin/transformers/pages/PageCreator.kt
+++ b/core/src/main/kotlin/transformers/pages/PageCreator.kt
@@ -1,7 +1,6 @@
package org.jetbrains.dokka.transformers.pages
import org.jetbrains.dokka.pages.RootPageNode
-import org.jetbrains.dokka.plugability.DokkaContext
interface CreationContext
diff --git a/core/src/main/kotlin/utilities/ServiceLocator.kt b/core/src/main/kotlin/utilities/ServiceLocator.kt
index 00c9ae9f..3e515348 100644
--- a/core/src/main/kotlin/utilities/ServiceLocator.kt
+++ b/core/src/main/kotlin/utilities/ServiceLocator.kt
@@ -65,20 +65,17 @@ object ServiceLocator {
when (it.protocol) {
"file" -> it.toFile().listFiles()?.filter { it.extension == "properties" }?.map { lookupDescriptor(category, it.nameWithoutExtension) } ?: emptyList()
"jar" -> {
- val file = JarFile(URL(it.file.substringBefore("!")).toFile())
- try {
+ JarFile(URL(it.file.substringBefore("!")).toFile()).use { file ->
val jarPath = it.file.substringAfterLast("!").removePrefix("/").removeSuffix("/")
file.entries()
- .asSequence()
- .filter { entry -> !entry.isDirectory && entry.path == jarPath && entry.extension == "properties" }
- .map { entry ->
- lookupDescriptor(category, entry.fileName.substringBeforeLast("."))
- }.toList()
- } finally {
- file.close()
+ .asSequence()
+ .filter { entry -> !entry.isDirectory && entry.path == jarPath && entry.extension == "properties" }
+ .map { entry ->
+ lookupDescriptor(category, entry.fileName.substringBeforeLast("."))
+ }.toList()
}
}
- else -> emptyList<ServiceDescriptor>()
+ else -> emptyList()
}
}
}
diff --git a/core/src/main/kotlin/utilities/safeEnumValueOf.kt b/core/src/main/kotlin/utilities/safeEnumValueOf.kt
index 8fd5a086..9f4c23c9 100644
--- a/core/src/main/kotlin/utilities/safeEnumValueOf.kt
+++ b/core/src/main/kotlin/utilities/safeEnumValueOf.kt
@@ -1,4 +1,4 @@
package org.jetbrains.dokka.utilities
inline fun <reified T : Enum<*>> enumValueOrNull(name: String): T? =
- T::class.java.enumConstants.firstOrNull { it.name.toUpperCase() == name.toUpperCase() } \ No newline at end of file
+ T::class.java.enumConstants.firstOrNull { it.name.equals(name, ignoreCase = true) } \ No newline at end of file
diff --git a/core/test-api/src/main/kotlin/testApi/context/MockContext.kt b/core/test-api/src/main/kotlin/testApi/context/MockContext.kt
index 7b17a8ee..7a3c4786 100644
--- a/core/test-api/src/main/kotlin/testApi/context/MockContext.kt
+++ b/core/test-api/src/main/kotlin/testApi/context/MockContext.kt
@@ -24,7 +24,7 @@ class MockContext(
private val plugins = mutableMapOf<KClass<out DokkaPlugin>, DokkaPlugin>()
- override fun <T : DokkaPlugin> plugin(kclass: KClass<T>): T? = plugins.getOrPut(kclass) {
+ override fun <T : DokkaPlugin> plugin(kclass: KClass<T>): T = plugins.getOrPut(kclass) {
kclass.constructors.single { it.parameters.isEmpty() }.call().also { it.injectContext(this) }
} as T
diff --git a/core/test-api/src/main/kotlin/testApi/testRunner/TestRunner.kt b/core/test-api/src/main/kotlin/testApi/testRunner/TestRunner.kt
index c692c83f..de0cd896 100644
--- a/core/test-api/src/main/kotlin/testApi/testRunner/TestRunner.kt
+++ b/core/test-api/src/main/kotlin/testApi/testRunner/TestRunner.kt
@@ -99,14 +99,12 @@ abstract class AbstractTest<M : TestMethods, T : TestBuilder<M>, D : DokkaTestGe
.replace("\r\n", "\n")
.sliceAt(filePathRegex)
.filter { it.isNotEmpty() && it.isNotBlank() && "\n" in it }
- .map { fileDeclaration -> fileDeclaration.trim() }
- .map { fileDeclaration ->
+ .map { fileDeclaration -> fileDeclaration.trim() }.associate { fileDeclaration ->
val filePathAndContent = fileDeclaration.split("\n", limit = 2)
val filePath = filePathAndContent.first().removePrefix("/").trim()
val content = filePathAndContent.last().trim()
filePath to content
}
- .toMap()
}
private fun String.sliceAt(regex: Regex): List<String> {