Merge pull request #57 from 2m/wip-classpath-scope-2m

Look for classes in LocalRoot project aggregate by default

Author: 2m

.travis.yml

@@ -11,7 +11,9 @@ jobs:
       name: Build code style check (fixed with `sbt scalafmtSbt`)
     - stage: test
       script: sbt test
-      name: Tests run
+      name: Run tests
+    - script: sbt scripted
+      name: Run sbt plugin tests
     - stage: publish
       script: sbt ^publish
       name: Publish artifacts

build.sbt

@@ -1,4 +1,6 @@
-scalaVersion := "2.12.8"
+import scala.collection.JavaConverters._
+
+scalaVersion := "2.12.9"
 
 sbtPlugin        := true
 crossSbtVersions := List("1.0.0")
@@ -31,3 +33,9 @@ bintrayRepository   := "sbt-plugin-releases"
 
 enablePlugins(AutomateHeaderPlugin)
 scalafmtOnCompile := true
+
+enablePlugins(SbtPlugin)
+scriptedLaunchOpts += ("-Dproject.version=" + version.value)
+scriptedLaunchOpts ++= java.lang.management.ManagementFactory.getRuntimeMXBean.getInputArguments.asScala.filter(
+  a => Seq("-Xmx", "-Xms", "-XX", "-Dfile").exists(a.startsWith)
+)

src/main/scala/com/lightbend/paradox/apidoc/ApidocKeys.scala

@@ -19,5 +19,7 @@ package com.lightbend.paradox.apidoc
 import sbt._
 
 trait ApidocKeys {
-  val apidocRootPackage = settingKey[String]("")
+  val apidocRootPackage = settingKey[String]("Root package for all candidate classes")
+  val apidocProjects    = settingKey[Seq[ProjectReference]]("Projects which will be queried for classes to link to")
+  val apidocClasses     = taskKey[Seq[URL]]("All of the classes that will be queried")
 }

src/main/scala/com/lightbend/paradox/apidoc/ApidocPlugin.scala

