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 NonEmptyList#toNem (issue #2346) #2541

Merged
merged 1 commit into from
Oct 8, 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
15 changes: 15 additions & 0 deletions core/src/main/scala/cats/data/NonEmptyList.scala
Original file line number Diff line number Diff line change
Expand Up @@ -406,6 +406,21 @@ final case class NonEmptyList[+A](head: A, tail: List[A]) {
*/
def groupByNem[B](f: A => B)(implicit B: Order[B]): NonEmptyMap[B, NonEmptyList[A]] =
NonEmptyMap.fromMapUnsafe(groupBy(f))


/**
* Creates new `NonEmptyMap`, similarly to List#toMap from scala standard library.
*{{{
* scala> import cats.data._
* scala> import cats.instances.int._
* scala> val nel = NonEmptyList((0, "a"), List((1, "b"),(0, "c"), (2, "d")))
* scala> nel.toNem
* res0: NonEmptyMap[Int,String] = Map(0 -> c, 1 -> b, 2 -> d)
*}}}
*
*/
def toNem[T, U](implicit ev: A <:< (T, U), order: Order[T]): NonEmptyMap[T, U] =
NonEmptyMap.fromMapUnsafe(SortedMap(toList.map(ev): _*)(order.toOrdering))
}

object NonEmptyList extends NonEmptyListInstances {
Expand Down
9 changes: 8 additions & 1 deletion tests/src/test/scala/cats/tests/NonEmptyListSuite.scala
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@ package tests

import cats.kernel.laws.discipline.{SemigroupTests, OrderTests, PartialOrderTests, EqTests}

import cats.data.{NonEmptyList, NonEmptyVector}
import cats.data.{NonEmptyList, NonEmptyVector, NonEmptyMap}
import cats.data.NonEmptyList.ZipNonEmptyList
import cats.laws.discipline.arbitrary._
import cats.laws.discipline.{CommutativeApplyTests, BimonadTests, NonEmptyTraverseTests, ReducibleTests, SemigroupKTests, SerializableTests}
import scala.collection.immutable.SortedMap

class NonEmptyListSuite extends CatsSuite {
// Lots of collections here.. telling ScalaCheck to calm down a bit
Expand Down Expand Up @@ -315,6 +316,12 @@ class NonEmptyListSuite extends CatsSuite {
ior.right.map(xs => xs.sorted should === (xs))
}
}

test("NonEmptyList#toNem is consistent with List#toMap and creating NonEmptyMap from it") {
forAll { nel: NonEmptyList[(Int, String)] =>
nel.toNem should ===(NonEmptyMap.fromMapUnsafe(SortedMap.empty[Int, String] ++ nel.toList.toMap))
}
}
}

@deprecated("to be able to test deprecated methods", since = "1.0.0-RC1")
Expand Down