Support Kotlin source code generation (#12)

* Support Kotlin source code generation

* Test Kotlin source code generation on CI

* Format

* Add descriptions about Kotlin

Author: nakamura-to

.github/workflows/ci.yml

@@ -31,9 +31,13 @@ jobs:
         working-directory: ./codegen
         run: ./gradlew build
 
-      - name: Test plugin
+      - name: Test plugin (generate Java code)
         working-directory: ./codegen-test
-        run: ./gradlew domaCodeGenDevAll build
+        run: ./gradlew domaCodeGenJavaAll build
+
+      - name: Test plugin (generate Kotlin code)
+        working-directory: ./codegen-test
+        run: ./gradlew domaCodeGenKotlinAll build
 
       - name: Set version
         id: set-version

README.md

@@ -2,7 +2,7 @@ Doma CodeGen Plugin
 ===================
 
 Doma CodeGen Plugin is a gradle plugin.  
-It generates Java source files and SQL files from Database.
+It generates Java, Kotlin, and SQL files from Database.
 
 [![Java CI with Gradle](https://github.com/domaframework/doma-codegen-plugin/workflows/Java%20CI%20with%20Gradle/badge.svg)](https://github.com/domaframework/doma-codegen-plugin/actions?query=workflow%3A%22Java+CI+with+Gradle%22)
 [![Google Group : doma-user](https://img.shields.io/badge/Google%20Group-doma--user-orange.svg)](https://groups.google.com/g/doma-user)
@@ -119,11 +119,13 @@ domaCodeGen {
 | ignoredTableNamePattern | database ignored table pattern (Regex) | | `.*\$.*` |
 | tableTypes | database table type | such as TABLE, VIEW and so on | `TABLE` |
 | versionColumnNamePattern | database version column pattern (Regex) | | `VERSION([_]?NO)?` |
+| languageType | language of generation code | `org.seasar.doma.gradle.codegen.desc.LanguageType.JAVA`, `org.seasar.doma.gradle.codegen.desc.LanguageType.KOTLIN` | `org.seasar.doma.gradle.codegen.desc.LanguageType.JAVA` |
+| languageClassResolver | class resolver for language dedicated classes | | depends on `languageType` |
 | templateEncoding | encoding for freeMarker template files | | `UTF-8` |
 | templateDir | directory for user customized template files | | |
 | encoding | encoding for generated Java source files | | `UTF-8` |
-| sourceDir | directory for generated Java source files | | `src/main/java` |
-| testSourceDir | directory for generated Java test source files | | `src/test/java` |
+| sourceDir | directory for generated Java source files | | depends on `languageType` |
+| testSourceDir | directory for generated Java test source files | | depends on `languageType` |
 | resourceDir | directory for generated SQL files | | src/main/resources |
 | globalFactory | entry point to customize plugin behavior | | `new org.seasar.doma.gradle.codegen.GlobalFactory()` |
 
@@ -209,6 +211,32 @@ domaCodeGen {
 Customization
 -------------
 
+### Generating Kotlin code
+
+To generate Kotlin code, specify `LanguageType.KOTLIN` to the languageType option as follows:
+
+```groovy
+import org.seasar.doma.gradle.codegen.desc.LanguageType
+
+...
+
+domaCodeGen {
+    dev {
+        url = '...'
+        user = '...'
+        password = '...'
+        languageType = LanguageType.KOTLIN
+        entity {
+          packageName = 'org.example.entity'
+        }
+        dao {
+          packageName = 'org.example.dao'
+        }
+    }
+}
+```
+
+
 ### Using custom template files
 
 Default template files are located in the source code repository of the Doma CodeGen Plugin.  

codegen-test/build.gradle

@@ -1,4 +1,5 @@
 import org.h2.Driver
+import org.seasar.doma.gradle.codegen.desc.LanguageType
 import org.seasar.doma.gradle.codegen.jdbc.SimpleDataSource
 
 buildscript {
@@ -17,6 +18,7 @@ buildscript {
 
 plugins {
     id 'java'
+    id 'org.jetbrains.kotlin.jvm' version '1.4.10'
     id 'org.seasar.doma.compile' version '1.1.0'
 }
 
@@ -49,7 +51,7 @@ def _user = ''
 def _password = ''
 
 domaCodeGen {
-    dev {
+    java {
         def basePackage = 'codegen'
         url = _url.toString()
         user = _user
@@ -61,6 +63,19 @@ domaCodeGen {
             packageName = "${basePackage}.dao"
         }
     }
+    kotlin {
+        def basePackage = 'codegen'
+        url = _url.toString()
+        user = _user
+        password = _password
+        languageType = LanguageType.KOTLIN
+        entity {
+            packageName = "${basePackage}.entity"
+        }
+        dao {
+            packageName = "${basePackage}.dao"
+        }
+    }
 }
 
 task deleteSrc {
@@ -100,4 +115,5 @@ task createDb {
     }
 }
 
-tasks.getByName('domaCodeGenDevDbMeta').dependsOn(deleteSrc, createDb)
+tasks.getByName('domaCodeGenJavaDbMeta').dependsOn(deleteSrc, createDb)
+tasks.getByName('domaCodeGenKotlinDbMeta').dependsOn(deleteSrc, createDb)

codegen-test/gradle/wrapper/gradle-wrapper.jar

@@ -1,6 +1,5 @@
-#Sat Apr 04 07:31:40 JST 2020
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-all.zip
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.3.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

codegen-test/gradle/wrapper/gradle-wrapper.properties

@@ -1,21 +1,5 @@
 #!/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
@@ -44,7 +28,7 @@ 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"'
+DEFAULT_JVM_OPTS='"-Xmx64m"'
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD="maximum"
@@ -125,8 +109,8 @@ 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
+# 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"`
     JAVACMD=`cygpath --unix "$JAVACMD"`
@@ -154,19 +138,19 @@ if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
         else
             eval `echo args$i`="\"$arg\""
         fi
-        i=`expr $i + 1`
+        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" ;;
+        (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
 
@@ -175,9 +159,14 @@ save () {
     for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
     echo " "
 }
-APP_ARGS=`save "$@"`
+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" "$@"

codegen-test/gradlew

@@ -1,19 +1,3 @@
-@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
@@ -29,11 +13,8 @@ if "%DIRNAME%" == "" set DIRNAME=.
 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"
+set DEFAULT_JVM_OPTS="-Xmx64m"
 
 @rem Find java.exe
 if defined JAVA_HOME goto findJavaFromJavaHome

codegen-test/gradlew.bat

@@ -10,7 +10,7 @@ gradlePlugin {
         compilePlugin {
             id = 'org.seasar.doma.codegen'
             displayName = 'Doma Codegen Plugin'
-            description = 'Generates Java source files and SQL files from Database'
+            description = 'Generates Java, Kotlin, and SQL files from Database'
             implementationClass = 'org.seasar.doma.gradle.codegen.CodeGenPlugin'
         }
     }

codegen/build.gradle

@@ -92,15 +92,15 @@ class EntityPropertyDescMerger {
           case SEQUENCE:
             dest.setGenerationType(GenerationType.SEQUENCE);
             if (src.sequenceGenerator != null) {
-              dest.setInitialValue(src.sequenceGenerator.initialValue());
+              dest.setInitialValue(src.sequenceGenerator.getDefaultValue());
               dest.setAllocationSize(src.sequenceGenerator.allocationSize());
               dest.setAllocationSize(src.sequenceGenerator.allocationSize());
             }
             break;
           case TABLE:
             dest.setGenerationType(GenerationType.TABLE);
             if (src.tableGenerator != null) {
-              dest.setInitialValue(src.tableGenerator.initialValue());
+              dest.setInitialValue(src.tableGenerator.getDefaultValue());
               dest.setAllocationSize(src.tableGenerator.allocationSize());
               dest.setAllocationSize(src.tableGenerator.allocationSize());
             }

codegen/src/main/groovy/org/seasar/doma/gradle/codegen/desc/EntityPropertyDescMerger.groovy

@@ -147,6 +147,8 @@ private void connectProperties(CodeGenDtoTask task, CodeGenConfig extension) {
     task.getTableNamePattern().set(extension.getTableNamePattern());
     task.getIgnoredTableNamePattern().set(extension.getIgnoredTableNamePattern());
     task.getVersionColumnNamePattern().set(extension.getVersionColumnNamePattern());
+    task.getLanguageType().set(extension.getLanguageType());
+    task.getLanguageClassResolver().set(extension.getLanguageClassResolver());
     task.getSourceDir().set(extension.getSourceDir());
     task.getEncoding().set(extension.getEncoding());
     task.setEntityConfig(extension.getEntityConfig());
@@ -161,12 +163,14 @@ private void connectProperties(CodeGenEntityDescTask task, CodeGenConfig extensi
     task.getTableNamePattern().set(extension.getTableNamePattern());
     task.getIgnoredTableNamePattern().set(extension.getIgnoredTableNamePattern());
     task.getVersionColumnNamePattern().set(extension.getVersionColumnNamePattern());
+    task.getLanguageClassResolver().set(extension.getLanguageClassResolver());
     task.setEntityConfig(extension.getEntityConfig());
   }
 
   private void connectProperties(CodeGenEntityTask task, CodeGenConfig extension) {
     task.getGlobalFactory().set(extension.getGlobalFactory());
     task.getGenerator().set(extension.getGenerator());
+    task.getLanguageType().set(extension.getLanguageType());
     task.getSourceDir().set(extension.getSourceDir());
     task.getEncoding().set(extension.getEncoding());
     task.setEntityConfig(extension.getEntityConfig());
@@ -179,6 +183,7 @@ private void connectProperties(CodeGenDaoDescTask task, CodeGenConfig extension)
 
   private void connectProperties(CodeGenDaoTask task, CodeGenConfig extension) {
     task.getGenerator().set(extension.getGenerator());
+    task.getLanguageType().set(extension.getLanguageType());
     task.getSourceDir().set(extension.getSourceDir());
     task.getEncoding().set(extension.getEncoding());
     task.setDaoConfig(extension.getDaoConfig());
@@ -200,6 +205,7 @@ private void connectProperties(CodeGenSqlTestTask task, CodeGenConfig extension)
     task.getPassword().set(extension.getPassword());
     task.getUrl().set(extension.getUrl());
     task.getGenerator().set(extension.getGenerator());
+    task.getLanguageType().set(extension.getLanguageType());
     task.getTestSourceDir().set(extension.getTestSourceDir());
     task.getEncoding().set(extension.getEncoding());
     task.setSqlTestConfig(extension.getSqlTestConfig());