@@ -29,19 +29,24 @@ object ApidocPlugin extends AutoPlugin {
   object autoImport extends ApidocKeys
   import autoImport._
 
-  val version = ParadoxPlugin.readProperty("akka-paradox.properties", "akka.paradox.version")
-
-  override def requires: Plugins = ParadoxPlugin
-
+  override def requires: Plugins      = ParadoxPlugin
   override def trigger: PluginTrigger = AllRequirements
 
-  override def projectSettings: Seq[Setting[_]] = apidocSettings(Compile)
+  override def projectSettings: Seq[Setting[_]] = apidocParadoxZeroSettings
 
-  def apidocParadoxGlobalSettings: Seq[Setting[_]] = Seq(
+  def apidocParadoxZeroSettings: Seq[Setting[_]] = Seq(
     apidocRootPackage := "scala",
+    apidocClasses := Def.taskDyn {
+          val classpathProjects = apidocProjects.?.value
+            .map(inProjects)
+            .getOrElse {
+              inAggregates(LocalRootProject, includeRoot = true)
+            }
+          val filter = ScopeFilter(classpathProjects, inConfigurations(Compile))
+          fullClasspath.all(filter).map(_.flatMap(_.files).map(_.toURI.toURL))
+        }.value,
     paradoxDirectives ++= Def.taskDyn {
-          val classpath   = (fullClasspath in Compile).value.files.map(_.toURI.toURL).toArray
-          val classLoader = new java.net.URLClassLoader(classpath, this.getClass.getClassLoader)
+          val classLoader = new java.net.URLClassLoader(apidocClasses.value.toArray, this.getClass.getClassLoader)
           val scanner = new ClassGraph()
             .whitelistPackages(apidocRootPackage.value)
             .addClassLoader(classLoader)
@@ -56,11 +61,4 @@ object ApidocPlugin extends AutoPlugin {
           }
         }.value
   )
-
-  def apidocSettings(config: Configuration): Seq[Setting[_]] =
-    apidocParadoxGlobalSettings ++ inConfig(config)(
-          Seq(
-            // scoped settings here
-          )
-        )
 }

src/sbt-test/apidoc/multi-project/build.sbt

@@ -0,0 +1,17 @@
+val lib = project
+
+val docs = project
+  .enablePlugins(ParadoxPlugin)
+  .settings(
+    paradoxTheme := None,
+    paradoxGroups := Map("Language" -> Seq("Java", "Scala")),
+    paradoxProperties ++= Map(
+      "scaladoc.apidoc.base_url" -> "https://localhost:8000",
+      "javadoc.apidoc.base_url" -> "https://localhost:8000"
+    ),
+    apidocRootPackage := ""
+  )
+
+val root = project
+  .in(file("."))
+  .aggregate(lib)

src/sbt-test/apidoc/multi-project/docs/src/main/paradox/_template/page.st

@@ -0,0 +1 @@
+$page.content$

src/sbt-test/apidoc/multi-project/docs/src/main/paradox/index.md

@@ -0,0 +1 @@
+Api link to sub-project @apidoc[LibClass]

src/sbt-test/apidoc/multi-project/expected/index.html

@@ -0,0 +1 @@
+<p>Api link to sub-project <span class="group-scala"><a href="https://localhost:8000/apidoc/LibClass.html">LibClass</a></span><span class="group-java"><a href="https://localhost:8000/?apidoc/LibClass.html">LibClass</a></span></p>

src/sbt-test/apidoc/multi-project/lib/src/main/scala/LibClass.scala

@@ -0,0 +1,3 @@
+package apidoc
+
+class LibClass

src/sbt-test/apidoc/multi-project/project/plugins.sbt

@@ -0,0 +1 @@
+addSbtPlugin("com.lightbend.paradox" % "sbt-paradox-apidoc" % sys.props("project.version"))

src/sbt-test/apidoc/multi-project/test

@@ -0,0 +1,3 @@
+> docs/paradox
+
+$ must-mirror docs/target/paradox/site/main/index.html expected/index.html

src/sbt-test/apidoc/single-project/build.sbt

@@ -0,0 +1,11 @@
+libraryDependencies += "com.typesafe.akka" %% "akka-stream" % "2.5.25"
+
+enablePlugins(ParadoxPlugin)
+paradoxTheme := None
+paradoxGroups := Map("Language" -> Seq("Java", "Scala"))
+paradoxProperties ++= Map(
+  "scaladoc.akka.base_url" -> "https://doc.akka.io/api/akka/2.5",
+  "javadoc.akka.base_url" -> "https://doc.akka.io/japi/akka/2.5"
+)
+
+apidocRootPackage := "akka"

src/sbt-test/apidoc/single-project/expected/index.html

@@ -0,0 +1 @@
+<p>Api link to Akka <span class="group-java"><a href="https://doc.akka.io/japi/akka/2.5/?akka/stream/javadsl/Flow.html">Flow</a></span><span class="group-scala"><a href="https://doc.akka.io/api/akka/2.5/akka/stream/scaladsl/Flow.html">Flow</a></span></p>

src/sbt-test/apidoc/single-project/project/plugins.sbt

@@ -0,0 +1 @@
+addSbtPlugin("com.lightbend.paradox" % "sbt-paradox-apidoc" % sys.props("project.version"))

src/sbt-test/apidoc/single-project/src/main/paradox/_template/page.st

@@ -0,0 +1 @@
+$page.content$

src/sbt-test/apidoc/single-project/src/main/paradox/index.md

@@ -0,0 +1 @@
+Api link to Akka @apidoc[Flow]

src/sbt-test/apidoc/single-project/test

@@ -0,0 +1,3 @@
+> paradox
+
+$ must-mirror target/paradox/site/main/index.html expected/index.html