Merge pull request #186 from cucumber/scala3rc1

Scala 3 support

Author: gaeljw

.gitignore

@@ -1,6 +1,7 @@
 .idea
 **/*.iml
 **/target/
+.bsp/
 release.properties
 pom.xml.releaseBackup
 pom.xml.versionsBackup

.scalafmt.conf

@@ -1,3 +1,5 @@
 version = 2.7.5
 
-preset=default
+preset=default
+
+runner.dialect = dotty

CHANGELOG.md

@@ -11,6 +11,9 @@ See also the [CHANGELOG](https://github.com/cucumber/cucumber-jvm/blob/master/CH
 
 ### Added
 
+- [Scala] Support Scala 3 RC1
+  - Check out the [v7.x upgrade guide](./docs/upgrade_v7.md)
+
 ### Changed
 
 - [Build] Use Github Actions instead of Travis CI

README.md

@@ -25,6 +25,7 @@ The minor version might differ because Cucumber Scala may add Scala-related feat
 
 - [Installation](./docs/install.md)
 - Upgrade notes
+  - [Version 7.x](docs/upgrade_v7.md)
   - [Version 6.x](docs/upgrade_v6.md)
   - [Version 5.x](docs/upgrade_v5.md)
 - Documentation

build.sbt

@@ -33,6 +33,7 @@ ThisBuild / homepage := Some(
 val scala211 = "2.11.12"
 val scala212 = "2.12.13"
 val scala213 = "2.13.5"
+val scala3 = "3.0.0-RC1"
 
 scalaVersion := scala213
 
@@ -52,6 +53,7 @@ lazy val commonSettings = Seq(
       case Some((2, 11)) => ScalacOptions.scalacOptions211
       case Some((2, 12)) => ScalacOptions.scalacOptions212
       case Some((2, 13)) => ScalacOptions.scalacOptions213
+      case Some((3, 0))  => ScalacOptions.scalacOptions3
       case _             => Seq()
     }
   }
@@ -75,23 +77,44 @@ lazy val cucumberScala = (projectMatrix in file("cucumber-scala"))
     libraryDependencies ++= Seq(
       "io.cucumber" % "cucumber-core" % cucumberVersion,
       // Users have to provide it (for JacksonDefaultDataTableTransformer)
-      "com.fasterxml.jackson.module" %% "jackson-module-scala" % jacksonVersion % Provided,
+      ("com.fasterxml.jackson.module" %% "jackson-module-scala" % jacksonVersion % Provided)
+        .withDottyCompat(scalaVersion.value),
       "junit" % "junit" % junitVersion % Test,
       "io.cucumber" % "cucumber-junit" % cucumberVersion % Test,
-      "org.mockito" %% "mockito-scala" % mockitoScalaVersion % Test
+      ("org.mockito" %% "mockito-scala" % mockitoScalaVersion % Test)
+        .withDottyCompat(scalaVersion.value)
     ),
     libraryDependencies ++= {
       CrossVersion.partialVersion(scalaVersion.value) match {
         case Some((2, n)) if n <= 12 =>
           List("org.scala-lang.modules" %% "scala-collection-compat" % "2.4.2")
+        case Some((3, 0)) =>
+          List("io.github.gaeljw" %% "typetrees" % "0.2.0")
         case _ => Nil
       }
     },
     unmanagedSourceDirectories in Compile ++= {
       val sourceDir = (sourceDirectory in Compile).value
       CrossVersion.partialVersion(scalaVersion.value) match {
-        case Some((2, n)) if n <= 11 => Seq(sourceDir / "scala-2.11")
-        case _                       => Seq()
+        case Some((2, n)) if n <= 11 =>
+          Seq(sourceDir / "scala-2", sourceDir / "scala-2.11")
+        case Some((2, n)) if n > 11 =>
+          Seq(sourceDir / "scala-2")
+        case Some((3, 0)) =>
+          Seq(sourceDir / "scala-3")
+        case _ =>
+          Seq()
+      }
+    },
+    unmanagedSourceDirectories in Test ++= {
+      val testSourceDir = (sourceDirectory in Test).value
+      CrossVersion.partialVersion(scalaVersion.value) match {
+        case Some((2, _)) =>
+          Seq(testSourceDir / "scala-2")
+        case Some((3, 0)) =>
+          Seq(testSourceDir / "scala-3")
+        case _ =>
+          Seq()
       }
     },
     // Generate I18n traits
@@ -102,7 +125,7 @@ lazy val cucumberScala = (projectMatrix in file("cucumber-scala"))
       Seq(file)
     }.taskValue
   )
