Merge pull request #65 from cucumber/v6.x

gaeljw · web-flow · commit 904d38aa6331 · 2020-06-07T14:53:40.000+02:00
Upgrade to Cucumber Core v6
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,13 +12,18 @@ See also the [CHANGELOG](https://github.com/cucumber/cucumber-jvm/blob/master/CH
 ### Added
 
 - [Scala] Conversion methods from `DataTable` to scala types ([#56](https://github.com/cucumber/cucumber-jvm-scala/issues/56) Gaël Jourdan-Weil)
+- [Scala] Add `attach(String, String, String)` in `Scenario` (Gaël Jourdan-Weil)
 
 ### Changed
 
+- [Core] Update `cucumber-core` dependency to 6.0.0 (Gaël Jourdan-Weil)
+
 ### Deprecated
 
 ### Removed
 
+- [Scala] Remove deprecated methods in `Scenario` (Gaël Jourdan-Weil)
+
 ### Fixed
 
 - [Scala DSL] Raise an exception at runtime if hooks are not correctly defined ([#60](https://github.com/cucumber/cucumber-jvm-scala/issues/60) Gaël Jourdan-Weil)
diff --git a/README.md b/README.md
@@ -17,6 +17,7 @@ The minor version might differ because Cucumber Scala may add Scala-related feat
 
 | Cucumber Scala version | Cucumber version | Scala versions   |
 |------------------------|------------------|------------------|
+| 6.0.0                  | 6.0.0            | 2.11, 2.12, 2.13 |
 | 5.7.0                  | 5.7.0            | 2.11, 2.12, 2.13 |
 | 5.6.0                  | 5.6.0            | 2.11, 2.12, 2.13 |
 | 4.7.1                  | 4.7.1            | 2.11, 2.12, 2.13 |
@@ -25,6 +26,7 @@ The minor version might differ because Cucumber Scala may add Scala-related feat
 
 - [Installation](./docs/install.md)
 - Upgrade notes
+  - [Version 6.x](docs/upgrade_v6.md)
   - [Version 5.x](docs/upgrade_v5.md)
 - Documentation
   - [Basic usage](docs/usage.md)
diff --git a/docs/default_jackson_datatable_transformer.md b/docs/default_jackson_datatable_transformer.md
@@ -12,7 +12,7 @@ To use this optional transformer, you need to have Jackson Scala in your depende
 <dependency>
     <groupId>com.fasterxml.jackson.module</groupId>
     <artifactId>jackson-module-scala_2.13</artifactId>
-    <version>2.10.3</version>
+    <version>2.11.0</version>
     <scope>test</scope>
 </dependency>
 ```
@@ -23,7 +23,7 @@ libraryDependencies += "com.fasterxml.jackson.module" %% "jackson-module-scala"
 ```
 
 
-The current version of Cucumber Scala has been tested against Jackson Module Scala **version 2.10.3**.
+The current version of Cucumber Scala has been tested against Jackson Module Scala **version 2.11.0**.
 
 ## Add the transformer
 
diff --git a/docs/upgrade_v6.md b/docs/upgrade_v6.md
@@ -0,0 +1,34 @@
+# Upgrading from 5.x to 6.x
+
+Upgrading from v5 should be straightforward.
+Prior to upgrading to v6.0.0 upgrade to v5.7.0 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/master/CHANGELOG.md)
+- [Cucumber JVM v6 Release Notes](https://github.com/cucumber/cucumber-jvm/blob/master/release-notes/v6.0.0.md)
+
+## Map DataTables to Scala types
+
+You can now map `DataTable`s to Scala collection types using additional `asScalaXxx` methods on the `DataTable` class.
+
+**The benefit of using Scala types** if that you will be handling `Option`s instead of potentially `null` values in the Java collections.
+
+For instance with `asScalaMaps`:
+
+```scala
+import io.cucumber.scala.{ScalaDsl, EN}
+import io.cucumber.scala.Implicits._
+
+class StepDefs extends ScalaDsl with EN {
+
+  Given("the following table as List of Map") { (table: DataTable) =>
+    val scalaTable: Seq[Map[String, Option[Int]]] = table.asScalaMaps[String, Int]
+    // Do something
+  }
+
+}
+```
+
+See the [DataTable documentation](./datatables.md) for more details.
diff --git a/examples/pom.xml b/examples/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>io.cucumber</groupId>
         <artifactId>cucumber-jvm-scala</artifactId>
-        <version>5.7.1-SNAPSHOT</version>
+        <version>6.0.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>scala-examples</artifactId>
diff --git a/pom.xml b/pom.xml
@@ -1,7 +1,7 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <artifactId>cucumber-jvm-scala</artifactId>
-    <version>5.7.1-SNAPSHOT</version>
+    <version>6.0.0-SNAPSHOT</version>
     <packaging>pom</packaging>
     <name>Cucumber-JVM: Scala</name>
     <description>Cucumber for Scala</description>
@@ -21,10 +21,10 @@
         <outputDirectory>${project.build.directory}</outputDirectory>
         <scala-maven-plugin.version>3.4.6</scala-maven-plugin.version>
         <build-helper-maven-plugin.version>3.1.0</build-helper-maven-plugin.version>
-        <cucumber.version>5.7.0</cucumber.version>
+        <cucumber.version>6.0.0</cucumber.version>
         <gherkin.version>9.2.0</gherkin.version>
         <groovy.version>2.4.19</groovy.version>
-        <jackson-databind.version>2.10.3</jackson-databind.version>
+        <jackson-databind.version>2.11.0</jackson-databind.version>
         <junit.version>4.13</junit.version>
         <scala.2.11.version>2.11.12</scala.2.11.version>
         <scala.2.12.version>2.12.11</scala.2.12.version>
diff --git a/scala/pom.xml b/scala/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>io.cucumber</groupId>
         <artifactId>cucumber-jvm-scala</artifactId>
-        <version>5.7.1-SNAPSHOT</version>
+        <version>6.0.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>cucumber-scala-aggregator</artifactId>
diff --git a/scala/scala_2.11/pom.xml b/scala/scala_2.11/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>io.cucumber</groupId>
         <artifactId>cucumber-scala-aggregator</artifactId>
-        <version>5.7.1-SNAPSHOT</version>
+        <version>6.0.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>cucumber-scala_2.11</artifactId>
diff --git a/scala/scala_2.12/pom.xml b/scala/scala_2.12/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>io.cucumber</groupId>
         <artifactId>cucumber-scala-aggregator</artifactId>
-        <version>5.7.1-SNAPSHOT</version>
+        <version>6.0.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>cucumber-scala_2.12</artifactId>
diff --git a/scala/scala_2.13/pom.xml b/scala/scala_2.13/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>io.cucumber</groupId>
         <artifactId>cucumber-scala-aggregator</artifactId>
-        <version>5.7.1-SNAPSHOT</version>
+        <version>6.0.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>cucumber-scala_2.13</artifactId>
diff --git a/scala/sources/src/main/scala/io/cucumber/scala/Scenario.scala b/scala/sources/src/main/scala/io/cucumber/scala/Scenario.scala
@@ -15,33 +15,26 @@ import io.cucumber.core.backend.{Status, TestCaseState}
  */
 class Scenario(val delegate: TestCaseState) {
 
+  /**
+   * @return tags of this scenario.
+   */
   def getSourceTagNames: util.Collection[String] = delegate.getSourceTagNames
 
   /**
-   * Returns the current status of this scenario.
+   * Returns the current status of this test case.
    * <p>
-   * The scenario status is calculate as the most severe status of the
-   * executed steps in the scenario so far.
+   * The test case status is calculate as the most severe status of the
+   * executed steps in the testcase so far.
    *
-   * @return the current status of this scenario
+   * @return the current status of this test case
    */
   def getStatus: Status = Status.valueOf(delegate.getStatus.name)
 
   /**
-   * @return true if and only if { @link #getStatus()} returns "failed"
+   * @return true if and only if `getStatus` returns "failed"
    */
   def isFailed: Boolean = delegate.isFailed
 
-  @deprecated(message = "Use attach instead", since = "5.x")
-  def embed(data: Array[Byte], mediaType: String): Unit = {
-    delegate.embed(data, mediaType)
-  }
-
-  @deprecated(message = "Use attach instead", since = "5.7.0")
-  def embed(data: Array[Byte], mediaType: String, name: String): Unit = {
-    attach(data, mediaType, name)
-  }
-
   /**
    * Attach data to the report(s).
    * <pre>
@@ -66,9 +59,16 @@ class Scenario(val delegate: TestCaseState) {
     delegate.attach(data, mediaType, name)
   }
 
-  @deprecated(message = "Use log instead", since = "5.7.0")
-  def write(text: String): Unit = {
-    log(text)
+  /**
+   * Attaches some text based data to the report.
+   *
+   * @param data      what to attach, for example html.
+   * @param mediaType what is the data?
+   * @param name      attachment name
+   * @see #attach(byte[], String, String)
+   */
+  def attach(data: String, mediaType: String, name: String): Unit = {
+    delegate.attach(data, mediaType, name)
   }
 
   /**
