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 .nested syntax. #2262

Merged
merged 4 commits into from
May 22, 2018
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
4 changes: 3 additions & 1 deletion core/src/main/scala/cats/syntax/all.scala
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,6 @@ trait AllSyntaxBinCompat0
with ApplicativeErrorExtension
with TrySyntax

trait AllSyntaxBinCompat1 extends FlatMapOptionSyntax
trait AllSyntaxBinCompat1
extends FlatMapOptionSyntax
with NestedSyntax
27 changes: 27 additions & 0 deletions core/src/main/scala/cats/syntax/nested.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package cats
package syntax

import cats.data.Nested

trait NestedSyntax {
implicit final def catsSyntaxNestedId[F[_], G[_], A](value: F[G[A]]): NestedIdOps[F, G, A] =
new NestedIdOps[F, G, A](value)
}

final class NestedIdOps[F[_], G[_], A](val value: F[G[A]]) extends AnyVal {
/**
* Wrap a value in `Nested`.
*
* `x.nested` is equivalent to `Nested(x)`.
*
* Example:
* {{{
* scala> import cats.implicits._
* scala> List(Some(3), None).nested.map(_+1).value
* res0: List[Option[Int]] = List(Some(4), None)
* }}}
*/
def nested: Nested[F, G, A] = Nested[F, G, A](value)
}


1 change: 1 addition & 0 deletions core/src/main/scala/cats/syntax/package.scala
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ package object syntax {
object monad extends MonadSyntax
object monadError extends MonadErrorSyntax
object monoid extends MonoidSyntax
object nested extends NestedSyntax
object option extends OptionSyntax
object order extends OrderSyntax
object parallel extends ParallelSyntax
Expand Down
11 changes: 9 additions & 2 deletions tests/src/test/scala/cats/tests/SyntaxSuite.scala
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@ package cats
package tests

import cats.arrow.Compose
import cats.data.Nested
import cats.instances.AllInstances
import cats.syntax.AllSyntax
import cats.syntax.{AllSyntax, AllSyntaxBinCompat1}


/**
Expand All @@ -24,7 +25,7 @@ import cats.syntax.AllSyntax
*
* None of these tests should ever run, or do any runtime checks.
*/
object SyntaxSuite extends AllInstances with AllSyntax {
object SyntaxSuite extends AllInstances with AllSyntax with AllSyntaxBinCompat1 {

// pretend we have a value of type A
def mock[A]: A = ???
Expand Down Expand Up @@ -338,5 +339,11 @@ object SyntaxSuite extends AllInstances with AllSyntax {
val gea4 = ga.recoverWith(pfegea)
}

def testNested[F[_], G[_], A]: Unit = {
val fga: F[G[A]] = mock[F[G[A]]]

val nested: Nested[F, G, A] = fga.nested
}

}