package basic import org.jetbrains.dokka.links.* import org.jetbrains.dokka.links.Callable import org.jetbrains.dokka.links.Nullable import org.jetbrains.dokka.links.TypeConstructor import org.jetbrains.dokka.model.* import org.jetbrains.dokka.pages.* import org.jetbrains.dokka.pages.dfs import org.junit.jupiter.api.Assertions.assertEquals import org.jetbrains.dokka.testApi.testRunner.AbstractCoreTest import org.junit.jupiter.api.Test class DRITest : AbstractCoreTest() { @Test fun issue634() { val configuration = dokkaConfiguration { passes { pass { sourceRoots = listOf("src/") } } } testInline( """ |/src/main/kotlin/basic/Test.kt |package toplevel | |inline fun > Array.mySortBy( | crossinline selector: (T) -> R?): Array = TODO() |} """.trimMargin(), configuration ) { documentablesMergingStage = { module -> val expected = TypeConstructor( "kotlin.Function1", listOf( TypeParam(listOf(Nullable(TypeConstructor("kotlin.Any", emptyList())))), Nullable(TypeParam(listOf(TypeConstructor("kotlin.Comparable", listOf(SelfType))))) ) ) val actual = module.packages.single() .functions.single() .dri.callable?.params?.single() assertEquals(expected, actual) } } } @Test fun issue634WithImmediateNullableSelf() { val configuration = dokkaConfiguration { passes { pass { sourceRoots = listOf("src/") } } } testInline( """ |/src/main/kotlin/basic/Test.kt |package toplevel | |fun > Array.doSomething(t: T?): Array = TODO() |} """.trimMargin(), configuration ) { documentablesMergingStage = { module -> val expected = Nullable(TypeParam(listOf(TypeConstructor("kotlin.Comparable", listOf(SelfType))))) val actual = module.packages.single() .functions.single() .dri.callable?.params?.single() assertEquals(expected, actual) } } } @Test fun issue634WithGenericNullableReceiver() { val configuration = dokkaConfiguration { passes { pass { sourceRoots = listOf("src/") } } } testInline( """ |/src/main/kotlin/basic/Test.kt |package toplevel | |fun > T?.doSomethingWithNullable() = TODO() |} """.trimMargin(), configuration ) { documentablesMergingStage = { module -> val expected = Nullable(TypeParam(listOf(TypeConstructor("kotlin.Comparable", listOf(SelfType))))) val actual = module.packages.single() .functions.single() .dri.callable?.receiver assertEquals(expected, actual) } } } @Test fun issue642WithStarAndAny() { val configuration = dokkaConfiguration { passes { pass { analysisPlatform = "js" sourceRoots = listOf("src/") } } } testInline( """ |/src/main/kotlin/Test.kt | |open class Bar |class ReBarBar : Bar() |class Foo, R : List>> | |fun > Foo.qux(): String = TODO() |fun > Foo.qux(): String = TODO() | """.trimMargin(), configuration ) { pagesGenerationStage = { module -> // DRI(//qux/Foo[TypeParam(bounds=[kotlin.Comparable[kotlin.Any?]]),*]#/PointingToFunctionOrClasslike/) val expectedDRI = DRI( "", null, Callable( "qux", TypeConstructor( "Foo", listOf( TypeParam( listOf( TypeConstructor( "kotlin.Comparable", listOf( Nullable(TypeConstructor("kotlin.Any", emptyList())) ) ) ) ), StarProjection ) ), emptyList() ) ) val driCount = module .withDescendants() .filterIsInstance() .sumBy { it.dri.count { dri -> dri == expectedDRI } } assertEquals(1, driCount) } } } @Test fun driForGenericClass(){ val configuration = dokkaConfiguration { passes { pass { sourceRoots = listOf("src/") } } } testInline( """ |/src/main/kotlin/Test.kt |package example | |class Sample(first: S){ } | | """.trimMargin(), configuration ) { pagesGenerationStage = { module -> val sampleClass = module.dfs { it.name == "Sample" } as ClasslikePageNode val classDocumentable = sampleClass.documentable as DClass assertEquals( "example/Sample///PointingToDeclaration/", sampleClass.dri.first().toString()) assertEquals("example/Sample///PointingToGenericParameters(0)/", classDocumentable.generics.first().dri.toString()) } } } @Test fun driForGenericFunction(){ val configuration = dokkaConfiguration { passes { pass { sourceRoots = listOf("src/") classpath = listOfNotNull(jvmStdlibPath) } } } testInline( """ |/src/main/kotlin/Test.kt |package example | |class Sample(first: S){ | fun genericFun(param1: String): Tuple = TODO() |} | | """.trimMargin(), configuration ) { pagesGenerationStage = { module -> val sampleClass = module.dfs { it.name == "Sample" } as ClasslikePageNode val functionNode = sampleClass.children.first { it.name == "genericFun" } as MemberPageNode val functionDocumentable = functionNode.documentable as DFunction val parameter = functionDocumentable.parameters.first() assertEquals("example/Sample/genericFun/#kotlin.String/PointingToDeclaration/", functionNode.dri.first().toString()) assertEquals(1, functionDocumentable.parameters.size) assertEquals("example/Sample/genericFun/#kotlin.String/PointingToCallableParameters(0)/", parameter.dri.toString()) //1 since from the function's perspective there is only 1 new generic declared //The other one is 'inherited' from class assertEquals( 1, functionDocumentable.generics.size) assertEquals( "T", functionDocumentable.generics.first().name) assertEquals( "example/Sample/genericFun/#kotlin.String/PointingToGenericParameters(0)/", functionDocumentable.generics.first().dri.toString()) } } } @Test fun driForFunctionNestedInsideInnerClass() { val configuration = dokkaConfiguration { passes { pass { sourceRoots = listOf("src/") classpath = listOfNotNull(jvmStdlibPath) } } } testInline( """ |/src/main/kotlin/Test.kt |package example | |class Sample(first: S){ | inner class SampleInner { | fun foo(): S = TODO() | } |} | | """.trimMargin(), configuration ) { pagesGenerationStage = { module -> val sampleClass = module.dfs { it.name == "Sample" } as ClasslikePageNode val sampleInner = sampleClass.children.first { it.name == "SampleInner" } as ClasslikePageNode val foo = sampleInner.children.first { it.name == "foo" } as MemberPageNode val documentable = foo.documentable as DFunction assertEquals(sampleClass.dri.first().toString(), (documentable.type as OtherParameter).declarationDRI.toString()) assertEquals(0, documentable.generics.size) } } } @Test fun driForGenericExtensionFunction(){ val configuration = dokkaConfiguration { passes { pass { sourceRoots = listOf("src/") } } } testInline( """ |/src/main/kotlin/Test.kt |package example | | fun List.extensionFunction(): String = "" | """.trimMargin(), configuration ) { pagesGenerationStage = { module -> val extensionFunction = module.dfs { it.name == "extensionFunction" } as MemberPageNode val documentable = extensionFunction.documentable as DFunction assertEquals( "example//extensionFunction/kotlin.collections.List[TypeParam(bounds=[kotlin.Any?])]#/PointingToDeclaration/", extensionFunction.dri.first().toString() ) assertEquals(1, documentable.generics.size) assertEquals("T", documentable.generics.first().name) assertEquals( "example//extensionFunction/kotlin.collections.List[TypeParam(bounds=[kotlin.Any?])]#/PointingToGenericParameters(0)/", documentable.generics.first().dri.toString() ) } } } }