Skip to content
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

Add parallel instance for IorT #2060

Merged
merged 2 commits into from
Dec 11, 2017
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
43 changes: 43 additions & 0 deletions core/src/main/scala/cats/data/IorT.scala
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package cats
package data

import cats.arrow.FunctionK
import cats.syntax.either._
import cats.syntax.option._

Expand Down Expand Up @@ -155,6 +156,7 @@ object IorT extends IorTInstances {
* scala> import cats.implicits._
* scala> IorT.leftT[Option, Int]("err")
* res0: cats.data.IorT[Option,String,Int] = IorT(Some(Left(err)))

* }}}
*/
final def leftT[F[_], B]: LeftTPartiallyApplied[F, B] = new LeftTPartiallyApplied[F, B]
Expand Down Expand Up @@ -412,6 +414,27 @@ private[data] abstract class IorTInstances extends IorTInstances1 {

implicit def catsDataMonoidForIorT[F[_], A, B](implicit F: Monoid[F[Ior[A, B]]]): Monoid[IorT[F, A, B]] =
new IorTMonoid[F, A, B] { val F0: Monoid[F[Ior[A, B]]] = F }

implicit def catsDataParallelForIorTWithParallelEffect[M[_], F[_], E]
(implicit P: Parallel[M, F], E: Semigroup[E]): Parallel[IorT[M, E, ?], IorT[F, E, ?]] = new Parallel[IorT[M, E, ?], IorT[F, E, ?]]
{
val parallel: IorT[M, E, ?] ~> IorT[F, E, ?] = λ[IorT[M, E, ?] ~> IorT[F, E, ?]](fm => IorT(P.parallel(fm.value)))
val sequential: IorT[F, E, ?] ~> IorT[M, E, ?] = λ[IorT[F, E, ?] ~> IorT[M, E, ?]](ff => IorT(P.sequential(ff.value)))

private[this] val FA: Applicative[F] = P.applicative
private[this] val IorA: Applicative[Ior[E, ?]] = Parallel[Ior[E, ?], Ior[E, ?]].applicative

val applicative: Applicative[IorT[F, E, ?]] = new Applicative[IorT[F, E, ?]] {
def pure[A](a: A): IorT[F, E, A] = IorT.pure(a)(FA)
def ap[A, B](ff: IorT[F, E, A => B])(fa: IorT[F, E, A]): IorT[F, E, B] =
IorT(FA.map2(ff.value, fa.value)((f, a) => IorA.ap(f)(a)))
}

lazy val monad: Monad[IorT[M, E, ?]] = {
implicit def underlyingMonadM: Monad[M] = P.monad
Monad[IorT[M, E, ?]]
}
}
}

private[data] abstract class IorTInstances1 extends IorTInstances2 {
Expand All @@ -426,6 +449,26 @@ private[data] abstract class IorTInstances1 extends IorTInstances2 {
val A0: Semigroup[A] = A
val F0: Monad[F] = F
}

implicit def catsDataParallelForIorTWithSequentialEffect[F[_], E]
(implicit F: Monad[F], E: Semigroup[E]): Parallel[IorT[F, E, ?], IorT[F, E, ?]] = new Parallel[IorT[F, E, ?], IorT[F, E, ?]]
{
private[this] val identityK: IorT[F, E, ?] ~> IorT[F, E, ?] = FunctionK.id
private[this] val underlyingParallel: Parallel[Ior[E, ?], Ior[E, ?]] =
Parallel[Ior[E, ?], Ior[E, ?]]

def parallel: IorT[F, E, ?] ~> IorT[F, E, ?] = identityK
def sequential: IorT[F, E, ?] ~> IorT[F, E, ?] = identityK

val applicative: Applicative[IorT[F, E, ?]] = new Applicative[IorT[F, E, ?]] {
def pure[A](a: A): IorT[F, E, A] = IorT.pure(a)
def ap[A, B](ff: IorT[F, E, A => B])(fa: IorT[F, E, A]): IorT[F, E, B] =
IorT(F.map2(ff.value, fa.value)((f, a) => underlyingParallel.applicative.ap(f)(a)))
}

lazy val monad: Monad[IorT[F, E, ?]] = Monad[IorT[F, E, ?]]
}

}

