From f98c791d8b893ad6d171c5a65ebcad025342895d Mon Sep 17 00:00:00 2001
From: Alex Saveau <asaveau@google.com>
Date: Tue, 14 Jul 2020 20:39:22 +0000
Subject: Follow Javadoc file path convention

The current file path looks like `/androidx.fragment.app/package-summary.html` which is non-standard. This CL changes the path to look like `/androidx/fragment/app/package-summary.html`.
---
 .../javadoc/location/JavadocLocationProvider.kt    | 11 +++++---
 .../kotlin/javadoc/location/JavadocLocationTest.kt | 32 +++++++++++++++++-----
 2 files changed, 32 insertions(+), 11 deletions(-)

diff --git a/plugins/javadoc/src/main/kotlin/javadoc/location/JavadocLocationProvider.kt b/plugins/javadoc/src/main/kotlin/javadoc/location/JavadocLocationProvider.kt
index 49278b062..0ce20c789 100644
--- a/plugins/javadoc/src/main/kotlin/javadoc/location/JavadocLocationProvider.kt
+++ b/plugins/javadoc/src/main/kotlin/javadoc/location/JavadocLocationProvider.kt
@@ -18,7 +18,10 @@ class JavadocLocationProvider(pageRoot: RootPageNode, dokkaContext: DokkaContext
 
     private val pathIndex = IdentityHashMap<PageNode, List<String>>().apply {
         fun registerPath(page: PageNode, prefix: List<String> = emptyList()) {
-            val newPrefix = prefix + page.takeIf { it is JavadocPackagePageNode }?.name.orEmpty()
+            val packagePath = page.takeIf { it is JavadocPackagePageNode }?.name.orEmpty()
+                .replace(".", "/")
+            val newPathPrefix = prefix + packagePath
+
             val path = (prefix + when (page) {
                 is AllClassesPage -> listOf("allclasses")
                 is TreeViewPage -> if (page.classes == null)
@@ -28,14 +31,14 @@ class JavadocLocationProvider(pageRoot: RootPageNode, dokkaContext: DokkaContext
                 is ContentPage -> if (page.dri.isNotEmpty() && page.dri.first().classNames != null)
                     listOfNotNull(page.dri.first().classNames)
                 else if (page is JavadocPackagePageNode)
-                    listOf(page.name, "package-summary")
+                    listOf(packagePath, "package-summary")
                 else
                     listOf("index")
                 else -> emptyList()
             }).filterNot { it.isEmpty() }
 
             put(page, path)
-            page.children.forEach { registerPath(it, newPrefix) }
+            page.children.forEach { registerPath(it, newPathPrefix) }
 
         }
         put(pageRoot, listOf("index"))
@@ -123,4 +126,4 @@ class JavadocLocationProvider(pageRoot: RootPageNode, dokkaContext: DokkaContext
     override fun ancestors(node: PageNode): List<PageNode> {
         TODO("Not yet implemented")
     }
-}
\ No newline at end of file
+}
diff --git a/plugins/javadoc/src/test/kotlin/javadoc/location/JavadocLocationTest.kt b/plugins/javadoc/src/test/kotlin/javadoc/location/JavadocLocationTest.kt
index 235f68c0d..b7a578a5b 100644
--- a/plugins/javadoc/src/test/kotlin/javadoc/location/JavadocLocationTest.kt
+++ b/plugins/javadoc/src/test/kotlin/javadoc/location/JavadocLocationTest.kt
@@ -37,8 +37,8 @@ class JavadocTest : AbstractCoreTest() {
         }
         testInline(
             """
-            |/jvmSrc/javadoc/Test.kt
-            |package javadoc
+            |/jvmSrc/javadoc/test/Test.kt
+            |package javadoc.test
             |import java.io.Serializable
             |class Test<A>() : Serializable, Cloneable {
             |   fun test() {}
@@ -120,9 +120,27 @@ class JavadocTest : AbstractCoreTest() {
         }
     }
 
-    private fun htmlTranslator(rootPageNode: RootPageNode, dokkaContext: DokkaContext) = JavadocContentToHtmlTranslator(
-        dokkaContext.plugin<JavadocPlugin>().querySingle { locationProviderFactory }
-            .getLocationProvider(rootPageNode),
-        dokkaContext
-    )
+    @Test
+    fun `resolved package path`() {
+
+        locationTestInline { rootPageNode, dokkaContext ->
+            val locationProvider = dokkaContext.plugin<JavadocPlugin>().querySingle { locationProviderFactory }
+                .getLocationProvider(rootPageNode)
+            val packageNode = rootPageNode.firstChildOfType<JavadocPackagePageNode>()
+            val packagePath = locationProvider.resolve(packageNode)
+
+            assertEquals("javadoc/test/package-summary", packagePath)
+        }
+    }
+
+    private fun htmlTranslator(rootPageNode: RootPageNode, dokkaContext: DokkaContext): JavadocContentToHtmlTranslator {
+        val locationProvider = dokkaContext.plugin<JavadocPlugin>().querySingle { locationProviderFactory }
+            .getLocationProvider(rootPageNode)
+        return htmlTranslator(dokkaContext, locationProvider)
+    }
+
+    private fun htmlTranslator(
+        dokkaContext: DokkaContext,
+        locationProvider: JavadocLocationProvider
+    ) = JavadocContentToHtmlTranslator(locationProvider, dokkaContext)
 }
-- 
cgit v1.2.3