feat: 🚀 Support generic types in DocStringType definitions

Author: gaeljw

CHANGELOG.md

@@ -11,6 +11,8 @@ See also the [CHANGELOG](https://github.com/cucumber/cucumber-jvm/blob/master/CH
 
 ### Added
 
+- [Scala] Support generic types in `DocStringType`
+
 ### Changed
 
 - [Core] Updated `cucumber-core` dependency to [7.2.0](https://github.com/cucumber/cucumber-jvm/blob/main/CHANGELOG.md)

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

@@ -2,8 +2,6 @@ package io.cucumber.scala
 
 import io.cucumber.scala.Aliases.DocStringDefinitionBody
 
-import scala.reflect.ClassTag
-
 private[scala] trait DocStringTypeDsl extends BaseScalaDsl {
 
   /** Register doc string type.
@@ -15,9 +13,9 @@ private[scala] trait DocStringTypeDsl extends BaseScalaDsl {
     */
   def DocStringType[T](
       contentType: String
-  )(body: DocStringDefinitionBody[T])(implicit ev: ClassTag[T]): Unit = {
+  )(body: DocStringDefinitionBody[T])(implicit ev: Stepable[T]): Unit = {
     registry.registerDocStringType(
-      ScalaDocStringTypeDetails[T](contentType, body, ev)
+      ScalaDocStringTypeDetails[T](contentType, body, ev.asJavaType)
     )
   }
 

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

@@ -4,24 +4,20 @@ import io.cucumber.core.backend.{DocStringTypeDefinition, ScenarioScoped}
 import io.cucumber.docstring.DocStringType
 import io.cucumber.docstring.DocStringType.Transformer
 
-import scala.reflect.ClassTag
-
-trait ScalaDocStringTypeDefinition[T]
+abstract class ScalaDocStringTypeDefinition[T]
     extends DocStringTypeDefinition
     with AbstractGlueDefinition {
 
   val details: ScalaDocStringTypeDetails[T]
 
-  implicit val ev: ClassTag[T]
-
   override val location: StackTraceElement = new Exception().getStackTrace()(3)
 
   private val transformer: Transformer[T] = (s: String) => {
     details.body.apply(s)
   }
 
   override val docStringType: DocStringType =
-    new DocStringType(ev.runtimeClass, details.contentType, transformer)
+    new DocStringType(details.`type`, details.contentType, transformer)
 
 }
 
@@ -32,21 +28,19 @@ object ScalaDocStringTypeDefinition {
       scenarioScoped: Boolean
   ): ScalaDocStringTypeDefinition[T] = {
     if (scenarioScoped) {
-      new ScalaScenarioScopedDocStringTypeDefinition(details)(details.tag)
+      new ScalaScenarioScopedDocStringTypeDefinition(details)
     } else {
-      new ScalaGlobalDocStringTypeDefinition(details)(details.tag)
+      new ScalaGlobalDocStringTypeDefinition(details)
     }
   }
 
 }
 
 class ScalaScenarioScopedDocStringTypeDefinition[T](
     override val details: ScalaDocStringTypeDetails[T]
-)(implicit val ev: ClassTag[T])
-    extends ScalaDocStringTypeDefinition[T]
+) extends ScalaDocStringTypeDefinition[T]
     with ScenarioScoped {}
 
 class ScalaGlobalDocStringTypeDefinition[T](
     override val details: ScalaDocStringTypeDetails[T]
-)(implicit val ev: ClassTag[T])
-    extends ScalaDocStringTypeDefinition[T] {}
+) extends ScalaDocStringTypeDefinition[T] {}

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

@@ -1,11 +1,11 @@
 package io.cucumber.scala
 
-import Aliases.DocStringDefinitionBody
+import io.cucumber.scala.Aliases.DocStringDefinitionBody
 
-import scala.reflect.ClassTag
+import java.lang.reflect.{Type => JType}
 
 case class ScalaDocStringTypeDetails[T](
     contentType: String,
     body: DocStringDefinitionBody[T],
-    tag: ClassTag[T]
+    `type`: JType
 )

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

