diff --git a/inline-serialization/README.md b/inline-serialization/README.md new file mode 100644 index 0000000..abacb7b --- /dev/null +++ b/inline-serialization/README.md @@ -0,0 +1,31 @@ +# inline-serialization-plugin +A Kotlin compiler plugin for inline serialization, implemented with ΛRROW Meta. + +## Notes +*This plug-in is not a polished product meant to be reused in other projects.* + +The current version of this plug-in based against on Kotlin 1.3.61 and Serialization Runtime 0.14.0. + +Kotlin 1.3.70+ and thus Serialization Runtime 0.20.0 are not supported by ΛRROW Meta, at the moment (https://github.com/arrow-kt/arrow-meta/issues/554). + +This plug-in project is derived by the original `hello-world` plug-in example by the ΛRROW Meta team. + +## Plug-in description and project structure +The plug-in is implemented in the `inline-serialization-plugin` module. + +Inline serialization is enabled using the `@InlineSerializable` annotation, defined in the `inline-serialization` module. + +For each class `a.b.c.Xyz` annotated with `@InlineSerializable`, the plug-in generates a serializer `XyzSerializer`, implementing inline serialization, in package `a.b.c.inline_serialization`, and also annotates the class with `@Serializable(with=a.b.c.inline_serialization.XyzSerializer::class)`. + +In this case, we annotated two classes in the library implemented in module `example-library`. The compiler plugin is invoked during the build of this module. This library is then used by the application in module `example-application`. + +## Usage +### Build +From the console: + +```./gradlew clean :example-application:shadowJar``` + +### Run +From the console: + +```java -jar example-application/build/libs/example-application-all.jar``` diff --git a/inline-serialization/build.gradle b/inline-serialization/build.gradle new file mode 100644 index 0000000..81862a6 --- /dev/null +++ b/inline-serialization/build.gradle @@ -0,0 +1,28 @@ +buildscript { + repositories { + jcenter() + maven { url "https://plugins.gradle.org/m2/" } + maven { url "https://kotlin.bintray.com/kotlinx" } + mavenCentral() + maven { url 'https://oss.jfrog.org/artifactory/oss-snapshot-local/' } + } + + dependencies { + classpath "org.jetbrains.kotlin:kotlin-serialization:$KOTLIN_VERSION" + + classpath "io.arrow-kt:gradle-plugin:$ARROW_META_VERSION" + classpath "io.arrow-kt:compiler-plugin:$ARROW_META_VERSION" + } +} + +plugins { + id "org.jetbrains.kotlin.jvm" version "$KOTLIN_VERSION" apply false + id "com.github.johnrengelman.shadow" version "$SHADOW_JAR_VERSION" apply false +} + +allprojects { + repositories { + mavenCentral() + maven { url 'https://oss.jfrog.org/artifactory/oss-snapshot-local/' } + } +} diff --git a/inline-serialization/example-application/build.gradle b/inline-serialization/example-application/build.gradle new file mode 100644 index 0000000..cf88434 --- /dev/null +++ b/inline-serialization/example-application/build.gradle @@ -0,0 +1,38 @@ +plugins { + id "org.jetbrains.kotlin.jvm" + id "com.github.johnrengelman.shadow" + id "kotlinx-serialization" +} + +dependencies { + compileOnly "org.jetbrains.kotlin:kotlin-stdlib:$KOTLIN_VERSION" + + compileOnly "org.jetbrains.kotlinx:kotlinx-serialization-runtime:$kotlinx_serialization_runtime_version" + compileOnly "org.jetbrains.kotlin:kotlin-reflect:$KOTLIN_VERSION" + + compileOnly project(":example-library") +} + +compileKotlin { + kotlinOptions { + jvmTarget = "$JVM_TARGET_VERSION" + } +} + +compileTestKotlin { + kotlinOptions { + jvmTarget = "$JVM_TARGET_VERSION" + } +} + +shadowJar { + configurations = [project.configurations.compileOnly] +} + +jar { + manifest { + attributes( + "Main-Class": "io.arrowkt.example.inline_serialization.example_application.MainKt" + ) + } +} diff --git a/inline-serialization/example-application/src/main/kotlin/io/arrowkt/example/inline_serialization/example_application/Info.kt b/inline-serialization/example-application/src/main/kotlin/io/arrowkt/example/inline_serialization/example_application/Info.kt new file mode 100644 index 0000000..4af212b --- /dev/null +++ b/inline-serialization/example-application/src/main/kotlin/io/arrowkt/example/inline_serialization/example_application/Info.kt @@ -0,0 +1,11 @@ +package io.arrowkt.example.inline_serialization.example_application + +import kotlinx.serialization.Serializable + +import io.arrowkt.example.inline_serialization.example_library.ChannelCount + +@Serializable +data class Info( + val channelCount: ChannelCount, + val sampleRate: SampleRateHz +) diff --git a/inline-serialization/example-application/src/main/kotlin/io/arrowkt/example/inline_serialization/example_application/Main.kt b/inline-serialization/example-application/src/main/kotlin/io/arrowkt/example/inline_serialization/example_application/Main.kt new file mode 100644 index 0000000..ebcbe7a --- /dev/null +++ b/inline-serialization/example-application/src/main/kotlin/io/arrowkt/example/inline_serialization/example_application/Main.kt @@ -0,0 +1,33 @@ +package io.arrowkt.example.inline_serialization.example_application + +import kotlinx.serialization.json.Json +import kotlinx.serialization.json.JsonConfiguration + +import io.arrowkt.example.inline_serialization.example_library.ChannelCount +import io.arrowkt.example.inline_serialization.example_library.UserId + +fun main(args : Array) { + val stereo = ChannelCount(2) + val mono = ChannelCount(1) + val tri = stereo + mono + + println(tri) + + val userId1 = UserId.unique() + + println(userId1) + + val sampleRate = SampleRateHz(44100) + + println(sampleRate) + + val info = Info(stereo, sampleRate) + + println(info) + + val json = Json(JsonConfiguration.Stable) + + println(json.stringify(ChannelCount.serializer(), tri)) + println(json.stringify(SampleRateHz.serializer(), sampleRate)) + println(json.stringify(Info.serializer(), info)) +} diff --git a/inline-serialization/example-application/src/main/kotlin/io/arrowkt/example/inline_serialization/example_application/SampleRateHz.kt b/inline-serialization/example-application/src/main/kotlin/io/arrowkt/example/inline_serialization/example_application/SampleRateHz.kt new file mode 100644 index 0000000..97794a3 --- /dev/null +++ b/inline-serialization/example-application/src/main/kotlin/io/arrowkt/example/inline_serialization/example_application/SampleRateHz.kt @@ -0,0 +1,26 @@ +package io.arrowkt.example.inline_serialization.example_application + +import kotlinx.serialization.* +import kotlinx.serialization.internal.* + +@Serializable(with = SampleRateHzSerializer::class) +data class SampleRateHz(val value : Int) { + override fun toString(): String = "$value hz" +} + +@Serializer(forClass = SampleRateHz::class) +class SampleRateHzSerializer : KSerializer { + override val descriptor: SerialDescriptor = + IntDescriptor.withName(SampleRateHz::class.java.simpleName) + //PrimitiveDescriptor(SampleRateHz::class.java.simpleName, PrimitiveKind.INT) + + //override fun serialize(encoder: Encoder, value: SampleRateHz) { + // encoder.encodeInt(value.value) + override fun serialize(encoder: Encoder, obj: SampleRateHz) { + encoder.encodeInt(obj.value) + } + + override fun deserialize(decoder: Decoder): SampleRateHz { + return SampleRateHz(decoder.decodeInt()) + } +} diff --git a/inline-serialization/example-library/build.gradle b/inline-serialization/example-library/build.gradle new file mode 100644 index 0000000..8657bd4 --- /dev/null +++ b/inline-serialization/example-library/build.gradle @@ -0,0 +1,37 @@ +plugins { + id "org.jetbrains.kotlin.jvm" + id "com.github.johnrengelman.shadow" + id "kotlinx-serialization" +} + +dependencies { + compileOnly "org.jetbrains.kotlin:kotlin-stdlib:$KOTLIN_VERSION" + + compileOnly "org.jetbrains.kotlinx:kotlinx-serialization-runtime:$kotlinx_serialization_runtime_version" + compileOnly "org.jetbrains.kotlin:kotlin-reflect:$KOTLIN_VERSION" + + compileOnly "io.arrow-kt:arrow-annotations:$ARROW_VERSION" + + // To run :inline-serialization-plugin:shadowJar when building this project + api project(path: ':inline-serialization-plugin', configuration: 'shadow') + api project(":inline-serialization") +} + +compileKotlin { + kotlinOptions { + jvmTarget = "$JVM_TARGET_VERSION" + freeCompilerArgs = [ + "-Xplugin=${project.rootDir}/inline-serialization-plugin/build/libs/inline-serialization-plugin-all.jar" + ] + } +} + +compileTestKotlin { + kotlinOptions { + jvmTarget = "$JVM_TARGET_VERSION" + } +} + +shadowJar { + configurations = [project.configurations.compileOnly] +} diff --git a/inline-serialization/example-library/src/main/kotlin/io/arrowkt/example/inline_serialization/example_library/ChannelCount.kt b/inline-serialization/example-library/src/main/kotlin/io/arrowkt/example/inline_serialization/example_library/ChannelCount.kt new file mode 100644 index 0000000..f127b03 --- /dev/null +++ b/inline-serialization/example-library/src/main/kotlin/io/arrowkt/example/inline_serialization/example_library/ChannelCount.kt @@ -0,0 +1,13 @@ +package io.arrowkt.example.inline_serialization.example_library + +import io.arrowkt.example.inline_serialization.inline_serialization.InlineSerializable + +//metadebug + +@InlineSerializable +data class ChannelCount(val value : Int) { + override fun toString(): String = "$value channels" + + operator fun plus(other : ChannelCount) = + ChannelCount(value + other.value) +} diff --git a/inline-serialization/example-library/src/main/kotlin/io/arrowkt/example/inline_serialization/example_library/UserId.kt b/inline-serialization/example-library/src/main/kotlin/io/arrowkt/example/inline_serialization/example_library/UserId.kt new file mode 100644 index 0000000..16b8048 --- /dev/null +++ b/inline-serialization/example-library/src/main/kotlin/io/arrowkt/example/inline_serialization/example_library/UserId.kt @@ -0,0 +1,13 @@ +package io.arrowkt.example.inline_serialization.example_library + +import io.arrowkt.example.inline_serialization.inline_serialization.InlineSerializable + +@InlineSerializable +data class UserId(val value : String) { + companion object { + fun unique() = + UserId(java.util.UUID.randomUUID().toString()) + } + + override fun toString(): String = "UserId($value)" +} diff --git a/inline-serialization/gradle.properties b/inline-serialization/gradle.properties new file mode 100644 index 0000000..2e8d66c --- /dev/null +++ b/inline-serialization/gradle.properties @@ -0,0 +1,8 @@ +KOTLIN_VERSION=1.3.61 +KOTLIN_TEST_VERSION=3.4.2 +JVM_TARGET_VERSION=1.8 +ARROW_VERSION=0.10.5 +ARROW_META_VERSION=1.3.61-SNAPSHOT +SHADOW_JAR_VERSION=5.2.0 + +kotlinx_serialization_runtime_version=0.14.0 diff --git a/inline-serialization/gradle/wrapper/gradle-wrapper.jar b/inline-serialization/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..5c2d1cf Binary files /dev/null and b/inline-serialization/gradle/wrapper/gradle-wrapper.jar differ diff --git a/inline-serialization/gradle/wrapper/gradle-wrapper.properties b/inline-serialization/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..5a51c68 --- /dev/null +++ b/inline-serialization/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Mon May 04 15:27:16 CEST 2020 +distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.4-all.zip +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStorePath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME diff --git a/inline-serialization/gradlew b/inline-serialization/gradlew new file mode 100755 index 0000000..83f2acf --- /dev/null +++ b/inline-serialization/gradlew @@ -0,0 +1,188 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or 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 UN*X +## +############################################################################## + +# 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\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# 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 "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# 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 + ;; + 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" = "false" -a "$darwin" = "false" -a "$nonstop" = "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 or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # 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 + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/inline-serialization/gradlew.bat b/inline-serialization/gradlew.bat new file mode 100644 index 0000000..9618d8d --- /dev/null +++ b/inline-serialization/gradlew.bat @@ -0,0 +1,100 @@ +@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=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@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%" == "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 Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_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=%* + +: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 diff --git a/inline-serialization/inline-serialization-plugin/build.gradle b/inline-serialization/inline-serialization-plugin/build.gradle new file mode 100644 index 0000000..3b895ff --- /dev/null +++ b/inline-serialization/inline-serialization-plugin/build.gradle @@ -0,0 +1,31 @@ +plugins { + id "org.jetbrains.kotlin.jvm" + id "com.github.johnrengelman.shadow" +} + +dependencies { + compileOnly "org.jetbrains.kotlin:kotlin-stdlib:$KOTLIN_VERSION" + compileOnly "org.jetbrains.kotlin:kotlin-compiler-embeddable:$KOTLIN_VERSION" + compileOnly "org.jetbrains.kotlin:kotlin-reflect:$KOTLIN_VERSION" + compileOnly "org.jetbrains.kotlinx:kotlinx-serialization-runtime:$kotlinx_serialization_runtime_version" + + compileOnly "io.arrow-kt:arrow-core:$ARROW_VERSION" + compileOnly "io.arrow-kt:compiler-plugin:$ARROW_META_VERSION" + + compileOnly project(":inline-serialization") +} + +compileKotlin { + kotlinOptions { + jvmTarget = "$JVM_TARGET_VERSION" + } +} + +// Create a new JAR with: Arrow Meta + new plugin +shadowJar { + configurations = [project.configurations.compileOnly] + dependencies { + exclude("org.jetbrains.kotlin:kotlin-stdlib") + exclude("org.jetbrains.kotlin:kotlin-compiler-embeddable") + } +} diff --git a/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/AllPrimitiveKinds.kt b/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/AllPrimitiveKinds.kt new file mode 100644 index 0000000..f657cf3 --- /dev/null +++ b/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/AllPrimitiveKinds.kt @@ -0,0 +1,18 @@ +package io.arrowkt.example.inline_serialization.plugin + +import kotlinx.serialization.PrimitiveKind + +val allPrimitiveKinds = mapOf( + "BOOLEAN" to PrimitiveKind.BOOLEAN, + "BYTE" to PrimitiveKind.BYTE, + "CHAR" to PrimitiveKind.CHAR, + "DOUBLE" to PrimitiveKind.DOUBLE, + "FLOAT" to PrimitiveKind.FLOAT, + "INT" to PrimitiveKind.INT, + "LONG" to PrimitiveKind.LONG, + "SHORT" to PrimitiveKind.SHORT, + "STRING" to PrimitiveKind.STRING +) + +val Map.allTypeNames get() = + keys.joinToString { it.toLowerCase().capitalize() } diff --git a/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/Diagnostics.kt b/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/Diagnostics.kt new file mode 100644 index 0000000..94066e4 --- /dev/null +++ b/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/Diagnostics.kt @@ -0,0 +1,15 @@ +package io.arrowkt.example.inline_serialization.plugin + +fun TargetClass.Problem.toException() = + when (this) { + TargetClass.Problem.WrongStructure -> + UnsupportedClassStructure() + is TargetClass.Problem.UnsupportedType -> + UnsupportedValArgumentType(valueParameterTypeName) + } + +class UnsupportedClassStructure : + Exception("Inline serialization is meaningful only for classes with one and only one val member") +class UnsupportedValArgumentType( + val valueParameterTypeName : String +) : Exception("Unsupported val member type $valueParameterTypeName: Only supported types are: ${allPrimitiveKinds.allTypeNames}}") diff --git a/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/InlineSerializationPlugin.kt b/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/InlineSerializationPlugin.kt new file mode 100644 index 0000000..8092461 --- /dev/null +++ b/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/InlineSerializationPlugin.kt @@ -0,0 +1,35 @@ +package io.arrowkt.example.inline_serialization.plugin + +import org.jetbrains.kotlin.psi.* + +import arrow.core.getOrHandle +import arrow.meta.CliPlugin +import arrow.meta.Meta +import arrow.meta.invoke +import arrow.meta.quotes.Transform +import arrow.meta.quotes.classDeclaration +import arrow.meta.quotes.plus + +import io.arrowkt.example.inline_serialization.inline_serialization.InlineSerializable + +val Meta.inlineSerialization: CliPlugin + get() = + "Inline Serialization" { + meta( + classDeclaration({ isAnnotatedWith() } ) { c -> + val targetClass = TargetClass.tryMake(c).getOrHandle { problem -> + throw problem.toException() + } + + val originalClassAnnotation = Transform.replace( + replacing = c, + newDeclaration = targetClass.annotatedClassSource.`class`.syntheticScope + ) + val serializerClassGeneration = Transform.newSources( + targetClass.serializerClassSource.file(targetClass.serializerSourceFilename) + ) + + originalClassAnnotation + serializerClassGeneration + } + ) + } diff --git a/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/MetaPlugin.kt b/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/MetaPlugin.kt new file mode 100644 index 0000000..7568321 --- /dev/null +++ b/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/MetaPlugin.kt @@ -0,0 +1,15 @@ +package io.arrowkt.example.inline_serialization.plugin + +import kotlin.contracts.ExperimentalContracts + +import arrow.meta.CliPlugin +import arrow.meta.Meta +import arrow.meta.phases.CompilerContext + +class MetaPlugin : Meta { + @ExperimentalContracts + override fun intercept(ctx: CompilerContext): List = + listOf( + inlineSerialization + ) +} diff --git a/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/SourceCodeGeneration.kt b/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/SourceCodeGeneration.kt new file mode 100644 index 0000000..1656147 --- /dev/null +++ b/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/SourceCodeGeneration.kt @@ -0,0 +1,35 @@ +package io.arrowkt.example.inline_serialization.plugin + +val TargetClass.serializerClassSource get() = + """ |package $serializerClassPackageName + | + |import kotlinx.serialization.* + |import kotlinx.serialization.internal.* + | + |import $fullyQualifiedName + | + |@Serializer(forClass = ${name}::class) + |class $serializerClassName : KSerializer<${name}> { + | override val descriptor: SerialDescriptor = + | ${valueParameterTypeName}Descriptor.withName("MyData") + | // PrimitiveDescriptor("$name", PrimitiveKind.$primitiveKindName) + | + | //override fun serialize(encoder: Encoder, value: $name) { + | // encoder.encode$valueParameterTypeName(value.value) + | override fun serialize(encoder: Encoder, obj: $name) { + | encoder.encode$valueParameterTypeName(obj.value) + | } + | + | override fun deserialize(decoder: Decoder): $name { + | return $name(decoder.decode$valueParameterTypeName()) + | } + |} + """.trimMargin() + +val TargetClass.annotatedClassSource get() = + """ |@kotlinx.serialization.Serializable(with = $serializerClassPackageName.$serializerClassName::class) + |""".trimMargin() + + originalClassSourceCode + +val TargetClass.serializerSourceFilename get() = + "${name}.inline_serialization.kt" diff --git a/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/TargetClass.kt b/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/TargetClass.kt new file mode 100644 index 0000000..0041bd6 --- /dev/null +++ b/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/TargetClass.kt @@ -0,0 +1,54 @@ +package io.arrowkt.example.inline_serialization.plugin + +import org.jetbrains.kotlin.psi.KtClass +import org.jetbrains.kotlin.psi.KtParameter +import org.jetbrains.kotlin.psi.KtPrimaryConstructor + +import arrow.core.Either +import arrow.core.left +import arrow.core.right + +class TargetClass private constructor( + val c : KtClass, + val ctor : KtPrimaryConstructor, + val valueParameter : KtParameter, + val valueParameterTypeName : String, + val primitiveKindName : String +) { + sealed class Problem { + object WrongStructure : Problem() + class UnsupportedType( + val valueParameterTypeName : String + ) : Problem() + } + companion object { + fun tryMake(c : KtClass) : Either = + c.primaryConstructor!!.let { ctor -> + if (ctor.valueParameters.size != 1) { + Problem.WrongStructure.left() + } else { + val valueParameter = ctor.valueParameters[0]!! + val valueParameterTypeName = valueParameter.typeReference?.text!! + + val primitiveKindName = valueParameterTypeName.toUpperCase() + + if (primitiveKindName !in allPrimitiveKinds.keys) + Problem.UnsupportedType(valueParameterTypeName).left() + else + TargetClass(c, ctor, valueParameter, valueParameterTypeName, primitiveKindName).right() + } + } + } + + val name get() = c.name!! + val packageName get() = c.packageName!! + val fullyQualifiedName get() = c.fullyQualifiedName + + val serializerClassName + get() = "${name}Serializer" + val serializerClassPackageName + get() = "${packageName}.inline_serialization" + + val originalClassSourceCode + get() = c.text +} diff --git a/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/Utility.kt b/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/Utility.kt new file mode 100644 index 0000000..e4aa118 --- /dev/null +++ b/inline-serialization/inline-serialization-plugin/src/main/kotlin/io/arrowkt/example/inline_serialization/plugin/Utility.kt @@ -0,0 +1,29 @@ +package io.arrowkt.example.inline_serialization.plugin + +import org.jetbrains.kotlin.psi.* + +fun String?.orNoName() = this ?: "" + +val KtParameter.description get() = + "${name.orNoName()} : ${typeReference?.text }" + +fun List.joinAsNames() = + filterNotNull().joinToString(".") + +fun List.joinAsNames(block : (T) -> String?) = + map(block).joinAsNames() + +val KtClass.packageDirective get() = + containingFile.children.filterIsInstance().firstOrNull() + +val KtClass.packageName get() = + packageDirective?.packageNames?.joinAsNames { it.getReferencedName() } + +val KtClass.fullyQualifiedName get() = + listOf(packageName, name).joinAsNames() + +inline fun isAnnotatedWith() : KtAnnotated.() -> Boolean = + { annotationEntries.any { it.shortName?.asString() == T::class.simpleName } } + +inline fun KtAnnotated.isAnnotatedWith() = + annotationEntries.any { it.shortName?.asString() == T::class.simpleName } diff --git a/inline-serialization/inline-serialization-plugin/src/main/resources/META-INF/services/org.jetbrains.kotlin.compiler.plugin.ComponentRegistrar b/inline-serialization/inline-serialization-plugin/src/main/resources/META-INF/services/org.jetbrains.kotlin.compiler.plugin.ComponentRegistrar new file mode 100644 index 0000000..a7f4c1e --- /dev/null +++ b/inline-serialization/inline-serialization-plugin/src/main/resources/META-INF/services/org.jetbrains.kotlin.compiler.plugin.ComponentRegistrar @@ -0,0 +1 @@ +io.arrowkt.example.inline_serialization.plugin.MetaPlugin diff --git a/inline-serialization/inline-serialization/build.gradle b/inline-serialization/inline-serialization/build.gradle new file mode 100644 index 0000000..87f5137 --- /dev/null +++ b/inline-serialization/inline-serialization/build.gradle @@ -0,0 +1,20 @@ +plugins { + id 'org.jetbrains.kotlin.jvm' +} + +version 'unspecified' + +repositories { + mavenCentral() +} + +dependencies { + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8" +} + +compileKotlin { + kotlinOptions.jvmTarget = "1.8" +} +compileTestKotlin { + kotlinOptions.jvmTarget = "1.8" +} diff --git a/inline-serialization/inline-serialization/src/main/kotlin/io/arrowkt/example/inline_serialization/inline_serialization/InlineSerializable.kt b/inline-serialization/inline-serialization/src/main/kotlin/io/arrowkt/example/inline_serialization/inline_serialization/InlineSerializable.kt new file mode 100644 index 0000000..6640cc4 --- /dev/null +++ b/inline-serialization/inline-serialization/src/main/kotlin/io/arrowkt/example/inline_serialization/inline_serialization/InlineSerializable.kt @@ -0,0 +1,3 @@ +package io.arrowkt.example.inline_serialization.inline_serialization + +annotation class InlineSerializable diff --git a/inline-serialization/settings.gradle b/inline-serialization/settings.gradle new file mode 100644 index 0000000..1745dde --- /dev/null +++ b/inline-serialization/settings.gradle @@ -0,0 +1,5 @@ +include ":inline-serialization" +include ':inline-serialization-plugin' +include ':example-library' +include ':example-application' +