private[data] abstract class IorTInstances2 extends IorTInstances3 {
Expand Down
49 changes: 49 additions & 0 deletions tests/src/test/scala/cats/tests/ParallelSuite.scala
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,57 @@ class ParallelSuite extends CatsSuite with ApplicativeErrorForEitherTest {
}
}

test("IorT leverages parallel effect instances when it exists") {
case class Marker(value: String) extends Exception("marker") {
override def fillInStackTrace: Throwable = null
}

def checkMarker[A](f: => A): Option[String] =
try { f; None } catch {
case marker: Marker => marker.value.some
case _: Throwable => None
}

final case class Effect[A](value: A)
val monadInstance: Monad[Effect] = new Monad[Effect] {
def pure[A](a: A): Effect[A] = Effect(a)
def flatMap[A, B](fa: Effect[A])(f: A => Effect[B]): Effect[B] = throw Marker("sequential")
def tailRecM[A, B](a: A)(f: A => Effect[Either[A, B]]): Effect[B] = ???
}
val parallelInstance: Parallel[Effect, Effect] = new Parallel[Effect, Effect] {
def parallel: Effect ~> Effect = arrow.FunctionK.id
def sequential: Effect ~> Effect = arrow.FunctionK.id

def applicative: Applicative[Effect] = new Applicative[Effect] {
def pure[A](a: A): Effect[A] = Effect(a)
def ap[A, B](ff: Effect[A => B])(fa: Effect[A]): Effect[B] = throw Marker("parallel")
}
def monad: Monad[Effect] = monadInstance
}

val iorts: List[IorT[Effect, String, Int]] = List(
IorT.leftT("hello")(monadInstance),
IorT.bothT(" world", 404)(monadInstance),
IorT.rightT(123)(monadInstance))

val resultSansInstance = {
implicit val ev0 = monadInstance
checkMarker(iorts.parSequence)
}
val resultWithInstance = {
implicit val ev0 = monadInstance
implicit val ev1 = parallelInstance
checkMarker(iorts.parSequence)
}

resultSansInstance should === ("sequential".some)
resultWithInstance should === ("parallel".some)
}

checkAll("Parallel[Either[String, ?], Validated[String, ?]]", ParallelTests[Either[String, ?], Validated[String, ?]].parallel[Int, String])
checkAll("Parallel[Ior[String, ?], Ior[String, ?]]", ParallelTests[Ior[String, ?], Ior[String, ?]].parallel[Int, String])
checkAll("Parallel[IorT[F, String, ?], IorT[F, String, ?]] with parallel effect", ParallelTests[IorT[Either[String, ?], String, ?], IorT[Validated[String, ?], String, ?]].parallel[Int, String])
checkAll("Parallel[IorT[F, String, ?], IorT[F, String, ?]] with sequential effect", ParallelTests[IorT[Option, String, ?], IorT[Option, String, ?]].parallel[Int, String])
checkAll("Parallel[OptionT[M, ?], Nested[F, Option, ?]]", ParallelTests[OptionT[Either[String, ?], ?], Nested[Validated[String, ?], Option, ?]].parallel[Int, String])
checkAll("Parallel[EitherT[M, String, ?], Nested[F, Validated[String, ?], ?]]", ParallelTests[EitherT[Either[String, ?], String, ?], Nested[Validated[String, ?], Validated[String, ?], ?]].parallel[Int, String])
checkAll("Parallel[EitherT[Option, String, ?], Nested[Option, Validated[String, ?], ?]]", ParallelTests[EitherT[Option, String, ?], Nested[Option, Validated[String, ?], ?]].parallel[Int, String])
Expand Down