azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix KT-4612 properly implement KDoc compiler, added integration test.

Browse Source
This commit is contained in:
Nikita Skvortsov
2014-02-28 16:13:18 +04:00
parent 98779cba2d
commit 9362bbcf1f
10 changed files with 423 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/tools/kotlin-gradle-plugin-core/src/main/kotlin/org/jetbrains/kotlin/gradle/plugin/KotlinPlugin.kt
+2 -6
View File
@@ -110,12 +110,8 @@ open class KotlinPlugin: Plugin<Project> {
}
project.getTasks()?.withType(javaClass<KDoc>(), object : Action<KDoc> {
override fun execute(param: KDoc?) {
param?.getConventionMapping()?.map("destinationDir", object : Callable<Any> {
override fun call(): Any {
return File(javaPluginConvention.getDocsDir(), "kdoc");
}
})
override fun execute(task: KDoc?) {
task!!.destinationDir = File(javaPluginConvention.getDocsDir(), "kdoc")
}
})
}
libraries/tools/kotlin-gradle-plugin-core/src/main/kotlin/org/jetbrains/kotlin/gradle/tasks/Tasks.kt
+50 -74
View File
@@ -25,6 +25,9 @@ import org.apache.commons.lang.StringUtils
import org.gradle.api.initialization.dsl.ScriptHandler
import org.apache.commons.io.FileUtils
import org.jetbrains.kotlin.gradle.plugin.*
import org.jetbrains.kotlin.doc.KDocConfig
import java.util.concurrent.Callable
import org.gradle.api.Project
public open class KotlinCompile(): AbstractCompile() {
@@ -40,7 +43,7 @@ public open class KotlinCompile(): AbstractCompile() {
override fun setSource(source: Any?) {
srcDirsRoots.clear()
if (source is SourceDirectorySet) {
srcDirsRoots.addAll(source.getSrcDirs()!!)
srcDirsRoots.addAll(source.getSrcDirs())
}
super.setSource(source)
}
@@ -49,7 +52,7 @@ public open class KotlinCompile(): AbstractCompile() {
override fun source(vararg sources: Any?): SourceTask? {
for (source in sources) {
if (source is SourceDirectorySet) {
srcDirsRoots.addAll(source.getSrcDirs()!!)
srcDirsRoots.addAll(source.getSrcDirs())
}
}
return super.source(sources)
@@ -104,7 +107,7 @@ public open class KotlinCompile(): AbstractCompile() {
args.outputDir = if (StringUtils.isEmpty(kotlinOptions.outputDir)) { kotlinDestinationDir?.getPath() } else { kotlinOptions.outputDir }
val embeddedAnnotations = getAnnotations()
val embeddedAnnotations = getAnnotations(getProject(), logger)
val userAnnotations = (kotlinOptions.annotations ?: "").split(File.pathSeparatorChar).toList()
val allAnnotations = if (kotlinOptions.noJdkAnnotations) userAnnotations else userAnnotations.plus(embeddedAnnotations.map {it.getPath()})
args.annotations = allAnnotations.makeString(File.pathSeparator)
@@ -127,91 +130,53 @@ public open class KotlinCompile(): AbstractCompile() {
FileUtils.copyDirectory(outputDirFile, getDestinationDir())
}
}
fun getAnnotations(): Collection<File> {
val annotations = getProject().getExtensions().getByName(DEFAULT_ANNOTATIONS) as Collection<File>
if (!annotations.isEmpty()) {
logger.info("using default annontations from [${annotations.map {it.getPath()}}]")
return annotations
} else {
throw GradleException("Default annotations not found in Kotlin gradle plugin classpath")
}
}
}
public open class KDoc(): SourceTask() {
val logger = Logging.getLogger(getClass())
/**
* Returns the directory to use to output the API docs
*/
public var destinationDir: String = ""
public var kdocArgs: KDocArguments = KDocArguments()
/**
* Returns the name of the documentation set
*/
public var title: String = ""
/**
* Returns the version name of the documentation set
*/
public var version: String = ""
/**
* Returns a map of the package prefix to the HTML URL for the root of the apidoc using javadoc/kdoc style
* directory layouts so that this API doc report can link to external packages
*/
public var packagePrefixToUrls: Map<String, String> = HashMap()
/**
* Returns a Set of the package name prefixes to ignore from the KDoc report
*/
public var ignorePackages: Set<String> = HashSet()
/**
* Returns true if a warning should be generated if there are no comments
* on documented function or property
*/
public var warnNoComments: Boolean = true
/**
* Returns the HTTP URL of the root directory of source code that we should link to
*/
public var sourceRootHref: String = ""
/**
* The root project directory used to deduce relative file names when linking to source code
*/
public var projectRootDir: String = ""
/**
* A map of package name to html or markdown files used to describe the package. If none is
* specified we will look for a package.html or package.md file in the source tree
*/
public var packageDescriptionFiles: Map<String, String> = HashMap()
/**
* A map of package name to summary text used in the package overviews
*/
public var packageSummaryText: Map<String, String> = HashMap()
public var destinationDir: File? = null;
{
// by default, output dir is not defined in options
kdocArgs.docConfig.docOutputDir = ""
}
TaskAction fun generateDocs() {
val args = KDocArguments()
val cfg = args.docConfig
cfg.docOutputDir = destinationDir
cfg.title = title
cfg.sourceRootHref = sourceRootHref
cfg.projectRootDir = projectRootDir
cfg.warnNoComments = warnNoComments
val kdocOptions = kdocArgs.docConfig
cfg.docOutputDir = if ((kdocOptions.docOutputDir.length == 0) && (destinationDir != null)) { destinationDir!!.path } else { kdocOptions.docOutputDir }
cfg.title = kdocOptions.title
cfg.sourceRootHref = kdocOptions.sourceRootHref
cfg.projectRootDir = kdocOptions.projectRootDir
cfg.warnNoComments = kdocOptions.warnNoComments
cfg.packagePrefixToUrls.putAll(kdocOptions.packagePrefixToUrls)
cfg.ignorePackages.addAll(kdocOptions.ignorePackages)
cfg.packageDescriptionFiles.putAll(kdocOptions.packageDescriptionFiles)
cfg.packageSummaryText.putAll(kdocOptions.packageSummaryText)
// KDoc compiler does not accept list of files as input. Try to pass directories instead.
args.src = getSource().map { it.getParentFile()!!.getAbsolutePath() }.toSet().makeString(File.pathSeparator)
// Drop compiled sources to temp. Why KDoc compiles anything after all?!
args.outputDir = getTemporaryDir()?.getAbsolutePath()
logger.warn(args.src)
val embeddedAnnotations = getAnnotations(getProject(), logger)
val userAnnotations = (kdocArgs.annotations ?: "").split(File.pathSeparatorChar).toList()
val allAnnotations = if (kdocArgs.noJdkAnnotations) userAnnotations else userAnnotations.plus(embeddedAnnotations.map {it.getPath()})
args.annotations = allAnnotations.makeString(File.pathSeparator)
args.noStdlib = true
args.noJdkAnnotations = true
cfg.packagePrefixToUrls.putAll(packagePrefixToUrls)
cfg.ignorePackages.addAll(ignorePackages)
cfg.packageDescriptionFiles.putAll(packageDescriptionFiles)
cfg.packageSummaryText.putAll(packageSummaryText)
val compiler = KDocCompiler()
@@ -227,6 +192,17 @@ public open class KDoc(): SourceTask() {
}
}
fun getAnnotations(project: Project, logger: Logger): Collection<File> {
val annotations = project.getExtensions().getByName(DEFAULT_ANNOTATIONS) as Collection<File>
if (!annotations.isEmpty()) {
logger.info("using default annontations from [${annotations.map {it.getPath()}}]")
return annotations
} else {
throw GradleException("Default annotations not found in Kotlin gradle plugin classpath")
}
}
class GradleMessageCollector(val logger : Logger): MessageCollector {
public override fun report(severity: CompilerMessageSeverity, message: String, location: CompilerMessageLocation) {
val path = location.getPath()
libraries/tools/kotlin-gradle-plugin-core/src/test/kotlin/org/jetbrains/kotlin/gradle/KotlinGradlePluginIT.kt
+38 -4
View File
@@ -20,9 +20,6 @@ class BasicKotlinGradleIT {
Before fun setUp() {
workingDir = Files.createTempDir()!!
workingDir.mkdirs()
copyRecursively(File("src/test/resources/testProject/alfa"), workingDir)
copyRecursively(File("src/test/resources/testProject/beta"), workingDir)
copyRecursively(File("src/test/resources/testProject/gamma"), workingDir)
}
@@ -31,6 +28,7 @@ class BasicKotlinGradleIT {
}
Test fun testSimpleCompile() {
copyRecursively(File("src/test/resources/testProject/alfa"), workingDir)
val projectDir = File(workingDir, "alfa")
val pathToKotlinPlugin = "-PpathToKotlinPlugin=${File("local-repo").getAbsolutePath()}"
@@ -92,7 +90,9 @@ class BasicKotlinGradleIT {
}
Test fun testKotlinCustomDirectory() {
val projectDir = File(workingDir, "beta")
copyRecursively(File("src/test/resources/testProject/beta"), workingDir)
val projectDir = File(workingDir, "beta")
val pathToKotlinPlugin = "-PpathToKotlinPlugin=${File("local-repo").getAbsolutePath()}"
val version = "-Pkotlin.gradle.plugin.version=0.1-SNAPSHOT"
@@ -122,7 +122,41 @@ class BasicKotlinGradleIT {
assertEquals(result, 0)
}
Test fun testSimpleKDoc() {
copyRecursively(File("src/test/resources/testProject/delta"), workingDir)
val projectDir = File(workingDir, "delta")
val pathToKotlinPlugin = "-PpathToKotlinPlugin=${File("local-repo").getAbsolutePath()}"
val version = "-Pkotlin.gradle.plugin.version=0.1-SNAPSHOT"
val cmd = if (SystemInfo.isWindows)
listOf("cmd", "/C", "gradlew.bat", "kdoc", pathToKotlinPlugin, version, "--no-daemon", "--debug")
else
listOf("/bin/bash", "./gradlew", "kdoc", pathToKotlinPlugin, version, "--no-daemon", "--debug")
val builder = ProcessBuilder(cmd)
builder.directory(projectDir)
builder.redirectErrorStream(true)
val process = builder.start()
val s = Scanner(process.getInputStream()!!)
val text = StringBuilder()
while (s.hasNextLine()) {
val line = s.nextLine()
text append line
text append "\n"
}
s.close()
val result = process.waitFor()
val buildOutput = text.toString()
println(buildOutput)
assertEquals(result, 0)
assertTrue(buildOutput.contains(":kdoc"), "Should contain ':kdoc'")
assertTrue(buildOutput.contains("Generating kdoc to"), "Should contain info on kdoc launch")
}
Ignore fun testKotlinExtraJavaSrc() {
copyRecursively(File("src/test/resources/testProject/gamma"), workingDir)
val projectDir = File(workingDir, "gamma")
val pathToKotlinPlugin = "-PpathToKotlinPlugin=${File("local-repo").getAbsolutePath()}"
libraries/tools/kotlin-gradle-plugin-core/src/test/resources/testProject/delta/build.gradle
+40
View File
@@ -0,0 +1,40 @@
buildscript {
repositories {
mavenCentral()
maven {
url 'file://' + pathToKotlinPlugin
}
}
dependencies {
classpath 'org.jetbrains.kotlin:kotlin-gradle-plugin-core:0.1-SNAPSHOT'
}
}
import org.jetbrains.kotlin.gradle.plugin.KotlinPlugin
apply plugin: KotlinPlugin
repositories {
maven {
url 'file://' + pathToKotlinPlugin
}
mavenCentral()
}
dependencies {
testCompile 'org.testng:testng:6.8'
testRuntime 'org.jetbrains.kotlin:kotlin-stdlib:0.1-SNAPSHOT'
}
test {
useTestNG()
}
compileKotlin {
kotlinOptions.annotations = "externalAnnotations"
}
task wrapper(type: Wrapper) {
gradleVersion="1.4"
}
libraries/tools/kotlin-gradle-plugin-core/src/test/resources/testProject/delta/externalAnnotations/com/google/common/base/annotations.xml
+18
View File
@@ -0,0 +1,18 @@
<root>
<item name='com.google.common.base.Joiner com.google.common.base.Joiner on(java.lang.String)'>
<annotation name='jet.runtime.typeinfo.KotlinSignature'>
<val name="value" val="&quot;fun on(separator : String?) : Joiner&quot;"/>
</annotation>
</item>
<item name='com.google.common.base.Joiner com.google.common.base.Joiner.MapJoiner withKeyValueSeparator(java.lang.String)'>
<annotation name='jet.runtime.typeinfo.KotlinSignature'>
<val name="value"
val="&quot;fun withKeyValueSeparator(keyValueSeparator : String?) : Joiner.MapJoiner?&quot;"/>
</annotation>
</item>
<item name='com.google.common.base.Joiner com.google.common.base.Joiner skipNulls()'>
<annotation name='jet.runtime.typeinfo.KotlinSignature'>
<val name="value" val="&quot;fun skipNulls() : Joiner&quot;"/>
</annotation>
</item>
</root>
libraries/tools/kotlin-gradle-plugin-core/src/test/resources/testProject/delta/gradle/wrapper/gradle-wrapper.jar
Vendored
BIN
View File
Binary file not shown.
libraries/tools/kotlin-gradle-plugin-core/src/test/resources/testProject/delta/gradle/wrapper/gradle-wrapper.properties
Vendored
+6
View File
@@ -0,0 +1,6 @@
#Thu Feb 28 14:00:49 MSK 2013
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=http\://services.gradle.org/distributions/gradle-1.4-bin.zip
libraries/tools/kotlin-gradle-plugin-core/src/test/resources/testProject/delta/gradlew
Vendored
+164
View File
@@ -0,0 +1,164 @@
#!/usr/bin/env bash
##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS=""
APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"
warn ( ) {
echo "$*"
}
die ( ) {
echo
echo "$*"
echo
exit 1
}
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
esac
# For Cygwin, ensure paths are in UNIX format before anything is touched.
if $cygwin ; then
[ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
fi
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >&-
APP_HOME="`pwd -P`"
cd "$SAVED" >&-
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi
# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi
# For Cygwin, switch paths to Windows format before running java
if $cygwin ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=$((i+1))
done
case $i in
(0) set -- ;;
(1) set -- "$args0" ;;
(2) set -- "$args0" "$args1" ;;
(3) set -- "$args0" "$args1" "$args2" ;;
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi
# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
function splitJvmOpts() {
JVM_OPTS=("$@")
}
eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"
libraries/tools/kotlin-gradle-plugin-core/src/test/resources/testProject/delta/gradlew.bat
Vendored
+90
View File
@@ -0,0 +1,90 @@
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS=
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto init
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto init
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:init
@rem Get command-line arguments, handling Windowz variants
if not "%OS%" == "Windows_NT" goto win9xME_args
if "%@eval[2+2]" == "4" goto 4NT_args
:win9xME_args
@rem Slurp the command line arguments.
set CMD_LINE_ARGS=
set _SKIP=2
:win9xME_args_slurp
if "x%~1" == "x" goto execute
set CMD_LINE_ARGS=%*
goto execute
:4NT_args
@rem Get arguments from the 4NT Shell from JP Software
set CMD_LINE_ARGS=%$
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega
libraries/tools/kotlin-gradle-plugin-core/src/test/resources/testProject/delta/src/main/kotlin/helloWorld.kt
+15
View File
@@ -0,0 +1,15 @@
package demo
/**
* This is **bold**
*
* New paragraph using newlines.
*
* We can also support wiki links notation
* for example [[List]] and [[Collection]] and [[java.util.Collection.size()]] will
* generate hypertext links to classes
*/
public class MyClass() {
val i: Int = 0
}