Merge pull request #1621 from wedens/monad_trans

Replace TransLift  with MonadTrans

core/src/main/scala/cats/MonadTrans.scala

@@ -0,0 +1,17 @@
+package cats
+
+/**
+ * A type class which abstracts over the ability to lift an M[A] into a
+ * MonadTransformer
+ */
+trait MonadTrans[MT[_[_], _]] {
+
+  /**
+   * Lift a value of type M[A] into a monad transformer MT[M, A]
+   */
+  def liftT[M[_]: Monad, A](ma: M[A]): MT[M, A]
+}
+
+object MonadTrans {
+  def apply[MT[_[_], _]](implicit MT: MonadTrans[MT]): MonadTrans[MT] = MT
+}

core/src/main/scala/cats/data/EitherT.scala

@@ -444,11 +444,9 @@ private[data] abstract class EitherTInstances extends EitherTInstances1 {
       val F0: Traverse[F] = F
     }
 
-  implicit def catsDataTransLiftForEitherT[E]: TransLift.Aux[EitherT[?[_], E, ?], Functor] =
-    new TransLift[EitherT[?[_], E, ?]] {
-      type TC[M[_]] = Functor[M]
-
-      def liftT[M[_]: Functor, A](ma: M[A]): EitherT[M, E, A] =
+  implicit def catsDataMonadTransForEitherT[E]: MonadTrans[EitherT[?[_], E, ?]] =
+    new MonadTrans[EitherT[?[_], E, ?]] {
+      def liftT[M[_]: Monad, A](ma: M[A]): EitherT[M, E, A] =
         EitherT.liftT(ma)
     }
 

core/src/main/scala/cats/data/Kleisli.scala

@@ -106,11 +106,9 @@ private[data] sealed abstract class KleisliInstances extends KleisliInstances0 {
         fa.local(f)
     }
 
-  implicit def catsDataTransLiftForKleisli[A]: TransLift.AuxId[Kleisli[?[_], A, ?]] =
-    new TransLift[Kleisli[?[_], A, ?]] {
-      type TC[M[_]] = Trivial
-
-      def liftT[M[_], B](ma: M[B])(implicit ev: Trivial): Kleisli[M, A, B] = Kleisli.lift(ma)
+  implicit def catsDataMonadTransForKleisli[A]: MonadTrans[Kleisli[?[_], A, ?]] =
+    new MonadTrans[Kleisli[?[_], A, ?]] {
+      def liftT[M[_]: Monad, B](ma: M[B]): Kleisli[M, A, B] = Kleisli.lift(ma)
     }
 
   implicit def catsDataApplicativeErrorForKleisli[F[_], A, E](implicit AE: ApplicativeError[F, E]): ApplicativeError[Kleisli[F, A, ?], E] =

core/src/main/scala/cats/data/OptionT.scala

@@ -231,11 +231,9 @@ private[data] sealed trait OptionTInstances0 extends OptionTInstances1 {
 
 private[data] sealed trait OptionTInstances1 extends OptionTInstances2 {
   // do NOT change this to val! I know it looks like it should work, and really I agree, but it doesn't (for... reasons)
-  implicit def catsDataTransLiftForOptionT: TransLift.Aux[OptionT, Functor] =
-    new TransLift[OptionT] {
-      type TC[M[_]] = Functor[M]
-
-      def liftT[M[_]: Functor, A](ma: M[A]): OptionT[M, A] = OptionT.liftF(ma)
+  implicit def catsDataMonadTransForOptionT: MonadTrans[OptionT] =
+    new MonadTrans[OptionT] {
+      def liftT[M[_]: Monad, A](ma: M[A]): OptionT[M, A] = OptionT.liftF(ma)
     }
 
   implicit def catsDataMonoidKForOptionT[F[_]](implicit F0: Monad[F]): MonoidK[OptionT[F, ?]] =

core/src/main/scala/cats/data/StateT.scala

@@ -188,8 +188,8 @@ private[data] sealed trait StateTInstances extends StateTInstances1 {
   implicit def catsDataMonadStateForStateT[F[_], S](implicit F0: Monad[F]): MonadState[StateT[F, S, ?], S] =
     new StateTMonadState[F, S] { implicit def F = F0 }
 
-  implicit def catsDataLiftForStateT[S]: TransLift.Aux[StateT[?[_], S, ?], Applicative] =
-    new StateTTransLift[S] {}
+  implicit def catsDataMonadTransForStateT[S]: MonadTrans[StateT[?[_], S, ?]] =
+    new StateTMonadTrans[S] {}
 }
 
 private[data] sealed trait StateTInstances1 extends StateTInstances2 {
@@ -289,10 +289,8 @@ private[data] sealed trait StateTMonadState[F[_], S] extends MonadState[StateT[F
   def set(s: S): StateT[F, S, Unit] = StateT(_ => F.pure((s, ())))
 }
 
-private[data] sealed trait StateTTransLift[S] extends TransLift[StateT[?[_], S, ?]] {
-  type TC[M[_]] = Applicative[M]
-
-  def liftT[M[_]: Applicative, A](ma: M[A]): StateT[M, S, A] = StateT(s => Applicative[M].map(ma)(s -> _))
+private[data] sealed trait StateTMonadTrans[S] extends MonadTrans[StateT[?[_], S, ?]] {
+  def liftT[M[_]: Monad, A](ma: M[A]): StateT[M, S, A] = StateT(s => Applicative[M].map(ma)(s -> _))
 }
 
 private[data] sealed trait StateTSemigroupK[F[_], S] extends SemigroupK[StateT[F, S, ?]] {
@@ -303,7 +301,7 @@ private[data] sealed trait StateTSemigroupK[F[_], S] extends SemigroupK[StateT[F
     StateT(s => G.combineK(x.run(s), y.run(s)))
 }
 
-private[data] sealed trait StateTMonadCombine[F[_], S] extends MonadCombine[StateT[F, S, ?]] with StateTMonad[F, S] with StateTSemigroupK[F, S] with StateTTransLift[S] {
+private[data] sealed trait StateTMonadCombine[F[_], S] extends MonadCombine[StateT[F, S, ?]] with StateTMonad[F, S] with StateTSemigroupK[F, S] with StateTMonadTrans[S] {
   implicit def F: MonadCombine[F]
   override def G: MonadCombine[F] = F
 

core/src/main/scala/cats/data/WriterT.scala

@@ -79,11 +79,9 @@ private[data] sealed abstract class WriterTInstances extends WriterTInstances0 {
         fab.bimap(f, g)
     }
 
-  implicit def catsDataTransLiftForWriterT[W](implicit W: Monoid[W]): TransLift.Aux[WriterT[?[_], W, ?], Functor] =
-    new TransLift[WriterT[?[_], W, ?]] {
-      type TC[M[_]] = Functor[M]
-
-      def liftT[M[_]: Functor, A](ma: M[A]): WriterT[M, W, A] =
+  implicit def catsDataMonadTransForWriterT[W](implicit W: Monoid[W]): MonadTrans[WriterT[?[_], W, ?]] =
+    new MonadTrans[WriterT[?[_], W, ?]] {
+      def liftT[M[_]: Monad, A](ma: M[A]): WriterT[M, W, A] =
         WriterT(Functor[M].map(ma)((W.empty, _)))
     }
 

core/src/main/scala/cats/syntax/all.scala

@@ -24,10 +24,11 @@ trait AllSyntax
     with InvariantSyntax
     with IorSyntax
     with ListSyntax
-    with MonadSyntax
     with MonadCombineSyntax
     with MonadErrorSyntax
     with MonadFilterSyntax
+    with MonadSyntax
+    with MonadTransSyntax
     with MonoidSyntax
     with OptionSyntax
     with OrderSyntax
@@ -39,7 +40,6 @@ trait AllSyntax
     with ShowSyntax
     with SplitSyntax
     with StrongSyntax
-    with TransLiftSyntax
     with TraverseFilterSyntax
     with TraverseSyntax
     with TupleSyntax

core/src/main/scala/cats/syntax/monadTrans.scala

@@ -0,0 +1,11 @@
+package cats
+package syntax
+
+trait MonadTransSyntax {
+  implicit final def catsSyntaxMonadTrans[F[_], A](fa: F[A]): MonadTransOps[F, A] = new MonadTransOps(fa)
+}
+
+final class MonadTransOps[F[_], A](val fa: F[A]) extends AnyVal {
+  def liftT[MT[_[_], _]](implicit F: Monad[F], MT: MonadTrans[MT]): MT[F, A] =
+    MT.liftT(fa)
+}

core/src/main/scala/cats/syntax/package.scala

@@ -39,7 +39,7 @@ package object syntax {
   object show extends Show.ToShowOps
   object split extends SplitSyntax
   object strong extends StrongSyntax
-  object transLift extends TransLiftSyntax
+  object monadTrans extends MonadTransSyntax
   object traverse extends TraverseSyntax
   object traverseFilter extends TraverseFilterSyntax
   object tuple extends TupleSyntax

free/src/main/scala/cats/free/FreeT.scala

@@ -206,12 +206,9 @@ private[free] sealed trait FreeTInstances1 extends FreeTInstances2 {
       implicit def M: Applicative[M] = M0
     }
 
-  implicit def catsFreeTransLiftForFreeT[S[_]]: TransLift.Aux[FreeT[S, ?[_], ?], Functor] =
-    new TransLift[FreeT[S, ?[_], ?]] {
-
-      type TC[M[_]] = Functor[M]
-
-      override def liftT[M[_]: Functor, A](ma: M[A]): FreeT[S, M, A] =
+  implicit def catsFreeMonadTransForFreeT[S[_]]: MonadTrans[FreeT[S, ?[_], ?]] =
+    new MonadTrans[FreeT[S, ?[_], ?]] {
+      override def liftT[M[_]: Monad, A](ma: M[A]): FreeT[S, M, A] =
         FreeT.liftT(ma)
     }
 }

free/src/test/scala/cats/free/FreeTTests.scala

@@ -50,6 +50,10 @@ class FreeTTests extends CatsSuite {
     checkAll("MonadState[FreeT[State[Int, ?],State[Int, ?], ?], Int]", SerializableTests.serializable(MonadState[FreeTState, Int]))
   }
 
+  {
+    checkAll("MonadTrans[FreeT[Option, ?[_], ?]]", MonadTransTests[FreeT[Option, ?[_], ?]].monadTrans[Option, Int, Int])
+  }
+
   test("FlatMap stack safety tested with 50k flatMaps") {
     val expected = Applicative[FreeTOption].pure(())
     val result =
@@ -96,11 +100,6 @@ class FreeTTests extends CatsSuite {
     val b = a.hoist(FunctionK.id)
   }
 
-  test("transLift for FreeT requires only Functor") {
-    implicit val transLiftInstance = FreeT.catsFreeTransLiftForFreeT[JustFunctor]
-    val d: FreeT[JustFunctor, JustFunctor, Int] = transLiftInstance.liftT[JustFunctor, Int](JustFunctor(1))
-  }
-
   test("compile to universal id equivalent to original instance") {
     forAll { a: FreeTOption[Int] =>
       val b = a.compile(FunctionK.id)

laws/src/main/scala/cats/laws/MonadTransLaws.scala

@@ -0,0 +1,17 @@
+package cats
+package laws
+
+trait MonadTransLaws[MT[_[_], _]] {
+  implicit def MT: MonadTrans[MT]
+
+  def identity[G[_], A](a: A)(implicit G: Monad[G], MTM: Monad[MT[G, ?]]): IsEq[MT[G, A]] =
+    MT.liftT(G.pure(a)) <-> MTM.pure(a)
+
+  def composition[G[_], A, B](ga: G[A], f: A => G[B])(implicit G: Monad[G], MTM: Monad[MT[G, ?]]): IsEq[MT[G, B]] =
+    MT.liftT(G.flatMap(ga)(f)) <-> MTM.flatMap(MT.liftT(ga))(a => MT.liftT(f(a)))
+}
+
+object MonadTransLaws {
+  def apply[MT[_[_], _]](implicit ev: MonadTrans[MT]): MonadTransLaws[MT] =
+    new MonadTransLaws[MT] { def MT: MonadTrans[MT] = ev }
+}

laws/src/main/scala/cats/laws/discipline/MonadTransTests.scala

@@ -0,0 +1,36 @@
+package cats
+package laws
+package discipline
+
+import org.scalacheck.{Arbitrary, Cogen, Prop}
+import org.typelevel.discipline.Laws
+import Prop._
+
+trait MonadTransTests[MT[_[_], _]] extends Laws {
+  def laws: MonadTransLaws[MT]
+
+  def monadTrans[G[_]: Monad, A: Arbitrary: Eq, B: Eq](implicit
+    MonadMTG: Monad[MT[G, ?]],
+    ArbGA: Arbitrary[G[A]],
+    ArbGB: Arbitrary[G[B]],
+    CogenA: Cogen[A],
+    EqGA: Eq[G[A]],
+    EqGB: Eq[G[B]],
+    EqMTGA: Eq[MT[G, A]],
+    EqMTGB: Eq[MT[G, B]]
+  ): RuleSet = {
+    new DefaultRuleSet(
+      name = "monadTrans",
+      parent = None,
+      "monadTrans identity" -> forAll(laws.identity[G, A] _),
+      "monadTrans composition" -> forAll(laws.composition[G, A, B] _)
+    )
+  }
+}
+
+object MonadTransTests {
+  def apply[MT[_[_], _]: MonadTrans]: MonadTransTests[MT] =
+    new MonadTransTests[MT] {
+      def laws: MonadTransLaws[MT] = MonadTransLaws[MT]
+    }
+}

tests/src/test/scala/cats/tests/EitherTTests.scala

@@ -53,9 +53,11 @@ class EitherTTests extends CatsSuite {
     Functor[EitherT[ListWrapper, String, ?]]
     Applicative[EitherT[ListWrapper, String, ?]]
     Monad[EitherT[ListWrapper, String, ?]]
+    MonadTrans[EitherT[?[_], String, ?]]
 
     checkAll("EitherT[ListWrapper, String, Int]", MonadErrorTests[EitherT[ListWrapper, String, ?], String].monadError[Int, Int, Int])
     checkAll("MonadError[EitherT[List, ?, ?]]", SerializableTests.serializable(MonadError[EitherT[ListWrapper, String, ?], String]))
+    checkAll("MonadTrans[EitherT[?[_], String, ?]]", MonadTransTests[EitherT[?[_], String, ?]].monadTrans[ListWrapper, Int, Int])
   }
 
   {

tests/src/test/scala/cats/tests/KleisliTests.scala

@@ -121,6 +121,7 @@ class KleisliTests extends CatsSuite {
 
   checkAll("Kleisli[Option, ?, Int]", ContravariantTests[Kleisli[Option, ?, Int]].contravariant[Int, Int, Int])
   checkAll("Contravariant[Kleisli[Option, ?, Int]]", SerializableTests.serializable(Contravariant[Kleisli[Option, ?, Int]]))
+  checkAll("MonadTrans[Kleisli[?[_], Int, ?]]", MonadTransTests[Kleisli[?[_], Int, ?]].monadTrans[Option, Int, Int])
 
   test("local composes functions") {
     forAll { (f: Int => Option[String], g: Int => Int, i: Int) =>
@@ -226,5 +227,7 @@ class KleisliTests extends CatsSuite {
     ApplicativeError[Kleisli[cats.data.Validated[Unit, ?], Int, ?], Unit]
     ApplicativeError[Kleisli[Option, Int, ?], Unit]
     MonadError[Kleisli[Option, Int, ?], Unit]
+
+    MonadTrans[Kleisli[?[_], Int, ?]]
   }
 }

tests/src/test/scala/cats/tests/OptionTTests.scala

@@ -57,6 +57,7 @@ class OptionTTests extends CatsSuite {
 
     checkAll("OptionT[ListWrapper, Int]", MonoidKTests[OptionT[ListWrapper, ?]].monoidK[Int])
     checkAll("MonoidK[OptionT[ListWrapper, ?]]", SerializableTests.serializable(MonoidK[OptionT[ListWrapper, ?]]))
+    checkAll("MonadTrans[OptionT]", MonadTransTests[OptionT].monadTrans[ListWrapper, Int, Int])
 
     FlatMap[OptionT[ListWrapper, ?]]
     Applicative[OptionT[ListWrapper, ?]]
@@ -307,6 +308,8 @@ class OptionTTests extends CatsSuite {
     implicit val T = ListWrapper.traverse
     implicit val M = ListWrapper.monad
     Functor[OptionT[ListWrapper, ?]]
+
+    MonadTrans[OptionT]
   }
 
 }

tests/src/test/scala/cats/tests/StateTTests.scala

@@ -235,12 +235,15 @@ class StateTTests extends CatsSuite {
 
     checkAll("StateT[ListWrapper, Int, Int]", MonadTests[StateT[ListWrapper, Int, ?]].monad[Int, Int, Int])
     checkAll("Monad[StateT[ListWrapper, Int, ?]]", SerializableTests.serializable(Monad[StateT[ListWrapper, Int, ?]]))
+    checkAll("MonadTrans[EitherT[?[_], String, ?]]", MonadTransTests[EitherT[?[_], String, ?]].monadTrans[ListWrapper, Int, Int])
 
     Monad[StateT[ListWrapper, Int, ?]]
     FlatMap[StateT[ListWrapper, Int, ?]]
     Applicative[StateT[ListWrapper, Int, ?]]
     Apply[StateT[ListWrapper, Int, ?]]
     Functor[StateT[ListWrapper, Int, ?]]
+
+    MonadTrans[StateT[?[_], Int, ?]]
   }
 
   {