Skip to content

Explicitly use scala.collection.Seq to allow use of mutable collections in Scala 2.13 #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package plotly

trait MutableSequenceImplicitConversions {
// Unneccessary in Scala 2.12, since the `Seq` alias refers to the supertype for mutable and immutable sequences
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package plotly

import plotly.Sequence.{DateTimes, Doubles, NestedDoubles, NestedInts, Strings}
import plotly.element.LocalDateTime
import scala.collection.{Seq => BaseScalaSeq}

trait MutableSequenceImplicitConversions {

implicit def fromMutableDoubleSeq(s: BaseScalaSeq[Double]): Sequence =
Doubles(s.toSeq)
implicit def fromMutableFloatSeq(s: BaseScalaSeq[Float]): Sequence =
Doubles(s.map(_.toDouble).toSeq)
implicit def fromMutableIntSeq(s: BaseScalaSeq[Int]): Sequence =
Doubles(s.map(_.toDouble).toSeq)
implicit def fromMutableLongSeq(s: BaseScalaSeq[Long]): Sequence =
Doubles(s.map(_.toDouble).toSeq)
implicit def fromMutableNestedDoubleSeq(s: BaseScalaSeq[BaseScalaSeq[Double]]): Sequence =
NestedDoubles(s.map(_.toSeq).toSeq)
implicit def fromMutableNestedIntSeq(s: BaseScalaSeq[BaseScalaSeq[Int]]): Sequence =
NestedInts(s.map(_.toSeq).toSeq)
implicit def fromMutableStringSeq(s: BaseScalaSeq[String]): Sequence =
Strings(s.toSeq)
implicit def fromMutableDateTimes(seq: BaseScalaSeq[LocalDateTime]): Sequence =
DateTimes(seq.toSeq)

}
2 changes: 1 addition & 1 deletion core/shared/src/main/scala/plotly/Sequence.scala
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import plotly.element.LocalDateTime

sealed abstract class Sequence extends Product with Serializable

object Sequence {
object Sequence extends MutableSequenceImplicitConversions {
final case class Doubles(seq: Seq[Double]) extends Sequence
final case class NestedDoubles(seq: Seq[Seq[Double]]) extends Sequence
final case class NestedInts(seq: Seq[Seq[Int]]) extends Sequence
Expand Down
31 changes: 31 additions & 0 deletions tests/src/test/scala/plotly/SequenceTests.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package plotly

import org.scalatest.FlatSpec

import scala.collection.mutable.ArrayBuffer

class SequenceTests extends FlatSpec {

"The implicit sequence conversion" should "convert a List to a Sequence" in {
assert((List(1, 2, 3): Sequence) === Sequence.Doubles(List(1d, 2d, 3d)))
}

it should "convert a mutable ArrayBuffer to a Sequence" in {
assert((ArrayBuffer(1, 2, 3): Sequence) === Sequence.Doubles(List(1d, 2d, 3d)))
}

it should "convert a nested mutable ArrayBuffer to a Sequence" in {
val mutableNestedDoubles: ArrayBuffer[ArrayBuffer[Double]] = ArrayBuffer(
ArrayBuffer(1d, 2d),
ArrayBuffer(3d, 4d),
)

val nestedDoublesList: List[List[Double]] = List(
List(1d, 2d),
List(3d, 4d),
)

assert((mutableNestedDoubles: Sequence) === Sequence.NestedDoubles(nestedDoublesList))
}

}