add mill plugin (#1)

cornerman · web-flow · commit 25c469c3a510 · 2024-04-10T11:57:05.000+02:00
diff --git a/.envrc b/.envrc
@@ -0,0 +1,7 @@
+# Automatically sets up your devbox environment whenever you cd into this
+# directory via our direnv integration:
+
+eval "$(devbox generate direnv --print-envrc)"
+
+# check out https://www.jetpack.io/devbox/docs/ide_configuration/direnv/
+# for more details
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -15,7 +15,7 @@ jobs:
       - uses: olafurpg/setup-scala@v12
 
       - name: Test
-        run: sbt ++test
+        run: sbt test
 
   publish:
     needs: [build]
diff --git a/.gitignore b/.gitignore
@@ -1,10 +1,32 @@
-# bloop and metals
-.bloop
-.bsp
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
 
-# metals
-.metals
+node_modules
+dist
+dist-ssr
+*.local
 
-# sbt
-target/
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
 
+# Scala stuff
+.bloop/
+.bsp/
+.metals/
+target/
+metals.sbt
+out/
diff --git a/README.md b/README.md
@@ -1,14 +1,16 @@
-# sbt-quillcodegen
+# scala-quillcodegen
 
-This is an sbt-plugin that uses the [quill-codegen-jdbc](https://zio.dev/zio-quill/code-generation/) to generate case classes and query schemas from a database schema.
+This is an sbt-plugin and mill-plugin that uses the [quill-codegen-jdbc](https://zio.dev/zio-quill/code-generation/) to generate case classes and query schemas from a database schema.
 
 Works with scala 2 and 3.
 
 ## Usage
 
+### sbt
+
 In `project/plugins.sbt`:
 ```sbt
-addSbtPlugin("com.github.cornerman" % "sbt-quillcodegen" % "0.1.5")
+addSbtPlugin("com.github.cornerman" % "sbt-quillcodegen" % "0.2.0")
 ```
 
 In `build.sbt`:
@@ -46,7 +48,7 @@ lazy val db = project
   )
 ```
 
-### Setup database before codegen
+#### Setup database before codegen
 
 An example for using the `quillcodegenSetupTask` to setup an sqlite database with a `schema.sql` file before the code generation runs:
 ```sbt
@@ -58,3 +60,21 @@ quillcodegenSetupTask := Def.taskDyn {
 
 The functions `executeSql` and `executeSqlFile` are provided for these kind of use-cases and use the provided jdbcUrl, username, and password.
 
+
+### mill
+
+In `build.sc`:
+```
+import mill._, scalalib._
+import $ivy.`com.github.cornerman::mill-quillcodegen:0.2.0`, quillcodegen.plugin.QuillCodegenModule
+
+object backend extends ScalaModule with QuillCodegenModule {
+  def quillcodegenJdbcUrl       = "com.example.db",
+  def quillcodegenPackagePrefix = "dbtypes"
+  def quillcodegenSetupTask = T.task {
+    val dbpath = quillcodegenJdbcUrl.stripPrefix("jdbc:sqlite:")
+    os.remove(os.pwd / dbpath)
+    executeSqlFile(PathRef(os.pwd / "schema.sql"))
+  }
+}
+```
diff --git a/build.sbt b/build.sbt
@@ -2,11 +2,9 @@ Global / onChangedBuildSource := ReloadOnSourceChanges
 
 inThisBuild(
   Seq(
-    organization       := "com.github.cornerman",
-    scalaVersion       := "2.12.12",
-    crossScalaVersions := Seq("2.12.12"),
-    licenses           := Seq("MIT License" -> url("https://opensource.org/licenses/MIT")),
-    homepage           := Some(url("https://github.com/cornerman/sbt-quillcodegen")),
+    organization := "com.github.cornerman",
+    licenses     := Seq("MIT License" -> url("https://opensource.org/licenses/MIT")),
+    homepage     := Some(url("https://github.com/cornerman/sbt-quillcodegen")),
     scmInfo := Some(
       ScmInfo(
         url("https://github.com/cornerman/sbt-quillcodegen"),
@@ -25,10 +23,10 @@ inThisBuild(
   )
 )
 
+// TODO: Use sbt-cross to workaround: https://github.com/sbt/sbt/issues/5586
 lazy val codegen = project
   .settings(
-    name               := "quillcodegen",
-    crossScalaVersions := Seq("2.12.12", "2.13.12"),
+    name := "quillcodegen",
     libraryDependencies ++= Seq(
       "org.scala-lang" % "scala-reflect" % scalaVersion.value,
       // Should be same as in Codegen.scala for generated code
@@ -40,11 +38,30 @@ lazy val codegen = project
       "org.mybatis"      % "mybatis"              % "3.5.15",
     ),
   )
+  .cross
 
-lazy val codegenPlugin = project
+lazy val codegen212 = codegen("2.12.19")
+lazy val codegen213 = codegen("2.13.13")
+
+lazy val pluginSbt = project
+  .settings(
+    name               := "sbt-quillcodegen",
+    scalaVersion       := "2.12.19",
+    crossScalaVersions := Seq("2.12.19"),
+    sbtPlugin          := true,
+    publishMavenStyle  := true,
+  )
+  .dependsOn(codegen212)
+
+lazy val pluginMill = project
   .settings(
-    name              := "sbt-quillcodegen",
-    sbtPlugin         := true,
-    publishMavenStyle := true,
+    name               := "mill-quillcodegen",
+    scalaVersion       := "2.13.13",
+    crossScalaVersions := Seq("2.13.13"),
+    libraryDependencies ++= Seq(
+      "com.lihaoyi" %% "mill-main"     % "0.11.7",
+      "com.lihaoyi" %% "mill-main-api" % "0.11.7",
+      "com.lihaoyi" %% "mill-scalalib" % "0.11.7",
+    ),
   )
-  .dependsOn(codegen)
+  .dependsOn(codegen213)
diff --git a/codegen/src/main/scala/quillcodegen/Codegen.scala b/codegen/src/main/scala/quillcodegen/Codegen.scala
@@ -31,27 +31,28 @@ object Codegen {
     val dataSource = SqlExecutor.getDataSource(jdbcUrl, username = username, password = password)
 
     object gen extends ComposeableTraitsJdbcCodegen(dataSource, packagePrefix = packagePrefix, nestedTrait = nestedTrait) {
-      override def typer: Typer = tpe => typeMapping(tpe, super.typer(tpe))
-      override def unrecognizedTypeStrategy: UnrecognizedTypeStrategy = unrecognizedType
-      override def numericPreference: NumericPreference = numericType
+      override def typer: Typer                                                  = tpe => typeMapping(tpe, super.typer(tpe))
+      override def unrecognizedTypeStrategy: UnrecognizedTypeStrategy            = unrecognizedType
+      override def numericPreference: NumericPreference                          = numericType
       override def filter(tc: RawSchema[JdbcTableMeta, JdbcColumnMeta]): Boolean = super.filter(tc) && tableFilter(tc)
-      override def nameParser: NameParser               = sanitizedNameParser(naming, shouldGenerateQuerySchema = generateQuerySchema)
-      override def packagingStrategy: PackagingStrategy = PackagingStrategy.ByPackageHeader.TablePerSchema(this.packagePrefix)
+      override def nameParser: NameParser                                        = sanitizedNameParser(naming, shouldGenerateQuerySchema = generateQuerySchema)
+      override def packagingStrategy: PackagingStrategy                          = PackagingStrategy.ByPackageHeader.TablePerSchema(this.packagePrefix)
 
       override def generatorMaker = new SingleGeneratorFactory[ContextifiedUnitGenerator] {
         override def apply(emitterSettings: EmitterSettings[JdbcTableMeta, JdbcColumnMeta]): ContextifiedUnitGenerator = {
           new ContextifiedUnitGeneratorWrap(emitterSettings)
         }
       }
 
-      class ContextifiedUnitGeneratorWrap(emitterSettings: EmitterSettings[JdbcTableMeta, JdbcColumnMeta]) extends ContextifiedUnitGenerator(emitterSettings) {
+      class ContextifiedUnitGeneratorWrap(emitterSettings: EmitterSettings[JdbcTableMeta, JdbcColumnMeta])
+          extends ContextifiedUnitGenerator(emitterSettings) {
         private val scala3CodeEmitter = new CodeEmitter(emitterSettings) {
           override def CombinedTableSchemas = new CombinedTableSchemasGenWrap(_, _)
 
           class CombinedTableSchemasGenWrap(
-                                             tableColumns: TableStereotype[TableMeta, ColumnMeta],
-                                             querySchemaNaming: QuerySchemaNaming
-                                           ) extends CombinedTableSchemasGen(tableColumns, querySchemaNaming) {
+            tableColumns: TableStereotype[TableMeta, ColumnMeta],
+            querySchemaNaming: QuerySchemaNaming,
+          ) extends CombinedTableSchemasGen(tableColumns, querySchemaNaming) {
             override def objectName: Option[String] = super.objectName.map(_ + "Dao")
 
             override def body: String = {
@@ -65,7 +66,7 @@ object Codegen {
             override def QuerySchema = new QuerySchemaGenWrap(_, _)
 
             class QuerySchemaGenWrap(tableColumns: TableStereotype[TableMeta, ColumnMeta], schema: TableMeta)
-              extends QuerySchemaGen(tableColumns, schema) {
+                extends QuerySchemaGen(tableColumns, schema) {
 
               override def code: String = indent(querySchema)
             }
@@ -75,8 +76,7 @@ object Codegen {
         override def tableSchemasCode: String =
           if (isScala3) {
             scala3CodeEmitter.tableSchemasCode.notEmpty
-              .map(tsCode =>
-                s"""
+              .map(tsCode => s"""
                    |object ${traitName} {
                    |  import io.getquill.*
                    |
@@ -105,6 +105,6 @@ object Codegen {
     cm => sanitizeScalaName(naming.parseColumn(cm)),
     tm => sanitizeScalaName(naming.parseTable(tm)),
   ) {
-    override def generateQuerySchemas: Boolean           = shouldGenerateQuerySchema
+    override def generateQuerySchemas: Boolean = shouldGenerateQuerySchema
   }
 }
diff --git a/codegen/src/main/scala/quillcodegen/SqlExecutor.scala b/codegen/src/main/scala/quillcodegen/SqlExecutor.scala
@@ -19,8 +19,8 @@ object SqlExecutor {
   }
 
   def executeSql(dataSource: DataSource, sql: String): Unit = {
-    val connection   = dataSource.getConnection
-    val reader       = new StringReader(sql)
+    val connection = dataSource.getConnection
+    val reader     = new StringReader(sql)
 
     try {
       createScriptRunner(connection).runScript(reader)
diff --git a/devbox.json b/devbox.json
@@ -0,0 +1,14 @@
+{
+  "$schema":  "https://raw.githubusercontent.com/jetpack-io/devbox/0.10.3/.schema/devbox.schema.json",
+  "packages": ["sbt@latest"],
+  "shell": {
+    "init_hook": [
+      "echo 'Welcome to devbox!' > /dev/null"
+    ],
+    "scripts": {
+      "test": [
+        "echo \"Error: no test specified\" && exit 1"
+      ]
+    }
+  }
+}
diff --git a/devbox.lock b/devbox.lock
@@ -0,0 +1,53 @@
+{
+  "lockfile_version": "1",
+  "packages": {
+    "sbt@latest": {
+      "last_modified": "2024-03-22T11:26:23Z",
+      "resolved": "github:NixOS/nixpkgs/a3ed7406349a9335cb4c2a71369b697cecd9d351#sbt",
+      "source": "devbox-search",
+      "version": "1.9.9",
+      "systems": {
+        "aarch64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/clrwyandbc3ig6f3g6yrs36d8z5jb7lp-sbt-1.9.9",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/clrwyandbc3ig6f3g6yrs36d8z5jb7lp-sbt-1.9.9"
+        },
+        "aarch64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/c8pk0h3i5ddzw2fiz2qwrlqy4mm1nib1-sbt-1.9.9",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/c8pk0h3i5ddzw2fiz2qwrlqy4mm1nib1-sbt-1.9.9"
+        },
+        "x86_64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/p0nh7i03z5mp1l9pzjirc2zkd6c294vi-sbt-1.9.9",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/p0nh7i03z5mp1l9pzjirc2zkd6c294vi-sbt-1.9.9"
+        },
+        "x86_64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/zadhq90vpjaflmczlzz2828h08dfbl1z-sbt-1.9.9",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/zadhq90vpjaflmczlzz2828h08dfbl1z-sbt-1.9.9"
+        }
+      }
+    }
+  }
+}
diff --git a/pluginMill/src/main/scala/quillcodegen/plugin/QuillCodegenModule.scala b/pluginMill/src/main/scala/quillcodegen/plugin/QuillCodegenModule.scala
diff --git a/pluginSbt/src/main/scala/ScalaExt.scala b/pluginSbt/src/main/scala/ScalaExt.scala
diff --git a/pluginSbt/src/main/scala/quillcodegen/plugin/QuillCodegenPlugin.scala b/pluginSbt/src/main/scala/quillcodegen/plugin/QuillCodegenPlugin.scala
diff --git a/project/plugins.sbt b/project/plugins.sbt

Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,8 @@ object SqlExecutor {`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`def executeSql(dataSource: DataSource, sql: String): Unit = {`
`22`		`- val connection = dataSource.getConnection`
`23`		`- val reader = new StringReader(sql)`
	`22`	`+ val connection = dataSource.getConnection`
	`23`	`+ val reader = new StringReader(sql)`
`24`	`24`
`25`	`25`	`try {`
`26`	`26`	`createScriptRunner(connection).runScript(reader)`