@@ -219,7 +219,7 @@ object Stepable {
 
 }
 
-class ScalaParameterizedType(self: JavaType, args: Array[JavaType])
+class ScalaParameterizedType(val self: JavaType, val args: Array[JavaType])
     extends JavaParameterizedType {
 
   override def getActualTypeArguments: Array[JavaType] = args
@@ -228,4 +228,13 @@ class ScalaParameterizedType(self: JavaType, args: Array[JavaType])
 
   override def getOwnerType: JavaType = null
 
+  override def getTypeName: String =
+    self.getTypeName + args.map(_.getTypeName).mkString("[", ",", "]")
+
+  override def equals(obj: Any): Boolean = obj match {
+    case x: ScalaParameterizedType =>
+      x.self == self && (x.args sameElements args)
+    case _ => false
+  }
+
 }

cucumber-scala/src/test/resources/tests/docstring/Docstring.feature

@@ -15,3 +15,26 @@ Feature: As Cucumber Scala, I want to use DocStringType
       <xml></xml>
       """
     Then I have a xml text
+
+  Scenario: Using no content type
+    Given the following raw text
+      """
+      something raw
+      """
+    Then I have a raw text
+
+  Scenario: Generic type - string
+    Given the following string list
+      """
+      item 1
+      item 2
+      """
+    Then I have a string list "item 1,item 2"
+
+  Scenario: Generic type - int
+    Given the following int list
+      """
+      1
+      2
+      """
+    Then I have a int list "1,2"

cucumber-scala/src/test/scala/tests/docstring/DocStringSteps.scala

@@ -8,6 +8,8 @@ class DocStringSteps extends ScalaDsl with EN {
 
   case class XmlText(xml: String)
 
+  case class RawText(raw: String)
+
   var _text: Any = _
 
   DocStringType("json") { (text) =>
@@ -18,6 +20,19 @@ class DocStringSteps extends ScalaDsl with EN {
     XmlText(text)
   }
 
+  DocStringType("") { (text) =>
+    RawText(text)
+  }
+
+  // Tests generic type
+  DocStringType[Seq[String]]("") { (text) =>
+    text.split('\n').toSeq
+  }
+
+  DocStringType[Seq[Int]]("") { (text) =>
+    text.split('\n').map(_.toInt).toSeq
+  }
+
   Given("the following json text") { (json: JsonText) =>
     _text = json
   }
@@ -26,6 +41,18 @@ class DocStringSteps extends ScalaDsl with EN {
     _text = xml
   }
 
+  Given("the following raw text") { (raw: RawText) =>
+    _text = raw
+  }
+
+  Given("the following string list") { (list: Seq[String]) =>
+    _text = list
+  }
+
+  Given("the following int list") { (list: Seq[Int]) =>
+    _text = list
+  }
+
   Then("I have a json text") {
     assert(_text.isInstanceOf[JsonText])
   }
@@ -34,4 +61,22 @@ class DocStringSteps extends ScalaDsl with EN {
     assert(_text.isInstanceOf[XmlText])
   }
 
+  Then("I have a raw text") {
+    assert(_text.isInstanceOf[RawText])
+  }
+
+  Then("I have a string list {string}") { (expectedList: String) =>
+    assert(_text.isInstanceOf[Seq[_]])
+    assert(_text.asInstanceOf[Seq[_]].head.isInstanceOf[String])
+    assert(_text.asInstanceOf[Seq[String]] == expectedList.split(',').toSeq)
+  }
+
+  Then("I have a int list {string}") { (expectedList: String) =>
+    assert(_text.isInstanceOf[Seq[_]])
+    assert(_text.asInstanceOf[Seq[_]].head.isInstanceOf[Int])
+    assert(
+      _text.asInstanceOf[Seq[Int]] == expectedList.split(',').map(_.toInt).toSeq
+    )
+  }
+
 }