-  .jvmPlatform(scalaVersions = Seq(scala213, scala212, scala211))
+  .jvmPlatform(scalaVersions = Seq(scala3, scala213, scala212, scala211))
 
 // Examples project
 lazy val examples = (projectMatrix in file("examples"))
@@ -116,7 +139,7 @@ lazy val examples = (projectMatrix in file("examples"))
     publishArtifact := false
   )
   .dependsOn(cucumberScala % Test)
-  .jvmPlatform(scalaVersions = Seq(scala213, scala212))
+  .jvmPlatform(scalaVersions = Seq(scala3, scala213, scala212))
 
 // Version policy check
 

cucumber-scala/src/main/codegen/gen.scala

@@ -1,6 +1,6 @@
 
 /*
- * Generates the evil looking apply methods in ScalaDsl#StepBody for Function1 to Function22
+ * Generates the evil looking apply methods in StepDsl#StepBody for Function1 to Function22
  */
 for (i <- 1 to 22) {
   val ts = (1 to i).map("T".+).mkString(", ")
@@ -15,6 +15,29 @@ for (i <- 1 to 22) {
   println(p1 + p2 + ": Unit = { " + register + pf + otherwise + closeRegister + "\n")
 }
 
+/*
+ * Generates the evil looking apply methods in StepDsl#StepBody for Function1 to Function22
+ * Scala 3
+ */
+for (i <- 1 to 22) {
+  val ts = (1 to i).map("T".+).mkString(", ")
+  val tagsDef = (1 to i).map(n => s"val t$n: TypeTreeTag = typeTreeTag[T$n]").mkString("\n")
+  val tagsParam = (1 to i).map(n => s"t$n").mkString(", ")
+  val listParams = (1 to i).map("a" + _ + ":AnyRef").mkString(", ")
+  val pf =  (1 to i).map(n => "a" + n + ".asInstanceOf[T" + n + "]").mkString(",\n        ")
+
+  println(s"""
+    |inline def apply[$ts](f: ($ts) => Any): Unit = {
+    |  $tagsDef
+    |  register($tagsParam) {
+    |    case List($listParams) =>
+    |      f($pf)
+    |    case _ =>
+    |      throw new IncorrectStepDefinitionException()
+    |  }
+    |}""".stripMargin)
+}
+
 /*
  * Generates the apply methods in ParameterTypeDsl for Function1 to Function22
  */

cucumber-scala/src/main/scala/io/cucumber/scala/ScalaTypeHelper.scala renamed to cucumber-scala/src/main/scala-2/io/cucumber/scala/ScalaTypeHelper.scala

@@ -0,0 +1,27 @@
+package io.cucumber.scala
+
+import io.github.gaeljw.typetrees.TypeTreeTag
+import java.lang.reflect.{ParameterizedType, Type}
+
+object ScalaTypeHelper {
+
+  def asJavaType(tag: TypeTreeTag): Type = {
+    if (tag.args.isEmpty) {
+      tag.self.runtimeClass
+    } else {
+      new ScalaParameterizedType(tag)
+    }
+  }
+
+}
+
+class ScalaParameterizedType(tag: TypeTreeTag) extends ParameterizedType {
+
+  override def getActualTypeArguments: Array[Type] =
+    tag.args.map(ScalaTypeHelper.asJavaType).toArray
+
+  override def getRawType: Type = tag.self.runtimeClass
+
+  override def getOwnerType: Type = null
+
+}