Merge pull request #233 from cucumber/cucumber7x

Upgrade to Cucumber 7.0.0-RC1

Author: gaeljw

CHANGELOG.md

@@ -9,16 +9,20 @@ See also the [CHANGELOG](https://github.com/cucumber/cucumber-jvm/blob/master/CH
 ----
 ## [Unreleased] (In Git)
 
+Check out the [Upgrade Guide](docs/upgrade_v8.md).
+
 ### Added
 
 ### Changed
 
-- [Build] Upgrade sbt to 1.5.5
+- [Core] Updated `cucumber-core` dependency to [7.0.0-RC1](https://github.com/cucumber/cucumber-jvm/blob/main/CHANGELOG.md)
 
 ### Deprecated
 
 ### Removed
 
+- [Core] Remove deprecated `io.cucumber.scala.TL`
+
 ### Fixed
 
 ## [7.1.0] (2021-08-06)

README.md

@@ -21,6 +21,7 @@ The table below shows the compatible versions:
 
 | Cucumber Scala version | Cucumber Core version | Scala versions        |
 |------------------------|-----------------------|-----------------------|
+| 8.x                    | 7.x                   | 2.11, 2.12, 2.13, 3.0 |
 | 7.x                    | 6.x                   | 2.11, 2.12, 2.13, 3.0 |
 | 6.x                    | 6.x                   | 2.11, 2.12, 2.13      |
 | 5.x                    | 5.x                   | 2.11, 2.12, 2.13      |
@@ -30,6 +31,7 @@ The table below shows the compatible versions:
 
 - [Installation](./docs/install.md)
 - Upgrade notes
+  - [Version 8.x](docs/upgrade_v8.md)
   - [Version 7.x](docs/upgrade_v7.md)
   - [Version 6.x](docs/upgrade_v6.md)
   - [Version 5.x](docs/upgrade_v5.md)

build.sbt

@@ -39,7 +39,7 @@ scalaVersion := scala213
 
 // Library versions
 
-val cucumberVersion = "6.11.0"
+val cucumberVersion = "7.0.0-RC1"
 val jacksonVersion = "2.12.5"
 val mockitoScalaVersion = "1.16.42"
 val junitVersion = "4.13.2"

cucumber-scala/src/main/scala/io/cucumber/scala/Scenario.scala

@@ -77,17 +77,29 @@ class Scenario(val delegate: TestCaseState) {
     */
   def getName: String = delegate.getName
 
-  /** @return the id of the Scenario.
+  /** Returns the unique identifier for this scenario.
+    * <p>
+    * If this is a Scenario from Scenario Outlines this will return the id of
+    * the example row in the Scenario Outline.
+    * <p>
+    * The id is not stable across multiple executions of Cucumber but does
+    * correlate with ids used in messages output. Use the uri + line number to
+    * obtain a somewhat stable identifier of a scenario.
+    *
+    * @return the id of the Scenario.
     */
   def getId: String = delegate.getId
 
   /** @return the uri of the Scenario.
     */
   def getUri: URI = delegate.getUri
 
-  /** @return the line in the feature file of the Scenario. If this is a Scenario
-    *         from Scenario Outlines this will return the line of the example row in
-    *         the Scenario Outline.
+  /** Returns the line in the feature file of the Scenario.
+    * <p>
+    * If this is a Scenario from Scenario Outlines this will return the line of
+    * the example row in the Scenario Outline.
+    *
+    * @return the line in the feature file of the Scenario
     */
   def getLine: Integer = delegate.getLine
 

cucumber-scala/src/main/scala/io/cucumber/scala/TL.scala

@@ -175,7 +175,7 @@ class ScalaDslDataTableTypeTest {
     class Glue extends ScalaDsl with EN {
       DataTableType { (table: DataTable) =>
         val authors = table
-          .asMaps()
+          .entries()
           .asScala
           .map(_.asScala)
           .map(entry =>
@@ -208,7 +208,7 @@ class ScalaDslDataTableTypeTest {
     class Glue extends ScalaDsl with EN {
       DataTableType("[empty]") { (table: DataTable) =>
         val authors = table
-          .asMaps()
+          .entries()
           .asScala
           .map(_.asScala)
           .map(entry =>
@@ -370,7 +370,7 @@ class ScalaDslDataTableTypeTest {
     object Glue extends ScalaDsl with EN {
       DataTableType { (table: DataTable) =>
         val authors = table
-          .asMaps()
+          .entries()
           .asScala
           .map(_.asScala)
           .map(entry =>
@@ -401,7 +401,7 @@ class ScalaDslDataTableTypeTest {
     object Glue extends ScalaDsl with EN {
       DataTableType("[empty]") { (table: DataTable) =>
         val authors = table
-          .asMaps()
+          .entries()
           .asScala
           .map(_.asScala)
           .map(entry =>

cucumber-scala/src/test/scala/io/cucumber/scala/ScalaDslDataTableTypeTest.scala

@@ -107,7 +107,7 @@ class DataTableTypeSteps extends ScalaDsl with EN {
 
   DataTableType { (table: DataTable) =>
     val authors = table
-      .asMaps()
+      .entries()
       .asScala
       .map(_.asScala)
       .map(entry =>
@@ -119,7 +119,7 @@ class DataTableTypeSteps extends ScalaDsl with EN {
 
   DataTableType("[empty]") { (table: DataTable) =>
     val authors = table
-      .asMaps()
+      .entries()
       .asScala
       .map(_.asScala)
       .map(entry =>

cucumber-scala/src/test/scala/tests/datatables/DataTableTypeSteps.scala

@@ -166,7 +166,7 @@ case class Author(name: String, surname: String, famousBook: String)
 case class GroupOfAuthor(authors: Seq[Author])
 
 DataTableType { table: DataTable =>
-  val authors = table.asMaps().asScala
+  val authors = table.entries().asScala
       .map(_.asScala)
       .map(entry => Author(entry("name"), entry("surname"), entry("famousBook")))
       .toSeq

docs/transformers.md

@@ -0,0 +1,21 @@
+# Upgrading from 7.x to 8.x
+
+Prior to upgrading to v8.0.0 upgrade to latest v7.x and stop using all deprecated features.
+Some features will log a deprecation warning.
+
+See also:
+- [Cucumber Scala CHANGELOG](../CHANGELOG.md)
+- [Cucumber JVM CHANGELOG](https://github.com/cucumber/cucumber-jvm/blob/main/CHANGELOG.md)
+
+## Cannot use `DataTable#asX` inside a `DataTableType`
+
+You should not use the methods `DataTable#asX()` in `DataTableType`s.
+It was working in previous versions, but it will now raise an exception when running your tests.
+
+Instead you should use:
+- Replace `DataTable#asList()` with `DataTable#values()`
+- Replace `DataTable#asLists()` with `DataTable#cells()`
+- Replace `DataTable#asMaps()` with `DataTable#entries()`
+
+
+More context for this change at https://github.com/cucumber/common/pull/1419

docs/upgrade_v8.md

@@ -5,9 +5,12 @@ object I18nGenerator {
 
   private val dialectProvider = new GherkinDialectProvider()
 
+  // The generated files for these languages don't compile
   private val unsupported = Seq(
-    "em"
-  ) // The generated files for Emoji do not compile.
+    "em", // Emoji
+    "en-tx" // Texan
+  )
+
   private val allLanguages = dialectProvider
     .getLanguages()
     .asScala