From 99e2524055b91d2a965531701cb4eb114f7cc37a Mon Sep 17 00:00:00 2001 From: Jolan Rensen Date: Fri, 30 Dec 2022 00:57:33 +0100 Subject: [PATCH] Initial commit --- .gitignore | 1 + README | 1 + gradle/wrapper/gradle-wrapper.properties | 5 + gradlew | 244 ++++++++++++++++++ gradlew.bat | 92 +++++++ greeting-plugin/build.gradle.kts | 44 ++++ .../plugin/KdocIncludePluginFunctionalTest.kt | 93 +++++++ .../plugin/ProcessKdocIncludePlugin.kt | 10 + .../example/plugin/ProcessKdocIncludeTask.kt | 190 ++++++++++++++ .../kotlin/com/example/plugin/kDocUtils.kt | 42 +++ .../example/plugin/KdocIncludePluginTest.kt | 60 +++++ settings.gradle.kts | 3 + 12 files changed, 785 insertions(+) create mode 100644 README create mode 100644 gradle/wrapper/gradle-wrapper.properties create mode 100644 gradlew create mode 100644 gradlew.bat create mode 100644 greeting-plugin/build.gradle.kts create mode 100644 greeting-plugin/src/functionalTest/kotlin/com/example/plugin/KdocIncludePluginFunctionalTest.kt create mode 100644 greeting-plugin/src/main/kotlin/com/example/plugin/ProcessKdocIncludePlugin.kt create mode 100644 greeting-plugin/src/main/kotlin/com/example/plugin/ProcessKdocIncludeTask.kt create mode 100644 greeting-plugin/src/main/kotlin/com/example/plugin/kDocUtils.kt create mode 100644 greeting-plugin/src/test/kotlin/com/example/plugin/KdocIncludePluginTest.kt create mode 100644 settings.gradle.kts diff --git a/.gitignore b/.gitignore index a1c2a238..2a012925 100644 --- a/.gitignore +++ b/.gitignore @@ -21,3 +21,4 @@ # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml hs_err_pid* +/.gradle/ diff --git a/README b/README new file mode 100644 index 00000000..30404ce4 --- /dev/null +++ b/README @@ -0,0 +1 @@ +TODO \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..070cb702 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 00000000..65dcd68d --- /dev/null +++ b/gradlew @@ -0,0 +1,244 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +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" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 00000000..6689b85b --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@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 + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@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="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +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 execute + +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 + +: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 %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 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! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/greeting-plugin/build.gradle.kts b/greeting-plugin/build.gradle.kts new file mode 100644 index 00000000..64513ed9 --- /dev/null +++ b/greeting-plugin/build.gradle.kts @@ -0,0 +1,44 @@ +plugins { + // Apply the Java Gradle plugin development plugin to add support for developing Gradle plugins + `java-gradle-plugin` + kotlin("jvm") version "1.8.0" +} + +group = "org.example" +version = "1.0-SNAPSHOT" + +repositories { + // Use Maven Central for resolving dependencies + mavenCentral() +} + +dependencies { + // Use JUnit test framework for unit tests + testImplementation(kotlin("test")) + testImplementation("io.kotest:kotest-assertions-core:5.5.4") + implementation(gradleApi()) +} + +gradlePlugin { + // Define the plugin + val kdocInclude by plugins.creating { + id = "com.example.plugin.kdocInclude" + implementationClass = "com.example.plugin.KdocIncludePlugin" + } +} + +// Add a source set and a task for a functional test suite +val functionalTest: SourceSet by sourceSets.creating +gradlePlugin.testSourceSets(functionalTest) + +configurations[functionalTest.implementationConfigurationName].extendsFrom(configurations.testImplementation.get()) + +val functionalTestTask = tasks.register("functionalTest") { + testClassesDirs = functionalTest.output.classesDirs + classpath = configurations[functionalTest.runtimeClasspathConfigurationName] + functionalTest.output +} + +tasks.check { + // Run the functional tests as part of `check` + dependsOn(functionalTestTask) +} diff --git a/greeting-plugin/src/functionalTest/kotlin/com/example/plugin/KdocIncludePluginFunctionalTest.kt b/greeting-plugin/src/functionalTest/kotlin/com/example/plugin/KdocIncludePluginFunctionalTest.kt new file mode 100644 index 00000000..0cfd55bb --- /dev/null +++ b/greeting-plugin/src/functionalTest/kotlin/com/example/plugin/KdocIncludePluginFunctionalTest.kt @@ -0,0 +1,93 @@ +package com.example.plugin + +import org.gradle.testkit.runner.GradleRunner +import org.intellij.lang.annotations.Language +import org.junit.Assert +import org.junit.Test +import java.io.File +import java.io.FileWriter +import java.io.IOException + +class KdocIncludePluginFunctionalTest { + + @Language("kts") + private val buildFile = """ + plugins { + kotlin("jvm") version "1.8.0" + id("com.example.plugin.kdocInclude") + } + + val kotlinMainSources = kotlin.sourceSets.main.get().kotlin.sourceDirectories + + val processKdocIncludeMain by tasks.creating(com.example.plugin.ProcessKdocIncludeTask::class) { + sources.set(kotlinMainSources) + } + + tasks.compileKotlin { dependsOn(processKdocIncludeMain) } + """.trimIndent() + + @Language("kt") + private val mainFile = """ + package com.example.plugin + + /** + * Hello World! + * + * This is a large example of how the plugin will work + * + * @param name The name of the person to greet + * @see [com.example.plugin.KdocIncludePlugin] + */ + private interface Test + + + /** + * Some extra text + * @include [Test] */ + fun someFun() { + println("Hello World!") + } + + /** @include [com.example.plugin.Test] */ + fun someMoreFun() { + println("Hello World!") + } + """.trimIndent() + + @Test + @Throws(IOException::class) + fun canRunTask() { + // Set up the test build + val projectDir = File("build/functionalTest") + projectDir.mkdirs() + + File(projectDir, "settings.gradle.kts") + .writeString("") + + File(projectDir, "build.gradle.kts") + .writeString(buildFile) + + File(projectDir, "src/main/kotlin/com/example/plugin/Main.kt") + .writeString(mainFile) + + // Run the build + val result = GradleRunner.create() + .forwardOutput() + .withPluginClasspath() + .withArguments("processKdocIncludeMain") + .withProjectDir(projectDir) + .build() + + // Verify the result + Assert.assertTrue(result.output.contains("Hello from plugin 'com.example.plugin.kdocInclude'")) + } + + @Throws(IOException::class) + private fun File.writeString(string: String) { + if (!parentFile.exists()) { + parentFile.mkdirs() + } + + FileWriter(this).use { writer -> writer.write(string) } + } +} \ No newline at end of file diff --git a/greeting-plugin/src/main/kotlin/com/example/plugin/ProcessKdocIncludePlugin.kt b/greeting-plugin/src/main/kotlin/com/example/plugin/ProcessKdocIncludePlugin.kt new file mode 100644 index 00000000..53f0aa1a --- /dev/null +++ b/greeting-plugin/src/main/kotlin/com/example/plugin/ProcessKdocIncludePlugin.kt @@ -0,0 +1,10 @@ +package com.example.plugin + +import org.gradle.api.Plugin +import org.gradle.api.Project + +class KdocIncludePlugin : Plugin { + override fun apply(project: Project) { + project.tasks.register("processKdocInclude", ProcessKdocIncludeTask::class.java) + } +} \ No newline at end of file diff --git a/greeting-plugin/src/main/kotlin/com/example/plugin/ProcessKdocIncludeTask.kt b/greeting-plugin/src/main/kotlin/com/example/plugin/ProcessKdocIncludeTask.kt new file mode 100644 index 00000000..f3e7d964 --- /dev/null +++ b/greeting-plugin/src/main/kotlin/com/example/plugin/ProcessKdocIncludeTask.kt @@ -0,0 +1,190 @@ +package com.example.plugin + +import org.gradle.api.DefaultTask +import org.gradle.api.model.ObjectFactory +import org.gradle.api.provider.ListProperty +import org.gradle.api.provider.Property +import org.gradle.api.tasks.Input +import org.gradle.api.tasks.InputFiles +import org.gradle.api.tasks.TaskAction +import java.io.File +import javax.inject.Inject + +open class ProcessKdocIncludeTask @Inject constructor(factory: ObjectFactory) : DefaultTask() { + + /** + * Source root folders for preprocessing + */ + @get:InputFiles + val sources: ListProperty = factory + .listProperty(File::class.java) + + /** + * Set base directory which will be used for relative source paths. + * By default, it is '$projectDir'. + */ + @get:Input + val baseDir: Property = factory + .property(File::class.java) + .convention(project.projectDir) + + /** + * List of file extensions to be included into preprocessing. + * By default: kt, kts + */ + @get:Input + val fileExtensions: ListProperty = factory + .listProperty(String::class.java) + .convention(listOf("kt", "kts")) + + /** + * Target folder to place preprocessing result in regular source processing + * phase. + */ + @get:Input + val target: Property = factory + .property(File::class.java) + .convention(File(project.buildDir, "kdocInclude${File.separatorChar}${taskIdentity.name}")) + + private val kdocSourceRegex = Regex("""( *)/\*\*([^*]|\*(?!/))*?\*/(\s+)(.*)(interface|class|object)(\s+).+""") + private val kdocRegex = Regex("""( *)/\*\*([^*]|\*(?!/))*?\*/""") + private val includeRegex = Regex("""@include(\s+)(\[?)(.+)(]?)""") + private val packageRegex = Regex("""package(\s+)(.+)(\s+)""") + + private data class SourceKdoc(val packageName: String, val source: String, val kdocContent: String) + + @TaskAction + fun process() { + println("Hello from plugin 'com.example.plugin.kdocInclude'") + + val fileExtensions = fileExtensions.get() + val sources = sources.get() + val target = target.get() + + if (target.exists()) target.deleteRecursively() + target.mkdir() + + println("Using target folder: $target") + println("Using source folders: $sources") + println("Using file extensions: $fileExtensions") + + // gather source kdocs + val sourceDocs = buildMap> { + for (source in sources) { + for (file in source.walkTopDown()) { + if (!file.isFile) continue + + val content = file.readText() + val sourceKDocs = readSourceKDocs(content) + + for (sourceKDoc in sourceKDocs) { + getOrPut(sourceKDoc.packageName) { mutableListOf() }.add(sourceKDoc) + } + } + } + } + + // replace @include tags with matching source kdocs + for (source in sources) { + for (file in source.walkTopDown()) { + if (!file.isFile) continue + + val relativePath = baseDir.get().toPath().relativize(file.toPath()) + val targetFile = File(target, relativePath.toString()) + targetFile.parentFile.mkdirs() + + val content = file.readText() + val processedContent = + if (file.extension !in fileExtensions) content + else processFileContent(content, sourceDocs) + + targetFile.writeText(processedContent) + } + } + } + + private fun getPackageName(fileContent: String): String = + packageRegex.find(fileContent)?.groupValues?.get(2) ?: "" + + /** + * Scans the given file content for source kdocs and returns a list of them. + * + * TODO maybe replace these sources with @define or something similar? + */ + private fun readSourceKDocs(fileContent: String): List { + + val packageName = getPackageName(fileContent) + + // Find all kdoc sources that can be targeted with @include + // This can be any (annotation-less) interface, class, or object + val sourceKDocs = kdocSourceRegex.findAll(fileContent).map { + val value = it.value + + val kdocPart = kdocRegex.find(value)!!.value + val sourcePart = value.removePrefix(kdocPart).trim() + + val kdocContent = kdocPart.getKdocContent() + + SourceKdoc(packageName, sourcePart, kdocContent) + }.toList() + + return sourceKDocs + } + + private fun processFileContent(fileContent: String, sourceKDocs: Map>): String { + val packageName = getPackageName(fileContent) + + // Find all kdocs and replace @include with the content of the targeted kdoc + return fileContent.replace(kdocRegex) { + processKdoc(it.value, sourceKDocs, packageName) + } + } + + /** + * Get include target name. + * For instance, changes `@include [Foo]` to `Foo` + */ + private fun String.getIncludeTargetName(): String { + require("@include" in this) + + return this + .trim() + .removePrefix("@include") + .trim() + .removePrefix("[") + .removeSuffix("]") + .trim() + } + + private fun processKdoc(kdoc: String, sourceKDocs: Map>, packageName: String): String { + val indent = kdoc.indexOfFirst { it != ' ' } + + val sourceKDocsCurrentPackage = sourceKDocs[packageName] ?: emptyList() + + return kdoc + .getKdocContent() + .replace(includeRegex) { match -> + val name = match.value.getIncludeTargetName() + + // try to get the content using the current package + val kdocContent = sourceKDocsCurrentPackage.firstOrNull { name in it.source }?.kdocContent + if (kdocContent != null) return@replace kdocContent + + // couldn't find the content in the current package and no package was specified, + // returning empty string + if ('.' !in name) return@replace "" + + // try to get the content using the specified package + val targetPackage = name.dropLastWhile { it != '.' } + val targetName = name.removePrefix(targetPackage) + + println("Looking for $targetName in ${targetPackage.dropLast(1)}") + + val otherKdocContent = sourceKDocs[targetPackage.dropLast(1)]?.firstOrNull { targetName in it.source }?.kdocContent + + return@replace otherKdocContent + ?: "" + } + .toKdoc(indent) + } +} \ No newline at end of file diff --git a/greeting-plugin/src/main/kotlin/com/example/plugin/kDocUtils.kt b/greeting-plugin/src/main/kotlin/com/example/plugin/kDocUtils.kt new file mode 100644 index 00000000..5972a4e3 --- /dev/null +++ b/greeting-plugin/src/main/kotlin/com/example/plugin/kDocUtils.kt @@ -0,0 +1,42 @@ +package com.example.plugin + +/** + * Returns the actual content of the KDoc comment + */ +fun String.getKdocContent() = this + .split('\n') + .joinToString("\n") { + it + .trim() + .removePrefix("/**") + .removeSuffix("*/") + .removePrefix("*") + .trim() + } + + +/** + * Turns multi-line String into valid kdoc. + */ +fun String.toKdoc(indent: Int = 0) = this + .split('\n') + .toMutableList() + .let { + it[0] = "/** ${it[0]}".trim() + + val lastIsBlank = it.last().isBlank() + + it[it.lastIndex] = it[it.lastIndex].trim() + " */" + + it.mapIndexed { index, s -> + buildString { + if (index != 0) append("\n") + append(" ".repeat(indent)) + + if (!(index == 0 || index == it.lastIndex && lastIsBlank)) { + append(" * ") + } + append(s) + } + }.joinToString("") + } \ No newline at end of file diff --git a/greeting-plugin/src/test/kotlin/com/example/plugin/KdocIncludePluginTest.kt b/greeting-plugin/src/test/kotlin/com/example/plugin/KdocIncludePluginTest.kt new file mode 100644 index 00000000..ae89b6a3 --- /dev/null +++ b/greeting-plugin/src/test/kotlin/com/example/plugin/KdocIncludePluginTest.kt @@ -0,0 +1,60 @@ +package com.example.plugin + +import io.kotest.matchers.shouldBe +import org.gradle.testfixtures.ProjectBuilder +import org.junit.Assert +import org.junit.Test + +class KdocIncludePluginTest { + @Test + fun pluginRegistersATask() { + // Create a test project and apply the plugin + val project = ProjectBuilder.builder().build() + project.plugins.apply("com.example.plugin.kdocInclude") + + // Verify the result + Assert.assertNotNull(project.tasks.findByName("processKdocInclude")) + } + + @Test + fun `Test Kdoc utils`() { + val kdoc1 = """ + /** + * Hello World! + * + * @see [com.example.plugin.KdocIncludePlugin] + */ + """.trimIndent() + + kdoc1.getKdocContent().toKdoc() shouldBe kdoc1 + + val kdoc2 = """ + /** Hello World! + * + * @see [com.example.plugin.KdocIncludePlugin] */ + """.trimIndent() + + kdoc2.getKdocContent().toKdoc() shouldBe kdoc2 + + val kdoc3 = """ + /** Hello World! + * @see [com.example.plugin.KdocIncludePlugin] */ + """.trimIndent() + + kdoc3.getKdocContent().toKdoc() shouldBe kdoc3 + + val kdoc4 = """ + /** Hello World! */ + """.trimIndent() + + kdoc4.getKdocContent().toKdoc() shouldBe kdoc4 + + val kdoc5 = """ + /** + * Hello World! + */ + """.trimIndent() + + kdoc5.getKdocContent().toKdoc() shouldBe kdoc5 + } +} \ No newline at end of file diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 00000000..4f6c54e0 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,3 @@ +rootProject.name = "gradle-plugin-in-java" + +include("greeting-plugin")